io.aeron.protocol

Class SetupFlyweight

java.lang.Object

org.agrona.AbstractMutableDirectBuffer

org.agrona.concurrent.UnsafeBuffer

io.aeron.protocol.HeaderFlyweight

io.aeron.protocol.SetupFlyweight

All Implemented Interfaces:

Comparable<DirectBuffer>, AtomicBuffer, DirectBuffer, MutableDirectBuffer

public class SetupFlyweight
extends HeaderFlyweight

HeaderFlyweight for Setup Message Frames.

Stream Setup wiki page.

Field Summary

Fields

Modifier and Type	Field and Description
static int	HEADER_LENGTH Length of the Setup Message 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 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
SetupFlyweight() Default constructor which can later be used to wrap a frame.
SetupFlyweight(ByteBuffer buffer) Construct the flyweight over a frame.
SetupFlyweight(UnsafeBuffer buffer) Construct the flyweight over a frame.

Method Summary

Modifier and Type	Method and Description
int	activeTermId() Get active term id field.
SetupFlyweight	activeTermId(int termId) Set active term id field.
int	initialTermId() Get initial term id field.
SetupFlyweight	initialTermId(int termId) Set initial term id field.
int	mtuLength() Get MTU length field.
SetupFlyweight	mtuLength(int mtuLength) Set MTU length field.
int	sessionId() Get session id field.
SetupFlyweight	sessionId(int sessionId) Set session id field.
int	streamId() Get stream id field.
SetupFlyweight	streamId(int streamId) Set stream id field.
int	termLength() Get term length field.
SetupFlyweight	termLength(int termLength) Set term length field.
int	termOffset() Get term offset field.
SetupFlyweight	termOffset(int termOffset) Set term offset field.
String	toString()
int	ttl() Get the TTL field.
SetupFlyweight	ttl(int ttl) Set the TTL field.

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

HEADER_LENGTH

public static final int HEADER_LENGTH

Length of the Setup Message Frame.

See Also:

Constant Field Values

Constructor Detail

SetupFlyweight

public SetupFlyweight()

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

SetupFlyweight

public SetupFlyweight(UnsafeBuffer buffer)

Construct the flyweight over a frame.

Parameters:

buffer - containing the frame.

SetupFlyweight

public SetupFlyweight(ByteBuffer buffer)

Construct the flyweight over a frame.

Parameters:

buffer - containing the frame.

Method Detail

termOffset

public int termOffset()

Get term offset field.

Returns:

term offset field.

termOffset

public SetupFlyweight termOffset(int termOffset)

Set term offset field.

Parameters:

termOffset - field value.

Returns:

this for a fluent API.

sessionId

public int sessionId()

Get session id field.

Returns:

session id field.

sessionId

public SetupFlyweight sessionId(int sessionId)

Set session id field.

Parameters:

sessionId - field value.

Returns:

this for a fluent API.

streamId

public int streamId()

Get stream id field.

Returns:

stream id field.

streamId

public SetupFlyweight streamId(int streamId)

Set stream id field.

Parameters:

streamId - field value.

Returns:

this for a fluent API.

initialTermId

public int initialTermId()

Get initial term id field.

Returns:

initial term id field.

initialTermId

public SetupFlyweight initialTermId(int termId)

Set initial term id field.

Parameters:

termId - field value.

Returns:

this for a fluent API.

activeTermId

public int activeTermId()

Get active term id field.

Returns:

term id field.

activeTermId

public SetupFlyweight activeTermId(int termId)

Set active term id field.

Parameters:

termId - field value.

Returns:

this for a fluent API.

termLength

public int termLength()

Get term length field.

Returns:

term length field value.

termLength

public SetupFlyweight termLength(int termLength)

Set term length field.

Parameters:

termLength - field value.

Returns:

this for a fluent API.

mtuLength

public int mtuLength()

Get MTU length field.

Returns:

MTU length field value.

mtuLength

public SetupFlyweight mtuLength(int mtuLength)

Set MTU length field.

Parameters:

mtuLength - field value.

Returns:

this for a fluent API.

ttl

public int ttl()

Get the TTL field.

Returns:

TTL field value.

ttl

public SetupFlyweight ttl(int ttl)

Set the TTL field.

Parameters:

ttl - field value.

Returns:

this for a fluent API.

toString

public String toString()

Overrides:

toString in class UnsafeBuffer