Grizzly NIO 5.0.2 · org.glassfish.grizzly · APIdia, the JavaDoc alternative

Interface Summary

Modifier and Type	Interface and Description
public interface	Appendable<T>
public interface	Appender<E>
public interface	Buffer JDK `ByteBuffer` was taken as base for Grizzly `Buffer` interface, but `Buffer` has several extensions: it's possible to prepend some data to a Buffer and release Buffer, when it's not required any more.
public interface	Cacheable
public interface	ChangeListener<E>
public interface	Closeable General asynchronous closable interface.
public interface	CloseListener<T extends Closeable, C extends ICloseType> The listener, which is used to be notified, when `Connection` gets closed.
public interface	Codec<K, L> Codec is able to transform the original message to a custom represantation and vise versa.
public interface	CompletionHandler< the type of the result E> Interface, which will be used by Grizzly to notify about asynchronous I/O operations status updates.
public interface	Connection< the Connection address type L> Common interface, which represents any kind of connection.
public interface	ConnectionProbe Monitoring probe providing callbacks that may be invoked by Grizzly `Connection` implementations.
public interface	ConnectorHandler<E> Client side connector handler API.
public interface	Copyable General interface for the objects, that could be copied/cloned.
public interface	FileChunk
public interface	GenericCloseListener Deprecated This interface was added to 2.3 to avoid having to declare `CloseListener` with parameter types.
public interface	GracefulShutdownListener Interface to notify interested parties that a `Transport` is being shutdown.
public interface	GrizzlyFuture< the result type R> Grizzly `Future` implementation.
public interface	ICloseType Deprecated Added for backwards compatibility.
public interface	InputSource This interface defines methods to allow an `InputStream` or `Reader` to notify the developer when and how much data is ready to be read without blocking.
public interface	Interceptor<R> Handler, which is used to finer control `Readable`.
public interface	IOEventLifeCycleListener The `IOEvent` life-cycle listener, which will be notified about changes in `IOEvent` processing statuses.
public interface	IOStrategy `strategy` is responsible for making decision how `Runnable` task will be run: in current thread, worker thread.
public interface	OutputSink This interface defines methods to allow an `java.io.OutputStream` or `java.io.Writer` to allow the developer to check with the runtime whether or not it's possible to write a certain amount of data, or if it's not possible, to be notified when it is.
public interface	Processor<E extends Context> Processor implementations are responsible for processing I/O events, which occur on connection.
public interface	ProcessorSelector Implementations of the interface will be responsible to find correct `Processor`, which will process `IOEvent`, occurred on the `Connection`
public interface	Readable<L> Implementations of this interface are able to read data from internal source to a `Buffer`.
public interface	Reader< the reader address type L> Implementations of this interface are able to read data from `Connection` to a `Buffer`.
public interface	ReadHandler This class represents a call-back mechanism that will notify implementations as more input data becomes available to read without blocking.
public interface	Result Common I/O result interface.
public interface	ShutdownContext This class will be passed to `GracefulShutdownListener` instances registered against a `Transport`.
public interface	SocketAcceptor Common interface for `SocketAcceptor` implementations.
public interface	SocketBinder Common API for `java.net.Socket` based `Transport`s, which are able to bind server `java.net.Socket` to specific address and listen for incoming data.
public interface	SocketConnectorHandler Socket based client side connector.
public interface	Transformer<K, L> `Transformer` interface, which knows how to transform the original data to some custom representation.
public interface	Transport Transport interface describes the transport unit used in Grizzly.
public interface	TransportProbe Monitoring probe providing callbacks that may be invoked by Grizzly `Transport` implementations.
public interface	Writeable<L> Implementations of this interface are able to write data from a `Buffer`.
public interface	WriteHandler Callback notification mechanism that signals the developer it's possible to write content.
public interface	Writer< the writer address type L> Implementations of this interface are able to write data from a `Buffer` to `Connection`.

Class Summary

Modifier and Type	Class and Description
public abstract class	AbstractBindingHandler
public abstract class	AbstractReader<L> Abstract class, which provides transitive dependencies for overloaded `Reader` methods.
public abstract class	AbstractSocketConnectorHandler Abstract class simplifies the implementation of `SocketConnectorHandler` interface by pre-implementing some of its methods.
public abstract class	AbstractTransformer<K, L>
public abstract class	AbstractTransport Abstract `Transport`.
public abstract class	AbstractWriter<L> Abstract class, which provides transitive dependencies for overloaded `Writer` methods.
public class	ChainProcessorSelector `ProcessorSelector` implementation, which acts like wrapper for chain of `ProcessorSelector`s.
public class	CloseReason An object, describing the reason why `Connection` was closed.
public class	Context Object, which is responsible for holding context during I/O event processing.
public class	DefaultProcessorSelector Default `ProcessorSelector` implementation, which uses `Connection`'s `Processor` preferences.
public class	EmptyCompletionHandler<E> Empty implementation for `CompletionHandler` interface.
public class	FileTransfer A simple class that abstracts `FileChannel#transferTo(long, long, java.nio.channels.WritableByteChannel)` for use with Grizzly 2.0 `org.glassfish.grizzly.asyncqueue.AsyncQueueWriter`.
public class	Grizzly Class contains information about Grizzly framework.
public abstract class	NIOTransportBuilder<T extends NIOTransportBuilder> This builder is responsible for creating `NIOTransport` implementations as well as providing basic configuration for `IOStrategies` and thread pools.
public class	PendingWriteQueueLimitExceededException Thrown when an attempt is made to add a record that exceeds the configured maximum queue size.
public class	PortRange Immutable class representing a port range.
public class	ProcessorExecutor
public class	ProcessorResult The interface represents the result of `Processor` execution.
public class	ReadResult< type of the message K, type of the address L> Result of read operation, returned by `Readable`.
public class	StandaloneProcessor `Processor`, which is not interested in processing I/O events.
public class	StandaloneProcessorSelector `ProcessorSelector`, which doesn't add any `Processor` to process occurred `IOEvent`.
public class	ThreadCache
public class	TransformationException Describes the problem, occurred during original message transformation.
public class	TransformationResult<I, O> Represents the result of message encoding/decoding.
public class	WriteResult< type of the message K, type of the address L> Result of write operation, returned by `Writeable`.

Modifier and Type	Enum and Description
public enum	CloseType References Deprecated `ICloseType` is deprecated or references (maybe indirectly) at least one deprecated element.
public enum	IOEvent Enumeration represents the I/O events, occurred on a `Connection`.

Package org.glassfish.grizzly

Interface Summary

Class Summary

Enum Summary