Module
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.
-
Interface Summary Interface Description BufferAllocator<B extends java.nio.Buffer> A simple allocator for buffers.Cancellable An operation which may be cancelled.ChannelDestination<T extends java.nio.channels.Channel> A channel destination.ChannelExceptionHandler<T extends java.nio.channels.Channel> An exception handler for utility channel listeners.ChannelListener<T extends java.nio.channels.Channel> A listener for channel events.ChannelListener.Setter<T extends java.nio.channels.Channel> A setter for a channel listener.ChannelSource<T extends java.nio.channels.Channel> A channel source.FileChangeCallback Callback for file system change eventsFileSystemWatcher File system watcher service.IoFuture<T> The future result of an asynchronous request.IoFuture.Notifier<T,A> A notifier that handles changes in the status of anIoFuture
.ManagementRegistration Pool<T> Deprecated. SeeByteBufferPool
.Pooled<T> Deprecated. SeeByteBufferPool
.Result<T> A handler for the result of an operation.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.XnioProvider An XNIO provider, used by the service loader discovery mechanism.XnioWorkerConfigurator An interface which is loaded viaServiceLoader
in order to take over the configuration of the default worker in the event that no overriding configuration is present. -
Class Summary Class Description AbstractConvertingIoFuture<T,D> AnIoFuture
implementation that wraps a different type ofIoFuture
.AbstractIoFuture<T> An abstract base class forIoFuture
objects.AutomaticReference<T> Deprecated. SeeCleanerReference
.Bits General bit-affecting utility methods.Buffers Buffer utility methods.ByteBufferPool A fast source of pooled buffers.ByteBufferPool.Set A set of buffer pools for each size, which can either beByteBufferPool.Set.DIRECT
orByteBufferPool.Set.HEAP
.ByteBufferSlicePool Deprecated. SeeByteBufferPool
.ByteString An immutable string of bytes.ChainedChannelListener<T extends java.nio.channels.Channel> A channel listener that chains calls to a number of other channel listeners.ChannelListener.SimpleSetter<T extends java.nio.channels.Channel> A simple implementation ofChannelListener.Setter
.ChannelListeners Channel listener utility methods.ChannelPipe<L extends CloseableChannel,R extends CloseableChannel> A one-way pipe.Closer ARunnable
that closes some resource.Connection The base for all connections.DelegatingChannelListener<T extends java.nio.channels.Channel> A base class for a channel listener which performs an action and then calls a delegate listener.FailedIoFuture<T> An implementation ofIoFuture
that represents an immediately-failed operation.FileChangeEvent The event object that is fired when a file system change is detected.FinishedIoFuture<T> An implementation ofIoFuture
that represents an immediately-successful operation.FutureResult<T> A result with a correspondingIoFuture
instance.IoFuture.HandlingNotifier<T,A> A base notifier class that calls the designated handler method on notification.IoUtils General I/O utility methods.LocalSocketAddress A socket address which is a local (UNIX domain) socket.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.Property An immutable property represented by a key and value.ReadPropertyAction A simple property-read privileged action.Sequence<T> An immutable sequence of elements.StreamConnection A connection between peers.TranslatingResult<T,O> Abstract base class forResult
s which translate from one type to another.Version The version class.Xnio The XNIO provider class.XnioIoThread An XNIO thread.XnioWorker A worker for I/O channel notification.XnioWorker.Builder A builder which allows workers to be programmatically configured. -
Enum Summary Enum Description CompressionType Supported compression types.FileAccess Possible file access modes.FileChangeEvent.Type Watched file event types.IoFuture.Status The current status of an asynchronous operation.SslClientAuthMode The desired SSL client authentication mode for SSL channels in server mode. -
Exception Summary Exception Description BrokenPipeException An exception that signifies that a pipe, stream, or channel was closed from the read side while the write side was still writing.ClosedWorkerException A channel open was attempted on a closed worker.