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 data
channels
over 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.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
Modifier and TypeFieldDescriptionstatic final long
Indicates to use the timeout that is configured via debug propertyopen.channel.timeout
(see .options file) which has a default of 10 seconds.static final long
-
Method Summary
Modifier and TypeMethodDescriptionReturns a collection of currently open channels.long
Synchronous request to open a newIChannel
with an undefined channel protocol.openChannel
(String protocolID, Object infraStructure) Synchronous request to open a newIChannel
with a channel protocol defined by a given protocol identifier.openChannel
(IProtocol<?> protocol) Synchronous request to open a newIChannel
with the given channel protocol .void
setOpenChannelTimeout
(long openChannelTimeout) 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
-
Field Details
-
NO_CHANNEL_TIMEOUT
static final long NO_CHANNEL_TIMEOUT- Since:
- 2.0
- See Also:
-
DEFAULT_OPEN_CHANNEL_TIMEOUT
static final long DEFAULT_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.- Since:
- 2.0
- See Also:
-
-
Method Details
-
openChannel
Synchronous request to open a newIChannel
with an undefined channel protocol. Since the peer connector can't lookup a protocolfactory
without a protocol identifier theIBufferHandler
of the peerIChannel
can only be provided by externally provided channellifecycle
listeners
.- Throws:
ChannelException
- Since:
- 2.0
- See Also:
-
openChannel
Synchronous request to open a newIChannel
with a channel protocol defined by a given protocol identifier. The peer connector will lookup a protocolfactory
with the protocol identifier, create aIBufferHandler
and inject it into the peerIChannel
.- Throws:
ChannelException
- Since:
- 2.0
- See Also:
-
openChannel
Synchronous request to open a newIChannel
with the given channel protocol . The peer connector will lookup a protocolfactory
with the protocol identifier, create aIBufferHandler
and inject it into the peer channel.- Throws:
ChannelException
- Since:
- 2.0
- See Also:
-
getChannels
Collection<IChannel> getChannels()Returns a collection of currently open channels.- Since:
- 2.0
-
getOpenChannelTimeout
long getOpenChannelTimeout()- Since:
- 2.0
-
setOpenChannelTimeout
void setOpenChannelTimeout(long openChannelTimeout) - Since:
- 2.0
-