io.aeron

Interface ReservedValueSupplier

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ReservedValueSupplier

Supplies the reserved value field for a data frame header. The returned value will be set in the header as ByteOrder.LITTLE_ENDIAN format.

This will be called as the last action of encoding a data frame right before the length is set. All other fields in the header plus the body of the frame will have been written at the point of supply.

The reserved value can be used for carrying out of band data with message fragments such a checksums or timestamps.

Method Summary

Modifier and Type	Method and Description
long	get(DirectBuffer termBuffer, int termOffset, int frameLength) Callback to provide the reserved value to be encoded with each message fragment as the last action before the length field is set which commits the fragment for sending to the media.

Method Detail

get

long get(DirectBuffer termBuffer,
         int termOffset,
         int frameLength)

Callback to provide the reserved value to be encoded with each message fragment as the last action before the length field is set which commits the fragment for sending to the media.

Parameters:

termBuffer - containing the encoding message fragment.

termOffset - at which the header of the frame begins.

frameLength - Total length of the frame including header.

Returns:

the value to be used for storing in the reserved value field.