DataHeaderFlyweight (Aeron Transport Protocol)

java.lang.Object
- org.agrona.concurrent.UnsafeBuffer
- - io.aeron.protocol.HeaderFlyweight
  - - io.aeron.protocol.DataHeaderFlyweight

All Implemented Interfaces:

java.lang.Comparable<org.agrona.DirectBuffer>, org.agrona.concurrent.AtomicBuffer, org.agrona.DirectBuffer, org.agrona.MutableDirectBuffer
```
public class DataHeaderFlyweight
extends HeaderFlyweight
```
HeaderFlyweight for Data Header Data Frame

Field Summary

Fields
Modifier and Type	Field and Description
`static short`	`BEGIN_AND_END_FLAGS` Begin and End Flags
`static short`	`BEGIN_FLAG` Begin Flag
`static int`	`DATA_OFFSET`
`static long`	`DEFAULT_RESERVE_VALUE`
`static short`	`END_FLAG` End Flag
`static int`	`HEADER_LENGTH` Length of the Data Header
`static int`	`RESERVED_VALUE_OFFSET`
`static int`	`SESSION_ID_FIELD_OFFSET`
`static int`	`STREAM_ID_FIELD_OFFSET`
`static int`	`TERM_ID_FIELD_OFFSET`
`static int`	`TERM_OFFSET_FIELD_OFFSET`

Fields inherited from class io.aeron.protocol.HeaderFlyweight
CURRENT_VERSION, EMPTY_BUFFER, FLAGS_FIELD_OFFSET, FRAME_LENGTH_FIELD_OFFSET, HDR_TYPE_DATA, HDR_TYPE_ERR, HDR_TYPE_EXT, HDR_TYPE_NAK, HDR_TYPE_PAD, HDR_TYPE_SETUP, HDR_TYPE_SM, 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

DataHeaderFlyweight()

DataHeaderFlyweight(java.nio.ByteBuffer buffer)

DataHeaderFlyweight(org.agrona.concurrent.UnsafeBuffer buffer)

Constructors
Constructor and Description
`DataHeaderFlyweight()`
`DataHeaderFlyweight(java.nio.ByteBuffer buffer)`
`DataHeaderFlyweight(org.agrona.concurrent.UnsafeBuffer buffer)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static org.agrona.concurrent.UnsafeBuffer`	`createDefaultHeader(int sessionId, int streamId, int termId)` Return an initialised default Data Frame Header.
`int`	`dataOffset()` Return offset in buffer for data
`long`	`reservedValue()` Get the reserved value in LITTLE_ENDIAN format.
`DataHeaderFlyweight`	`reservedValue(long reservedValue)` Set the reserved value in LITTLE_ENDIAN format.
`int`	`sessionId()` return session id field
`DataHeaderFlyweight`	`sessionId(int sessionId)` set session id field
`int`	`streamId()` return stream id field
`DataHeaderFlyweight`	`streamId(int streamId)` set stream id field
`int`	`termId()` return term id field
`DataHeaderFlyweight`	`termId(int termId)` set term id field
`int`	`termOffset()` return term offset field
`DataHeaderFlyweight`	`termOffset(int termOffset)` set term offset 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, getStringUtf8, getStringUtf8, getStringUtf8, getStringWithoutLengthUtf8, hashCode, isExpandable, putByte, putBytes, putBytes, putBytes, putBytes, putBytes, putByteVolatile, putChar, putChar, putCharVolatile, putDouble, putDouble, putFloat, putFloat, putInt, putInt, putIntOrdered, putIntVolatile, putLong, putLong, putLongOrdered, putLongVolatile, putShort, putShort, putShortVolatile, putStringUtf8, putStringUtf8, putStringUtf8, putStringUtf8, 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 Data Header
    
    See Also:
    
    Constant Field Values
  - BEGIN_FLAG
```
public static final short BEGIN_FLAG
```
    Begin Flag
    
    See Also:
    
    Constant Field Values
  - END_FLAG
```
public static final short END_FLAG
```
    End Flag
    
    See Also:
    
    Constant Field Values
  - BEGIN_AND_END_FLAGS
```
public static final short BEGIN_AND_END_FLAGS
```
    Begin and End Flags
    
    See Also:
    
    Constant Field Values
  - DEFAULT_RESERVE_VALUE
```
public static final long DEFAULT_RESERVE_VALUE
```
    See Also:
    
    Constant Field Values
  - TERM_OFFSET_FIELD_OFFSET
```
public static final int TERM_OFFSET_FIELD_OFFSET
```
    See Also:
    
    Constant Field Values
  - SESSION_ID_FIELD_OFFSET
```
public static final int SESSION_ID_FIELD_OFFSET
```
    See Also:
    
    Constant Field Values
  - STREAM_ID_FIELD_OFFSET
```
public static final int STREAM_ID_FIELD_OFFSET
```
    See Also:
    
    Constant Field Values
  - TERM_ID_FIELD_OFFSET
```
public static final int TERM_ID_FIELD_OFFSET
```
    See Also:
    
    Constant Field Values
  - RESERVED_VALUE_OFFSET
```
public static final int RESERVED_VALUE_OFFSET
```
    See Also:
    
    Constant Field Values
  - DATA_OFFSET
```
public static final int DATA_OFFSET
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DataHeaderFlyweight
```
public DataHeaderFlyweight()
```
  - DataHeaderFlyweight
```
public DataHeaderFlyweight(org.agrona.concurrent.UnsafeBuffer buffer)
```
  - DataHeaderFlyweight
```
public DataHeaderFlyweight(java.nio.ByteBuffer buffer)
```
- Method Detail
  - sessionId
```
public int sessionId()
```
    return session id field
    
    Returns:
    
    session id field
  - sessionId
```
public DataHeaderFlyweight 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 DataHeaderFlyweight streamId(int streamId)
```
    set stream id field
    
    Parameters:
    
    streamId - field value
    
    Returns:
    
    flyweight
  - termId
```
public int termId()
```
    return term id field
    
    Returns:
    
    term id field
  - termId
```
public DataHeaderFlyweight termId(int termId)
```
    set term id field
    
    Parameters:
    
    termId - field value
    
    Returns:
    
    flyweight
  - termOffset
```
public int termOffset()
```
    return term offset field
    
    Returns:
    
    term offset field
  - termOffset
```
public DataHeaderFlyweight termOffset(int termOffset)
```
    set term offset field
    
    Parameters:
    
    termOffset - field value
    
    Returns:
    
    flyweight
  - reservedValue
```
public long reservedValue()
```
    Get the reserved value in LITTLE_ENDIAN format.
    
    Returns:
    
    value of the reserved value.
  - reservedValue
```
public DataHeaderFlyweight reservedValue(long reservedValue)
```
    Set the reserved value in LITTLE_ENDIAN format.
    
    Parameters:
    
    reservedValue - to be stored
    
    Returns:
    
    flyweight
  - dataOffset
```
public int dataOffset()
```
    Return offset in buffer for data
    
    Returns:
    
    offset of data in the buffer
  - createDefaultHeader
```
public static org.agrona.concurrent.UnsafeBuffer createDefaultHeader(int sessionId,
                                                                     int streamId,
                                                                     int termId)
```
    Return an initialised default Data Frame Header.
    
    Parameters:
    
    sessionId - for the header
    
    streamId - for the header
    
    termId - for the header
    
    Returns:
    
    byte array containing the header
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class DataHeaderFlyweight

Field Summary

Fields inherited from class io.aeron.protocol.HeaderFlyweight

Fields inherited from class org.agrona.concurrent.UnsafeBuffer

Constructor Summary

Method Summary

Methods inherited from class io.aeron.protocol.HeaderFlyweight

Methods inherited from class org.agrona.concurrent.UnsafeBuffer

Methods inherited from class java.lang.Object

Field Detail

HEADER_LENGTH

BEGIN_FLAG

END_FLAG

BEGIN_AND_END_FLAGS

DEFAULT_RESERVE_VALUE

TERM_OFFSET_FIELD_OFFSET

SESSION_ID_FIELD_OFFSET

STREAM_ID_FIELD_OFFSET

TERM_ID_FIELD_OFFSET

RESERVED_VALUE_OFFSET

DATA_OFFSET

Constructor Detail

DataHeaderFlyweight

DataHeaderFlyweight

DataHeaderFlyweight

Method Detail

sessionId

sessionId

streamId

streamId

termId

termId

termOffset

termOffset

reservedValue

reservedValue

dataOffset

createDefaultHeader

toString