Message Headers
This page documents the message headers used for client-server communication.
MessageHeader
Used for requests from the client to the server. The sequence number tracks the number of messages sent on this connection since it was established.
MessageHeader
Message header definition
Fields:
| Field | Type | Label | Description |
|---|---|---|---|
sequence_number | uint64 | optional | Sequence number of the message since midnight UTC |
correlation_id | string | optional | Correlation ID for tracking by client |
part_number | uint32 | optional | Part number for multi-part message |
total_parts | uint32 | optional | Total number of parts in the multi-part message |
sent_timestamp | int64 | optional | Time the message was sent in UTC (linux milliseconds since epoch) |
sender | string | optional | Sender identifier |
ApplianceMessageHeader
Used for responses from the server to the client. The sequence number tracks the number of messages sent since midnight UTC.
ApplianceMessageHeader
Message header definition
Fields:
| Field | Type | Label | Description |
|---|---|---|---|
sequence_number | uint64 | optional | Sequence number of the message since midnight UTC |
correlation_id | string | optional | Correlation ID for tracking by client |
part_number | uint32 | optional | Part number for multi-part message |
total_parts | uint32 | optional | Total number of parts in the multi-part message |
sent_timestamp | int64 | optional | Time the message was sent in UTC (linux milliseconds since epoch) |
sender | string | optional | Sender identifier |