Module io.netty5.codec
Package io.netty5.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 Interface Description ByteToMessageDecoder.Cumulator CumulateBuffers.DecoderResultProvider Provides the accessor methods for theDecoderResultproperty of a decoded message.DefaultHeaders.NameValidator<K> Headers<K,V,T extends Headers<K,V,T>> Common interface forHeaderswhich represents a mapping of key to value.ProtocolEvent An application-level event propagated via anChannelPipeline, such as a TLS or WebSocket handshake event.ValueConverter<T> Converts to/from a generic object to the type. -
Class Summary Class Description ByteToMessageCodec<I> A Codec for on-the-fly encoding/decoding of bytes to messages and vise-versa.ByteToMessageDecoder ChannelHandlerwhich decodes bytes in a stream-like fashion from oneBufferto an other Message type.CharSequenceValueConverter Converts to/from native types, generalObject, andCharSequences.DatagramPacketDecoder A decoder that decodes the content of the receivedDatagramPacketusing the specifiedBufferdecoder.DatagramPacketEncoder<M> An encoder that encodes the content inAddressedEnvelopetoDatagramPacketusing the specified message encoder.DateFormatter A formatter for HTTP header dates, such as "Expires" and "Date" headers, or "expires" field in "Set-Cookie".DecoderResult DefaultHeaders<K,V,T extends Headers<K,V,T>> Default implementation ofHeaders;DefaultHeaders.HeaderEntry<K,V> DefaultHeadersImpl<K,V> A concrete implementation ofDefaultHeadersthat allows for direct instantiation.DelimiterBasedFrameDecoder A decoder that splits the receivedBuffers by one or more delimiters.Delimiters A set of commonly used delimiters forDelimiterBasedFrameDecoder.EmptyHeaders<K,V,T extends Headers<K,V,T>> FixedLengthFrameDecoder A decoder that splits the receivedBuffers by the fixed number of bytes.HeadersUtils Provides utility methods related toHeaders.LengthFieldBasedFrameDecoder A decoder that splits the receivedBuffers 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 receivedBuffers on line endings.MessageAggregator<I,S,C extends AutoCloseable,A extends AutoCloseable> An abstractChannelHandlerthat aggregates a series of message objects into a single aggregated message.MessageToByteEncoder<I> ChannelHandlerwhich encodes message in a stream-like fashion from one message to aBuffer.MessageToMessageCodec<INBOUND_IN,OUTBOUND_IN> A Codec for on-the-fly encoding/decoding of message.MessageToMessageDecoder<I> ChannelHandlerwhich decodes from one message to another message.MessageToMessageEncoder<I> ChannelHandlerwhich encodes from one message to another message For example here is an implementation which decodes anIntegerto anString.ProtocolDetectionResult<T> Result of detecting a protocol.UnsupportedValueConverter<V> UnsupportedOperationExceptionwill be thrown from allValueConvertermethods. -
Enum Summary Enum Description ProtocolDetectionState The state of the current detection. -
Exception Summary Exception Description CodecException AnExceptionwhich is thrown by a codec.CorruptedFrameException AnDecoderExceptionwhich is thrown when the received frame data could not be decoded by an inbound handler.DecoderException AnCodecExceptionwhich is thrown by a decoder.EncoderException AnCodecExceptionwhich is thrown by an encoder.MessageAggregationException Raised byMessageAggregatorwhen aggregation fails due to an unexpected message sequence.PrematureChannelClosureException ACodecExceptionwhich is thrown when aChannelis closed unexpectedly before the codec finishes handling the current message, such as missing response while waiting for a request.TooLongFrameException AnDecoderExceptionwhich is thrown when the length of the frame decoded is greater than the allowed maximum.UnsupportedMessageTypeException Thrown if an unsupported message is received by a codec.