The core channel API which is asynchronous and event-driven abstraction of various transports such as a NIO Channel.
Interface Summary Interface Description AddressedEnvelope<M,A extends SocketAddress>A message that wraps another message with a sender address and a recipient address. ChannelA nexus to a network socket or a component which is capable of I/O operations such as read, write, connect, and bind. ChannelFactory<T extends Channel>Creates a new
ChannelHandlerHandles an I/O event or intercepts an I/O operation, and forwards it to its next handler in its
ChannelHandlerto interact with its
ChannelPipelineand other handlers.
ChannelIdRepresents the globally unique identifier of a
ChannelInboundInvoker ChannelOutboundBuffer.MessageProcessor<T extends Exception> ChannelOutboundInvoker ChannelPipelineA list of
ChannelHandlers which handles or intercepts inbound events and outbound operations of a
EventLoopWill handle all the I/O operations for a
EventExecutorGroupwhich allows registering
IoHandles that get processed for later selection during the event loop.
FileRegionA region of a file that is sent via a
Channelwhich supports zero-copy file transfer.
IoExecutionContextThe execution context for an
IoHandleA handle that will process I/O. IoHandlerHandles IO dispatching for an
EventLoopAll operations except
IoHandler.isCompatible(Class)MUST be executed on the
EventLoopthread and should never be called from the user-directly.
RecvBufferAllocatorthat 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.
RecvBufferAllocatorthat limits the number of read operations that will be attempted when a read operation is attempted by the event loop.
MessageSizeEstimatorResponsible to estimate the size of a message. MessageSizeEstimator.Handle RecvBufferAllocatorAllocates a new receive buffer whose capacity is probably large enough to read all inbound data and small enough not to waste its space. RecvBufferAllocator.Handle SelectStrategySelect strategy interface. SelectStrategyFactoryFactory that creates a new
ServerChannel ServerChannelFactory<T extends ServerChannel>Creates a new
Class Summary Class Description AbstractChannel<P extends Channel,L extends SocketAddress,R extends SocketAddress>A skeletal
AbstractChannel.DefaultAbstractChannelPipeline AbstractCoalescingBufferQueue AbstractServerChannel<P extends Channel,L extends SocketAddress,R extends SocketAddress>A skeletal server-side
RecvBufferAllocatorthat automatically increases and decreases the predicted buffer size on feed back.
BufferAddressedEnvelope<A extends SocketAddress,T extends BufferAddressedEnvelope<A,T>>Base class for addressed envelopes that have
Bufferinstances as messages.
FutureContextListenerlisteners that take a context, and listens to the result of a
ChannelHandlerAdapterSkeleton implementation of a
ChannelInitializer<C extends Channel>A special
ChannelHandlerwhich offers an easy way to initialize a
Channelonce it was registered to its
ChannelMetadataRepresents the properties of a
ChannelOptionallows to configure a
Channelin a type-safe way.
ChannelOutboundBuffer(Transport implementors only) an internal data structure used by
AbstractChannelto store its pending outbound write requests.
CoalescingBufferQueueA FIFO queue of bytes where producers add bytes by repeatedly adding
Bufferand consumers take bytes in arbitrary lengths.
CombinedChannelDuplexHandler<I extends ChannelHandler,O extends ChannelHandler>Combines the inbound handling of one
ChannelHandlerwith the outbound handling of another
DefaultAddressedEnvelope<M,A extends SocketAddress>The default
DefaultBufferAddressedEnvelope<A extends SocketAddress>The default
FileRegionimplementation which transfer data from a
RecvBufferAllocatorthat yields a buffer size prediction based upon decrementing the value from the max bytes per read.
DefaultMaxMessagesRecvBufferAllocatorDefault implementation of
ChannelOption.AUTO_READand also prevents overflow.
MessageSizeEstimatorimplementation which supports the estimation of the size of
DefaultSelectStrategyFactoryFactory which uses the default select strategy. FixedRecvBufferAllocatorThe
RecvBufferAllocatorthat always yields the same buffer size prediction.
EventLoopGroupimplementation that will handle its tasks with multiple threads.
PendingWriteQueueA queue of write operations which are pending for later execution. ReflectiveChannelFactory<T extends Channel>A
ChannelFactorythat instantiates a new
Channelby invoking its default constructor reflectively.
ReflectiveServerChannelFactory<T extends ServerChannel>A
ChannelFactorythat instantiates a new
ServerChannelby invoking its default constructor reflectively.
MaxMessagesRecvBufferAllocatorimplementation which should be used for
ChannelHandlerwhich allows to explicit only handle a specific type of messages.
ChannelHandlerwhich allows to conveniently only handle a specific type of user events.
WriteBufferWaterMarkis used to set low water mark and high water mark for the write buffer.
Enum Summary Enum Description ChannelShutdownDirectionThe direction of a shutdown.
Exception Summary Exception Description ChannelExceptionA
RuntimeExceptionwhich is thrown when an I/O operation fails.
ChannelOutputShutdownExceptionUsed to fail pending writes when a channel's output has been shutdown. ChannelPipelineExceptionA
ChannelExceptionwhich is thrown when a
ChannelPipelinefailed to execute an operation.
ConnectExceptionwhich will be thrown if a connection could not be established because of a connection timeout.
ChannelExceptionwhich will be thrown by
EventLoopGroupimplementations when an error occurs.