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 newChannel.ChannelHandler Handles an I/O event or intercepts an I/O operation, and forwards it to its next handler in itsChannelPipeline.ChannelHandlerContext Enables aChannelHandlerto interact with itsChannelPipelineand other handlers.ChannelId Represents the globally unique identifier of aChannel.ChannelInboundInvoker ChannelOutboundBuffer.MessageProcessor<T extends Exception> ChannelOutboundInvoker ChannelPipeline A list ofChannelHandlers which handles or intercepts inbound events and outbound operations of aChannel.EventLoop Will handle all the I/O operations for aIoHandleonce registered.EventLoopGroup SpecialEventExecutorGroupwhich allows registeringIoHandles that get processed for later selection during the event loop.FileRegion A region of a file that is sent via aChannelwhich supports zero-copy file transfer.IoExecutionContext The execution context for anIoHandler.IoHandle A handle that will process I/O.IoHandler Handles IO dispatching for anEventLoopAll operations exceptIoHandler.wakeup(boolean)andIoHandler.isCompatible(Class)MUST be executed on theEventLoopthread and should never be called from the user-directly.IoHandlerFactory Factory forIoHandlerinstances.MaxBytesRecvBufferAllocator 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.MaxMessagesRecvBufferAllocator RecvBufferAllocatorthat 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 newSelectStrategyevery time.ServerChannel ServerChannelFactory<T extends ServerChannel> Creates a newServerChannel. -
Class Summary Class Description AbstractChannel<P extends Channel,L extends SocketAddress,R extends SocketAddress> A skeletalChannelimplementation.AbstractChannel.DefaultAbstractChannelPipeline AbstractCoalescingBufferQueue AbstractServerChannel<P extends Channel,L extends SocketAddress,R extends SocketAddress> A skeletal server-sideChannelimplementation.AdaptiveRecvBufferAllocator TheRecvBufferAllocatorthat 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 haveBufferinstances as messages.ChannelFutureListeners FutureContextListenerlisteners that take a context, and listens to the result of aFuture.ChannelHandlerAdapter Skeleton implementation of aChannelHandler.ChannelInitializer<C extends Channel> A specialChannelHandlerwhich offers an easy way to initialize aChannelonce it was registered to itsEventLoop.ChannelMetadata Represents the properties of aChannelimplementation.ChannelOption<T> AChannelOptionallows to configure aChannelin a type-safe way.ChannelOutboundBuffer (Transport implementors only) an internal data structure used byAbstractChannelto store its pending outbound write requests.CoalescingBufferQueue A FIFO queue of bytes where producers add bytes by repeatedly addingBufferand consumers take bytes in arbitrary lengths.CombinedChannelDuplexHandler<I extends ChannelHandler,O extends ChannelHandler> Combines the inbound handling of oneChannelHandlerwith the outbound handling of anotherChannelHandler.DefaultAddressedEnvelope<M,A extends SocketAddress> The defaultAddressedEnvelopeimplementation.DefaultBufferAddressedEnvelope<A extends SocketAddress> The defaultAddressedEnvelopeimplementation forBuffermessages.DefaultChannelId The defaultChannelIdimplementation.DefaultChannelPipeline The defaultChannelPipelineimplementation.DefaultFileRegion DefaultMaxBytesRecvBufferAllocator TheRecvBufferAllocatorthat yields a buffer size prediction based upon decrementing the value from the max bytes per read.DefaultMaxMessagesRecvBufferAllocator Default implementation ofMaxMessagesRecvBufferAllocatorwhich respectsChannelOption.AUTO_READand also prevents overflow.DefaultMessageSizeEstimator DefaultMessageSizeEstimatorimplementation which supports the estimation of the size ofBufferandFileRegion.DefaultSelectStrategyFactory Factory which uses the default select strategy.FixedRecvBufferAllocator TheRecvBufferAllocatorthat always yields the same buffer size prediction.MultithreadEventLoopGroup EventLoopGroupimplementation that will handle its tasks with multiple threads.PendingWriteQueue A queue of write operations which are pending for later execution.ReflectiveChannelFactory<T extends Channel> AChannelFactorythat instantiates a newChannelby invoking its default constructor reflectively.ReflectiveServerChannelFactory<T extends ServerChannel> AChannelFactorythat instantiates a newServerChannelby invoking its default constructor reflectively.ServerChannelRecvBufferAllocator MaxMessagesRecvBufferAllocatorimplementation which should be used forServerChannels.SimpleChannelInboundHandler<I> ChannelHandlerwhich allows to explicit only handle a specific type of messages.SimpleUserEventChannelHandler<I> ChannelHandlerwhich allows to conveniently only handle a specific type of user events.SingleThreadEventLoop WriteBufferWaterMark WriteBufferWaterMarkis 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 ARuntimeExceptionwhich is thrown when an I/O operation fails.ChannelOutputShutdownException Used to fail pending writes when a channel's output has been shutdown.ChannelPipelineException AChannelExceptionwhich is thrown when aChannelPipelinefailed to execute an operation.ConnectTimeoutException ConnectExceptionwhich will be thrown if a connection could not be established because of a connection timeout.EventLoopException SpecialChannelExceptionwhich will be thrown byEventLoopandEventLoopGroupimplementations when an error occurs.