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.Location

    Nested classes/interfaces inherited from interface org.eclipse.net4j.util.event.INotifier

    org.eclipse.net4j.util.event.INotifier.INotifier2

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final long
    NO_TIMEOUT
     

    Fields inherited from interface org.eclipse.net4j.channel.IChannelMultiplexer

    DEFAULT_OPEN_CHANNEL_TIMEOUT, NO_CHANNEL_TIMEOUT

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    connect()
    Synchronous connect with infinite timeout value.
    void
    connect(long timeout)
    Synchronous connect.
    void
    connectAsync()
    Asynchronous connect.
    ConnectorState
    getState()
    Returns the current state of this connector.
    String
    getURL()
     
    boolean
    isConnected()
    Same as getState() == ConnectorState.CONNECTED.
    void
    waitForConnection(long timeout)
    Blocks until isConnected() == true or the given timeout expired.

    Methods inherited from interface org.eclipse.net4j.util.collection.Closeable

    close, isClosed

    Methods inherited from interface org.eclipse.net4j.channel.IChannelMultiplexer

    getChannels, getOpenChannelTimeout, openChannel, openChannel, openChannel, setOpenChannelTimeout

    Methods inherited from interface org.eclipse.net4j.util.container.IContainer

    getElements, isEmpty

    Methods inherited from interface org.eclipse.net4j.ILocationAware

    getLocation, isClient, isServer

    Methods inherited from interface org.eclipse.net4j.util.event.INotifier

    addListener, getListeners, hasListeners, removeListener

    Methods inherited from interface org.eclipse.net4j.util.properties.IPropertiesContainer

    properties

    Methods inherited from interface org.eclipse.net4j.util.security.IUserAware

    getUserID