HeaderFlyweight (Aeron Message Transport)

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

All Implemented Interfaces:: Comparable<DirectBuffer>, AtomicBuffer, DirectBuffer, MutableDirectBuffer

Direct Known Subclasses:: DataHeaderFlyweight, NakFlyweight, ResolutionEntryFlyweight, RttMeasurementFlyweight, SetupFlyweight, StatusMessageFlyweight

public class HeaderFlyweight
extends UnsafeBuffer

Flyweight for general Aeron network protocol header of a message frame.

   0                   1                   2                   3
   0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  |                        Frame Length                           |
  +---------------------------------------------------------------+
  |  Version    |     Flags     |               Type              |
  +-------------+---------------+---------------------------------+
  |                       Depends on Type                        ...

Field Summary

Fields
Modifier and Type	Field and Description
`static byte`	`CURRENT_VERSION` default version
`static int`	`FLAGS_FIELD_OFFSET` Offset in the frame at which the flags field begins.
`static int`	`FRAME_LENGTH_FIELD_OFFSET` Offset in the frame at which the frame length field begins.
`static int`	`HDR_TYPE_DATA` header type DATA
`static int`	`HDR_TYPE_ERR` header type ERR
`static int`	`HDR_TYPE_EXT` header type EXT
`static int`	`HDR_TYPE_NAK` header type NAK
`static int`	`HDR_TYPE_PAD` header type PAD
`static int`	`HDR_TYPE_RES` header type RESOLUTION
`static int`	`HDR_TYPE_RTTM` header type RTT Measurement
`static int`	`HDR_TYPE_SETUP` header type SETUP
`static int`	`HDR_TYPE_SM` header type SM
`static int`	`MIN_HEADER_LENGTH` Minimum length of any Aeron frame.
`static int`	`TYPE_FIELD_OFFSET` Offset in the frame at which the frame type field begins.
`static int`	`VERSION_FIELD_OFFSET` Offset in the frame at which the version field begins.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`appendFlagsAsChars(short flags, Appendable appendable)` Append header flags to an `Appendable` to be human readable.
`short`	`flags()` The flags field value.
`HeaderFlyweight`	`flags(short flags)` Set the flags field value.
`static char[]`	`flagsToChars(short flags)` Convert header flags to an array of chars to be human readable.
`int`	`frameLength()` The length of the frame field value.
`HeaderFlyweight`	`frameLength(int length)` Set the length of the frame field value.
`int`	`headerType()` The type field value.
`HeaderFlyweight`	`headerType(int type)` Set the type field value.
`short`	`version()` The version field value.
`HeaderFlyweight`	`version(short version)` Set the version field value.

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, toString, 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
  - HDR_TYPE_PAD
```
public static final int HDR_TYPE_PAD
```
    header type PAD
    
    See Also:
    
    Constant Field Values
  - HDR_TYPE_DATA
```
public static final int HDR_TYPE_DATA
```
    header type DATA
    
    See Also:
    
    Constant Field Values
  - HDR_TYPE_NAK
```
public static final int HDR_TYPE_NAK
```
    header type NAK
    
    See Also:
    
    Constant Field Values
  - HDR_TYPE_SM
```
public static final int HDR_TYPE_SM
```
    header type SM
    
    See Also:
    
    Constant Field Values
  - HDR_TYPE_ERR
```
public static final int HDR_TYPE_ERR
```
    header type ERR
    
    See Also:
    
    Constant Field Values
  - HDR_TYPE_SETUP
```
public static final int HDR_TYPE_SETUP
```
    header type SETUP
    
    See Also:
    
    Constant Field Values
  - HDR_TYPE_RTTM
```
public static final int HDR_TYPE_RTTM
```
    header type RTT Measurement
    
    See Also:
    
    Constant Field Values
  - HDR_TYPE_RES
```
public static final int HDR_TYPE_RES
```
    header type RESOLUTION
    
    See Also:
    
    Constant Field Values
  - HDR_TYPE_EXT
```
public static final int HDR_TYPE_EXT
```
    header type EXT
    
    See Also:
    
    Constant Field Values
  - CURRENT_VERSION
```
public static final byte CURRENT_VERSION
```
    default version
    
    See Also:
    
    Constant Field Values
  - FRAME_LENGTH_FIELD_OFFSET
```
public static final int FRAME_LENGTH_FIELD_OFFSET
```
    Offset in the frame at which the frame length field begins.
    
    See Also:
    
    Constant Field Values
  - VERSION_FIELD_OFFSET
```
public static final int VERSION_FIELD_OFFSET
```
    Offset in the frame at which the version field begins.
    
    See Also:
    
    Constant Field Values
  - FLAGS_FIELD_OFFSET
```
public static final int FLAGS_FIELD_OFFSET
```
    Offset in the frame at which the flags field begins.
    
    See Also:
    
    Constant Field Values
  - TYPE_FIELD_OFFSET
```
public static final int TYPE_FIELD_OFFSET
```
    Offset in the frame at which the frame type field begins.
    
    See Also:
    
    Constant Field Values
  - MIN_HEADER_LENGTH
```
public static final int MIN_HEADER_LENGTH
```
    Minimum length of any Aeron frame.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HeaderFlyweight
```
public HeaderFlyweight()
```
    Default constructor which can later be use to wrap a frame.
  - HeaderFlyweight
```
public HeaderFlyweight(UnsafeBuffer buffer)
```
    Construct a flyweight which wraps a UnsafeBuffer over the frame.
    
    Parameters:
    
    buffer - to wrap for the flyweight.
  - HeaderFlyweight
```
public HeaderFlyweight(ByteBuffer buffer)
```
    Construct a flyweight which wraps a ByteBuffer over the frame.
    
    Parameters:
    
    buffer - to wrap for the flyweight.
- Method Detail
  - version
```
public short version()
```
    The version field value.
    
    Returns:
    
    version field value.
  - version
```
public HeaderFlyweight version(short version)
```
    Set the version field value.
    
    Parameters:
    
    version - field value to be set.
    
    Returns:
    
    this for a fluent API.
  - flags
```
public short flags()
```
    The flags field value.
    
    Returns:
    
    the flags field value.
  - flags
```
public HeaderFlyweight flags(short flags)
```
    Set the flags field value.
    
    Parameters:
    
    flags - field value.
    
    Returns:
    
    this for a fluent API.
  - headerType
```
public int headerType()
```
    The type field value.
    
    Returns:
    
    the type field value.
  - headerType
```
public HeaderFlyweight headerType(int type)
```
    Set the type field value.
    
    Parameters:
    
    type - field value.
    
    Returns:
    
    this for a fluent API.
  - frameLength
```
public int frameLength()
```
    The length of the frame field value.
    
    Returns:
    
    length of the frame field value.
  - frameLength
```
public HeaderFlyweight frameLength(int length)
```
    Set the length of the frame field value.
    
    Parameters:
    
    length - field value.
    
    Returns:
    
    this for a fluent API.
  - flagsToChars
```
public static char[] flagsToChars(short flags)
```
    Convert header flags to an array of chars to be human readable.
    
    Parameters:
    
    flags - to be converted.
    
    Returns:
    
    header flags converted to an array of chars to be human readable.
  - appendFlagsAsChars
```
public static void appendFlagsAsChars(short flags,
                                      Appendable appendable)
```
    Append header flags to an Appendable to be human readable.
    
    Parameters:
    
    flags - to be converted.
    
    appendable - to append flags to.

Class HeaderFlyweight

Field Summary

Fields inherited from class org.agrona.concurrent.UnsafeBuffer

Fields inherited from interface org.agrona.DirectBuffer

Constructor Summary

Method Summary

Methods inherited from class org.agrona.concurrent.UnsafeBuffer

Methods inherited from class java.lang.Object

Field Detail

HDR_TYPE_PAD

HDR_TYPE_DATA

HDR_TYPE_NAK

HDR_TYPE_SM

HDR_TYPE_ERR

HDR_TYPE_SETUP

HDR_TYPE_RTTM

HDR_TYPE_RES

HDR_TYPE_EXT

CURRENT_VERSION

FRAME_LENGTH_FIELD_OFFSET

VERSION_FIELD_OFFSET

FLAGS_FIELD_OFFSET

TYPE_FIELD_OFFSET

MIN_HEADER_LENGTH

Constructor Detail

HeaderFlyweight

HeaderFlyweight

HeaderFlyweight

Method Detail

version

version

flags

flags

headerType

headerType

frameLength

frameLength

flagsToChars

appendFlagsAsChars