FrameCodecDecoder (Simple Binary Encoding (SBE))

java.lang.Object
- uk.co.real_logic.sbe.ir.generated.FrameCodecDecoder

public final class FrameCodecDecoder
extends Object

Frame Header for start of encoding IR.

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 String`	`SEMANTIC_VERSION`
`static int`	`TEMPLATE_ID`

Constructor Summary

Constructors
Constructor and Description

FrameCodecDecoder()

Constructors
Constructor and Description
`FrameCodecDecoder()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`actingVersion()`
`StringBuilder`	`appendTo(StringBuilder builder)`
`DirectBuffer`	`buffer()`
`int`	`encodedLength()`
`int`	`getNamespaceName(byte[] dst, int dstOffset, int length)`
`int`	`getNamespaceName(MutableDirectBuffer dst, int dstOffset, int length)`
`int`	`getPackageName(byte[] dst, int dstOffset, int length)`
`int`	`getPackageName(MutableDirectBuffer dst, int dstOffset, int length)`
`int`	`getSemanticVersion(byte[] dst, int dstOffset, int length)`
`int`	`getSemanticVersion(MutableDirectBuffer dst, int dstOffset, int length)`
`int`	`irId()`
`static int`	`irIdEncodingLength()`
`static int`	`irIdEncodingOffset()`
`static int`	`irIdId()`
`static int`	`irIdMaxValue()`
`static String`	`irIdMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`irIdMinValue()`
`static int`	`irIdNullValue()`
`static int`	`irIdSinceVersion()`
`int`	`irVersion()`
`static int`	`irVersionEncodingLength()`
`static int`	`irVersionEncodingOffset()`
`static int`	`irVersionId()`
`static int`	`irVersionMaxValue()`
`static String`	`irVersionMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`irVersionMinValue()`
`static int`	`irVersionNullValue()`
`static int`	`irVersionSinceVersion()`
`int`	`limit()`
`void`	`limit(int limit)`
`String`	`namespaceName()`
`static String`	`namespaceNameCharacterEncoding()`
`static int`	`namespaceNameHeaderLength()`
`static int`	`namespaceNameId()`
`int`	`namespaceNameLength()`
`static String`	`namespaceNameMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`namespaceNameSinceVersion()`
`int`	`offset()`
`String`	`packageName()`
`static String`	`packageNameCharacterEncoding()`
`static int`	`packageNameHeaderLength()`
`static int`	`packageNameId()`
`int`	`packageNameLength()`
`static String`	`packageNameMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`packageNameSinceVersion()`
`int`	`sbeBlockLength()`
`int`	`sbeDecodedLength()`
`FrameCodecDecoder`	`sbeRewind()`
`int`	`sbeSchemaId()`
`int`	`sbeSchemaVersion()`
`String`	`sbeSemanticType()`
`FrameCodecDecoder`	`sbeSkip()`
`int`	`sbeTemplateId()`
`int`	`schemaVersion()`
`static int`	`schemaVersionEncodingLength()`
`static int`	`schemaVersionEncodingOffset()`
`static int`	`schemaVersionId()`
`static int`	`schemaVersionMaxValue()`
`static String`	`schemaVersionMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`schemaVersionMinValue()`
`static int`	`schemaVersionNullValue()`
`static int`	`schemaVersionSinceVersion()`
`String`	`semanticVersion()`
`static String`	`semanticVersionCharacterEncoding()`
`static int`	`semanticVersionHeaderLength()`
`static int`	`semanticVersionId()`
`int`	`semanticVersionLength()`
`static String`	`semanticVersionMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`semanticVersionSinceVersion()`
`int`	`skipNamespaceName()`
`int`	`skipPackageName()`
`int`	`skipSemanticVersion()`
`String`	`toString()`
`FrameCodecDecoder`	`wrap(DirectBuffer buffer, int offset, int actingBlockLength, int actingVersion)`
`FrameCodecDecoder`	`wrapAndApplyHeader(DirectBuffer buffer, int offset, MessageHeaderDecoder headerDecoder)`
`void`	`wrapNamespaceName(DirectBuffer wrapBuffer)`
`void`	`wrapPackageName(DirectBuffer wrapBuffer)`
`void`	`wrapSemanticVersion(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

SEMANTIC_VERSION

public static final String SEMANTIC_VERSION

See Also:: Constant Field Values

BYTE_ORDER

public static final ByteOrder BYTE_ORDER

Constructor Detail
- FrameCodecDecoder
```
public FrameCodecDecoder()
```

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()
```

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

wrap

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

wrapAndApplyHeader

public FrameCodecDecoder wrapAndApplyHeader(DirectBuffer buffer,
                                            int offset,
                                            MessageHeaderDecoder headerDecoder)

sbeRewind
```
public FrameCodecDecoder sbeRewind()
```

sbeDecodedLength
```
public int sbeDecodedLength()
```

actingVersion
```
public int actingVersion()
```

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

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

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

irIdId
```
public static int irIdId()
```

irIdSinceVersion
```
public static int irIdSinceVersion()
```

irIdEncodingOffset

public static int irIdEncodingOffset()

irIdEncodingLength

public static int irIdEncodingLength()

irIdMetaAttribute

public static String irIdMetaAttribute(MetaAttribute metaAttribute)

irIdNullValue
```
public static int irIdNullValue()
```

irIdMinValue
```
public static int irIdMinValue()
```

irIdMaxValue
```
public static int irIdMaxValue()
```

irId
```
public int irId()
```

irVersionId
```
public static int irVersionId()
```

irVersionSinceVersion

public static int irVersionSinceVersion()

irVersionEncodingOffset

public static int irVersionEncodingOffset()

irVersionEncodingLength

public static int irVersionEncodingLength()

irVersionMetaAttribute

public static String irVersionMetaAttribute(MetaAttribute metaAttribute)

irVersionNullValue

public static int irVersionNullValue()

irVersionMinValue
```
public static int irVersionMinValue()
```

irVersionMaxValue
```
public static int irVersionMaxValue()
```

irVersion
```
public int irVersion()
```

schemaVersionId
```
public static int schemaVersionId()
```

schemaVersionSinceVersion

public static int schemaVersionSinceVersion()

schemaVersionEncodingOffset

public static int schemaVersionEncodingOffset()

schemaVersionEncodingLength

public static int schemaVersionEncodingLength()

schemaVersionMetaAttribute

public static String schemaVersionMetaAttribute(MetaAttribute metaAttribute)

schemaVersionNullValue

public static int schemaVersionNullValue()

schemaVersionMinValue

public static int schemaVersionMinValue()

schemaVersionMaxValue

public static int schemaVersionMaxValue()

schemaVersion
```
public int schemaVersion()
```

packageNameId
```
public static int packageNameId()
```

packageNameSinceVersion

public static int packageNameSinceVersion()

packageNameCharacterEncoding

public static String packageNameCharacterEncoding()

packageNameMetaAttribute

public static String packageNameMetaAttribute(MetaAttribute metaAttribute)

packageNameHeaderLength

public static int packageNameHeaderLength()

packageNameLength
```
public int packageNameLength()
```

skipPackageName
```
public int skipPackageName()
```

getPackageName

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

getPackageName

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

wrapPackageName

public void wrapPackageName(DirectBuffer wrapBuffer)

packageName
```
public String packageName()
```

namespaceNameId
```
public static int namespaceNameId()
```

namespaceNameSinceVersion

public static int namespaceNameSinceVersion()

namespaceNameCharacterEncoding

public static String namespaceNameCharacterEncoding()

namespaceNameMetaAttribute

public static String namespaceNameMetaAttribute(MetaAttribute metaAttribute)

namespaceNameHeaderLength

public static int namespaceNameHeaderLength()

namespaceNameLength
```
public int namespaceNameLength()
```

skipNamespaceName
```
public int skipNamespaceName()
```

getNamespaceName

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

getNamespaceName

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

wrapNamespaceName

public void wrapNamespaceName(DirectBuffer wrapBuffer)

namespaceName
```
public String namespaceName()
```

semanticVersionId
```
public static int semanticVersionId()
```

semanticVersionSinceVersion

public static int semanticVersionSinceVersion()

semanticVersionCharacterEncoding

public static String semanticVersionCharacterEncoding()

semanticVersionMetaAttribute

public static String semanticVersionMetaAttribute(MetaAttribute metaAttribute)

semanticVersionHeaderLength

public static int semanticVersionHeaderLength()

semanticVersionLength
```
public int semanticVersionLength()
```

skipSemanticVersion
```
public int skipSemanticVersion()
```

getSemanticVersion

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

getSemanticVersion

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

wrapSemanticVersion

public void wrapSemanticVersion(DirectBuffer wrapBuffer)

semanticVersion
```
public String semanticVersion()
```

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

toString in class Object

appendTo

public StringBuilder appendTo(StringBuilder builder)

sbeSkip
```
public FrameCodecDecoder sbeSkip()
```

Class FrameCodecDecoder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BLOCK_LENGTH

TEMPLATE_ID

SCHEMA_ID

SCHEMA_VERSION

SEMANTIC_VERSION

BYTE_ORDER

Constructor Detail

FrameCodecDecoder

Method Detail

sbeBlockLength

sbeTemplateId

sbeSchemaId

sbeSchemaVersion

sbeSemanticType

buffer

offset

wrap

wrapAndApplyHeader

sbeRewind

sbeDecodedLength

actingVersion

encodedLength

limit

limit

irIdId

irIdSinceVersion

irIdEncodingOffset

irIdEncodingLength

irIdMetaAttribute

irIdNullValue

irIdMinValue

irIdMaxValue

irId

irVersionId

irVersionSinceVersion

irVersionEncodingOffset

irVersionEncodingLength

irVersionMetaAttribute

irVersionNullValue

irVersionMinValue

irVersionMaxValue

irVersion

schemaVersionId

schemaVersionSinceVersion

schemaVersionEncodingOffset

schemaVersionEncodingLength

schemaVersionMetaAttribute

schemaVersionNullValue

schemaVersionMinValue

schemaVersionMaxValue

schemaVersion

packageNameId

packageNameSinceVersion

packageNameCharacterEncoding

packageNameMetaAttribute

packageNameHeaderLength

packageNameLength

skipPackageName

getPackageName

getPackageName

wrapPackageName

packageName

namespaceNameId

namespaceNameSinceVersion

namespaceNameCharacterEncoding

namespaceNameMetaAttribute

namespaceNameHeaderLength

namespaceNameLength

skipNamespaceName

getNamespaceName

getNamespaceName

wrapNamespaceName

namespaceName

semanticVersionId