# All Classes and Interfaces

Class
Description
AbstractConduit<D>
An abstract base class for filtering conduits.
AbstractConvertingIoFuture<T,D>
An `IoFuture` implementation that wraps a different type of `IoFuture`.
AbstractIoFuture<T>
An abstract base class for `IoFuture` objects.
AbstractMessageSinkConduit<D>
An abstract base class for filtering message sink conduits.
AbstractMessageSourceConduit<D>
An abstract base class for filtering message source conduits.
AbstractSinkConduit<D>
An abstract base class for filtering output conduits.
AbstractSourceConduit<D>
An abstract base class for filtering source conduits.
AbstractStreamSinkConduit<D>
An abstract base class for filtering stream sink conduits.
AbstractStreamSourceConduit<D>
An abstract base class for filtering stream source conduits.
AbstractSynchronizedConduit<D>
An abstract synchronized conduit.
AbstractSynchronizedSinkConduit<D>
AbstractSynchronizedSourceConduit<D>
An abstract synchronized source conduit.
AcceptingChannel<C>
A channel which can accept inbound connections from remote endpoints.
AcceptListenerSettable<C>
An object which supports directly setting the accept listener may implement this interface.
AcceptListenerSettable.Setter<C>
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.
AutomaticReference<T>
Deprecated.
See `CleanerReference`.
Bits
General bit-affecting utility methods.
BlockingByteChannel
A blocking wrapper for a `StreamChannel`.
BlockingReadableByteChannel
A blocking wrapper for a `StreamSourceChannel`.
BlockingStreamSinkConduit
BlockingStreamSourceConduit
A stream source conduit which can switch into and out of blocking mode.
BlockingWritableByteChannel
A blocking wrapper for a `StreamChannel`.
BoundChannel
A channel that is bound to a local address.
BoundMultipointMessageChannel
A multipoint datagram channel.
BrokenPipeException
An exception that signifies that a pipe, stream, or channel was closed from the read side while the write side was still writing.
BufferAllocator<B>
A simple allocator for buffers.
BufferedChannelInputStream
An input stream which reads from a stream source channel with a buffer.
BufferedStreamSinkConduit
A stream sink conduit that buffers output data.
BufferedStreamSourceConduit
A stream source conduit which buffers input.
BufferPipeInputStream
An `InputStream` implementation which is populated asynchronously with `ByteBuffer` instances.
BufferPipeInputStream.InputHandler
A handler for events relating to the consumption of data from a `BufferPipeInputStream` instance.
BufferPipeOutputStream
An `OutputStream` implementation which writes out `ByteBuffer`s to a consumer.
BufferPipeOutputStream.BufferWriter
A buffer writer for an `BufferPipeOutputStream`.
Buffers
Buffer utility methods.
ByteBufferPool
A fast source of pooled buffers.
ByteBufferPool.Set
A set of buffer pools for each size, which can either be `ByteBufferPool.Set.DIRECT` or `ByteBufferPool.Set.HEAP`.
ByteBufferSlicePool
Deprecated.
See `ByteBufferPool`.
ByteChannel
An extension of a simple NIO `ByteChannel` which includes scatter/gather operations.
ByteString
An immutable string of bytes.
Cancellable
An operation which may be cancelled.
ChainedChannelListener<T>
A channel listener that chains calls to a number of other channel listeners.
ChannelDestination<T>
A channel destination.
ChannelExceptionHandler<T>
An exception handler for utility channel listeners.
ChannelFactory<C>
A generalized channel factory type.
ChannelInputStream
An input stream which reads from a stream source channel.
ChannelListener<T>
A listener for channel events.
ChannelListener.Setter<T>
A setter for a channel listener.
ChannelListener.SimpleSetter<T>
A simple implementation of `ChannelListener.Setter`.
ChannelListeners
Channel listener utility methods.
ChannelOutputStream
An output stream which writes to a stream sink channel.
ChannelPipe<L,R>
A one-way pipe.
Channels
A utility class containing static methods to support channel usage.
ChannelSource<T>
A channel source.
CloseableChannel
A channel which is closeable.
ClosedWorkerException
A channel open was attempted on a closed worker.
CloseListenerSettable<C>
An object which supports directly setting the close listener may implement this interface.
CloseListenerSettable.Setter<C>
A channel listener setter implementation which delegates to the appropriate setter method.
Closer
A `Runnable` that closes some resource.
CompressionType
Supported compression types.
ConcurrentStreamChannelAccessException
An exception which is thrown when more than one thread tries to access a stream channel at once.
Conduit
A conduit, or stage which data transfer is processed by or provided by.
ConduitReadableByteChannel
A byte channel which wraps a conduit.
ConduitReadableMessageChannel
A readable message channel which is backed by a message source conduit.
Conduits
General utility methods for manipulating conduits.
ConduitStreamSinkChannel
A stream sink channel which wraps a stream sink conduit.
ConduitStreamSourceChannel
A stream source channel which wraps a stream source conduit.
ConduitWritableByteChannel
A byte channel which wraps a conduit.
ConduitWritableMessageChannel
A writable message channel which is backed by a message sink conduit.
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.
Connection
The base for all connections.
ConnectionClosedEarlyException
Exception thrown if the connection is unexpectedly closed during http upgrade before the response can be fully read.
DeflatingStreamSinkConduit
A filtering stream sink conduit which compresses the written data.
DelegatingChannelListener<T>
A base class for a channel listener which performs an action and then calls a delegate listener.
EmptyStreamSourceChannel
A stream source channel which is always empty.
EmptyStreamSourceConduit
A stream source conduit which is always empty.
ExtendedHandshakeChecker
A class that can decide if a HTTP upgrade handshake is valid.
FailedIoFuture<T>
An implementation of `IoFuture` that represents an immediately-failed operation.
FileAccess
Possible file access modes.
FileChangeCallback
Callback for file system change events
FileChangeEvent
The event object that is fired when a file system change is detected.
FileChangeEvent.Type
Watched file event types.
FileChannel
Compatibility stub.
FileChannel.MapMode
FileSystemWatcher
File system watcher service.
FinishedIoFuture<T>
An implementation of `IoFuture` that represents an immediately-successful operation.
FixedLengthOverflowException
Exception thrown when a fixed-length write channel is written beyond its full length.
FixedLengthStreamSinkChannel
A channel which writes a fixed amount of data.
FixedLengthStreamSinkConduit
A stream sink conduit with a limited length.
FixedLengthStreamSourceChannel
A channel which reads data of a fixed length and calls a finish listener.
FixedLengthStreamSourceConduit
A stream source conduit which limits the length of input.
FixedLengthUnderflowException
Exception thrown when a fixed-length write channel is not written to its full length.
FramedMessageChannel
Deprecated.
This class is deprecated; use conduits instead.
FramingMessageSinkConduit
A message sink conduit which implements a simple message framing protocol over a stream conduit.
FramingMessageSourceConduit
A message source conduit which implements a simple message framing protocol over a stream conduit.
FutureResult<T>
A result with a corresponding `IoFuture` instance.
HandshakeChecker
A class that can decide if a HTTP upgrade handshake is valid.
HttpUpgrade
Simple HTTP client that can perform a HTTP upgrade.
InflatingStreamSourceConduit
A filtering stream source conduit which decompresses the source data.
IoFuture<T>
The future result of an asynchronous request.
IoFuture.HandlingNotifier<T,A>
A base notifier class that calls the designated handler method on notification.
IoFuture.Notifier<T,A>
A notifier that handles changes in the status of an `IoFuture`.
IoFuture.Status
The current status of an asynchronous operation.
IoUtils
General I/O utility methods.
JsseSslConnection
JsseSslStreamConnection
StreamConnection with SSL support.
JsseSslUtils
Utility methods for creating JSSE constructs and configuring them via XNIO option maps.
JsseXnioSsl
An XNIO SSL provider based on JSSE.
LimitedInputStream
An input stream which truncates the underlying stream to the given length.
LimitedOutputStream
An output stream which truncates the writable output to the given length.
LocalSocketAddress
A socket address which is a local (UNIX domain) socket.
ManagementRegistration
MessageChannel
A channel that sends and receives whole messages.
MessageConnection
A message-oriented connection between peers.
Messages
Messages_$logger
Warning this class consists of generated code.
MessageSinkConduit
A message sink conduit.
MessageSourceConduit
A message source conduit.
MessageStreamSinkConduit
A stream sink conduit which wraps each write into a single message.
MessageStreamSourceConduit
A stream source conduit which reads stream data from 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.
NullStreamSinkChannel
A bit-bucket stream sink channel.
NullStreamSinkConduit
A stream sink conduit which discards all data written to it.
Option<T>
A strongly-typed option to configure an aspect of a service or connection.
Option.SetBuilder
A builder for an immutable option set.
OptionMap
An immutable map of options to option values.
OptionMap.Builder
A builder for immutable option maps.
Options
Common channel options.
Pipe
An in-VM pipe between an input stream and an output stream, which does not suffer from the bugs in `PipedInputStream`.
Pool<T>
Deprecated.
See `ByteBufferPool`.
Pooled<T>
Deprecated.
See `ByteBufferPool`.
Property
An immutable property represented by a key and value.
ProtectedWrappedChannel<C>
A protected, wrapped channel.
PushBackStreamChannel
A stream source channel which can have data pushed back into it.
PushBackStreamSourceConduit
A stream source conduit which allows buffers to be "pushed back" to the head of the stream.
ReadableMessageChannel
A channel that can receive messages.
ReadableMultipointMessageChannel
The readable side of a multipoint message channel.
ReaderInputStream
An input stream which encodes characters into bytes.
ReadListenerSettable<C>
An object which supports directly setting the read listener may implement this interface.
ReadListenerSettable.Setter<C>
A channel listener setter implementation which delegates to the appropriate setter method.
ReadPropertyAction
A simple property-read privileged action.
ReadReadyHandler
A conduit read-ready handler.
ReadReadyHandler.ChannelListenerHandler<C>
A read ready handler which calls channel listener(s).
ReadReadyHandler.ReadyTask
A runnable task which invokes the `ReadReadyHandler.readReady()` method of the given handler.
ReadTimeoutException
Thrown when a blocking read operation times out.
RedirectException
An extension of `IOException` used to convey that a connection has failed as a redirect has been encountered.
Result<T>
A handler for the result of an operation.
SaslQop
The SASL quality-of-protection value.
SaslStrength
The SASL cipher strength value.
SaslUnwrappingConduit
SaslUtils
Utility methods for handling SASL authentication using NIO-style programming methods.
SaslWrapper
A wrapper delegation class for SASL that presents the same wrap/unwrap API regardless of whether it is dealing with a SASL client or server.
SaslWrappingConduit
Sequence<T>
An immutable sequence of elements.
SimpleAcceptingChannel<C>
A channel which can accept connections.
SinkConduit
A conduit which is a target or output for data.
SocketAddressBuffer
A buffer for source and destination addresses.
SourceConduit
SplitStreamSinkChannel
A half-duplex (write side) wrapper for a full-duplex channel.
SplitStreamSourceChannel
A half-duplex (read side) wrapper for a full-duplex channel.
SslChannel
A channel which can use SSL/TLS to negotiate a security layer.
SslClientAuthMode
The desired SSL client authentication mode for SSL channels in server mode.
SslConnection
A stream connection which can use SSL/TLS to negotiate a security layer.
StreamChannel
A stream channel.
StreamConnection
A connection between peers.
Streams
Stream utility class.
StreamSinkChannel
A stream sink channel.
StreamSinkChannelWrappingConduit
A conduit which wraps a channel, for compatibility.
StreamSinkConduit
A sink (writable) conduit for byte streams.
StreamSourceChannel
A stream source channel.
StreamSourceChannelWrappingConduit
A conduit which wraps a channel, for compatibility.
StreamSourceConduit
SuspendableAcceptChannel
A suspendable accept channel.
SuspendableChannel
A suspendable bidirectional channel.
SuspendableReadChannel
A suspendable readable channel.
SuspendableWriteChannel
A suspendable writable channel.
SynchronizedMessageSinkConduit
A synchronized message sink conduit.
SynchronizedMessageSourceConduit
A synchronized message source conduit.
SynchronizedStreamSinkConduit
A synchronized stream sink conduit.
SynchronizedStreamSourceConduit
A synchronized stream source conduit.
TerminateHandler
The base ready handler type, which can forward termination requests as well as notifications of termination completion.
TerminateHandler.ChannelListenerHandler<C>
A terminate handler which calls a channel listener on termination notification.
TerminateHandler.ReadyTask
A runnable task which invokes the `TerminateHandler.terminated()` method of the given handler.
TranslatingResult<T,O>
Abstract base class for `Result`s which translate from one type to another.
TranslatingSuspendableChannel<C,W>
Deprecated.
This class is deprecated; use conduits instead.
UnsupportedOptionException
An exception that is thrown when an invalid option is specified for a `Configurable`.
UpgradeFailedException
Exception that is thrown when a valid HTTP response is received that is not an upgrade or redirect response.
Version
The version class.
WrappedChannel<C>
A wrapped channel.
WritableMessageChannel
A channel that can send messages.
WritableMultipointMessageChannel
The writable side of a multipoint message channel.
WriteListenerSettable<C>
An object which supports directly setting the write listener may implement this interface.
WriteListenerSettable.Setter<C>
A channel listener setter implementation which delegates to the appropriate setter method.
WriteReadyHandler
A conduit write-ready handler.
WriteReadyHandler.ChannelListenerHandler<C>
A write ready handler which calls channel listener(s).
WriteReadyHandler.ReadyTask
A runnable task which invokes the `WriteReadyHandler.writeReady()` method of the given handler.
WriterOutputStream
An output stream which decodes bytes into a character writer.
WriteTimeoutException
Thrown when a blocking write operation times out.
Xnio
The XNIO provider class.
XnioExecutor
An executor with the capability to run timed, cancellable tasks.
XnioExecutor.Key
A task key for a timeout task.
XnioIoFactory
An XNIO I/O factory which can be used to create channels.
XnioIoThread
An XNIO thread.
XnioProvider
An XNIO provider, used by the service loader discovery mechanism.
XnioProviderMXBean
The MXBean interface for XNIO providers.
XnioServerMXBean
XnioSsl
An SSL provider for XNIO.
XnioWorker
A worker for I/O channel notification.
XnioWorker.Builder
A builder which allows workers to be programmatically configured.
XnioWorkerConfigurator
An interface which is loaded via `ServiceLoader` in order to take over the configuration of the default worker in the event that no overriding configuration is present.
XnioWorkerMXBean