FramingHeaderSpecification (OnixS CME iLink3 Handler Parent 1.2.0 API)

java.lang.Object
- biz.onixs.sbe.def.FramingHeaderSpecification

```
public class FramingHeaderSpecification
extends Object
```
Specification of the Simple Open Framing Header.
The specification defines the Simple Open Framing Header (SOFH) that prepends SBE message header and the message content. It is used for creating the MessageSchema instance.
This class allows to configure different parameters of the both SOFH fields: messageLength and encodingType. Please note that despite the fact the SOFH Standard assumes for the messageLength field big-endian encoding only, here it possible to specify little-endian encoding for all SOFH fields.
Also, the class contains a set of predefined static constants for particular headers.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`FramingHeaderSpecification.EndianessFieldSpecification` Specification for the `encodingType` field.
`static class`	`FramingHeaderSpecification.FieldSpecification` Field specification.

Field Summary

Fields
Modifier and Type	Field and Description
`static FramingHeaderSpecification`	`B3_FRAMING_HEADER` Specification for the Simple Open Framing Header that is compliant to the B3 requirements.
`static byte[]`	`CME_SBE_1_0_LE_BIGENDIAN_SIGN` Signature for big-endian-encoded message in little-endian-encoded header.
`static byte[]`	`CME_SBE_1_0_LE_LITTLEENDIAN_SIGN` Signature for little-endian-encoded message in little-endian-encoded header.
`static FramingHeaderSpecification`	`CMEILINK3_FRAMING_HEADER` Specification for the Simple Open Framing Header that is compliant to the CME iLink3 requirements.
`static FramingHeaderSpecification`	`CMEMDP3_FRAMING_HEADER` Specification for the Simple Open Framing Header that is compliant to the CME MDP3 requirements.
`static byte[]`	`SBE_1_0_BE_BIGENDIAN_SIGN` Signature for big-endian-encoded message in big-endian-encoded header.
`static byte[]`	`SBE_1_0_BE_LITTLEENDIAN_SIGN` Signature for little-endian-encoded message in big-endian-encoded header.
`static byte[]`	`SBE_1_0_LE_BIGENDIAN_SIGN` Signature for big-endian-encoded message in little-endian-encoded header.
`static byte[]`	`SBE_1_0_LE_LITTLEENDIAN_SIGN` Signature for little-endian-encoded message in little-endian-encoded header.
`static FramingHeaderSpecification`	`SBE_BE_FRAMING_HEADER` Specification for the Simple Open Framing Header that is compliant to the SBE v.1.0 standard.

Constructor Summary

Constructors
Constructor and Description
`FramingHeaderSpecification(FramingHeaderSpecification.FieldSpecification messageSize, FramingHeaderSpecification.EndianessFieldSpecification endianess)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FramingHeaderSpecification.EndianessFieldSpecification`	`getEndianessField()` Specification of the `encodingType` field.
`FramingHeaderSpecification.FieldSpecification`	`getMessageSizeField()` Specification of the `messageLength` field.
`int`	`getSize()` Whole size of the framing header.

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

- Field Detail
  - SBE_1_0_BE_BIGENDIAN_SIGN
```
public static final byte[] SBE_1_0_BE_BIGENDIAN_SIGN
```
    Signature for big-endian-encoded message in big-endian-encoded header.
    In byte representation that is the 2-bytes sequence: [0x5B, 0xE0]. The constant compliant to the SBE v.1.0 standard.
  - SBE_1_0_BE_LITTLEENDIAN_SIGN
```
public static final byte[] SBE_1_0_BE_LITTLEENDIAN_SIGN
```
    Signature for little-endian-encoded message in big-endian-encoded header.
    In byte representation that is the 2-bytes sequence: [0xEB, 0x50]. The constant compliant to the SBE v.1.0 standard.
  - SBE_1_0_LE_BIGENDIAN_SIGN
```
public static final byte[] SBE_1_0_LE_BIGENDIAN_SIGN
```
    Signature for big-endian-encoded message in little-endian-encoded header.
    In byte representation that is the 2-bytes sequence: [0xE0, 0x5B]. The constant is derived from the SBE v.1.0 standard.
  - SBE_1_0_LE_LITTLEENDIAN_SIGN
```
public static final byte[] SBE_1_0_LE_LITTLEENDIAN_SIGN
```
    Signature for little-endian-encoded message in little-endian-encoded header.
    In byte representation that is the 2-bytes sequence: [0x50, 0xEB]. The constant is derived from the SBE v.1.0 standard.
  - CME_SBE_1_0_LE_LITTLEENDIAN_SIGN
```
public static final byte[] CME_SBE_1_0_LE_LITTLEENDIAN_SIGN
```
    Signature for little-endian-encoded message in little-endian-encoded header.
    In byte representation that is the 2-bytes sequence: [0xFE, 0xCE]. The constant compliant to the CME iLink3 requirements.
  - CME_SBE_1_0_LE_BIGENDIAN_SIGN
```
public static final byte[] CME_SBE_1_0_LE_BIGENDIAN_SIGN
```
    Signature for big-endian-encoded message in little-endian-encoded header.
    In byte representation that is the 2-bytes sequence: [0xFE, 0xCE]. The constant is derived from the CME iLink3 requirements.
  - SBE_BE_FRAMING_HEADER
```
public static final FramingHeaderSpecification SBE_BE_FRAMING_HEADER
```
    Specification for the Simple Open Framing Header that is compliant to the SBE v.1.0 standard.
    The 6-bytes header consists of:
    - messageLength: uint32, big-endian;
    - encodingType: uint16, big-endian. Use SBE_1_0_BE_LITTLEENDIAN_SIGN or SBE_1_0_BE_BIGENDIAN_SIGN signatures.
  - B3_FRAMING_HEADER
```
public static final FramingHeaderSpecification B3_FRAMING_HEADER
```
    Specification for the Simple Open Framing Header that is compliant to the B3 requirements.
    The 4-bytes header consists of:
    - messageLength: uint16, little-endian;
    - encodingType: uint16, little-endian. Use SBE_1_0_LE_LITTLEENDIAN_SIGN or SBE_1_0_LE_BIGENDIAN_SIGN signatures.
  - CMEILINK3_FRAMING_HEADER
```
public static final FramingHeaderSpecification CMEILINK3_FRAMING_HEADER
```
    Specification for the Simple Open Framing Header that is compliant to the CME iLink3 requirements.
    The 4-bytes header consists of:
    - messageLength: uint16, little-endian;
    - encodingType: uint16, little-endian. Use CME_SBE_1_0_LE_LITTLEENDIAN_SIGN or CME_SBE_1_0_LE_BIGENDIAN_SIGN signatures.
  - CMEMDP3_FRAMING_HEADER
```
public static final FramingHeaderSpecification CMEMDP3_FRAMING_HEADER
```
    Specification for the Simple Open Framing Header that is compliant to the CME MDP3 requirements.
    The 2-bytes header consists of:
    - messageLength: uint16, little-endian;
    - encodingType: not used.
- Constructor Detail
  - FramingHeaderSpecification
```
public FramingHeaderSpecification(FramingHeaderSpecification.FieldSpecification messageSize,
                                  FramingHeaderSpecification.EndianessFieldSpecification endianess)
```
    Constructor.
    
    Parameters:
    
    messageSize - Specification for the messageLength field.
    
    endianess - Specification for the encodingType field. Can be null.
- Method Detail
  - getMessageSizeField
```
public FramingHeaderSpecification.FieldSpecification getMessageSizeField()
```
    Specification of the messageLength field.
    
    Returns:
    
    Specification of the messageLength field.
  - getEndianessField
```
public FramingHeaderSpecification.EndianessFieldSpecification getEndianessField()
```
    Specification of the encodingType field.
    
    Returns:
    
    Specification of the encodingType field.
  - getSize
```
public int getSize()
```
    Whole size of the framing header.
    
    Returns:
    
    Size of the framing header, in bytes.

Class FramingHeaderSpecification

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SBE_1_0_BE_BIGENDIAN_SIGN

SBE_1_0_BE_LITTLEENDIAN_SIGN

SBE_1_0_LE_BIGENDIAN_SIGN

SBE_1_0_LE_LITTLEENDIAN_SIGN

CME_SBE_1_0_LE_LITTLEENDIAN_SIGN

CME_SBE_1_0_LE_BIGENDIAN_SIGN

SBE_BE_FRAMING_HEADER

B3_FRAMING_HEADER

CMEILINK3_FRAMING_HEADER

CMEMDP3_FRAMING_HEADER

Constructor Detail

FramingHeaderSpecification

Method Detail

getMessageSizeField

getEndianessField

getSize