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.

See: Description

Interface Summary

Interface	Description
BinaryHeaders	A typical AsciiString multimap used by protocols that use binary headers (such as HTTP/2) for the representation of arbitrary key-value data.
BinaryHeaders.EntryVisitor	A visitor that helps reduce GC pressure while iterating over a collection of Headers.
BinaryHeaders.NameVisitor	A visitor that helps reduce GC pressure while iterating over a collection of Headers.
ByteToMessageDecoder.Cumulator	Cumulate ByteBufs.
ConvertibleHeaders<UnconvertedType,ConvertedType>	Extension to the Headers interface to provide methods which convert the native UnconvertedType to the not-native ConvertedType
ConvertibleHeaders.TypeConverter<UnconvertedType,ConvertedType>	Interface to do conversions to and from the two generic type parameters
DecoderResultProvider	Provides the accessor methods for the DecoderResult property of a decoded message.
DefaultHeaders.HashCodeGenerator<T>	Allows users of this interface to specify a hash code other than the default Object.hashCode()
DefaultHeaders.NameConverter<T>	Allows users to convert the name elements before being processed by this map
Headers<T>
Headers.EntryVisitor<T>	A visitor that helps reduce GC pressure while iterating over a collection of Headers.
Headers.NameVisitor<T>	A visitor that helps reduce GC pressure while iterating over a collection of Headers.
Headers.ValueConverter<T>	Converts to/from a generic object to the type of the name for this map
TextHeaders	A typical string multimap used by text protocols such as HTTP for the representation of arbitrary key-value data.
TextHeaders.EntryVisitor	A visitor that helps reduce GC pressure while iterating over a collection of Headers.
TextHeaders.NameVisitor	A visitor that helps reduce GC pressure while iterating over a collection of Headers.

Class Summary

Class	Description
AsciiHeadersEncoder
AsciiString	A string which has been encoded into a character encoding whose character always takes a single byte, similarly to ASCII.
ByteToMessageCodec<I>	A Codec for on-the-fly encoding/decoding of bytes to messages and vise-versa.
ByteToMessageDecoder	A ChannelHandler which decodes bytes in a stream-like fashion from one ByteBuf to an other Message type.
DecoderResult
DefaultBinaryHeaders
DefaultConvertibleHeaders<UnconvertedType,ConvertedType>
DefaultHeaders<T>
DefaultHeaders.IdentityNameConverter<T>	A name converted which does not covert but instead just returns this name unchanged
DefaultTextHeaders
DefaultTextHeaders.DefaultTextValueTypeConverter
DelimiterBasedFrameDecoder	A decoder that splits the received ByteBufs by one or more delimiters.
Delimiters	A set of commonly used delimiters for DelimiterBasedFrameDecoder.
EmptyBinaryHeaders
EmptyConvertibleHeaders<UnconvertedType,ConvertedType>
EmptyHeaders<T>
EmptyTextHeaders
FixedLengthFrameDecoder	A decoder that splits the received ByteBufs by the fixed number of bytes.
LengthFieldBasedFrameDecoder	A decoder that splits the received ByteBufs dynamically by the value of the length field in the message.
LengthFieldPrepender	An encoder that prepends the length of the message.
LineBasedFrameDecoder	A decoder that splits the received ByteBufs on line endings.
MessageAggregator<I,S,C extends ByteBufHolder,O extends ByteBufHolder>	An abstract ChannelHandler that aggregates a series of message objects into a single aggregated message.
MessageToByteEncoder<I>	ChannelHandlerAdapter which encodes message in a stream-like fashion from one message to an ByteBuf.
MessageToMessageCodec<INBOUND_IN,OUTBOUND_IN>	A Codec for on-the-fly encoding/decoding of message.
MessageToMessageDecoder<I>	A ChannelHandler which decodes from one message to an other message.
MessageToMessageEncoder<I>	A ChannelHandler which encodes from one message to an other message For example here is an implementation which decodes an Integer to an String.
ReplayingDecoder<S>	A specialized variation of ByteToMessageDecoder which enables implementation of a non-blocking decoder in the blocking I/O paradigm.

Enum Summary

Enum	Description
AsciiHeadersEncoder.NewlineType	The newline characters to insert between header entries.
AsciiHeadersEncoder.SeparatorType	The separator characters to insert between a header name and a header value.

Exception Summary

Exception	Description
CodecException	An Exception which is thrown by a codec.
CorruptedFrameException	An DecoderException which is thrown when the received frame data could not be decoded by an inbound handler.
DecoderException	An CodecException which is thrown by a dencoder.
EncoderException	An CodecException which is thrown by an encoder.
MessageAggregationException	Raised by MessageAggregator when aggregation fails due to an unexpected message sequence.
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.
TooLongFrameException	An DecoderException which is thrown when the length of the frame decoded is greater than the allowed maximum.
UnsupportedMessageTypeException	Thrown if an unsupported message is received by an codec.

Package io.netty.handler.codec Description

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.