MarkFileHeaderDecoder (Aeron Message Transport)

java.lang.Object
- io.aeron.archive.codecs.mark.MarkFileHeaderDecoder

public final class MarkFileHeaderDecoder
extends Object

Mark file header.

Field Summary

Fields
Modifier and Type Field and Description

static int BLOCK_LENGTH

static ByteOrder BYTE_ORDER

static int SCHEMA_ID

static int SCHEMA_VERSION

static int TEMPLATE_ID

Fields
Modifier and Type	Field and Description
`static int`	`BLOCK_LENGTH`
`static ByteOrder`	`BYTE_ORDER`
`static int`	`SCHEMA_ID`
`static int`	`SCHEMA_VERSION`
`static int`	`TEMPLATE_ID`

Constructor Summary

Constructors
Constructor and Description

MarkFileHeaderDecoder()

Constructors
Constructor and Description
`MarkFileHeaderDecoder()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`activityTimestamp()`
`static int`	`activityTimestampEncodingLength()`
`static int`	`activityTimestampEncodingOffset()`
`static int`	`activityTimestampId()`
`static long`	`activityTimestampMaxValue()`
`static String`	`activityTimestampMetaAttribute(MetaAttribute metaAttribute)`
`static long`	`activityTimestampMinValue()`
`static long`	`activityTimestampNullValue()`
`static int`	`activityTimestampSinceVersion()`
`String`	`aeronDirectory()`
`static String`	`aeronDirectoryCharacterEncoding()`
`static int`	`aeronDirectoryHeaderLength()`
`static int`	`aeronDirectoryId()`
`int`	`aeronDirectoryLength()`
`static String`	`aeronDirectoryMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`aeronDirectorySinceVersion()`
`StringBuilder`	`appendTo(StringBuilder builder)`
`DirectBuffer`	`buffer()`
`String`	`controlChannel()`
`static String`	`controlChannelCharacterEncoding()`
`static int`	`controlChannelHeaderLength()`
`static int`	`controlChannelId()`
`int`	`controlChannelLength()`
`static String`	`controlChannelMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`controlChannelSinceVersion()`
`int`	`controlStreamId()`
`static int`	`controlStreamIdEncodingLength()`
`static int`	`controlStreamIdEncodingOffset()`
`static int`	`controlStreamIdId()`
`static int`	`controlStreamIdMaxValue()`
`static String`	`controlStreamIdMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`controlStreamIdMinValue()`
`static int`	`controlStreamIdNullValue()`
`static int`	`controlStreamIdSinceVersion()`
`int`	`encodedLength()`
`int`	`errorBufferLength()`
`static int`	`errorBufferLengthEncodingLength()`
`static int`	`errorBufferLengthEncodingOffset()`
`static int`	`errorBufferLengthId()`
`static int`	`errorBufferLengthMaxValue()`
`static String`	`errorBufferLengthMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`errorBufferLengthMinValue()`
`static int`	`errorBufferLengthNullValue()`
`static int`	`errorBufferLengthSinceVersion()`
`String`	`eventsChannel()`
`static String`	`eventsChannelCharacterEncoding()`
`static int`	`eventsChannelHeaderLength()`
`static int`	`eventsChannelId()`
`int`	`eventsChannelLength()`
`static String`	`eventsChannelMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`eventsChannelSinceVersion()`
`int`	`eventsStreamId()`
`static int`	`eventsStreamIdEncodingLength()`
`static int`	`eventsStreamIdEncodingOffset()`
`static int`	`eventsStreamIdId()`
`static int`	`eventsStreamIdMaxValue()`
`static String`	`eventsStreamIdMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`eventsStreamIdMinValue()`
`static int`	`eventsStreamIdNullValue()`
`static int`	`eventsStreamIdSinceVersion()`
`int`	`getAeronDirectory(Appendable appendable)`
`int`	`getAeronDirectory(byte[] dst, int dstOffset, int length)`
`int`	`getAeronDirectory(MutableDirectBuffer dst, int dstOffset, int length)`
`int`	`getControlChannel(Appendable appendable)`
`int`	`getControlChannel(byte[] dst, int dstOffset, int length)`
`int`	`getControlChannel(MutableDirectBuffer dst, int dstOffset, int length)`
`int`	`getEventsChannel(Appendable appendable)`
`int`	`getEventsChannel(byte[] dst, int dstOffset, int length)`
`int`	`getEventsChannel(MutableDirectBuffer dst, int dstOffset, int length)`
`int`	`getLocalControlChannel(Appendable appendable)`
`int`	`getLocalControlChannel(byte[] dst, int dstOffset, int length)`
`int`	`getLocalControlChannel(MutableDirectBuffer dst, int dstOffset, int length)`
`int`	`headerLength()`
`static int`	`headerLengthEncodingLength()`
`static int`	`headerLengthEncodingOffset()`
`static int`	`headerLengthId()`
`static int`	`headerLengthMaxValue()`
`static String`	`headerLengthMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`headerLengthMinValue()`
`static int`	`headerLengthNullValue()`
`static int`	`headerLengthSinceVersion()`
`int`	`initialOffset()`
`int`	`limit()`
`void`	`limit(int limit)`
`String`	`localControlChannel()`
`static String`	`localControlChannelCharacterEncoding()`
`static int`	`localControlChannelHeaderLength()`
`static int`	`localControlChannelId()`
`int`	`localControlChannelLength()`
`static String`	`localControlChannelMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`localControlChannelSinceVersion()`
`int`	`localControlStreamId()`
`static int`	`localControlStreamIdEncodingLength()`
`static int`	`localControlStreamIdEncodingOffset()`
`static int`	`localControlStreamIdId()`
`static int`	`localControlStreamIdMaxValue()`
`static String`	`localControlStreamIdMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`localControlStreamIdMinValue()`
`static int`	`localControlStreamIdNullValue()`
`static int`	`localControlStreamIdSinceVersion()`
`int`	`offset()`
`long`	`pid()`
`static int`	`pidEncodingLength()`
`static int`	`pidEncodingOffset()`
`static int`	`pidId()`
`static long`	`pidMaxValue()`
`static String`	`pidMetaAttribute(MetaAttribute metaAttribute)`
`static long`	`pidMinValue()`
`static long`	`pidNullValue()`
`static int`	`pidSinceVersion()`
`int`	`sbeBlockLength()`
`int`	`sbeSchemaId()`
`int`	`sbeSchemaVersion()`
`String`	`sbeSemanticType()`
`int`	`sbeTemplateId()`
`int`	`skipAeronDirectory()`
`int`	`skipControlChannel()`
`int`	`skipEventsChannel()`
`int`	`skipLocalControlChannel()`
`long`	`startTimestamp()`
`static int`	`startTimestampEncodingLength()`
`static int`	`startTimestampEncodingOffset()`
`static int`	`startTimestampId()`
`static long`	`startTimestampMaxValue()`
`static String`	`startTimestampMetaAttribute(MetaAttribute metaAttribute)`
`static long`	`startTimestampMinValue()`
`static long`	`startTimestampNullValue()`
`static int`	`startTimestampSinceVersion()`
`String`	`toString()`
`int`	`version()`
`static int`	`versionEncodingLength()`
`static int`	`versionEncodingOffset()`
`static int`	`versionId()`
`static int`	`versionMaxValue()`
`static String`	`versionMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`versionMinValue()`
`static int`	`versionNullValue()`
`static int`	`versionSinceVersion()`
`MarkFileHeaderDecoder`	`wrap(DirectBuffer buffer, int offset, int actingBlockLength, int actingVersion)`
`void`	`wrapAeronDirectory(DirectBuffer wrapBuffer)`
`void`	`wrapControlChannel(DirectBuffer wrapBuffer)`
`void`	`wrapEventsChannel(DirectBuffer wrapBuffer)`
`void`	`wrapLocalControlChannel(DirectBuffer wrapBuffer)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BLOCK_LENGTH
```
public static final int BLOCK_LENGTH
```
See Also:

Constant Field Values

TEMPLATE_ID
```
public static final int TEMPLATE_ID
```
See Also:

Constant Field Values

SCHEMA_ID
```
public static final int SCHEMA_ID
```
See Also:

Constant Field Values

SCHEMA_VERSION
```
public static final int SCHEMA_VERSION
```
See Also:

Constant Field Values

BYTE_ORDER

public static final ByteOrder BYTE_ORDER

Constructor Detail
- MarkFileHeaderDecoder
```
public MarkFileHeaderDecoder()
```

Method Detail

sbeBlockLength
```
public int sbeBlockLength()
```

sbeTemplateId
```
public int sbeTemplateId()
```

sbeSchemaId
```
public int sbeSchemaId()
```

sbeSchemaVersion
```
public int sbeSchemaVersion()
```

sbeSemanticType
```
public String sbeSemanticType()
```

buffer
```
public DirectBuffer buffer()
```

initialOffset
```
public int initialOffset()
```

offset
```
public int offset()
```

wrap

public MarkFileHeaderDecoder wrap(DirectBuffer buffer,
                                  int offset,
                                  int actingBlockLength,
                                  int actingVersion)

encodedLength
```
public int encodedLength()
```

limit
```
public int limit()
```

limit
```
public void limit(int limit)
```

versionId
```
public static int versionId()
```

versionSinceVersion

public static int versionSinceVersion()

versionEncodingOffset

public static int versionEncodingOffset()

versionEncodingLength

public static int versionEncodingLength()

versionMetaAttribute

public static String versionMetaAttribute(MetaAttribute metaAttribute)

versionNullValue
```
public static int versionNullValue()
```

versionMinValue
```
public static int versionMinValue()
```

versionMaxValue
```
public static int versionMaxValue()
```

version
```
public int version()
```

activityTimestampId

public static int activityTimestampId()

activityTimestampSinceVersion

public static int activityTimestampSinceVersion()

activityTimestampEncodingOffset

public static int activityTimestampEncodingOffset()

activityTimestampEncodingLength

public static int activityTimestampEncodingLength()

activityTimestampMetaAttribute

public static String activityTimestampMetaAttribute(MetaAttribute metaAttribute)

activityTimestampNullValue

public static long activityTimestampNullValue()

activityTimestampMinValue

public static long activityTimestampMinValue()

activityTimestampMaxValue

public static long activityTimestampMaxValue()

activityTimestamp
```
public long activityTimestamp()
```

startTimestampId
```
public static int startTimestampId()
```

startTimestampSinceVersion

public static int startTimestampSinceVersion()

startTimestampEncodingOffset

public static int startTimestampEncodingOffset()

startTimestampEncodingLength

public static int startTimestampEncodingLength()

startTimestampMetaAttribute

public static String startTimestampMetaAttribute(MetaAttribute metaAttribute)

startTimestampNullValue

public static long startTimestampNullValue()

startTimestampMinValue

public static long startTimestampMinValue()

startTimestampMaxValue

public static long startTimestampMaxValue()

startTimestamp
```
public long startTimestamp()
```

pidId
```
public static int pidId()
```

pidSinceVersion
```
public static int pidSinceVersion()
```

pidEncodingOffset
```
public static int pidEncodingOffset()
```

pidEncodingLength
```
public static int pidEncodingLength()
```

pidMetaAttribute

public static String pidMetaAttribute(MetaAttribute metaAttribute)

pidNullValue
```
public static long pidNullValue()
```

pidMinValue
```
public static long pidMinValue()
```

pidMaxValue
```
public static long pidMaxValue()
```

pid
```
public long pid()
```

controlStreamIdId
```
public static int controlStreamIdId()
```

controlStreamIdSinceVersion

public static int controlStreamIdSinceVersion()

controlStreamIdEncodingOffset

public static int controlStreamIdEncodingOffset()

controlStreamIdEncodingLength

public static int controlStreamIdEncodingLength()

controlStreamIdMetaAttribute

public static String controlStreamIdMetaAttribute(MetaAttribute metaAttribute)

controlStreamIdNullValue

public static int controlStreamIdNullValue()

controlStreamIdMinValue

public static int controlStreamIdMinValue()

controlStreamIdMaxValue

public static int controlStreamIdMaxValue()

controlStreamId
```
public int controlStreamId()
```

localControlStreamIdId

public static int localControlStreamIdId()

localControlStreamIdSinceVersion

public static int localControlStreamIdSinceVersion()

localControlStreamIdEncodingOffset

public static int localControlStreamIdEncodingOffset()

localControlStreamIdEncodingLength

public static int localControlStreamIdEncodingLength()

localControlStreamIdMetaAttribute

public static String localControlStreamIdMetaAttribute(MetaAttribute metaAttribute)

localControlStreamIdNullValue

public static int localControlStreamIdNullValue()

localControlStreamIdMinValue

public static int localControlStreamIdMinValue()

localControlStreamIdMaxValue

public static int localControlStreamIdMaxValue()

localControlStreamId
```
public int localControlStreamId()
```

eventsStreamIdId
```
public static int eventsStreamIdId()
```

eventsStreamIdSinceVersion

public static int eventsStreamIdSinceVersion()

eventsStreamIdEncodingOffset

public static int eventsStreamIdEncodingOffset()

eventsStreamIdEncodingLength

public static int eventsStreamIdEncodingLength()

eventsStreamIdMetaAttribute

public static String eventsStreamIdMetaAttribute(MetaAttribute metaAttribute)

eventsStreamIdNullValue

public static int eventsStreamIdNullValue()

eventsStreamIdMinValue

public static int eventsStreamIdMinValue()

eventsStreamIdMaxValue

public static int eventsStreamIdMaxValue()

eventsStreamId
```
public int eventsStreamId()
```

headerLengthId
```
public static int headerLengthId()
```

headerLengthSinceVersion

public static int headerLengthSinceVersion()

headerLengthEncodingOffset

public static int headerLengthEncodingOffset()

headerLengthEncodingLength

public static int headerLengthEncodingLength()

headerLengthMetaAttribute

public static String headerLengthMetaAttribute(MetaAttribute metaAttribute)

headerLengthNullValue

public static int headerLengthNullValue()

headerLengthMinValue

public static int headerLengthMinValue()

headerLengthMaxValue

public static int headerLengthMaxValue()

headerLength
```
public int headerLength()
```

errorBufferLengthId

public static int errorBufferLengthId()

errorBufferLengthSinceVersion

public static int errorBufferLengthSinceVersion()

errorBufferLengthEncodingOffset

public static int errorBufferLengthEncodingOffset()

errorBufferLengthEncodingLength

public static int errorBufferLengthEncodingLength()

errorBufferLengthMetaAttribute

public static String errorBufferLengthMetaAttribute(MetaAttribute metaAttribute)

errorBufferLengthNullValue

public static int errorBufferLengthNullValue()

errorBufferLengthMinValue

public static int errorBufferLengthMinValue()

errorBufferLengthMaxValue

public static int errorBufferLengthMaxValue()

errorBufferLength
```
public int errorBufferLength()
```

controlChannelId
```
public static int controlChannelId()
```

controlChannelSinceVersion

public static int controlChannelSinceVersion()

controlChannelCharacterEncoding

public static String controlChannelCharacterEncoding()

controlChannelMetaAttribute

public static String controlChannelMetaAttribute(MetaAttribute metaAttribute)

controlChannelHeaderLength

public static int controlChannelHeaderLength()

controlChannelLength
```
public int controlChannelLength()
```

skipControlChannel
```
public int skipControlChannel()
```

getControlChannel

public int getControlChannel(MutableDirectBuffer dst,
                             int dstOffset,
                             int length)

getControlChannel

public int getControlChannel(byte[] dst,
                             int dstOffset,
                             int length)

wrapControlChannel

public void wrapControlChannel(DirectBuffer wrapBuffer)

controlChannel
```
public String controlChannel()
```

getControlChannel

public int getControlChannel(Appendable appendable)

localControlChannelId

public static int localControlChannelId()

localControlChannelSinceVersion

public static int localControlChannelSinceVersion()

localControlChannelCharacterEncoding

public static String localControlChannelCharacterEncoding()

localControlChannelMetaAttribute

public static String localControlChannelMetaAttribute(MetaAttribute metaAttribute)

localControlChannelHeaderLength

public static int localControlChannelHeaderLength()

localControlChannelLength

public int localControlChannelLength()

skipLocalControlChannel
```
public int skipLocalControlChannel()
```

getLocalControlChannel

public int getLocalControlChannel(MutableDirectBuffer dst,
                                  int dstOffset,
                                  int length)

getLocalControlChannel

public int getLocalControlChannel(byte[] dst,
                                  int dstOffset,
                                  int length)

wrapLocalControlChannel

public void wrapLocalControlChannel(DirectBuffer wrapBuffer)

localControlChannel
```
public String localControlChannel()
```

getLocalControlChannel

public int getLocalControlChannel(Appendable appendable)

eventsChannelId
```
public static int eventsChannelId()
```

eventsChannelSinceVersion

public static int eventsChannelSinceVersion()

eventsChannelCharacterEncoding

public static String eventsChannelCharacterEncoding()

eventsChannelMetaAttribute

public static String eventsChannelMetaAttribute(MetaAttribute metaAttribute)

eventsChannelHeaderLength

public static int eventsChannelHeaderLength()

eventsChannelLength
```
public int eventsChannelLength()
```

skipEventsChannel
```
public int skipEventsChannel()
```

getEventsChannel

public int getEventsChannel(MutableDirectBuffer dst,
                            int dstOffset,
                            int length)

getEventsChannel

public int getEventsChannel(byte[] dst,
                            int dstOffset,
                            int length)

wrapEventsChannel

public void wrapEventsChannel(DirectBuffer wrapBuffer)

eventsChannel
```
public String eventsChannel()
```

getEventsChannel

public int getEventsChannel(Appendable appendable)

aeronDirectoryId
```
public static int aeronDirectoryId()
```

aeronDirectorySinceVersion

public static int aeronDirectorySinceVersion()

aeronDirectoryCharacterEncoding

public static String aeronDirectoryCharacterEncoding()

aeronDirectoryMetaAttribute

public static String aeronDirectoryMetaAttribute(MetaAttribute metaAttribute)

aeronDirectoryHeaderLength

public static int aeronDirectoryHeaderLength()

aeronDirectoryLength
```
public int aeronDirectoryLength()
```

skipAeronDirectory
```
public int skipAeronDirectory()
```

getAeronDirectory

public int getAeronDirectory(MutableDirectBuffer dst,
                             int dstOffset,
                             int length)

getAeronDirectory

public int getAeronDirectory(byte[] dst,
                             int dstOffset,
                             int length)

wrapAeronDirectory

public void wrapAeronDirectory(DirectBuffer wrapBuffer)

aeronDirectory
```
public String aeronDirectory()
```

getAeronDirectory

public int getAeronDirectory(Appendable appendable)

toString
```
public String toString()
```
Overrides:

toString in class Object

appendTo

public StringBuilder appendTo(StringBuilder builder)

Class MarkFileHeaderDecoder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BLOCK_LENGTH

TEMPLATE_ID

SCHEMA_ID

SCHEMA_VERSION

BYTE_ORDER

Constructor Detail

MarkFileHeaderDecoder

Method Detail

sbeBlockLength

sbeTemplateId

sbeSchemaId

sbeSchemaVersion

sbeSemanticType

buffer

initialOffset

offset

wrap

encodedLength

limit

limit

versionId

versionSinceVersion

versionEncodingOffset

versionEncodingLength

versionMetaAttribute

versionNullValue

versionMinValue

versionMaxValue

version

activityTimestampId

activityTimestampSinceVersion

activityTimestampEncodingOffset

activityTimestampEncodingLength

activityTimestampMetaAttribute

activityTimestampNullValue

activityTimestampMinValue

activityTimestampMaxValue

activityTimestamp

startTimestampId

startTimestampSinceVersion

startTimestampEncodingOffset

startTimestampEncodingLength

startTimestampMetaAttribute

startTimestampNullValue

startTimestampMinValue

startTimestampMaxValue

startTimestamp

pidId

pidSinceVersion

pidEncodingOffset

pidEncodingLength

pidMetaAttribute

pidNullValue

pidMinValue

pidMaxValue

pid

controlStreamIdId

controlStreamIdSinceVersion

controlStreamIdEncodingOffset

controlStreamIdEncodingLength

controlStreamIdMetaAttribute

controlStreamIdNullValue

controlStreamIdMinValue

controlStreamIdMaxValue

controlStreamId

localControlStreamIdId

localControlStreamIdSinceVersion

localControlStreamIdEncodingOffset

localControlStreamIdEncodingLength

localControlStreamIdMetaAttribute

localControlStreamIdNullValue

localControlStreamIdMinValue

localControlStreamIdMaxValue

localControlStreamId