FrameCodec (Simple Binary Encoding)

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

```
public class FrameCodec
extends Object
```

Field Summary

Fields
Modifier and Type Field and Description

static int BLOCK_LENGTH

static int SCHEMA_ID

static int SCHEMA_VERSION

static int TEMPLATE_ID

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

Constructor Summary

Constructors
Constructor and Description

FrameCodec()

Constructors
Constructor and Description
`FrameCodec()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getNamespaceName(byte[] dst, int dstOffset, int length)`
`int`	`getPackageName(byte[] dst, int dstOffset, int length)`
`int`	`getSemanticVersion(byte[] dst, int dstOffset, int length)`
`int`	`irId()`
`FrameCodec`	`irId(int value)`
`static int`	`irIdId()`
`static int`	`irIdMaxValue()`
`static String`	`irIdMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`irIdMinValue()`
`static int`	`irIdNullValue()`
`int`	`irVersion()`
`FrameCodec`	`irVersion(int value)`
`static int`	`irVersionId()`
`static int`	`irVersionMaxValue()`
`static String`	`irVersionMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`irVersionMinValue()`
`static int`	`irVersionNullValue()`
`int`	`limit()`
`void`	`limit(int limit)`
`static String`	`namespaceNameCharacterEncoding()`
`static int`	`namespaceNameHeaderSize()`
`static int`	`namespaceNameId()`
`static String`	`namespaceNameMetaAttribute(MetaAttribute metaAttribute)`
`int`	`offset()`
`static String`	`packageNameCharacterEncoding()`
`static int`	`packageNameHeaderSize()`
`static int`	`packageNameId()`
`static String`	`packageNameMetaAttribute(MetaAttribute metaAttribute)`
`int`	`putNamespaceName(byte[] src, int srcOffset, int length)`
`int`	`putPackageName(byte[] src, int srcOffset, int length)`
`int`	`putSemanticVersion(byte[] src, int srcOffset, int length)`
`int`	`sbeBlockLength()`
`int`	`sbeSchemaId()`
`int`	`sbeSchemaVersion()`
`String`	`sbeSemanticType()`
`int`	`sbeTemplateId()`
`int`	`schemaVersion()`
`FrameCodec`	`schemaVersion(int value)`
`static int`	`schemaVersionId()`
`static int`	`schemaVersionMaxValue()`
`static String`	`schemaVersionMetaAttribute(MetaAttribute metaAttribute)`
`static int`	`schemaVersionMinValue()`
`static int`	`schemaVersionNullValue()`
`static String`	`semanticVersionCharacterEncoding()`
`static int`	`semanticVersionHeaderSize()`
`static int`	`semanticVersionId()`
`static String`	`semanticVersionMetaAttribute(MetaAttribute metaAttribute)`
`int`	`size()`
`FrameCodec`	`wrapForDecode(DirectBuffer buffer, int offset, int actingBlockLength, int actingVersion)`
`FrameCodec`	`wrapForEncode(DirectBuffer buffer, int offset)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

Constructor Detail
- FrameCodec
```
public FrameCodec()
```

Method Detail

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

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

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

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

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

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

wrapForEncode

public FrameCodec wrapForEncode(DirectBuffer buffer,
                                int offset)

wrapForDecode

public FrameCodec wrapForDecode(DirectBuffer buffer,
                                int offset,
                                int actingBlockLength,
                                int actingVersion)

size
```
public int size()
```

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

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

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

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

irId
```
public FrameCodec irId(int value)
```

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

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

irVersion

public FrameCodec irVersion(int value)

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

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

schemaVersion

public FrameCodec schemaVersion(int value)

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

packageNameCharacterEncoding

public static String packageNameCharacterEncoding()

packageNameMetaAttribute

public static String packageNameMetaAttribute(MetaAttribute metaAttribute)

packageNameHeaderSize

public static int packageNameHeaderSize()

getPackageName

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

putPackageName

public int putPackageName(byte[] src,
                          int srcOffset,
                          int length)

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

namespaceNameCharacterEncoding

public static String namespaceNameCharacterEncoding()

namespaceNameMetaAttribute

public static String namespaceNameMetaAttribute(MetaAttribute metaAttribute)

namespaceNameHeaderSize

public static int namespaceNameHeaderSize()

getNamespaceName

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

putNamespaceName

public int putNamespaceName(byte[] src,
                            int srcOffset,
                            int length)

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

semanticVersionCharacterEncoding

public static String semanticVersionCharacterEncoding()

semanticVersionMetaAttribute

public static String semanticVersionMetaAttribute(MetaAttribute metaAttribute)

semanticVersionHeaderSize

public static int semanticVersionHeaderSize()

getSemanticVersion

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

putSemanticVersion

public int putSemanticVersion(byte[] src,
                              int srcOffset,
                              int length)

Class FrameCodec

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BLOCK_LENGTH

TEMPLATE_ID

SCHEMA_ID

SCHEMA_VERSION

Constructor Detail

FrameCodec

Method Detail

sbeBlockLength

sbeTemplateId

sbeSchemaId

sbeSchemaVersion

sbeSemanticType

offset

wrapForEncode

wrapForDecode

size

limit

limit

irIdId

irIdMetaAttribute

irIdNullValue

irIdMinValue

irIdMaxValue

irId

irId

irVersionId

irVersionMetaAttribute

irVersionNullValue

irVersionMinValue

irVersionMaxValue

irVersion

irVersion

schemaVersionId

schemaVersionMetaAttribute

schemaVersionNullValue

schemaVersionMinValue

schemaVersionMaxValue

schemaVersion

schemaVersion

packageNameId

packageNameCharacterEncoding

packageNameMetaAttribute

packageNameHeaderSize

getPackageName

putPackageName

namespaceNameId

namespaceNameCharacterEncoding

namespaceNameMetaAttribute

namespaceNameHeaderSize

getNamespaceName

putNamespaceName

semanticVersionId

semanticVersionCharacterEncoding

semanticVersionMetaAttribute

semanticVersionHeaderSize

getSemanticVersion

putSemanticVersion