reactor.io.codec

Class Codec<SRC,IN,OUT>

java.lang.Object

reactor.io.codec.Codec<SRC,IN,OUT>

Type Parameters:

SRC - The type that the codec decodes from and encodes to

IN - The type produced by decoding

OUT - The type consumed by encoding

All Implemented Interfaces:

Function<OUT,SRC>

Direct Known Subclasses:

BufferCodec, PassThroughCodec

public abstract class Codec<SRC,IN,OUT>
extends java.lang.Object
implements Function<OUT,SRC>

Implementations of a Codec are responsible for decoding a SRC into an instance of IN and passing that to the given Consumer. A codec also provides an encoder to take an instance of OUT and encode to an instance of SRC.

Field Summary

Fields

Modifier and Type	Field and Description
static byte	DEFAULT_DELIMITER
protected java.lang.Byte	delimiter

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Codec() Create a new Codec set with a \0 delimiter to finish any Buffer encoded value or scan for delimited decoded Buffers.
protected	Codec(java.lang.Byte delimiter) A delimiter can be used to trail any decoded buffer or to finalize encoding from any incoming value

Method Summary

Modifier and Type	Method and Description
protected Buffer	addDelimiterIfAny(Buffer buffer) Add a trailing delimiter if defined
org.reactivestreams.Publisher<IN>	decode(org.reactivestreams.Publisher<? extends SRC> publisherToDecode) Provide the caller with a decoder to turn a source object into an instance of the input type.
Function<SRC,IN>	decoder() Provide the caller with a decoder to turn a source object into an instance of the input type.
abstract Function<SRC,IN>	decoder(Consumer<IN> next) Provide the caller with a decoder to turn a source object into an instance of the input type.
protected IN	doBufferDecode(Buffer buffer) Decode a buffer
protected IN	doDelimitedBufferDecode(Consumer<IN> decoderCallback, Buffer buffer) Helper method to scan for delimiting byte the codec might benefit from, e.g.
org.reactivestreams.Publisher<SRC>	encode(org.reactivestreams.Publisher<? extends OUT> publisherToEncode) Provide the caller with an encoder to turn an output sequence into an sequence of the source type.
Function<OUT,SRC>	encoder() Provide the caller with an encoder to turn an output object into an instance of the source type.
protected static <IN> IN	invokeCallbackOrReturn(Consumer<IN> consumer, IN v)

Methods inherited from class java.lang.Object

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

Methods inherited from interface reactor.fn.Function

apply

Field Detail

DEFAULT_DELIMITER

public static final byte DEFAULT_DELIMITER

See Also:

Constant Field Values

delimiter

protected final java.lang.Byte delimiter

Constructor Detail

Codec

protected Codec()

Create a new Codec set with a \0 delimiter to finish any Buffer encoded value or scan for delimited decoded Buffers.

Codec

protected Codec(java.lang.Byte delimiter)

A delimiter can be used to trail any decoded buffer or to finalize encoding from any incoming value

Parameters:

delimiter - delimiter can be left undefined (null) to bypass appending at encode time and scanning at decode time.

Method Detail

decode

public org.reactivestreams.Publisher<IN> decode(org.reactivestreams.Publisher<? extends SRC> publisherToDecode)

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

Returns:

The decoded object.

Since:

2.0.4

decoder

public Function<SRC,IN> decoder()

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

Returns:

The decoded object.

decoder

public abstract Function<SRC,IN> decoder(Consumer<IN> next)

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

Parameters:

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

Returns:

The decoded object.

encode

public org.reactivestreams.Publisher<SRC> encode(org.reactivestreams.Publisher<? extends OUT> publisherToEncode)

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

Returns:

The encoded source sequence.

Since:

2.0.4

encoder

public Function<OUT,SRC> encoder()

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

Returns:

The encoded source object.

doDelimitedBufferDecode

protected IN doDelimitedBufferDecode(Consumer<IN> decoderCallback,
                                     Buffer buffer)

Helper method to scan for delimiting byte the codec might benefit from, e.g. JSON codec. A DelimitedCodec or alike will obviously not require to make use of that helper as it is already delimiting.

Parameters:

decoderCallback -

buffer -

Returns:

a value if no callback is supplied and there is only one delimited buffer

invokeCallbackOrReturn

protected static <IN> IN invokeCallbackOrReturn(Consumer<IN> consumer,
                                                IN v)

doBufferDecode

protected IN doBufferDecode(Buffer buffer)

Decode a buffer

Parameters:

buffer -

Returns:

addDelimiterIfAny

protected Buffer addDelimiterIfAny(Buffer buffer)

Add a trailing delimiter if defined

Parameters:

buffer - the buffer to prepend to this codec delimiter if any

Returns:

the positioned and expanded buffer reference if any delimiter, otherwise the passed buffer