HeaderFlyweight (Aeron Message Transport)

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

All Implemented Interfaces:: java.lang.Comparable<org.agrona.DirectBuffer>, org.agrona.concurrent.AtomicBuffer, org.agrona.DirectBuffer, org.agrona.MutableDirectBuffer

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

public class HeaderFlyweight
extends org.agrona.concurrent.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`
`static int`	`FRAME_LENGTH_FIELD_OFFSET`
`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_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`
`static int`	`TYPE_FIELD_OFFSET`
`static int`	`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

HeaderFlyweight()

HeaderFlyweight(java.nio.ByteBuffer buffer)

HeaderFlyweight(org.agrona.concurrent.UnsafeBuffer buffer)

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`short`	`flags()` return flags field value
`HeaderFlyweight`	`flags(short flags)` set the flags field value
`int`	`frameLength()` return frame length field
`HeaderFlyweight`	`frameLength(int length)` set frame length field
`int`	`headerType()` return header type field
`HeaderFlyweight`	`headerType(int type)` set header type field
`short`	`version()` return version field value
`HeaderFlyweight`	`version(short version)` set 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, getStringUtf8, getStringUtf8, getStringUtf8, 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_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
```
    See Also:
    
    Constant Field Values
  - VERSION_FIELD_OFFSET
```
public static final int VERSION_FIELD_OFFSET
```
    See Also:
    
    Constant Field Values
  - FLAGS_FIELD_OFFSET
```
public static final int FLAGS_FIELD_OFFSET
```
    See Also:
    
    Constant Field Values
  - TYPE_FIELD_OFFSET
```
public static final int TYPE_FIELD_OFFSET
```
    See Also:
    
    Constant Field Values
  - MIN_HEADER_LENGTH
```
public static final int MIN_HEADER_LENGTH
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HeaderFlyweight
```
public HeaderFlyweight()
```
  - HeaderFlyweight
```
public HeaderFlyweight(org.agrona.concurrent.UnsafeBuffer buffer)
```
  - HeaderFlyweight
```
public HeaderFlyweight(java.nio.ByteBuffer buffer)
```
- Method Detail
  - version
```
public short version()
```
    return version field value
    
    Returns:
    
    ver field value
  - version
```
public HeaderFlyweight version(short version)
```
    set version field value
    
    Parameters:
    
    version - field value
    
    Returns:
    
    flyweight
  - flags
```
public short flags()
```
    return flags field value
    
    Returns:
    
    flags field value
  - flags
```
public HeaderFlyweight flags(short flags)
```
    set the flags field value
    
    Parameters:
    
    flags - field value
    
    Returns:
    
    flyweight
  - headerType
```
public int headerType()
```
    return header type field
    
    Returns:
    
    type field value
  - headerType
```
public HeaderFlyweight headerType(int type)
```
    set header type field
    
    Parameters:
    
    type - field value
    
    Returns:
    
    flyweight
  - frameLength
```
public int frameLength()
```
    return frame length field
    
    Returns:
    
    frame length field
  - frameLength
```
public HeaderFlyweight frameLength(int length)
```
    set frame length field
    
    Parameters:
    
    length - field value
    
    Returns:
    
    flyweight

Class HeaderFlyweight

Field Summary

Fields inherited from class org.agrona.concurrent.UnsafeBuffer

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_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