Package io.netty.channel
package io.netty.channel
The core channel API which is asynchronous and event-driven abstraction of
various transports such as a
NIO Channel.
-
ClassDescriptionA skeletal
Channel
implementation.Skeletal implementation ofEventLoop
.Skeletal implementation ofEventLoopGroup
.A skeletal server-sideChannel
implementation.TheRecvByteBufAllocator
that automatically increases and decreases the predicted buffer size on feed back.AddressedEnvelope<M,A extends SocketAddress> A message that wraps another message with a sender address and a recipient address.A nexus to a network socket or a component which is capable of I/O operations such as read, write, connect, and bind.Unsafe operations that should never be called from user-code.A set of configuration properties of aChannel
.ChannelHandler
implementation which represents a combination out of aChannelInboundHandler
and theChannelOutboundHandler
.ARuntimeException
which is thrown when an I/O operation fails.ChannelFactory<T extends Channel>Creates a newChannel
.This implementation allows to registerChannelFuture
instances which will get notified once some amount of data was written and so a checkpoint was reached.The result of an asynchronousChannel
I/O operation.Listens to the result of aChannelFuture
.Handles an I/O event or intercepts an I/O operation, and forwards it to its next handler in itsChannelPipeline
.Indicates that the same instance of the annotatedChannelHandler
can be added to one or moreChannelPipeline
s multiple times without a race condition.Skeleton implementation of aChannelHandler
.Enables aChannelHandler
to interact with itsChannelPipeline
and other handlers.Indicates that the annotated event handler method inChannelHandler
will not be invoked byChannelPipeline
and so MUST only be used when theChannelHandler
method does nothing except forward to the nextChannelHandler
in the pipeline.Represents the globally unique identifier of aChannel
.ChannelHandler
which adds callbacks for state changes.Abstract base class forChannelInboundHandler
implementations which provide implementations of all of their methods.ChannelInitializer<C extends Channel>A specialChannelInboundHandler
which offers an easy way to initialize aChannel
once it was registered to itsEventLoop
.Represents the properties of aChannel
implementation.AChannelOption
allows to configure aChannelConfig
in a type-safe way.(Transport implementors only) an internal data structure used byAbstractChannel
to store its pending outbound write requests.ChannelHandler
which will get notified for IO-outbound-operations.Skeleton implementation of aChannelOutboundHandler
.A list ofChannelHandler
s which handles or intercepts inbound events and outbound operations of aChannel
.AChannelException
which is thrown when aChannelPipeline
failed to execute an operation.An specialChannelFuture
which is used to indicate theFileRegion
transfer progressAnEventListener
listener which will be called once the sending task associated with future is being transferred.SpecialChannelPromise
which will be notified once the associated bytes is transferring.SpecialChannelFuture
which is writable.Deprecated.UsePromiseCombiner
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.Deprecated.usePromiseNotifier
.A FIFO queue of bytes where producers add bytes by repeatedly addingByteBuf
and consumers take bytes in arbitrary lengths.A skeletalChannelFuture
implementation which represents aChannelFuture
which has been completed already.ConnectException
which will be thrown if a connection could not be established because of a connection timeout.DefaultAddressedEnvelope<M,A extends SocketAddress> The defaultAddressedEnvelope
implementation.The defaultChannelConfig
implementation.The defaultChannelId
implementation.The defaultChannelPipeline
implementation.The defaultChannelProgressivePromise
implementation.The defaultChannelPromise
implementation.MultithreadEventLoopGroup
which must be used for the local transport.TheRecvByteBufAllocator
that yields a buffer size prediction based upon decrementing the value from the max bytes per read.Default implementation ofMaxMessagesRecvByteBufAllocator
which respectsChannelConfig.isAutoRead()
and also prevents overflow.DefaultMessageSizeEstimator
implementation which supports the estimation of the size ofByteBuf
,ByteBufHolder
andFileRegion
.Default select strategy.Factory which uses the default select strategy.Will handle all the I/O operations for aChannel
once registered.SpecialChannelException
which will be thrown byEventLoop
andEventLoopGroup
implementations when an error occurs.SpecialEventExecutorGroup
which allows registeringChannel
s that get processed for later selection during the event loop.TheCompleteChannelFuture
which is failed already.A region of a file that is sent via aChannel
which supports zero-copy file transfer.TheRecvByteBufAllocator
that always yields the same buffer size prediction.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.RecvByteBufAllocator
that limits the number of read operations that will be attempted when a read operation is attempted by the event loop.Responsible to estimate the size of a message.Abstract base class forEventLoopGroup
implementations that handles their tasks with multiple threads at the same time.A queue of write operations which are pending for later execution.Holds all meta-data and construct the linked-list structure.Wraps anotherByteBufAllocator
and use heapbuffers everywhere except when a direct buffer is explicit requested.Allocates a new receive buffer whose capacity is probably large enough to read all inbound data and small enough not to waste its space.ARecvByteBufAllocator.Handle
which delegates all call to some otherRecvByteBufAllocator.Handle
.Deprecated.ReflectiveChannelFactory<T extends Channel>AChannelFactory
that instantiates a newChannel
by invoking its default constructor reflectively.Select strategy interface.Factory that creates a newSelectStrategy
every time.MaxMessagesRecvByteBufAllocator
implementation which should be used forServerChannel
s.ChannelInboundHandlerAdapter
which allows to explicit only handle a specific type of messages.ChannelInboundHandlerAdapter
which allows to conveniently only handle a specific type of user events.Abstract base class forEventLoop
s that execute all its submitted tasks in a single thread.CheapClosedChannelException
that does not fill in the stacktrace.TheCompleteChannelFuture
which is succeeded already.Deprecated.this will be remove in the next-major release.Deprecated.this will be remove in the next-major release.WriteBufferWaterMark is used to set low water mark and high water mark for the write buffer.