io.aeron.protocol

Class NakFlyweight

java.lang.Object

org.agrona.concurrent.UnsafeBuffer

io.aeron.protocol.HeaderFlyweight

io.aeron.protocol.NakFlyweight

All Implemented Interfaces:

Comparable<DirectBuffer>, AtomicBuffer, DirectBuffer, MutableDirectBuffer

public class NakFlyweight
extends HeaderFlyweight

Flyweight for a NAK Message Frame.

Data Loss Recovery wiki page.

Field Summary

Fields

Modifier and Type	Field and Description
static int	HEADER_LENGTH Length of the frame in bytes.

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
NakFlyweight() Default constructor which can later be use to wrap a frame.
NakFlyweight(ByteBuffer buffer) Construct the flyweight over a frame.
NakFlyweight(UnsafeBuffer buffer) Construct the flyweight over a frame.

Method Summary

Modifier and Type	Method and Description
int	length() The length of the encoded frame.
NakFlyweight	length(int length) Set length of the encoded frame.
int	sessionId() The session-id for the stream.
NakFlyweight	sessionId(int sessionId) Set session-id for the stream.
int	streamId() The stream-id for the stream.
NakFlyweight	streamId(int streamId) Set stream-id for the stream.
int	termId() The term-id for the stream.
NakFlyweight	termId(int termId) Set term-id for the stream.
int	termOffset() The term-offset for the stream.
NakFlyweight	termOffset(int termOffset) Set term-offset 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 frame in bytes.

See Also:

Constant Field Values

Constructor Detail

NakFlyweight

public NakFlyweight()

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

NakFlyweight

public NakFlyweight(ByteBuffer buffer)

Construct the flyweight over a frame.

Parameters:

buffer - containing the frame.

NakFlyweight

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

Set stream-id for the stream.

Parameters:

streamId - stream-id for the stream.

Returns:

this for a fluent API.

termId

public int termId()

The term-id for the stream.

Returns:

term-id for the stream.

termId

public NakFlyweight termId(int termId)

Set term-id for the stream.

Parameters:

termId - term-id for the stream.

Returns:

this for a fluent API.

termOffset

public int termOffset()

The term-offset for the stream.

Returns:

term-offset for the stream.

termOffset

public NakFlyweight termOffset(int termOffset)

Set term-offset for the stream.

Parameters:

termOffset - term-offset for the stream.

Returns:

for a fluent API.

length

public int length()

The length of the encoded frame.

Returns:

length of the encoded frame.

length

public NakFlyweight length(int length)

Set length of the encoded frame.

Parameters:

length - of the encoded frame.

Returns:

this for a fluent API.

toString

public String toString()

Overrides:

toString in class UnsafeBuffer