Package org.jboss.netty.channel
The core channel API which is asynchronous and event-driven abstraction of
various transports such as a
NIO Channel.
-
Interface Summary Interface Description Channel A nexus to a network socket or a component which is capable of I/O operations such as read, write, connect, and bind.ChannelConfig A set of configuration properties of aChannel
.ChannelDownstreamHandler Handles or intercepts a downstreamChannelEvent
, and sends aChannelEvent
to the next handler in aChannelPipeline
.ChannelEvent An I/O event or I/O request associated with aChannel
.ChannelFactory The main interface to a transport that creates aChannel
associated with a certain communication entity such as a network socket.ChannelFuture The result of an asynchronousChannel
I/O operation.ChannelFutureListener Listens to the result of aChannelFuture
.ChannelFutureProgressListener Listens to the progress of a time-consuming I/O operation such as a large file transfer.ChannelHandler Handles or intercepts aChannelEvent
, and sends aChannelEvent
to the next handler in aChannelPipeline
.ChannelHandlerContext Enables aChannelHandler
to interact with itsChannelPipeline
and other handlers.ChannelPipeline ChannelPipelineFactory Creates a newChannelPipeline
for a newChannel
.ChannelSink Receives and processes the terminal downstreamChannelEvent
s.ChannelStateEvent AChannelEvent
which represents the change of theChannel
state.ChannelUpstreamHandler Handles or intercepts an upstreamChannelEvent
, and sends aChannelEvent
to the next handler in aChannelPipeline
.ChildChannelStateEvent AChannelEvent
which represents the notification of the state of a childChannel
.ExceptionEvent AChannelEvent
which represents the notification of an exception raised by aChannelHandler
or an I/O thread.FileRegion A region of a file that is sent via aChannel
which supports zero-copy file transfer.LifeCycleAwareChannelHandler AChannelHandler
that is notified when it is added to or removed from aChannelPipeline
.MessageEvent AChannelEvent
which represents the transmission or reception of a message.ReceiveBufferSizePredictor Predicts the number of readable bytes in the receive buffer of aChannel
.ReceiveBufferSizePredictorFactory Creates a newReceiveBufferSizePredictor
.ServerChannel ServerChannelFactory AChannelFactory
that creates aServerChannel
.WriteCompletionEvent AChannelEvent
which represents the notification of the completion of a write request on aChannel
. -
Class Summary Class Description AbstractChannel A skeletalChannel
implementation.AbstractChannelSink A skeletalChannelSink
implementation.AbstractServerChannel A skeletal server-sideChannel
implementation.AdaptiveReceiveBufferSizePredictor TheReceiveBufferSizePredictor
that automatically increases and decreases the predicted buffer size on feed back.AdaptiveReceiveBufferSizePredictorFactory TheReceiveBufferSizePredictorFactory
that creates a newAdaptiveReceiveBufferSizePredictor
.ChannelFutureNotifier ChannelFutureListener implementation which takes another ChannelFuture and notifies it once the operationComplete method was called.ChannelLocal<T> A global variable that is local to aChannel
.Channels A helper class which provides various convenience methods related withChannel
,ChannelHandler
, andChannelPipeline
.CompleteChannelFuture A skeletalChannelFuture
implementation which represents aChannelFuture
which has been completed already.DefaultChannelConfig The defaultSocketChannelConfig
implementation.DefaultChannelFuture The defaultChannelFuture
implementation.DefaultChannelPipeline The defaultChannelPipeline
implementation.DefaultChildChannelStateEvent The defaultChildChannelStateEvent
implementation.DefaultExceptionEvent The defaultExceptionEvent
implementation.DefaultFileRegion DefaultServerChannelConfig The defaultServerSocketChannelConfig
implementation.DefaultWriteCompletionEvent The defaultWriteCompletionEvent
implementation.DownstreamChannelStateEvent The default downstreamChannelStateEvent
implementation.DownstreamMessageEvent The default downstreamMessageEvent
implementation.FailedChannelFuture TheCompleteChannelFuture
which is failed already.FixedReceiveBufferSizePredictor TheReceiveBufferSizePredictor
that always yields the same buffer size prediction.FixedReceiveBufferSizePredictorFactory TheReceiveBufferSizePredictorFactory
that returns aFixedReceiveBufferSizePredictor
with the pre-defined configuration.SimpleChannelDownstreamHandler AChannelDownstreamHandler
which provides an individual handler method for each event type.SimpleChannelHandler AChannelHandler
which provides an individual handler method for each event type.SimpleChannelUpstreamHandler AChannelUpstreamHandler
which provides an individual handler method for each event type.SucceededChannelFuture TheCompleteChannelFuture
which is succeeded already.UpstreamChannelStateEvent The default upstreamChannelStateEvent
implementation.UpstreamMessageEvent The default upstreamMessageEvent
implementation. -
Enum Summary Enum Description ChannelState The current or future state of aChannel
. -
Exception Summary Exception Description ChannelException ARuntimeException
which is thrown when an I/O operation fails.ChannelHandlerLifeCycleException ARuntimeException
which is thrown when aLifeCycleAwareChannelHandler
throws anException
in its handler methods.ChannelPipelineException AChannelException
which is thrown when aChannelPipeline
failed to process aChannelEvent
or when aChannelPipelineFactory
failed to initialize aChannelPipeline
.ConnectTimeoutException ConnectException
which will be thrown if a connection could not be established because of a connection timeout. -
Annotation Types Summary Annotation Type Description ChannelHandler.Sharable Indicates that the same instance of the annotatedChannelHandler
can be added to one or moreChannelPipeline
s multiple times without a race condition.