Package io.netty.channel

The core channel API which is asynchronous and event-driven abstraction of various transports such as a NIO Channel.

See: Description

Interface Summary

Interface	Description
AddressedEnvelope<M,A extends SocketAddress>	A message that wraps another message with a sender address and a recipient address.
Channel	A nexus to a network socket or a component which is capable of I/O operations such as read, write, connect, and bind.
Channel.Unsafe	Unsafe operations that should never be called from user-code.
ChannelConfig	A set of configuration properties of a Channel.
ChannelFactory<T extends Channel>	Creates a new Channel.
ChannelFuture	The result of an asynchronous Channel I/O operation.
ChannelFutureListener	Listens to the result of a ChannelFuture.
ChannelHandler	Handles an I/O event or intercepts an I/O operation, and forwards it to its next handler in its ChannelPipeline.
ChannelHandlerContext	Enables a ChannelHandler to interact with its ChannelPipeline and other handlers.
ChannelId	Represents the globally unique identifier of a Channel.
ChannelInboundHandler	ChannelHandler which adds callbacks for state changes.
ChannelInboundInvoker
ChannelOutboundBuffer.MessageProcessor
ChannelOutboundHandler	ChannelHandler which will get notified for IO-outbound-operations.
ChannelOutboundInvoker
ChannelPipeline	A list of ChannelHandlers which handles or intercepts inbound events and outbound operations of a Channel.
ChannelProgressiveFuture	An special ChannelFuture which is used to indicate the FileRegion transfer progress
ChannelProgressiveFutureListener	An EventListener listener which will be called once the sending task associated with future is being transferred.
ChannelProgressivePromise	Special ChannelPromise which will be notified once the associated bytes is transferring.
ChannelPromise	Special ChannelFuture which is writable.
EventLoop	Will handle all the I/O operations for a Channel once registered.
EventLoopGroup	Special EventExecutorGroup which allows registering Channels that get processed for later selection during the event loop.
EventLoopTaskQueueFactory	Factory used to create Queue instances that will be used to store tasks for an EventLoop.
FileRegion	A region of a file that is sent via a Channel which supports zero-copy file transfer.
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.
MaxMessagesRecvByteBufAllocator	RecvByteBufAllocator that limits the number of read operations that will be attempted when a read operation is attempted by the event loop.
MessageSizeEstimator	Responsible to estimate the size of a message.
MessageSizeEstimator.Handle
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.
RecvByteBufAllocator.ExtendedHandle
RecvByteBufAllocator.Handle	Deprecated Use RecvByteBufAllocator.ExtendedHandle.
SelectStrategy	Select strategy interface.
SelectStrategyFactory	Factory that creates a new SelectStrategy every time.
ServerChannel	A Channel that accepts an incoming connection attempt and creates its child Channels by accepting them.

Class Summary

Class	Description
AbstractChannel	A skeletal Channel implementation.
AbstractCoalescingBufferQueue
AbstractEventLoop	Skeletal implementation of EventLoop.
AbstractEventLoopGroup	Skeletal implementation of EventLoopGroup.
AbstractServerChannel	A skeletal server-side Channel implementation.
AdaptiveRecvByteBufAllocator	The RecvByteBufAllocator that automatically increases and decreases the predicted buffer size on feed back.
ChannelDuplexHandler	ChannelHandler implementation which represents a combination out of a ChannelInboundHandler and the ChannelOutboundHandler.
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.
ChannelHandlerAdapter	Skeleton implementation of a ChannelHandler.
ChannelInboundHandlerAdapter	Abstract base class for ChannelInboundHandler implementations which provide implementations of all of their methods.
ChannelInitializer<C extends Channel>	A special ChannelInboundHandler which offers an easy way to initialize a Channel once it was registered to its EventLoop.
ChannelMetadata	Represents the properties of a Channel implementation.
ChannelOption<T>	A ChannelOption allows to configure a ChannelConfig in a type-safe way.
ChannelOutboundBuffer	(Transport implementors only) an internal data structure used by AbstractChannel to store its pending outbound write requests.
ChannelOutboundHandlerAdapter	Skeleton implementation of a ChannelOutboundHandler.
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.
ChannelPromiseNotifier	Deprecated use PromiseNotifier.
CoalescingBufferQueue	A FIFO queue of bytes where producers add bytes by repeatedly adding ByteBuf and consumers take bytes in arbitrary lengths.
CombinedChannelDuplexHandler<I extends ChannelInboundHandler,O extends ChannelOutboundHandler>	Combines a ChannelInboundHandler and a ChannelOutboundHandler into one ChannelHandler.
DefaultAddressedEnvelope<M,A extends SocketAddress>	The default AddressedEnvelope implementation.
DefaultChannelConfig	The default ChannelConfig implementation.
DefaultChannelId	The default ChannelId implementation.
DefaultChannelPipeline	The default ChannelPipeline implementation.
DefaultChannelProgressivePromise	The default ChannelProgressivePromise implementation.
DefaultChannelPromise	The default ChannelPromise implementation.
DefaultEventLoop
DefaultEventLoopGroup	MultithreadEventLoopGroup which must be used for the local transport.
DefaultFileRegion	Default FileRegion implementation which transfer data from a FileChannel or File.
DefaultMaxBytesRecvByteBufAllocator	The RecvByteBufAllocator that yields a buffer size prediction based upon decrementing the value from the max bytes per read.
DefaultMaxMessagesRecvByteBufAllocator	Default implementation of MaxMessagesRecvByteBufAllocator which respects ChannelConfig.isAutoRead() and also prevents overflow.
DefaultMessageSizeEstimator	Default MessageSizeEstimator implementation which supports the estimation of the size of ByteBuf, ByteBufHolder and FileRegion.
DefaultSelectStrategyFactory	Factory which uses the default select strategy.
DelegatingChannelPromiseNotifier
FixedRecvByteBufAllocator	The RecvByteBufAllocator that always yields the same buffer size prediction.
MultithreadEventLoopGroup	Abstract base class for EventLoopGroup implementations that handles their tasks with multiple threads at the same time.
PendingWriteQueue	A queue of write operations which are pending for later execution.
PreferHeapByteBufAllocator	Wraps another ByteBufAllocator and use heapbuffers everywhere except when a direct buffer is explicit requested.
RecvByteBufAllocator.DelegatingHandle	A RecvByteBufAllocator.Handle which delegates all call to some other RecvByteBufAllocator.Handle.
ReflectiveChannelFactory<T extends Channel>	A ChannelFactory that instantiates a new Channel by invoking its default constructor reflectively.
ServerChannelRecvByteBufAllocator	MaxMessagesRecvByteBufAllocator implementation which should be used for ServerChannels.
SimpleChannelInboundHandler<I>	ChannelInboundHandlerAdapter which allows to explicit only handle a specific type of messages.
SimpleUserEventChannelHandler<I>	ChannelInboundHandlerAdapter which allows to conveniently only handle a specific type of user events.
SingleThreadEventLoop	Abstract base class for EventLoops that execute all its submitted tasks in a single thread.
SingleThreadEventLoop.ChannelsReadOnlyIterator<T extends Channel>
ThreadPerChannelEventLoop	Deprecated this will be remove in the next-major release.
ThreadPerChannelEventLoopGroup	Deprecated this will be remove in the next-major release.
VoidChannelPromise
WriteBufferWaterMark	WriteBufferWaterMark is used to set low water mark and high water mark for the write buffer.

Exception Summary

Exception	Description
ChannelException	A RuntimeException which is thrown when an I/O operation fails.
ChannelPipelineException	A ChannelException which is thrown when a ChannelPipeline failed to execute an operation.
ConnectTimeoutException	ConnectException which will be thrown if a connection could not be established because of a connection timeout.
EventLoopException	Special ChannelException which will be thrown by EventLoop and EventLoopGroup implementations when an error occurs.

Annotation Types Summary

Annotation Type	Description
ChannelHandler.Sharable	Indicates that the same instance of the annotated ChannelHandler can be added to one or more ChannelPipelines multiple times without a race condition.

Package io.netty.channel Description

The core channel API which is asynchronous and event-driven abstraction of various transports such as a NIO Channel.