Package io.netty.channel

The core channel API which is asynchronous and event-driven abstraction of various transports such as a NIO Channel.

See: Description

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.
Channel.Unsafe	Unsafe operations that should never be called from user-code.
ChannelConfig	A set of configuration properties of a Channel.
ChannelFuture	The result of an asynchronous Channel I/O operation.
ChannelFuture.Unsafe	A ChannelFuture which is not allowed to be sent to ChannelPipeline due to implementation details.
ChannelFutureFactory	Factory which is responsible to create new ChannelFuture's
ChannelFutureListener	Listens to the result of a ChannelFuture.
ChannelFutureProgressListener	Listens to the progress of a time-consuming I/O operation such as a large file transfer.
ChannelHandler	Handles or intercepts a ChannelEvent, and sends a ChannelEvent to the next handler in a ChannelPipeline.
ChannelHandlerContext	Enables a ChannelHandler to interact with its ChannelPipeline and other handlers.
ChannelInboundByteHandler	ChannelInboundHandler which offers a ByteBuf to store inbound data in.
ChannelInboundHandler	ChannelStateHandler which handles inbound data.
ChannelInboundInvoker
ChannelInboundMessageHandler<I>	Special ChannelInboundHandler which store the inbound data in a MessageBuf for futher processing.
ChannelOperationHandler
ChannelOutboundByteHandler
ChannelOutboundHandler
ChannelOutboundInvoker
ChannelOutboundMessageHandler<I>
ChannelPipeline	A list of ChannelHandlers which handles or intercepts ChannelEvents of a Channel.
ChannelStateHandler	ChannelHandler which adds callbacks for state changes.
EventExecutor	The EventExecutor is a special ScheduledExecutorService which comes with some handy methods to see if a Thread is executed in a event loop.
EventExecutorGroup	The EventExecutorGroup is responsible to provide EventExecutor's to use via its EventExecutorGroup.next() method.
EventLoop
EventLoopGroup	Special EventExecutorGroup which allows to register Channel's that get processed for later selection during the event loop.
ServerChannel	A Channel that accepts an incoming connection attempt and creates its child Channels by accepting them.

Class Summary

Class	Description
AbstractChannel	A skeletal Channel implementation.
AbstractServerChannel	A skeletal server-side Channel implementation.
ChannelFlushFutureNotifier
ChannelFutureAggregator	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.
ChannelHandlerAdapter
ChannelHandlerUtil
ChannelInboundByteHandlerAdapter	Abstract base class for ChannelInboundHandlerAdapter which should be extended by the user to get notified once more data is ready to get consumed from the inbound ByteBuf.
ChannelInboundHandlerAdapter
ChannelInboundMessageHandlerAdapter<I>
ChannelInitializer<C extends Channel>
ChannelInputShutdownEvent
ChannelMetadata	Represents the properties of a Channel implementation.
ChannelOperationHandlerAdapter
ChannelOption<T>
ChannelOutboundByteHandlerAdapter
ChannelOutboundHandlerAdapter
ChannelOutboundMessageHandlerAdapter<I>
ChannelStateHandlerAdapter
ChannelTaskScheduler
CombinedChannelHandler
CompleteChannelFuture	A skeletal ChannelFuture implementation which represents a ChannelFuture which has been completed already.
DefaultChannelConfig	The default SocketChannelConfig implementation.
DefaultChannelFuture	The default ChannelFuture implementation.
DefaultChannelPipeline	The default ChannelPipeline implementation.
DefaultEventExecutorGroup
FailedChannelFuture	The CompleteChannelFuture which is failed already.
MultithreadEventExecutorGroup
MultithreadEventLoopGroup
SingleThreadEventExecutor	Abstract base class for EventExecutor's that execute all its submitted tasks in a single thread.
SingleThreadEventLoop
SucceededChannelFuture	The CompleteChannelFuture which is succeeded already.
VoidChannelFuture

Enum Summary

Enum	Description
ChannelHandlerType	Define the type of a ChannelHandler

Exception Summary

Exception	Description
BlockingOperationException	An IllegalStateException which is raised when a user performed a blocking operation when the user is in an event loop thread.
ChannelException	A RuntimeException which is thrown when an I/O operation fails.
ChannelHandlerLifeCycleException	A RuntimeException which is thrown when a LifeCycleAwareChannelHandler throws an Exception in its handler methods.
ChannelPipelineException	A ChannelException which is thrown when a ChannelPipeline failed to process a ChannelEvent or when a ChannelPipelineFactory failed to initialize a ChannelPipeline.
EventLoopException
NoSuchBufferException	A ChannelPipelineException which is raised if an inbound or outbound buffer of the expected type is not found while transferring data between ChannelHandlers.

Annotation Types Summary

Annotation Type	Description
ChannelHandler.Sharable	Indicates that the same instance of the annotated ChannelHandler can be added to one or more ChannelPipelines multiple times without a race condition.

Package io.netty.channel Description

The core channel API which is asynchronous and event-driven abstraction of various transports such as a NIO Channel.