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.LocationNested classes/interfaces inherited from interface org.eclipse.net4j.util.event.INotifier
org.eclipse.net4j.util.event.INotifier.INotifier2 -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final longIndicates 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.longSynchronous request to open a newIChannelwith an undefined channel protocol.openChannel(String protocolID, Object infraStructure) Synchronous request to open a newIChannelwith a channel protocol defined by a given protocol identifier.openChannel(IProtocol<?> protocol) Synchronous request to open a newIChannelwith the given channel protocol .voidsetOpenChannelTimeout(long openChannelTimeout) Methods 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
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 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
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
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:
-
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
-