# Package org.xnio

package org.xnio
The main API package for XNIO.

In addition to interfaces that are used and implemented by users of XNIO, this package contains several utility classes which, while not required to write an XNIO application, simplify boilerplate tasks associated with low-level I/O operations.

Related Packages
Package
Description
org.xnio._private
org.xnio.channels
The core XNIO channel API.
org.xnio.conduits
The XNIO conduit SPI.
org.xnio.http
org.xnio.management
org.xnio.sasl
Utility classes for using SASL mechanisms atop NIO or XNIO APIs.
org.xnio.ssl
Utility classes for using and implementing SSL within XNIO providers.
org.xnio.streams
Utility classes for creating streams which use XNIO channels.
Class
Description
AbstractConvertingIoFuture<T,D>
An `IoFuture` implementation that wraps a different type of `IoFuture`.
AbstractIoFuture<T>
An abstract base class for `IoFuture` objects.
AutomaticReference<T>
Deprecated.
See `CleanerReference`.
Bits
General bit-affecting utility methods.
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 extends Buffer>
A simple allocator for buffers.
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`.
ByteString
An immutable string of bytes.
Cancellable
An operation which may be cancelled.
ChainedChannelListener<T extends Channel>
A channel listener that chains calls to a number of other channel listeners.
ChannelDestination<T extends Channel>
A channel destination.
ChannelExceptionHandler<T extends Channel>
An exception handler for utility channel listeners.
ChannelListener<T extends Channel>
A listener for channel events.
ChannelListener.Setter<T extends Channel>
A setter for a channel listener.
ChannelListener.SimpleSetter<T extends Channel>
A simple implementation of `ChannelListener.Setter`.
ChannelListeners
Channel listener utility methods.
ChannelPipe<L extends CloseableChannel,R extends CloseableChannel>
A one-way pipe.
ChannelSource<T extends Channel>
A channel source.
ClosedWorkerException
A channel open was attempted on a closed worker.
Closer
A `Runnable` that closes some resource.
CompressionType
Supported compression types.
Connection
The base for all connections.
DelegatingChannelListener<T extends Channel>
A base class for a channel listener which performs an action and then calls a delegate listener.
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.
FileSystemWatcher
File system watcher service.
FinishedIoFuture<T>
An implementation of `IoFuture` that represents an immediately-successful operation.
FutureResult<T>
A result with a corresponding `IoFuture` instance.
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.
LocalSocketAddress
A socket address which is a local (UNIX domain) socket.
ManagementRegistration
MessageConnection
A message-oriented connection between peers.
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.
Pool<T>
Deprecated.
See `ByteBufferPool`.
Pooled<T>
Deprecated.
See `ByteBufferPool`.
Property
An immutable property represented by a key and value.
ReadPropertyAction
A simple property-read privileged action.
Result<T>
A handler for the result of an operation.
Sequence<T>
An immutable sequence of elements.
SslClientAuthMode
The desired SSL client authentication mode for SSL channels in server mode.
StreamConnection
A connection between peers.
TranslatingResult<T,O>
Abstract base class for `Result`s which translate from one type to another.
Version
The version class.
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.
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.