Package org.eclipse.net4j.channel
Interface IChannelMultiplexer
- 
- All Superinterfaces:
- org.eclipse.net4j.util.container.IContainer<IChannel>,- ILocationAware,- org.eclipse.net4j.util.event.INotifier,- org.eclipse.net4j.util.properties.IPropertiesContainer
 - All Known Subinterfaces:
- IConnector,- IJVMConnector,- InternalChannelMultiplexer,- InternalConnector,- IServerConnector,- ITCPConnector,- IWSConnector
 - All Known Implementing Classes:
- ChannelMultiplexer,- Connector
 
 public interface IChannelMultiplexer extends ILocationAware, org.eclipse.net4j.util.container.IContainer<IChannel>, org.eclipse.net4j.util.properties.IPropertiesContainer Manages and multiplexes virtual datachannelsover a shared physical connection.- 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.IContainerorg.eclipse.net4j.util.container.IContainer.Modifiable<E extends java.lang.Object>, org.eclipse.net4j.util.container.IContainer.Persistable<E extends java.lang.Object>, org.eclipse.net4j.util.container.IContainer.Persistence<E extends java.lang.Object>
 - 
Nested classes/interfaces inherited from interface org.eclipse.net4j.ILocationAwareILocationAware.Location
 
- 
 - 
Field SummaryFields Modifier and Type Field Description static longDEFAULT_OPEN_CHANNEL_TIMEOUTIndicates to use the timeout that is configured via debug propertyopen.channel.timeout(see .options file) which has a default of 10 seconds.static longNO_CHANNEL_TIMEOUT
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Collection<IChannel>getChannels()Returns a collection of currently open channels.longgetOpenChannelTimeout()IChannelopenChannel()Synchronous request to open a newIChannelwith an undefined channel protocol.IChannelopenChannel(java.lang.String protocolID, java.lang.Object infraStructure)Synchronous request to open a newIChannelwith a channel protocol defined by a given protocol identifier.IChannelopenChannel(IProtocol<?> protocol)Synchronous request to open a newIChannelwith the given channel protocol .voidsetOpenChannelTimeout(long openChannelTimeout)- 
Methods inherited from interface org.eclipse.net4j.ILocationAwaregetLocation, isClient, isServer
 
- 
 
- 
- 
- 
Field Detail- 
NO_CHANNEL_TIMEOUTstatic final long NO_CHANNEL_TIMEOUT - Since:
- 2.0
- See Also:
- Constant Field Values
 
 - 
DEFAULT_OPEN_CHANNEL_TIMEOUTstatic final long DEFAULT_OPEN_CHANNEL_TIMEOUT Indicates to use the timeout that is configured via debug propertyopen.channel.timeout(see .options file) which has a default of 10 seconds.- Since:
- 2.0
- See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
openChannelIChannel openChannel() throws ChannelException Synchronous request to open a newIChannelwith an undefined channel protocol. Since the peer connector can't lookup a protocolfactorywithout a protocol identifier theIBufferHandlerof the peerIChannelcan only be provided by externally provided channellifecyclelisteners.- Throws:
- ChannelException
- Since:
- 2.0
- See Also:
- openChannel(String, Object),- openChannel(IProtocol)
 
 - 
openChannelIChannel openChannel(java.lang.String protocolID, java.lang.Object infraStructure) throws ChannelException Synchronous request to open a newIChannelwith a channel protocol defined by a given protocol identifier. The peer connector will lookup a protocolfactorywith the protocol identifier, create aIBufferHandlerand inject it into the peerIChannel.- Throws:
- ChannelException
- Since:
- 2.0
- See Also:
- openChannel(),- openChannel(IProtocol)
 
 - 
openChannelIChannel openChannel(IProtocol<?> protocol) throws ChannelException Synchronous request to open a newIChannelwith the given channel protocol . The peer connector will lookup a protocolfactorywith the protocol identifier, create aIBufferHandlerand inject it into the peer channel.- Throws:
- ChannelException
- Since:
- 2.0
- See Also:
- openChannel(),- openChannel(String, Object)
 
 - 
getChannelsjava.util.Collection<IChannel> getChannels() Returns a collection of currently open channels.- Since:
- 2.0
 
 - 
getOpenChannelTimeoutlong getOpenChannelTimeout() - Since:
- 2.0
 
 - 
setOpenChannelTimeoutvoid setOpenChannelTimeout(long openChannelTimeout) - Since:
- 2.0
 
 
- 
 
-