io.aeron.protocol

Class StatusMessageFlyweight

java.lang.Object

org.agrona.concurrent.UnsafeBuffer

io.aeron.protocol.HeaderFlyweight

io.aeron.protocol.StatusMessageFlyweight

All Implemented Interfaces:

Comparable<DirectBuffer>, AtomicBuffer, DirectBuffer, MutableDirectBuffer

public class StatusMessageFlyweight
extends HeaderFlyweight

Flyweight for a Status Message Frame.

Status Message wiki page.

Field Summary

Fields

Modifier and Type	Field and Description
static int	HEADER_LENGTH Length of the Status Message Frame
static short	SEND_SETUP_FLAG Publisher should send SETUP frame

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_RES, 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

Fields inherited from interface org.agrona.DirectBuffer

DISABLE_ARRAY_CONTENT_PRINTOUT_PROP_NAME, STR_HEADER_LEN

Constructor Summary

Constructors

Constructor and Description
StatusMessageFlyweight() Default constructor which can later be use to wrap a frame.
StatusMessageFlyweight(ByteBuffer buffer) Construct the flyweight over a frame.
StatusMessageFlyweight(UnsafeBuffer buffer) Construct the flyweight over a frame.

Method Summary

Modifier and Type	Method and Description
int	asfLength() The length of the Application Specific Feedback (or gtag).
int	consumptionTermId() The highest consumption term-id.
StatusMessageFlyweight	consumptionTermId(int termId) Set the highest consumption term-id.
int	consumptionTermOffset() The highest consumption offset within the term.
StatusMessageFlyweight	consumptionTermOffset(int termOffset) Set the highest consumption offset within the term.
long	getLongUnaligned(int offset) Get long value from a field that is not aligned on an 8 byte boundary.
long	groupTag() The group tag (if present) from the Status Message.
StatusMessageFlyweight	groupTag(Long groupTag) Set the Receiver Group Tag for the Status Message.
static int	groupTagFieldOffset() Return the field offset within the flyweight for the group tag field.
StatusMessageFlyweight	putLongUnaligned(int offset, long value) Set long value into a field that is not aligned on an 8 byte boundary.
long	receiverId() Identifier for the receiver to distinguish them for FlowControl strategies.
StatusMessageFlyweight	receiverId(long id) Identifier for the receiver to distinguish them for FlowControl strategies.
int	receiverWindowLength() The receiver window length they will accept.
StatusMessageFlyweight	receiverWindowLength(int receiverWindowLength) Set the receiver window length they will accept.
int	sessionId() The session-id for the stream.
StatusMessageFlyweight	sessionId(int sessionId) Set the session-id of the stream.
int	streamId() The stream-id for the stream.
StatusMessageFlyweight	streamId(int streamId) Set the session-id for the stream.
String	toString()

Methods inherited from class io.aeron.protocol.HeaderFlyweight

appendFlagsAsChars, flags, flags, flagsToChars, 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, getStringAscii, getStringAscii, getStringAscii, getStringUtf8, getStringUtf8, getStringUtf8, getStringWithoutLengthAscii, 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 Status Message Frame

See Also:

Constant Field Values

SEND_SETUP_FLAG

public static final short SEND_SETUP_FLAG

Publisher should send SETUP frame

See Also:

Constant Field Values

Constructor Detail

StatusMessageFlyweight

public StatusMessageFlyweight()

Default constructor which can later be use to wrap a frame.

StatusMessageFlyweight

public StatusMessageFlyweight(ByteBuffer buffer)

Construct the flyweight over a frame.

Parameters:

buffer - containing the frame.

StatusMessageFlyweight

public StatusMessageFlyweight(UnsafeBuffer buffer)

Construct the flyweight over a frame.

Parameters:

buffer - containing the frame.

Method Detail

sessionId

public int sessionId()

The session-id for the stream.

Returns:

session-id for the stream.

sessionId

public StatusMessageFlyweight sessionId(int sessionId)

Set the session-id of the stream.

Parameters:

sessionId - field value.

Returns:

this for a fluent API.

streamId

public int streamId()

The stream-id for the stream.

Returns:

the session-id for the stream.

streamId

public StatusMessageFlyweight streamId(int streamId)

Set the session-id for the stream.

Parameters:

streamId - field value.

Returns:

this for a fluent API.

consumptionTermOffset

public int consumptionTermOffset()

The highest consumption offset within the term.

Returns:

the highest consumption offset within the term.

consumptionTermOffset

public StatusMessageFlyweight consumptionTermOffset(int termOffset)

Set the highest consumption offset within the term.

Parameters:

termOffset - field value.

Returns:

this for a fluent API.

consumptionTermId

public int consumptionTermId()

The highest consumption term-id.

Returns:

highest consumption term-id.

consumptionTermId

public StatusMessageFlyweight consumptionTermId(int termId)

Set the highest consumption term-id.

Parameters:

termId - field value.

Returns:

this for a fluent API.

receiverWindowLength

public int receiverWindowLength()

The receiver window length they will accept.

Returns:

receiver window length they will accept.

receiverWindowLength

public StatusMessageFlyweight receiverWindowLength(int receiverWindowLength)

Set the receiver window length they will accept.

Parameters:

receiverWindowLength - field value.

Returns:

this for a fluent API.

receiverId

public long receiverId()

Identifier for the receiver to distinguish them for FlowControl strategies.

Returns:

identifier for the receiver to distinguish them for FlowControl strategies.

receiverId

public StatusMessageFlyweight receiverId(long id)

Identifier for the receiver to distinguish them for FlowControl strategies.

Parameters:

id - for the receiver to distinguish them for FlowControl strategies.

Returns:

this for a fluent API.

asfLength

public int asfLength()

The length of the Application Specific Feedback (or gtag).

Returns:

length, in bytes, of the Application Specific Feedback (or gtag).

groupTag

public long groupTag()

The group tag (if present) from the Status Message.

Returns:

the group tag value or 0 if not present.

groupTag

public StatusMessageFlyweight groupTag(Long groupTag)

Set the Receiver Group Tag for the Status Message.

Parameters:

groupTag - value to set if not null.

Returns:

this for a fluent API.

groupTagFieldOffset

public static int groupTagFieldOffset()

Return the field offset within the flyweight for the group tag field.

Returns:

offset of group tag field

getLongUnaligned

public long getLongUnaligned(int offset)

Get long value from a field that is not aligned on an 8 byte boundary.

Parameters:

offset - of the field to get.

Returns:

value of field.

putLongUnaligned

public StatusMessageFlyweight putLongUnaligned(int offset,
                                               long value)

Set long value into a field that is not aligned on an 8 byte boundary.

Parameters:

offset - of the field to put.

value - of the field to put.

Returns:

this for fluent API.

toString

public String toString()

Overrides:

toString in class UnsafeBuffer