Interface Flyweight

All Known Subinterfaces:
CompositeDecoderFlyweight, CompositeEncoderFlyweight, DecoderFlyweight, EncoderFlyweight, MessageDecoderFlyweight, MessageEncoderFlyweight, MessageFlyweight

public interface Flyweight
An SBE (Simple Binary Encoding) flyweight object.
  • Method Summary

    Modifier and Type
    Method
    Description
    Buffer in which the flyweight is encoded.
    int
    The length of the encoded type in bytes.
    int
    Offset within the buffer() the flyweight is encoded.
    int
    The SBE Schema identifier containing the message declaration.
    int
    The version number of the SBE Schema containing the message.
  • Method Details

    • buffer

      DirectBuffer buffer()
      Buffer in which the flyweight is encoded.
      Returns:
      buffer in which the flyweight is encoded.
    • offset

      int offset()
      Offset within the buffer() the flyweight is encoded.
      Returns:
      offset within the buffer() the flyweight is encoded.
    • encodedLength

      int encodedLength()
      The length of the encoded type in bytes.

      The value is only guaranteed to valid for a DecoderFlyweight before decoding and after encoding for a EncoderFlyweight.

      Returns:
      the length of the encoded type in bytes.
    • sbeSchemaId

      int sbeSchemaId()
      The SBE Schema identifier containing the message declaration.
      Returns:
      the SBE Schema identifier containing the message declaration.
    • sbeSchemaVersion

      int sbeSchemaVersion()
      The version number of the SBE Schema containing the message.
      Returns:
      the version number of the SBE Schema containing the message.