Package org.eclipse.net4j.connector
Interface IConnector
- All Superinterfaces:
org.eclipse.net4j.util.collection.Closeable,IChannelMultiplexer,org.eclipse.net4j.util.container.IContainer<IChannel>,ILocationAware,org.eclipse.net4j.util.event.INotifier,org.eclipse.net4j.util.properties.IPropertiesContainer,org.eclipse.net4j.util.security.IUserAware
- All Known Subinterfaces:
IJVMConnector,InternalConnector,IServerConnector,ITCPConnector,IWSConnector
- All Known Implementing Classes:
Connector
public interface IConnector
extends IChannelMultiplexer, org.eclipse.net4j.util.security.IUserAware, org.eclipse.net4j.util.collection.Closeable
One endpoint of a physical connection of arbitrary nature between two communicating parties. A
IConnector
encapsulates the process of establishing and closing such connections and has a
location of
CLIENT or
SERVER with respect to this process. Once a connection is
established either party can use its connector to open multiple IChannels to asynchronously exchange
IBuffers.
This interface is not intended to be implemented by clients. Providers of connectors for new physical connection types have to implement org.eclipse.internal.net4j.connector.InternalConnector.
- Author:
- Eike Stepper
- No Implement
- This interface is not intended to be implemented by clients.
- No Extend
- This interface is not intended to be extended by clients.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.eclipse.net4j.util.container.IContainer
org.eclipse.net4j.util.container.IContainer.Modifiable<E extends Object>, org.eclipse.net4j.util.container.IContainer.Persistable<E extends Object>, org.eclipse.net4j.util.container.IContainer.Persistence<E extends Object>Nested classes/interfaces inherited from interface org.eclipse.net4j.ILocationAware
ILocationAware.LocationNested classes/interfaces inherited from interface org.eclipse.net4j.util.event.INotifier
org.eclipse.net4j.util.event.INotifier.INotifier2 -
Field Summary
FieldsFields inherited from interface org.eclipse.net4j.channel.IChannelMultiplexer
DEFAULT_OPEN_CHANNEL_TIMEOUT, NO_CHANNEL_TIMEOUT -
Method Summary
Modifier and TypeMethodDescriptionvoidconnect()Synchronous connect with infinite timeout value.voidconnect(long timeout) Synchronous connect.voidAsynchronous connect.getState()Returns the current state of this connector.getURL()booleanSame as.getState()==ConnectorState.CONNECTEDvoidwaitForConnection(long timeout) Blocks untilor the given timeout expired.isConnected()== trueMethods inherited from interface org.eclipse.net4j.util.collection.Closeable
close, isClosedMethods inherited from interface org.eclipse.net4j.channel.IChannelMultiplexer
getChannels, getOpenChannelTimeout, openChannel, openChannel, openChannel, setOpenChannelTimeoutMethods inherited from interface org.eclipse.net4j.util.container.IContainer
getElements, isEmptyMethods inherited from interface org.eclipse.net4j.ILocationAware
getLocation, isClient, isServerMethods inherited from interface org.eclipse.net4j.util.event.INotifier
addListener, getListeners, hasListeners, removeListenerMethods inherited from interface org.eclipse.net4j.util.properties.IPropertiesContainer
propertiesMethods inherited from interface org.eclipse.net4j.util.security.IUserAware
getUserID
-
Field Details
-
NO_TIMEOUT
static final long NO_TIMEOUT- Since:
- 2.0
- See Also:
-
-
Method Details
-
getURL
String getURL() -
getState
ConnectorState getState()Returns the current state of this connector. -
isConnected
boolean isConnected()Same as.getState()==ConnectorState.CONNECTED -
connect
Synchronous connect with infinite timeout value. Same asconnect(NO_TIMEOUT).- Throws:
ConnectorException- Since:
- 4.0
-
connect
Synchronous connect. Blocks untilor the given timeout expired.isConnected()== true- Parameters:
timeout- The maximum number of milli seconds to block orNO_TIMEOUTto block indefinetely in case no connection occurs.- Throws:
ConnectorException- Since:
- 4.0
-
connectAsync
Asynchronous connect. May leave thisIConnectorin a state where.isConnected()== false- Throws:
ConnectorException- See Also:
-
waitForConnection
Blocks untilor the given timeout expired.isConnected()== true- Parameters:
timeout- The maximum number of milli seconds to block orNO_TIMEOUTto block indefinetely in case no connection occurs.- Throws:
ConnectorException- Since:
- 4.0
-