Package org.xnio.channels

The core XNIO channel API.

See: Description

Interface Summary

Interface	Description
AcceptingChannel<C extends ConnectedChannel>	A channel which can accept inbound connections from remote endpoints.
AcceptListenerSettable<C extends Channel>	An object which supports directly setting the accept listener may implement this interface.
BoundChannel	A channel that is bound to a local address.
BoundMultipointMessageChannel	A multipoint datagram channel.
ByteChannel	An extension of a simple NIO ByteChannel which includes scatter/gather operations.
ChannelFactory<C extends Channel>	A generalized channel factory type.
CloseableChannel	A channel which is closeable.
CloseListenerSettable<C extends Channel>	An object which supports directly setting the close listener may implement this interface.
Configurable	A channel that has parameters that may be configured while the channel is open.
ConnectedChannel	A channel that has a local and peer endpoint address.
ConnectedMessageChannel	A channel that sends and receives messages to a connected peer.
ConnectedSslStreamChannel	A TLS-encapsulated connected stream channel.
ConnectedStreamChannel	A stream channel that is a connection between a local and remote endpoint.
MessageChannel	A channel that sends and receives whole messages.
MulticastMessageChannel	A multicast-capable point-to-multipoint channel.
MulticastMessageChannel.Key	A registration key for a multicast group.
MultipointMessageChannel	A point-to-multipoint message channel.
ProtectedWrappedChannel<C extends Channel>	A protected, wrapped channel.
ReadableMessageChannel	A channel that can receive messages.
ReadableMultipointMessageChannel	The readable side of a multipoint message channel.
ReadListenerSettable<C extends Channel>	An object which supports directly setting the read listener may implement this interface.
SimpleAcceptingChannel<C extends CloseableChannel>	A channel which can accept connections.
SslChannel	A channel which can use SSL/TLS to negotiate a security layer.
StreamChannel	A stream channel.
StreamSinkChannel	A stream sink channel.
StreamSourceChannel	A stream source channel.
SuspendableAcceptChannel	A suspendable accept channel.
SuspendableChannel	A suspendable bidirectional channel.
SuspendableReadChannel	A suspendable readable channel.
SuspendableWriteChannel	A suspendable writable channel.
WrappedChannel<C extends Channel>	A wrapped channel.
WritableMessageChannel	A channel that can send messages.
WritableMultipointMessageChannel	The writable side of a multipoint message channel.
WriteListenerSettable<C extends Channel>	An object which supports directly setting the write listener may implement this interface.

Class Summary

Class	Description
AcceptListenerSettable.Setter<C extends Channel>	A channel listener setter implementation which delegates to the appropriate setter method.
AssembledChannel	A closeable view over a read and write side of a suspendable channel.
AssembledConnectedChannel	A closeable, connected view over a read and write side of a suspendable channel, at least one of which is connected.
AssembledConnectedMessageChannel	A connected bidirectional message channel assembled from a readable and writable message channel.
AssembledConnectedSslStreamChannel	A connected SSL stream channel assembled from a stream source and stream sink.
AssembledConnectedStreamChannel	A connected stream channel assembled from a stream source and stream sink.
AssembledMessageChannel	A bidirectional message channel assembled from a readable and writable message channel.
AssembledSslChannel	An assembled SSL channel.
AssembledStreamChannel	A stream channel assembled from a stream source and stream sink.
BlockingByteChannel	A blocking wrapper for a StreamChannel.
BlockingReadableByteChannel	A blocking wrapper for a StreamSourceChannel.
BlockingWritableByteChannel	A blocking wrapper for a StreamChannel.
Channels	A utility class containing static methods to support channel usage.
CloseListenerSettable.Setter<C extends Channel>	A channel listener setter implementation which delegates to the appropriate setter method.
EmptyStreamSourceChannel	A stream source channel which is always empty.
FixedLengthStreamSinkChannel	A channel which writes a fixed amount of data.
FixedLengthStreamSourceChannel	A channel which reads data of a fixed length and calls a finish listener.
FramedMessageChannel	A connected message channel providing a SASL-style framing layer over a stream channel where each message is prepended by a four-byte length field.
NullStreamSinkChannel	A bit-bucket stream sink channel.
PushBackStreamChannel	A stream source channel which can have data pushed back into it.
ReadListenerSettable.Setter<C extends Channel>	A channel listener setter implementation which delegates to the appropriate setter method.
SocketAddressBuffer	A buffer for source and destination addresses.
SplitStreamSinkChannel	A half-duplex (write side) wrapper for a full-duplex channel.
SplitStreamSourceChannel	A half-duplex (read side) wrapper for a full-duplex channel.
TranslatingSuspendableChannel<C extends SuspendableChannel,W extends SuspendableChannel>	An abstract wrapped channel.
WriteListenerSettable.Setter<C extends Channel>	A channel listener setter implementation which delegates to the appropriate setter method.

Exception Summary

Exception	Description
ConcurrentStreamChannelAccessException	An exception which is thrown when more than one thread tries to access a stream channel at once.
FixedLengthOverflowException	Exception thrown when a fixed-length write channel is written beyond its full length.
FixedLengthUnderflowException	Exception thrown when a fixed-length write channel is not written to its full length.
ReadTimeoutException	Thrown when a blocking read operation times out.
UnsupportedOptionException	An exception that is thrown when an invalid option is specified for a Configurable.
WriteTimeoutException	Thrown when a blocking write operation times out.

Package org.xnio.channels Description

The core XNIO channel API.