Top Description Interfaces Classes Enums
[default module]

Package io.netty.handler.codec


Extensible decoder and its common implementations which deal with the packet fragmentation and reassembly issue found in a stream-based transport such as TCP/IP.

Interface Summary

Modifier and TypeInterface and Description
public interface
DecoderResultProvider

Provides the accessor methods for the DecoderResult property of a decoded message.

public interface
Headers<
the type of the header name.
K
,
the type of the header value.
V
,
the type to use for return values when the intention is to return this object.
T extends Headers<K, V, T>
>

Common interface for Headers which represents a mapping of key to value.

public interface
ValueConverter<T>

Converts to/from a generic object to the type.

Class Summary

Modifier and TypeClass and Description
public class
public abstract class
ByteToMessageCodec<I>

A Codec for on-the-fly encoding/decoding of bytes to messages and vise-versa.

public abstract class
ByteToMessageDecoder

ChannelInboundHandlerAdapter which decodes bytes in a stream-like fashion from one ByteBuf to an other Message type.

public class
CharSequenceValueConverter

Converts to/from native types, general Object, and CharSequences.

public class
CodecException

An Exception which is thrown by a codec.

pack-priv class
CodecOutputList

Special AbstractList implementation which is used within our codec base classes.

public class
CorruptedFrameException

An DecoderException which is thrown when the received frame data could not be decoded by an inbound handler.

public class
DatagramPacketDecoder

A decoder that decodes the content of the received DatagramPacket using the specified ByteBuf decoder.

public class
DatagramPacketEncoder<
the type of message to be encoded
M
>

An encoder that encodes the content in AddressedEnvelope to DatagramPacket using the specified message encoder.

public class
DateFormatter

A formatter for HTTP header dates, such as "Expires" and "Date" headers, or "expires" field in "Set-Cookie".

public class
DecoderException

An CodecException which is thrown by a decoder.

public class
public class
DefaultHeaders<
the type of the header name.
K
,
the type of the header value.
V
,
the type to use for return values when the intention is to return this object.
T extends Headers<K, V, T>
>

Default implementation of Headers;

public class
DefaultHeadersImpl<
the type of the header name.
K
,
the type of the header value.
V
>

A concrete implementation of DefaultHeaders that allows for direct instantiation.

public class
DelimiterBasedFrameDecoder

A decoder that splits the received ByteBufs by one or more delimiters.

public class
Delimiters

A set of commonly used delimiters for DelimiterBasedFrameDecoder.

public class
EmptyHeaders<K, V, T extends Headers<K, V, T>>

public class
EncoderException

An CodecException which is thrown by an encoder.

public class
FixedLengthFrameDecoder

A decoder that splits the received ByteBufs by the fixed number of bytes.

public class
HeadersUtils

Provides utility methods related to Headers.

public class
LengthFieldBasedFrameDecoder

A decoder that splits the received ByteBufs dynamically by the value of the length field in the message.

public class
LengthFieldPrepender

An encoder that prepends the length of the message.

public class
LineBasedFrameDecoder

A decoder that splits the received ByteBufs on line endings.

public class
MessageAggregationException

Raised by MessageAggregator when aggregation fails due to an unexpected message sequence.

public abstract class
MessageAggregator<
the type that covers both start message and content message
I
,
the type of the start message
S
,
the type of the content message (must be a subtype of ByteBufHolder)
C extends ByteBufHolder
,
the type of the aggregated message (must be a subtype of S and ByteBufHolder)
O extends ByteBufHolder
>

An abstract ChannelHandler that aggregates a series of message objects into a single aggregated message.

public abstract class
MessageToByteEncoder<I>

ChannelOutboundHandlerAdapter which encodes message in a stream-like fashion from one message to an ByteBuf.

public abstract class
MessageToMessageCodec<INBOUND_IN, OUTBOUND_IN>

A Codec for on-the-fly encoding/decoding of message.

public abstract class
MessageToMessageDecoder<I>

ChannelInboundHandlerAdapter which decodes from one message to an other message.

public abstract class
MessageToMessageEncoder<I>

ChannelOutboundHandlerAdapter which encodes from one message to an other message For example here is an implementation which decodes an Integer to an String.

public class
PrematureChannelClosureException

A CodecException which is thrown when a Channel is closed unexpectedly before the codec finishes handling the current message, such as missing response while waiting for a request.

public class
ProtocolDetectionResult<
the type of the protocol
T
>

Result of detecting a protocol.

public abstract class
ReplayingDecoder<
the state type which is usually an Enum; use Void if state management is unused
S
>

A specialized variation of ByteToMessageDecoder which enables implementation of a non-blocking decoder in the blocking I/O paradigm.

pack-priv class
ReplayingDecoderByteBuf

Special ByteBuf implementation which is used by the ReplayingDecoder

public class
TooLongFrameException

An DecoderException which is thrown when the length of the frame decoded is greater than the allowed maximum.

public class
UnsupportedMessageTypeException

Thrown if an unsupported message is received by an codec.

public class

Enum Summary

Modifier and TypeEnum and Description
public enum
ProtocolDetectionState

The state of the current detection.