Netty 4.1.107.Final · io.netty.channel

Interface Summary

Modifier and Type	Interface and Description
public interface	AddressedEnvelope< the type of the wrapped message M, the type of the address A extends SocketAddress> A message that wraps another message with a sender address and a recipient address.
public interface	Channel A nexus to a network socket or a component which is capable of I/O operations such as read, write, connect, and bind.
public interface	ChannelConfig A set of configuration properties of a `Channel`.
public interface	ChannelFactory<T extends Channel> Deprecated as a consequence of `ChannelFactory` being deprecated. Creates a new `Channel`.
public interface	ChannelFuture The result of an asynchronous `Channel` I/O operation.
public interface	ChannelFutureListener Listens to the result of a `ChannelFuture`.
public interface	ChannelHandler Handles an I/O event or intercepts an I/O operation, and forwards it to its next handler in its `ChannelPipeline`.
public interface	ChannelHandlerContext Enables a `ChannelHandler` to interact with its `ChannelPipeline` and other handlers.
public interface	ChannelId Represents the globally unique identifier of a `Channel`.
public interface	ChannelInboundHandler `ChannelHandler` which adds callbacks for state changes.
public interface	ChannelInboundInvoker
public interface	ChannelOutboundHandler `ChannelHandler` which will get notified for IO-outbound-operations.
public interface	ChannelOutboundInvoker
public interface	ChannelPipeline A list of `ChannelHandler`s which handles or intercepts inbound events and outbound operations of a `Channel`.
public interface	ChannelProgressiveFuture An special `ChannelFuture` which is used to indicate the `FileRegion` transfer progress
public interface	ChannelProgressiveFutureListener An `EventListener` listener which will be called once the sending task associated with future is being transferred.
public interface	ChannelProgressivePromise Special `ChannelPromise` which will be notified once the associated bytes is transferring.
public interface	ChannelPromise Special `ChannelFuture` which is writable.
public interface	EventLoop Will handle all the I/O operations for a `Channel` once registered.
public interface	EventLoopGroup Special `EventExecutorGroup` which allows registering `Channel`s that get processed for later selection during the event loop.
public interface	EventLoopTaskQueueFactory Factory used to create `Queue` instances that will be used to store tasks for an `EventLoop`.
public interface	FileRegion A region of a file that is sent via a `Channel` which supports zero-copy file transfer.
public interface	MaxBytesRecvByteBufAllocator `RecvByteBufAllocator` that limits a read operation based upon a maximum value per individual read and a maximum amount when a read operation is attempted by the event loop.
public interface	MaxMessagesRecvByteBufAllocator `RecvByteBufAllocator` that limits the number of read operations that will be attempted when a read operation is attempted by the event loop.
public interface	MessageSizeEstimator Responsible to estimate the size of a message.
public interface	RecvByteBufAllocator Allocates a new receive buffer whose capacity is probably large enough to read all inbound data and small enough not to waste its space.
public interface	SelectStrategy Select strategy interface.
public interface	SelectStrategyFactory Factory that creates a new `SelectStrategy` every time.
public interface	ServerChannel A `Channel` that accepts an incoming connection attempt and creates its child `Channel`s by accepting them.

Class Summary

Modifier and Type	Class and Description
public abstract class	AbstractChannel A skeletal `Channel` implementation.
pack-priv abstract class	AbstractChannelHandlerContext
public abstract class	AbstractCoalescingBufferQueue
public abstract class	AbstractEventLoop Skeletal implementation of `EventLoop`.
public abstract class	AbstractEventLoopGroup Skeletal implementation of `EventLoopGroup`.
public abstract class	AbstractServerChannel A skeletal server-side `Channel` implementation.
public class	AdaptiveRecvByteBufAllocator The `RecvByteBufAllocator` that automatically increases and decreases the predicted buffer size on feed back.
public class	ChannelDuplexHandler `ChannelHandler` implementation which represents a combination out of a `ChannelInboundHandler` and the `ChannelOutboundHandler`.
public class	ChannelException A `RuntimeException` which is thrown when an I/O operation fails.
public class	ChannelFlushPromiseNotifier This implementation allows to register `ChannelFuture` instances which will get notified once some amount of data was written and so a checkpoint was reached.
public abstract class	ChannelHandlerAdapter Skeleton implementation of a `ChannelHandler`.
pack-priv class	ChannelHandlerMask
public class	ChannelInboundHandlerAdapter Abstract base class for `ChannelInboundHandler` implementations which provide implementations of all of their methods.
public abstract class	ChannelInitializer< A sub-type of `Channel` C extends Channel> A special `ChannelInboundHandler` which offers an easy way to initialize a `Channel` once it was registered to its `EventLoop`.
public class	ChannelMetadata Represents the properties of a `Channel` implementation.
public class	ChannelOption< the type of the value which is valid for the `ChannelOption` T> A `ChannelOption` allows to configure a `ChannelConfig` in a type-safe way.
public class	ChannelOutboundBuffer (Transport implementors only) an internal data structure used by `AbstractChannel` to store its pending outbound write requests.
public class	ChannelOutboundHandlerAdapter Skeleton implementation of a `ChannelOutboundHandler`.
public class	ChannelPipelineException A `ChannelException` which is thrown when a `ChannelPipeline` failed to execute an operation.
public class	ChannelPromiseAggregator Deprecated Use `PromiseCombiner` Class which is used to consolidate multiple channel futures into one, by listening to the individual futures and producing an aggregated result (success/failure) when all futures have completed.
public class	ChannelPromiseNotifier Deprecated use `PromiseNotifier`. ChannelFutureListener implementation which takes other `ChannelPromise`(s) and notifies them on completion.
public class	CoalescingBufferQueue A FIFO queue of bytes where producers add bytes by repeatedly adding `ByteBuf` and consumers take bytes in arbitrary lengths.
public class	CombinedChannelDuplexHandler<I extends ChannelInboundHandler, O extends ChannelOutboundHandler> Combines a `ChannelInboundHandler` and a `ChannelOutboundHandler` into one `ChannelHandler`.
pack-priv abstract class	CompleteChannelFuture A skeletal `ChannelFuture` implementation which represents a `ChannelFuture` which has been completed already.
public class	ConnectTimeoutException `ConnectException` which will be thrown if a connection could not be established because of a connection timeout.
public class	DefaultAddressedEnvelope< the type of the wrapped message M, the type of the recipient address A extends SocketAddress> The default `AddressedEnvelope` implementation.
public class	DefaultChannelConfig The default `ChannelConfig` implementation.
pack-priv class	DefaultChannelHandlerContext
public class	DefaultChannelId The default `ChannelId` implementation.
public class	DefaultChannelPipeline The default `ChannelPipeline` implementation.
public class	DefaultChannelProgressivePromise The default `ChannelProgressivePromise` implementation.
public class	DefaultChannelPromise The default `ChannelPromise` implementation.
public class	DefaultEventLoop
public class	DefaultEventLoopGroup `MultithreadEventLoopGroup` which must be used for the local transport.
public class	DefaultFileRegion Default `FileRegion` implementation which transfer data from a `FileChannel` or `File`.
public class	DefaultMaxBytesRecvByteBufAllocator The `RecvByteBufAllocator` that yields a buffer size prediction based upon decrementing the value from the max bytes per read.
public abstract class	DefaultMaxMessagesRecvByteBufAllocator Default implementation of `MaxMessagesRecvByteBufAllocator` which respects `ChannelConfig#isAutoRead()` and also prevents overflow.
public class	DefaultMessageSizeEstimator Default `MessageSizeEstimator` implementation which supports the estimation of the size of `ByteBuf`, `ByteBufHolder` and `FileRegion`.
pack-priv class	DefaultSelectStrategy Default select strategy.
public class	DefaultSelectStrategyFactory Factory which uses the default select strategy.
public class	DelegatingChannelPromiseNotifier
public class	EventLoopException Special `ChannelException` which will be thrown by `EventLoop` and `EventLoopGroup` implementations when an error occurs.
pack-priv class	ExtendedClosedChannelException
pack-priv class	FailedChannelFuture The `CompleteChannelFuture` which is failed already.
public class	FixedRecvByteBufAllocator The `RecvByteBufAllocator` that always yields the same buffer size prediction.
public abstract class	MultithreadEventLoopGroup Abstract base class for `EventLoopGroup` implementations that handles their tasks with multiple threads at the same time.
pack-priv abstract class	PendingBytesTracker
public class	PendingWriteQueue A queue of write operations which are pending for later execution.
public class	PreferHeapByteBufAllocator Wraps another `ByteBufAllocator` and use heapbuffers everywhere except when a direct buffer is explicit requested.
public class	ReflectiveChannelFactory<T extends Channel> Deprecated as a consequence of `ChannelFactory` being deprecated. A `ChannelFactory` that instantiates a new `Channel` by invoking its default constructor reflectively.
public class	ServerChannelRecvByteBufAllocator `MaxMessagesRecvByteBufAllocator` implementation which should be used for `ServerChannel`s.
public abstract class	SimpleChannelInboundHandler<I> `ChannelInboundHandlerAdapter` which allows to explicit only handle a specific type of messages.
public abstract class	SimpleUserEventChannelHandler<I> `ChannelInboundHandlerAdapter` which allows to conveniently only handle a specific type of user events.
public abstract class	SingleThreadEventLoop Abstract base class for `EventLoop`s that execute all its submitted tasks in a single thread.
pack-priv class	StacklessClosedChannelException Cheap `ClosedChannelException` that does not fill in the stacktrace.
pack-priv class	SucceededChannelFuture The `CompleteChannelFuture` which is succeeded already.
public class	ThreadPerChannelEventLoop Deprecated this will be remove in the next-major release. `SingleThreadEventLoop` which is used to handle OIO `Channel`'s.
public class	ThreadPerChannelEventLoopGroup Deprecated this will be remove in the next-major release. An `EventLoopGroup` that creates one `EventLoop` per `Channel`.
public class	VoidChannelPromise
public class	WriteBufferWaterMark WriteBufferWaterMark is used to set low water mark and high water mark for the write buffer.

Package io.netty.channel

Interface Summary

Class Summary