Module io.netty5.transport

Package io.netty5.channel

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.
Channel	A 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 Channel.
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.
ChannelInboundInvoker
ChannelOutboundBuffer.MessageProcessor<T extends Exception>
ChannelOutboundInvoker
ChannelPipeline	A list of ChannelHandlers which handles or intercepts inbound events and outbound operations of a Channel.
EventLoop	Will handle all the I/O operations for a IoHandle once registered.
EventLoopGroup	Special EventExecutorGroup which allows registering IoHandles that get processed for later selection during the event loop.
FileRegion	A region of a file that is sent via a Channel which supports zero-copy file transfer.
IoExecutionContext	The execution context for an IoHandler.
IoHandle	A handle that will process I/O.
IoHandler	Handles IO dispatching for an EventLoop All operations except IoHandler.wakeup(boolean) and IoHandler.isCompatible(Class) MUST be executed on the EventLoop thread and should never be called from the user-directly.
IoHandlerFactory	Factory for IoHandler instances.
MaxBytesRecvBufferAllocator	RecvBufferAllocator 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.
MaxMessagesRecvBufferAllocator	RecvBufferAllocator 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
RecvBufferAllocator	Allocates 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
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.
ServerChannelFactory<T extends ServerChannel>	Creates a new ServerChannel.

Class Summary

Class	Description
AbstractChannel<P extends Channel,L extends SocketAddress,R extends SocketAddress>	A skeletal Channel implementation.
AbstractChannel.DefaultAbstractChannelPipeline
AbstractCoalescingBufferQueue
AbstractServerChannel<P extends Channel,L extends SocketAddress,R extends SocketAddress>	A skeletal server-side Channel implementation.
AdaptiveRecvBufferAllocator	The RecvBufferAllocator that 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 Buffer instances as messages.
ChannelFutureListeners	FutureContextListener listeners that take a context, and listens to the result of a Future.
ChannelHandlerAdapter	Skeleton implementation of a ChannelHandler.
ChannelInitializer<C extends Channel>	A special ChannelHandler 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 Channel in a type-safe way.
ChannelOutboundBuffer	(Transport implementors only) an internal data structure used by AbstractChannel to store its pending outbound write requests.
CoalescingBufferQueue	A FIFO queue of bytes where producers add bytes by repeatedly adding Buffer and consumers take bytes in arbitrary lengths.
CombinedChannelDuplexHandler<I extends ChannelHandler,O extends ChannelHandler>	Combines the inbound handling of one ChannelHandler with the outbound handling of another ChannelHandler.
DefaultAddressedEnvelope<M,A extends SocketAddress>	The default AddressedEnvelope implementation.
DefaultBufferAddressedEnvelope<A extends SocketAddress>	The default AddressedEnvelope implementation for Buffer messages.
DefaultChannelId	The default ChannelId implementation.
DefaultChannelPipeline	The default ChannelPipeline implementation.
DefaultFileRegion	Default FileRegion implementation which transfer data from a FileChannel or File.
DefaultMaxBytesRecvBufferAllocator	The RecvBufferAllocator that yields a buffer size prediction based upon decrementing the value from the max bytes per read.
DefaultMaxMessagesRecvBufferAllocator	Default implementation of MaxMessagesRecvBufferAllocator which respects ChannelOption.AUTO_READ and also prevents overflow.
DefaultMessageSizeEstimator	Default MessageSizeEstimator implementation which supports the estimation of the size of Buffer and FileRegion.
DefaultSelectStrategyFactory	Factory which uses the default select strategy.
FixedRecvBufferAllocator	The RecvBufferAllocator that always yields the same buffer size prediction.
MultithreadEventLoopGroup	EventLoopGroup implementation that will handle its tasks with multiple threads.
PendingWriteQueue	A queue of write operations which are pending for later execution.
ReflectiveChannelFactory<T extends Channel>	A ChannelFactory that instantiates a new Channel by invoking its default constructor reflectively.
ReflectiveServerChannelFactory<T extends ServerChannel>	A ChannelFactory that instantiates a new ServerChannel by invoking its default constructor reflectively.
ServerChannelRecvBufferAllocator	MaxMessagesRecvBufferAllocator implementation which should be used for ServerChannels.
SimpleChannelInboundHandler<I>	ChannelHandler which allows to explicit only handle a specific type of messages.
SimpleUserEventChannelHandler<I>	ChannelHandler which allows to conveniently only handle a specific type of user events.
SingleThreadEventLoop	EventLoop that execute all its submitted tasks in a single thread and uses an IoHandler for IO processing.
WriteBufferWaterMark	WriteBufferWaterMark is used to set low water mark and high water mark for the write buffer.

Enum Summary

Enum	Description
ChannelShutdownDirection	The direction of a shutdown.

Exception Summary

Exception	Description
ChannelException	A RuntimeException which is thrown when an I/O operation fails.
ChannelOutputShutdownException	Used to fail pending writes when a channel's output has been shutdown.
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.