io.aeron.protocol

Class DataHeaderFlyweight

java.lang.Object

org.agrona.concurrent.UnsafeBuffer

io.aeron.protocol.HeaderFlyweight

io.aeron.protocol.DataHeaderFlyweight

All Implemented Interfaces:

java.lang.Comparable<org.agrona.DirectBuffer>, org.agrona.concurrent.AtomicBuffer, org.agrona.DirectBuffer, org.agrona.MutableDirectBuffer

public class DataHeaderFlyweight
extends HeaderFlyweight

HeaderFlyweight for Data Frame header of a message fragment.

Data Frame wiki page.

Field Summary

Fields

Modifier and Type	Field and Description
static short	BEGIN_AND_END_FLAGS Begin and End Flags
static short	BEGIN_END_AND_EOS_FLAGS Begin, End, and End of Stream Flags
static short	BEGIN_FLAG Begin Flag
static int	DATA_OFFSET
static long	DEFAULT_RESERVE_VALUE
static short	END_FLAG End Flag
static short	EOS_FLAG End of Stream Flag
static int	HEADER_LENGTH Length of the Data Header
static int	RESERVED_VALUE_OFFSET
static int	SESSION_ID_FIELD_OFFSET
static int	STREAM_ID_FIELD_OFFSET
static int	TERM_ID_FIELD_OFFSET
static int	TERM_OFFSET_FIELD_OFFSET

Fields inherited from class io.aeron.protocol.HeaderFlyweight

CURRENT_VERSION, FLAGS_FIELD_OFFSET, FRAME_LENGTH_FIELD_OFFSET, HDR_TYPE_DATA, HDR_TYPE_ERR, HDR_TYPE_EXT, HDR_TYPE_NAK, HDR_TYPE_PAD, HDR_TYPE_RTTM, HDR_TYPE_SETUP, HDR_TYPE_SM, MIN_HEADER_LENGTH, TYPE_FIELD_OFFSET, VERSION_FIELD_OFFSET

Fields inherited from class org.agrona.concurrent.UnsafeBuffer

ALIGNMENT, DISABLE_BOUNDS_CHECKS_PROP_NAME, SHOULD_BOUNDS_CHECK

Constructor Summary

Constructors

Constructor and Description
DataHeaderFlyweight()
DataHeaderFlyweight(java.nio.ByteBuffer buffer)
DataHeaderFlyweight(org.agrona.concurrent.UnsafeBuffer buffer)

Method Summary

Modifier and Type	Method and Description
static org.agrona.concurrent.UnsafeBuffer	createDefaultHeader(int sessionId, int streamId, int termId) Return an initialised default Data Frame Header.
int	dataOffset() Return offset in buffer for data
static boolean	isEndOfStream(org.agrona.concurrent.UnsafeBuffer packet) Does the data frame in the packet have the EOS flag set?
static boolean	isHeartbeat(org.agrona.concurrent.UnsafeBuffer packet, int length) Is the frame at data frame at the beginning of packet a heartbeat message?
long	reservedValue() Get the reserved value in LITTLE_ENDIAN format.
DataHeaderFlyweight	reservedValue(long reservedValue) Set the reserved value in LITTLE_ENDIAN format.
int	sessionId() return session id field
DataHeaderFlyweight	sessionId(int sessionId) set session id field
static int	sessionId(org.agrona.concurrent.UnsafeBuffer termBuffer, int frameOffset)
int	streamId() return stream id field
DataHeaderFlyweight	streamId(int streamId) set stream id field
static int	streamId(org.agrona.concurrent.UnsafeBuffer termBuffer, int frameOffset)
int	termId() return term id field
DataHeaderFlyweight	termId(int termId) set term id field
static int	termId(org.agrona.concurrent.UnsafeBuffer termBuffer, int frameOffset)
int	termOffset() return term offset field
DataHeaderFlyweight	termOffset(int termOffset) set term offset field
static int	termOffset(org.agrona.concurrent.UnsafeBuffer termBuffer, int frameOffset)
java.lang.String	toString()

Methods inherited from class io.aeron.protocol.HeaderFlyweight

flags, flags, frameLength, frameLength, headerType, headerType, version, version

Methods inherited from class org.agrona.concurrent.UnsafeBuffer

addIntOrdered, addLongOrdered, addressOffset, boundsCheck, byteArray, byteBuffer, capacity, checkLimit, compareAndSetInt, compareAndSetLong, compareTo, equals, getAndAddInt, getAndAddLong, getAndSetInt, getAndSetLong, getByte, getBytes, getBytes, getBytes, getBytes, getBytes, getByteVolatile, getChar, getChar, getCharVolatile, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getIntVolatile, getLong, getLong, getLongVolatile, getShort, getShort, getShortVolatile, getStringAscii, getStringAscii, getStringAscii, getStringUtf8, getStringUtf8, getStringUtf8, getStringWithoutLengthAscii, getStringWithoutLengthUtf8, hashCode, isExpandable, parseIntAscii, parseLongAscii, parseNaturalIntAscii, parseNaturalLongAscii, putByte, putBytes, putBytes, putBytes, putBytes, putBytes, putByteVolatile, putChar, putChar, putCharVolatile, putDouble, putDouble, putFloat, putFloat, putInt, putInt, putIntAscii, putIntOrdered, putIntVolatile, putLong, putLong, putLongAscii, putLongOrdered, putLongVolatile, putNaturalIntAscii, putNaturalIntAsciiFromEnd, putNaturalLongAscii, putNaturalPaddedIntAscii, putShort, putShort, putShortVolatile, putStringAscii, putStringAscii, putStringUtf8, putStringUtf8, putStringUtf8, putStringUtf8, putStringWithoutLengthAscii, putStringWithoutLengthAscii, putStringWithoutLengthUtf8, setMemory, verifyAlignment, wrap, wrap, wrap, wrap, wrap, wrap, wrap, wrapAdjustment

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

HEADER_LENGTH

public static final int HEADER_LENGTH

Length of the Data Header

See Also:

Constant Field Values

BEGIN_FLAG

public static final short BEGIN_FLAG

Begin Flag

See Also:

Constant Field Values

END_FLAG

public static final short END_FLAG

End Flag

See Also:

Constant Field Values

BEGIN_AND_END_FLAGS

public static final short BEGIN_AND_END_FLAGS

Begin and End Flags

See Also:

Constant Field Values

EOS_FLAG

public static final short EOS_FLAG

End of Stream Flag

See Also:

Constant Field Values

BEGIN_END_AND_EOS_FLAGS

public static final short BEGIN_END_AND_EOS_FLAGS

Begin, End, and End of Stream Flags

See Also:

Constant Field Values

DEFAULT_RESERVE_VALUE

public static final long DEFAULT_RESERVE_VALUE

See Also:

Constant Field Values

TERM_OFFSET_FIELD_OFFSET

public static final int TERM_OFFSET_FIELD_OFFSET

See Also:

Constant Field Values

SESSION_ID_FIELD_OFFSET

public static final int SESSION_ID_FIELD_OFFSET

See Also:

Constant Field Values

STREAM_ID_FIELD_OFFSET

public static final int STREAM_ID_FIELD_OFFSET

See Also:

Constant Field Values

TERM_ID_FIELD_OFFSET

public static final int TERM_ID_FIELD_OFFSET

See Also:

Constant Field Values

RESERVED_VALUE_OFFSET

public static final int RESERVED_VALUE_OFFSET

See Also:

Constant Field Values

DATA_OFFSET

public static final int DATA_OFFSET

See Also:

Constant Field Values

Constructor Detail

DataHeaderFlyweight

public DataHeaderFlyweight()

DataHeaderFlyweight

public DataHeaderFlyweight(org.agrona.concurrent.UnsafeBuffer buffer)

DataHeaderFlyweight

public DataHeaderFlyweight(java.nio.ByteBuffer buffer)

Method Detail

isHeartbeat

public static boolean isHeartbeat(org.agrona.concurrent.UnsafeBuffer packet,
                                  int length)

Is the frame at data frame at the beginning of packet a heartbeat message?

Parameters:

packet - containing the data frame.

length - of the data frame.

Returns:

true if a heartbeat otherwise false.

isEndOfStream

public static boolean isEndOfStream(org.agrona.concurrent.UnsafeBuffer packet)

Does the data frame in the packet have the EOS flag set?

Parameters:

packet - containing the data frame.

Returns:

true if the EOS flag is set otherwise false.

sessionId

public int sessionId()

return session id field

Returns:

session id field

sessionId

public static int sessionId(org.agrona.concurrent.UnsafeBuffer termBuffer,
                            int frameOffset)

sessionId

public DataHeaderFlyweight sessionId(int sessionId)

set session id field

Parameters:

sessionId - field value

Returns:

flyweight

streamId

public int streamId()

return stream id field

Returns:

stream id field

streamId

public static int streamId(org.agrona.concurrent.UnsafeBuffer termBuffer,
                           int frameOffset)

streamId

public DataHeaderFlyweight streamId(int streamId)

set stream id field

Parameters:

streamId - field value

Returns:

flyweight

termId

public int termId()

return term id field

Returns:

term id field

termId

public static int termId(org.agrona.concurrent.UnsafeBuffer termBuffer,
                         int frameOffset)

termId

public DataHeaderFlyweight termId(int termId)

set term id field

Parameters:

termId - field value

Returns:

flyweight

termOffset

public int termOffset()

return term offset field

Returns:

term offset field

termOffset

public static int termOffset(org.agrona.concurrent.UnsafeBuffer termBuffer,
                             int frameOffset)

termOffset

public DataHeaderFlyweight termOffset(int termOffset)

set term offset field

Parameters:

termOffset - field value

Returns:

flyweight

reservedValue

public long reservedValue()

Get the reserved value in LITTLE_ENDIAN format.

Returns:

value of the reserved value.

reservedValue

public DataHeaderFlyweight reservedValue(long reservedValue)

Set the reserved value in LITTLE_ENDIAN format.

Parameters:

reservedValue - to be stored

Returns:

flyweight

dataOffset

public int dataOffset()

Return offset in buffer for data

Returns:

offset of data in the buffer

createDefaultHeader

public static org.agrona.concurrent.UnsafeBuffer createDefaultHeader(int sessionId,
                                                                     int streamId,
                                                                     int termId)

Return an initialised default Data Frame Header.

Parameters:

sessionId - for the header

streamId - for the header

termId - for the header

Returns:

byte array containing the header

toString

public java.lang.String toString()

Overrides:

toString in class org.agrona.concurrent.UnsafeBuffer