Headers Property
Headers associated with the message.
Data Type
StringDefault Value
""Remarks
This property holds additional Headers associated with the message. It may be empty if the message does not have any headers set.
This property must be specified as a JSON object containing name-type-value tuples; for example:
{ { "name": "Header1", "type": "long", "value": 12345678901234 }, { "name": "Header2", "type": "boolean", "value": "false" }, { "name": "Header3", "type": "string", "value": "This is a test." } }
All "name" values must be ASCII strings that:
- Start with an ASCII letter, $, or $ character.
- Only contain ASCII letters, digits, underscores, $, and $ characters.
- Are unique among their siblings.
- Are no longer than 128 characters.
The following table describes all valid "type" values, and how to format the "value" field for each:
JSON Value Type | Description | Value Format |
boolean | Boolean | "True" or "False" |
byte | Byte | -128 to 127 |
ubyte | Unsigned byte | 0 to 255 |
short | Short | -32768 to 32767 |
ushort | Unsigned short | 0 to 65535 |
int | Integer | -2147483648 to 2147483647 |
uint | Unsigned integer | 0 to 4294967295 |
long | Long | -9223372036854775808 to 9223372036854775807 |
ulong | Unsigned long | 0 to 18446744073709551615 |
float | Float | IEEE 754 32-bit floating point number |
double | Double | IEEE 754 64-bit floating point number |
decimal | Decimal | Hex-encoded byte string |
sstring | Short string | UTF-8 string data, limited to 255 bytes; may not contain null bytes (\0) |
string | String | String data |
array | Array | JSON array of type-value pairs |
timestamp | Timestamp | Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC) |
table | Table | JSON object containing name-type-value tuples |
null | Null | N/A (Value is ignored) |
Note: The ulong and sstring value types are not supported when the RabbitMQCompatible configuration setting is enabled.
Headers of the table type should be specified in the same manner as shown above, while headers of the array type should be specified as a JSON array of type-value pairs; for example:
[ { "type": "int", "value": 23 }, { "type": "int", "value": -52 }, { "type": "int", "value": 153325 } ]
Nesting and mixing multiple levels of arrays and tables is allowed.