io.aeron.protocol

Class RttMeasurementFlyweight

java.lang.Object

org.agrona.AbstractMutableDirectBuffer

org.agrona.concurrent.UnsafeBuffer

io.aeron.protocol.HeaderFlyweight

io.aeron.protocol.RttMeasurementFlyweight

All Implemented Interfaces:

Comparable<DirectBuffer>, AtomicBuffer, DirectBuffer, MutableDirectBuffer

public class RttMeasurementFlyweight
extends HeaderFlyweight

Flyweight for an RTT Measurement Frame Header.

RTT Measurement Frame Header wiki page.

Field Summary

Fields

Modifier and Type	Field and Description
static int	HEADER_LENGTH Length of the header of the frame.
static short	REPLY_FLAG Flag set to indicate this is a reply message.

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 class org.agrona.AbstractMutableDirectBuffer

addressOffset, byteArray, capacity

Fields inherited from interface org.agrona.concurrent.AtomicBuffer

STRICT_ALIGNMENT_CHECKS, STRICT_ALIGNMENT_CHECKS_PROP_NAME

Fields inherited from interface org.agrona.DirectBuffer

DISABLE_ARRAY_CONTENT_PRINTOUT_PROP_NAME, STR_HEADER_LEN

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
long	echoTimestampNs() Timestamp to echo in a reply or the timestamp in the original RTT Measurement.
RttMeasurementFlyweight	echoTimestampNs(long timestampNs) Set timestamp to echo in a reply or the timestamp in the original RTT Measurement.
long	receiverId() The receiver-id which uniquely identifies a receiver of a stream.
RttMeasurementFlyweight	receiverId(long id) Set receiver-id which uniquely identifies a receiver of a stream.
long	receptionDelta() Time in nanoseconds between receiving original RTT Measurement and sending Reply RTT Measurement.
RttMeasurementFlyweight	receptionDelta(long deltaNs) Set time in nanoseconds between receiving original RTT Measurement and sending Reply RTT Measurement.
int	sessionId() The session-id for the stream.
RttMeasurementFlyweight	sessionId(int sessionId) Set session-id for the stream.
int	streamId() The stream-id for the stream.
RttMeasurementFlyweight	streamId(int streamId) Set stream-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, byteBuffer, compareAndSetInt, compareAndSetLong, ensureCapacity, getAndAddInt, getAndAddLong, getAndSetInt, getAndSetLong, getByteVolatile, getCharVolatile, getIntVolatile, getLongVolatile, getShortVolatile, isExpandable, putByteVolatile, putCharVolatile, putIntOrdered, putIntVolatile, putLongOrdered, putLongVolatile, putShortVolatile, verifyAlignment, wrap, wrap, wrap, wrap, wrap, wrap, wrap, wrapAdjustment

Methods inherited from class org.agrona.AbstractMutableDirectBuffer

addressOffset, boundsCheck, boundsCheck0, byteArray, capacity, checkLimit, compareTo, equals, getByte, getBytes, getBytes, getBytes, getBytes, getBytes, getChar, getChar, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getLong, getLong, getShort, getShort, getStringAscii, getStringAscii, getStringAscii, getStringAscii, getStringAscii, getStringAscii, getStringUtf8, getStringUtf8, getStringUtf8, getStringWithoutLengthAscii, getStringWithoutLengthAscii, getStringWithoutLengthUtf8, hashCode, parseIntAscii, parseLongAscii, parseNaturalIntAscii, parseNaturalLongAscii, putByte, putBytes, putBytes, putBytes, putBytes, putBytes, putChar, putChar, putDouble, putDouble, putFloat, putFloat, putInt, putInt, putIntAscii, putLong, putLong, putLongAscii, putNaturalIntAscii, putNaturalIntAsciiFromEnd, putNaturalLongAscii, putNaturalPaddedIntAscii, putShort, putShort, putStringAscii, putStringAscii, putStringAscii, putStringAscii, putStringUtf8, putStringUtf8, putStringUtf8, putStringUtf8, putStringWithoutLengthAscii, putStringWithoutLengthAscii, putStringWithoutLengthAscii, putStringWithoutLengthAscii, putStringWithoutLengthUtf8, setMemory

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.agrona.MutableDirectBuffer

putByte, putBytes, putBytes, putBytes, putBytes, putBytes, putChar, putChar, putDouble, putDouble, putFloat, putFloat, putInt, putInt, putIntAscii, putLong, putLong, putLongAscii, putNaturalIntAscii, putNaturalIntAsciiFromEnd, putNaturalLongAscii, putNaturalPaddedIntAscii, putShort, putShort, putStringAscii, putStringAscii, putStringAscii, putStringAscii, putStringUtf8, putStringUtf8, putStringUtf8, putStringUtf8, putStringWithoutLengthAscii, putStringWithoutLengthAscii, putStringWithoutLengthAscii, putStringWithoutLengthAscii, putStringWithoutLengthUtf8, setMemory

Methods inherited from interface org.agrona.DirectBuffer

addressOffset, boundsCheck, byteArray, capacity, checkLimit, getByte, getBytes, getBytes, getBytes, getBytes, getBytes, getChar, getChar, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getLong, getLong, getShort, getShort, getStringAscii, getStringAscii, getStringAscii, getStringAscii, getStringAscii, getStringAscii, getStringUtf8, getStringUtf8, getStringUtf8, getStringWithoutLengthAscii, getStringWithoutLengthAscii, getStringWithoutLengthUtf8, parseIntAscii, parseLongAscii, parseNaturalIntAscii, parseNaturalLongAscii

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

REPLY_FLAG

public static final short REPLY_FLAG

Flag set to indicate this is a reply message.

See Also:

Constant Field Values

HEADER_LENGTH

public static final int HEADER_LENGTH

Length of the header of the frame.

See Also:

Constant Field Values

Constructor Detail

RttMeasurementFlyweight

public RttMeasurementFlyweight()

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

RttMeasurementFlyweight

public RttMeasurementFlyweight(ByteBuffer buffer)

Construct the flyweight over a frame.

Parameters:

buffer - containing the frame.

RttMeasurementFlyweight

public RttMeasurementFlyweight(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 RttMeasurementFlyweight sessionId(int sessionId)

Set session-id for the stream.

Parameters:

sessionId - session-id for the stream.

Returns:

this for a fluent API.

streamId

public int streamId()

The stream-id for the stream.

Returns:

stream-id for the stream.

streamId

public RttMeasurementFlyweight streamId(int streamId)

Set stream-id for the stream.

Parameters:

streamId - stream-id for the stream.

Returns:

this for a fluent API.

echoTimestampNs

public long echoTimestampNs()

Timestamp to echo in a reply or the timestamp in the original RTT Measurement.

Returns:

timestamp to echo in a reply or the timestamp in the original RTT Measurement.

echoTimestampNs

public RttMeasurementFlyweight echoTimestampNs(long timestampNs)

Set timestamp to echo in a reply or the timestamp in the original RTT Measurement.

Parameters:

timestampNs - to echo in a reply or the timestamp in the original RTT Measurement.

Returns:

this for a fluent API.

receptionDelta

public long receptionDelta()

Time in nanoseconds between receiving original RTT Measurement and sending Reply RTT Measurement.

Returns:

time in nanoseconds between receiving original RTT Measurement and sending Reply RTT Measurement.

receptionDelta

public RttMeasurementFlyweight receptionDelta(long deltaNs)

Set time in nanoseconds between receiving original RTT Measurement and sending Reply RTT Measurement.

Parameters:

deltaNs - in nanoseconds between receiving original RTT Measurement and sending Reply RTT Measurement.

Returns:

this for a fluent API.

receiverId

public long receiverId()

The receiver-id which uniquely identifies a receiver of a stream.

Returns:

receiver-id which uniquely identifies a receiver of a stream.

receiverId

public RttMeasurementFlyweight receiverId(long id)

Set receiver-id which uniquely identifies a receiver of a stream.

Parameters:

id - for the receiver of the stream.

Returns:

this for a fluent API.

toString

public String toString()

Overrides:

toString in class UnsafeBuffer