io.aeron.protocol

Class StatusMessageFlyweight

java.lang.Object

org.agrona.concurrent.UnsafeBuffer

io.aeron.protocol.HeaderFlyweight

io.aeron.protocol.StatusMessageFlyweight

All Implemented Interfaces:

java.lang.Comparable<org.agrona.DirectBuffer>, org.agrona.concurrent.AtomicBuffer, org.agrona.DirectBuffer, org.agrona.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_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
StatusMessageFlyweight()
StatusMessageFlyweight(java.nio.ByteBuffer buffer)
StatusMessageFlyweight(org.agrona.concurrent.UnsafeBuffer buffer)

Method Summary

Modifier and Type	Method and Description
int	applicationSpecificFeedback(byte[] destination) Retrieve the Application Specific Feedback (if present) from the Status Message.
StatusMessageFlyweight	applicationSpecificFeedback(byte[] source, int offset, int length) Set the Application Specific Feedback for the Status Message.
int	consumptionTermId() return highest consumption term id field
StatusMessageFlyweight	consumptionTermId(int termId) set highest consumption term id field
int	consumptionTermOffset() return highest consumption term offset field
StatusMessageFlyweight	consumptionTermOffset(int termOffset) set highest consumption term offset field
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() return receiver window field
StatusMessageFlyweight	receiverWindowLength(int receiverWindowLength) set receiver window field
int	sessionId() return session id field
StatusMessageFlyweight	sessionId(int sessionId) set session id field
int	streamId() return stream id field
StatusMessageFlyweight	streamId(int streamId) set stream id field
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 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()

StatusMessageFlyweight

public StatusMessageFlyweight(java.nio.ByteBuffer buffer)

StatusMessageFlyweight

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

Method Detail

sessionId

public int sessionId()

return session id field

Returns:

session id field

sessionId

public StatusMessageFlyweight 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 StatusMessageFlyweight streamId(int streamId)

set stream id field

Parameters:

streamId - field value

Returns:

flyweight

consumptionTermOffset

public int consumptionTermOffset()

return highest consumption term offset field

Returns:

highest consumption term offset field

consumptionTermOffset

public StatusMessageFlyweight consumptionTermOffset(int termOffset)

set highest consumption term offset field

Parameters:

termOffset - field value

Returns:

flyweight

consumptionTermId

public int consumptionTermId()

return highest consumption term id field

Returns:

highest consumption term id field

consumptionTermId

public StatusMessageFlyweight consumptionTermId(int termId)

set highest consumption term id field

Parameters:

termId - field value

Returns:

flyweight

receiverWindowLength

public int receiverWindowLength()

return receiver window field

Returns:

receiver window field

receiverWindowLength

public StatusMessageFlyweight receiverWindowLength(int receiverWindowLength)

set receiver window field

Parameters:

receiverWindowLength - field value

Returns:

flyweight

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:

flyweight

applicationSpecificFeedback

public int applicationSpecificFeedback(byte[] destination)

Retrieve the Application Specific Feedback (if present) from the Status Message.

Parameters:

destination - to store the feedback

Returns:

the number of bytes in the feedback copied into the destination

applicationSpecificFeedback

public StatusMessageFlyweight applicationSpecificFeedback(byte[] source,
                                                          int offset,
                                                          int length)

Set the Application Specific Feedback for the Status Message.

Parameters:

source - of the feedback to set

offset - of the feedback in the source

length - of the feedback in bytes

Returns:

flyweight

toString

public java.lang.String toString()

Overrides:

toString in class org.agrona.concurrent.UnsafeBuffer