Package uk.co.real_logic.sbe.ir

Class HeaderStructure

java.lang.Object
uk.co.real_logic.sbe.ir.HeaderStructure
public class HeaderStructure extends Object
Metadata description for a message header structure expected before messages to understand the type requiring decoding.

  • Field Details

    • BLOCK_LENGTH

      public static final String BLOCK_LENGTH
      The field containing the length of the root block in bytes.
      See Also:

    • TEMPLATE_ID

      public static final String TEMPLATE_ID
      The field containing the template id of the following message.
      See Also:

    • SCHEMA_ID

      public static final String SCHEMA_ID
      The field containing the schema id to which the following message belongs.
      See Also:

    • SCHEMA_VERSION

      public static final String SCHEMA_VERSION
      The field containing the version of the following message.
      See Also:

  • Constructor Details

    • HeaderStructure

      public HeaderStructure(List<Token> tokens)
      Construct the header structure from a list of tokens containing the minimum expected set of fields.
      Parameters:
      tokens - for the header structure.

  • Method Details

    • tokens

      public List<Token> tokens()
      The IR tokens for the header.
      Returns:
      the IR tokens for the header.

    • blockLengthType

      public PrimitiveType blockLengthType()
      The declared data type for the block length field.
      Returns:
      the declared data type for the block length field.

    • templateIdType

      public PrimitiveType templateIdType()
      The declared data type for the template id field.
      Returns:
      the declared data type for the template id field.

    • schemaIdType

      public PrimitiveType schemaIdType()
      The declared data type for the SBE schema id field.
      Returns:
      the declared data type for the SBE schema id field.

    • schemaVersionType

      public PrimitiveType schemaVersionType()
      The declared data type for the SBE schema version field.
      Returns:
      the declared data type for the SBE schema version field.