Top Description Interfaces Classes Enums
[default 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

Modifier and TypeInterface and Description
public interface
BufferAllocator<
the buffer type
B extends Buffer
>

A simple allocator for buffers.

public interface
Cancellable

An operation which may be cancelled.

public interface
ChannelDestination<
the channel type
T extends Channel
>

A channel destination.

public interface
ChannelExceptionHandler<T extends Channel>

An exception handler for utility channel listeners.

public interface
ChannelListener<
the channel type
T extends Channel
>

A listener for channel events.

public interface
ChannelSource<
the type of channel
T extends Channel
>

A channel source.

public interface
FileChangeCallback

Callback for file system change events

public interface
FileSystemWatcher

File system watcher service.

public interface
IoFuture<
the type of result that this operation produces
T
>

The future result of an asynchronous request.

public interface
public interface
Pool<
the resource type
T
>

Deprecated See ByteBufferPool.
A generic pooled resource manager.
public interface
Pooled<
the pooled resource type
T
>

Deprecated See ByteBufferPool.
A resource which is pooled.
public interface
Result<T>

A handler for the result of an operation.

public interface
XnioExecutor

An executor with the capability to run timed, cancellable tasks.

public interface
XnioIoFactory

An XNIO I/O factory which can be used to create channels.

public interface
XnioProvider

An XNIO provider, used by the service loader discovery mechanism.

public interface
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.

Class Summary

Modifier and TypeClass and Description
public abstract class
AbstractConvertingIoFuture<
the type of this future result
T
,
the type of the delegate result
D
>

An IoFuture implementation that wraps a different type of IoFuture.

public abstract class
AbstractIoFuture<
the type of result that this operation produces
T
>

An abstract base class for IoFuture objects.

public abstract class
AutomaticReference<T>

Deprecated See CleanerReference.
An automatic reference is a phantom reference which is automatically freed by a background thread when it is enqueued.
public class
Bits

General bit-affecting utility methods.

public class
BrokenPipeException

An exception that signifies that a pipe, stream, or channel was closed from the read side while the write side was still writing.

public class
Buffers

Buffer utility methods.

public abstract class
ByteBufferPool

A fast source of pooled buffers.

public class
ByteBufferSlicePool

Deprecated See ByteBufferPool.
A buffer pooled allocator.
public class
ByteString

An immutable string of bytes.

public class
ChainedChannelListener<T extends Channel>

A channel listener that chains calls to a number of other channel listeners.

public class
ChannelListeners

Channel listener utility methods.

public class
ChannelPipe<L extends CloseableChannel, R extends CloseableChannel>

A one-way pipe.

public class
ClosedWorkerException

A channel open was attempted on a closed worker.

public class
Closer

A Runnable that closes some resource.

public abstract class
Connection

The base for all connections.

pack-priv class
public abstract class
DelegatingChannelListener<T extends Channel>

A base class for a channel listener which performs an action and then calls a delegate listener.

public class
FailedIoFuture<
the type of result that this operation produces
T
>

An implementation of IoFuture that represents an immediately-failed operation.

public class
FileChangeEvent

The event object that is fired when a file system change is detected.

public class
FinishedIoFuture<
the type of result that this operation produces
T
>

An implementation of IoFuture that represents an immediately-successful operation.

public class
FutureResult<
the IoFuture result type
T
>

A result with a corresponding org.xnio.IoFuture instance.

public class
IoUtils

General I/O utility methods.

public class
LocalSocketAddress

A socket address which is a local (UNIX domain) socket.

public abstract class
MessageConnection

A message-oriented connection between peers.

pack-priv class
ObjectProperties

A Hashtable variant which keeps property names in order, for use by MBean ObjectNames.

public abstract class
Option<
the option value type
T
>

A strongly-typed option to configure an aspect of a service or connection.

public class
OptionMap

An immutable map of options to option values.

public class
Options

Common channel options.

pack-priv class
PollingFileSystemWatcher

Polling based file system watcher service, for use on JDK6

public class
Property

An immutable property represented by a key and value.

public class
ReadPropertyAction

A simple property-read privileged action.

public class
Sequence<
the element type
T
>

An immutable sequence of elements.

pack-priv class
pack-priv class
public abstract class
StreamConnection

A connection between peers.

public abstract class
TranslatingResult<
the result type to accept
T
,
the result type to pass to the delegate
O
>

Abstract base class for Results which translate from one type to another.

pack-priv class
pack-priv class
public class
Version

The version class.

public abstract class
Xnio

The XNIO provider class.

pack-priv class
public abstract class
XnioIoThread

An XNIO thread.

public abstract class
XnioWorker

A worker for I/O channel notification.

pack-priv class
XnioXmlParser

The XNIO XML configuration parser.

Enum Summary

Modifier and TypeEnum and Description
public enum
CompressionType

Supported compression types.

public enum
FileAccess

Possible file access modes.

public enum
SslClientAuthMode

The desired SSL client authentication mode for SSL channels in server mode.