Members

Enumerations

Structures

Classes

  • class AcceptBackoffHandler

    A ChannelHandler that implements a backoff for a ServerChannel when accept produces an IOError. These errors are often recoverable by reducing the rate at which we call accept.

  • class BackPressureHandler

    ChannelHandler implementation which enforces back-pressure by stopping to read from the remote peer when it cannot write back fast enough. It will start reading again once pending data was written.

  • class ByteToMessageHandler

    A handler which turns a given ByteToMessageDecoder into a ChannelInboundHandler that can then be added to a ChannelPipeline.

  • class ChannelHandlerContext

    Every ChannelHandler has – when added to a ChannelPipeline – a corresponding ChannelHandlerContext which is the way ChannelHandlers can interact with other ChannelHandlers in the pipeline.

  • class ChannelPipeline

    A list of ChannelHandlers that handle or intercept inbound events and outbound operations of a Channel. ChannelPipeline implements an advanced form of the Intercepting Filter pattern to give a user full control over how an event is handled and how the ChannelHandlers in a pipeline interact with each other.

  • class EventLoopFuture

    Holder for a result that will be provided later.

  • class IdleStateHandler

    Triggers an IdleStateEvent when a Channel has not performed read, write, or both operation for a while.

  • class MessageToByteHandler

    A handler which turns a given MessageToByteEncoder into a ChannelOutboundHandler that can then be added to a ChannelPipeline.

  • class NIOCloseOnErrorHandler

    A ChannelInboundHandler that closes the channel when an error is caught

  • class NIOFileHandle

    A NIOFileHandle is a handle to an open file.

  • class NIOSingleStepByteToMessageProcessor

    NIOSingleStepByteToMessageProcessor uses a NIOSingleStepByteToMessageDecoder to produce messages from a stream of incoming bytes. It works like ByteToMessageHandler but may be used outside of the channel pipeline. This allows processing of wrapped protocols in a general way.

  • class RepeatedTask

    Returned once a task was scheduled to be repeatedly executed on the EventLoop.

Protocols

  • protocol ByteToMessageDecoder

    ByteToMessageDecoders decode bytes in a stream-like fashion from ByteBuffer to another message type.

  • protocol Channel

    A Channel is easiest thought of as a network socket. But it can be anything that is capable of I/O operations such as read, write, connect, and bind.

  • protocol ChannelCore

    The core Channel methods that are for internal use of the Channel implementation only.

  • protocol ChannelHandler

    You should never implement this protocol directly. Please implement one of its sub-protocols.

  • protocol ChannelInboundHandler

    ChannelHandler which handles inbound I/O events for a Channel.

  • protocol ChannelInboundInvoker

    Fire inbound events related to a Channel through the ChannelPipeline until its end is reached or it’s consumed by a ChannelHandler.

  • protocol ChannelInvoker

    A protocol that signals that outbound and inbound events are triggered by this invoker.

  • protocol ChannelOption

    A configuration option that can be set on a Channel to configure different behaviour.

  • protocol ChannelOutboundHandler

    ChannelHandler which handles outbound I/O events or intercept an outbound I/O operation for a Channel.

  • protocol ChannelOutboundInvoker

    Allows users to invoke an “outbound” operation related to a Channel that will flow through the ChannelPipeline until it will finally be executed by the the ChannelCore implementation.

  • protocol EventLoop

    An EventLoop processes IO / tasks in an endless loop for Channels until it’s closed.

  • protocol EventLoopGroup

    Provides an endless stream of EventLoops to use.

  • protocol FileDescriptor
  • protocol MessageToByteEncoder

    A protocol for straightforward encoders which encode custom messages to ByteBuffers. To add a MessageToByteEncoder to a ChannelPipeline, use channel.pipeline.addHandler(MessageToByteHandler(myEncoder).

  • protocol MulticastChannel

    A MulticastChannel is a Channel that supports IP multicast operations: that is, a channel that can join multicast groups.

  • protocol NIOClientTCPBootstrapProtocol

    NIOClientTCPBootstrapProtocol is implemented by various underlying transport mechanisms. Typically, this will be the BSD Sockets API implemented by ClientBootstrap.

  • protocol NIOClientTLSProvider
  • protocol NIOSingleStepByteToMessageDecoder

    A simplified version of ByteToMessageDecoder that can generate zero or one messages for each invocation of decode or decodeLast. Having decode and decodeLast return an optional message avoids re-entrancy problems, since the functions relinquish exclusive access to the ByteBuffer when returning. This allows for greatly simplified processing.

  • protocol NIOSynchronousChannelOptions
  • protocol RecvByteBufferAllocator

    Allocates ByteBuffers to be used to read bytes from a Channel and records the number of the actual bytes that were used.

  • protocol RemovableChannelHandler

    A RemovableChannelHandler is a ChannelHandler that can be dynamically removed from a ChannelPipeline whilst the Channel is operating normally. A RemovableChannelHandler is required to remove itself from the ChannelPipeline (using ChannelHandlerContext.removeHandler) as soon as possible.

  • protocol SocketOptionProvider

    This protocol defines an object, most commonly a Channel, that supports setting and getting socket options (via setsockopt/getsockopt or similar). It provides a strongly typed API that makes working with larger, less-common socket options easier than the ChannelOption API allows.

  • protocol WriteObservingByteToMessageDecoder

    Some ByteToMessageDecoders need to observe writes (which are outbound events). ByteToMessageDecoders which implement the WriteObservingByteToMessageDecoder protocol will be notified about every outbound write.

Removed Members

Classes