reactor.io.encoding

Class LengthFieldCodec<IN,OUT>

java.lang.Object

reactor.io.encoding.LengthFieldCodec<IN,OUT>

Type Parameters:

IN - The type that will be produced by decoding

OUT - The type that will be consumed by encoding

All Implemented Interfaces:

Codec<Buffer,IN,OUT>

public class LengthFieldCodec<IN,OUT>
extends java.lang.Object
implements Codec<Buffer,IN,OUT>

A codec that uses a length-field at the start of each chunk to denote the chunk's size. During decoding the delegate is used to process each chunk. During encoding the delegate is used to encode each piece of output into a buffer. The buffer is then output, with its length prepended.

Constructor Summary

Constructors

Constructor and Description
LengthFieldCodec(Codec<Buffer,IN,OUT> delegate) Create a length-field codec that reads the first integer as the length of the remaining message.
LengthFieldCodec(int lengthFieldLength, Codec<Buffer,IN,OUT> delegate) Create a length-field codec that reads the first short, integer, or long as the length of the remaining message, and prepends a short, integer, long to its output.

Method Summary

Modifier and Type	Method and Description
Function<Buffer,IN>	decoder(Consumer<IN> next) Provide the caller with a decoder to turn a source object into an instance of the input type.
Function<OUT,Buffer>	encoder() Provide the caller with an encoder to turn an output object into an instance of the source type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LengthFieldCodec

public LengthFieldCodec(Codec<Buffer,IN,OUT> delegate)

Create a length-field codec that reads the first integer as the length of the remaining message.

Parameters:

delegate - The delegate Codec.

LengthFieldCodec

public LengthFieldCodec(int lengthFieldLength,
                        Codec<Buffer,IN,OUT> delegate)

Create a length-field codec that reads the first short, integer, or long as the length of the remaining message, and prepends a short, integer, long to its output.

Parameters:

lengthFieldLength - The size of the length field. Valid values are 4 (int) or 8 (long).

delegate - The delegate Codec.

Method Detail

decoder

public Function<Buffer,IN> decoder(Consumer<IN> next)

Description copied from interface: Codec

Provide the caller with a decoder to turn a source object into an instance of the input type.

Specified by:

decoder in interface Codec<Buffer,IN,OUT>

Parameters:

next - The Consumer to call after the object has been decoded.

Returns:

The decoded object.

encoder

public Function<OUT,Buffer> encoder()

Description copied from interface: Codec

Provide the caller with an encoder to turn an output object into an instance of the source type.

Specified by:

encoder in interface Codec<Buffer,IN,OUT>

Returns:

The encoded source object.