How to onboard a new venue

Use this workflow for production onboarding.

1. Get the venue XML SBE template and protocol documentation.
2. Parse schema and inspect model:
   • MessageSchema
   • UnifiedMetaData
   • Object model guide
3. Identify framing header format (often documented outside XML template):
   • FramingHeaderPolicy
   • FramingHeaderSpecification
   • Framing and message headers guide
4. Identify message header layout and check for custom header fields:
   • Message header section
   • Virtual field access section
5. Check repeating-group headers for custom extensions.
6. Find custom composites and choose handling mode:
   • stateful object;
   • stateless interface;
   • virtual fields.
   • Composite data guide
7. Build MessageSchema and ByteDecoder:
   • ByteDecoderFactory
   • ByteDecoder
8. Configure runtime safety switches:
   • DecoderSettings
   • Configuring guide
9. Validate decode/encode flow with real payload samples:
   • Message encoding and decoding guide

API map for integration

Use this quick mapping when implementing code:

• Schema and metadata:
  • MessageSchema
  • UnifiedMetaData
• Runtime decoder:
  • ByteDecoderFactory
  • ByteDecoder
• Message access:
  • IMessage
  • IFieldSet
  • IGroup
• Composite handling:
  • createEmptyCustomComposite
  • createEmptyComposite
  • isNullComposite

Related documentation pages:

• Message flow
• Composite handling
• Headers and framing
• Configuration
• Object model

Value narrowing

Narrowing is conversion between integer types with different ranges. It appears when API method type does not match schema field type.

Examples:

• int32 -> int16: valid range is [-32768..32767].
• int16 -> uint32: valid range is [0..32767].
• uint16 -> int16: valid range is [0..32767].
• uint8 -> int16: always valid.

Narrowing can happen in two places:

• Write narrowing: setter value type is wider than field type. Example: field is int8, code uses setInt(...).
• Read narrowing: getter type is narrower than field type. Example: field is int32, code uses getShort(...).

By default, narrowing is disabled. Without narrowing, use matching getter/setter pairs for field type.

Configure narrowing in DecoderSettings:

Recommendation:

• do not enable narrowing unless you need it;
• if enabled, also enable validation flags.

DecoderSettings.createFullControlSettings() returns preset with all narrowing flags enabled and validated.