Top Description Interfaces Classes
[default module]

Package org.xnio.channels


The core XNIO channel API.

Interface Summary

Modifier and TypeInterface and Description
public interface
AcceptingChannel<
the channel type
C extends ConnectedChannel
>

A channel which can accept inbound connections from remote endpoints.

public interface
AcceptListenerSettable<C extends Channel>

An object which supports directly setting the accept listener may implement this interface.

public interface
BoundChannel

A channel that is bound to a local address.

public interface
BoundMultipointMessageChannel

A multipoint datagram channel.

public interface
ByteChannel

An extension of a simple NIO java.nio.channels.ByteChannel which includes scatter/gather operations.

public interface
ChannelFactory<C extends Channel>

A generalized channel factory type.

public interface
CloseableChannel

A channel which is closeable.

public interface
CloseListenerSettable<C extends Channel>

An object which supports directly setting the close listener may implement this interface.

public interface
Configurable

A channel that has parameters that may be configured while the channel is open.

public interface
ConnectedChannel

A channel that has a local and peer endpoint address.

public interface
ConnectedMessageChannel

A channel that sends and receives messages to a connected peer.

public interface
ConnectedSslStreamChannel

A TLS-encapsulated connected stream channel.

public interface
ConnectedStreamChannel

A stream channel that is a connection between a local and remote endpoint.

public interface
MessageChannel

A channel that sends and receives whole messages.

public interface
MulticastMessageChannel

A multicast-capable point-to-multipoint channel.

public interface
MultipointMessageChannel

A point-to-multipoint message channel.

public interface
ProtectedWrappedChannel<
the wrapped channel type
C extends Channel
>

A protected, wrapped channel.

public interface
ReadableMessageChannel

A channel that can receive messages.

public interface
ReadableMultipointMessageChannel

The readable side of a multipoint message channel.

public interface
ReadListenerSettable<C extends Channel>

An object which supports directly setting the read listener may implement this interface.

public interface
SimpleAcceptingChannel<
the channel type
C extends CloseableChannel
>

A channel which can accept connections.

public interface
SslChannel

A channel which can use SSL/TLS to negotiate a security layer.

public interface
StreamChannel

A stream channel.

public interface
StreamSinkChannel

A stream sink channel.

public interface
StreamSourceChannel

A stream source channel.

public interface
SuspendableAcceptChannel

A suspendable accept channel.

public interface
SuspendableChannel

A suspendable bidirectional channel.

public interface
SuspendableReadChannel

A suspendable readable channel.

public interface
SuspendableWriteChannel

A suspendable writable channel.

public interface
WrappedChannel<
the wrapped channel type
C extends Channel
>

A wrapped channel.

public interface
WritableMessageChannel

A channel that can send messages.

public interface
WritableMultipointMessageChannel

The writable side of a multipoint message channel.

public interface
WriteListenerSettable<C extends Channel>

An object which supports directly setting the write listener may implement this interface.

Class Summary

Modifier and TypeClass and Description
public class
AssembledChannel

A closeable view over a read and write side of a suspendable channel.

public class
AssembledConnectedChannel

A closeable, connected view over a read and write side of a suspendable channel, at least one of which is connected.

public class
AssembledConnectedMessageChannel

A connected bidirectional message channel assembled from a readable and writable message channel.

public class
AssembledConnectedSslStreamChannel

A connected SSL stream channel assembled from a stream source and stream sink.

public class
AssembledConnectedStreamChannel

A connected stream channel assembled from a stream source and stream sink.

public class
AssembledMessageChannel

A bidirectional message channel assembled from a readable and writable message channel.

public class
AssembledSslChannel

An assembled SSL channel.

public class
AssembledStreamChannel

A stream channel assembled from a stream source and stream sink.

public class
BlockingByteChannel

A blocking wrapper for a StreamChannel.

public class
BlockingReadableByteChannel

A blocking wrapper for a StreamSourceChannel.

public class
BlockingWritableByteChannel

A blocking wrapper for a StreamChannel.

public class
Channels

A utility class containing static methods to support channel usage.

public class
ConcurrentStreamChannelAccessException

An exception which is thrown when more than one thread tries to access a stream channel at once.

public class
EmptyStreamSourceChannel

A stream source channel which is always empty.

public class
FixedLengthOverflowException

Exception thrown when a fixed-length write channel is written beyond its full length.

public class
FixedLengthStreamSinkChannel

A channel which writes a fixed amount of data.

public class
FixedLengthStreamSourceChannel

A channel which reads data of a fixed length and calls a finish listener.

public class
FixedLengthUnderflowException

Exception thrown when a fixed-length write channel is not written to its full length.

public class
FramedMessageChannel

Deprecated This class is deprecated; use conduits instead.
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.
public class
NullStreamSinkChannel

A bit-bucket stream sink channel.

public class
PushBackStreamChannel

A stream source channel which can have data pushed back into it.

public class
ReadTimeoutException

Thrown when a blocking read operation times out.

public class
SocketAddressBuffer

A buffer for source and destination addresses.

public class
SplitStreamSinkChannel

A half-duplex (write side) wrapper for a full-duplex channel.

public class
SplitStreamSourceChannel

A half-duplex (read side) wrapper for a full-duplex channel.

public abstract class
TranslatingSuspendableChannel<
the channel type implemented by this class
C extends SuspendableChannel
,
the channel type being wrapped by this class
W extends SuspendableChannel
>

Deprecated This class is deprecated; use conduits instead.
An abstract wrapped channel.
public class
UnsupportedOptionException

An exception that is thrown when an invalid option is specified for a Configurable.

public class
WriteTimeoutException

Thrown when a blocking write operation times out.