IncomingMessageValueType Property
This message's value data type.
Syntax
amqp.getIncomingMessageValueType(index, [callback])
Possible Values
0 (mvtNull), 1 (mvtBoolean), 2 (mvtUbyte), 3 (mvtUshort), 4 (mvtUint), 5 (mvtUlong), 6 (mvtByte), 7 (mvtShort), 8 (mvtInt), 9 (mvtLong), 10 (mvtFloat), 11 (mvtDouble), 12 (mvtDecimal), 13 (mvtChar), 14 (mvtTimestamp), 15 (mvtUuid), 16 (mvtBinary), 17 (mvtString), 18 (mvtSymbol), 19 (mvtJson)
Default Value
0
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for the getIncomingMessageValueType([callback]) method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
The callback for the setIncomingMessageValueType([callback]) method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
This message's value data type.
This property specifies the data type of this message's IncomingMessageValue.
The table below shows the possible value types, their descriptions, and how to format the data assigned to IncomingMessageValue. All numeric value types should use their standard string formatting (except for the mvtDecimal (12) type, which should be specified as hex-encoded bytes).
Type | Description | Value Format |
mvtNull (0 - default) | Null | N/A (IncomingMessageValue is ignored) |
mvtBoolean (1) | Boolean | "True" or "False" |
mvtUbyte (2) | Unsigned byte | 0 to 255 |
mvtUshort (3) | Unsigned short | 0 to 65535 |
mvtUint (4) | Unsigned integer | 0 to 4294967295 |
mvtUlong (5) | Unsigned long | 0 to 18446744073709551615 |
mvtByte (6) | Byte | -128 to 127 |
mvtShort (7) | Short | -32768 to 32767 |
mvtInt (8) | Integer | -2147483648 to 2147483647 |
mvtLong (9) | Long | -9223372036854775808 to 9223372036854775807 |
mvtFloat (10) | Float | IEEE 754 32-bit floating point number |
mvtDouble (11) | Double | IEEE 754 64-bit floating point number |
mvtDecimal (12) | Decimal | Hex-encoded byte string |
mvtChar (13) | Char | Single character |
mvtTimestamp (14) | Timestamp | Number of milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC). |
mvtUuid (15) | UUID | Hex-encoded UUID in the form XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX (hyphens optional, case-insensitive) |
mvtBinary (16) | Binary data | Hex-encoded byte string |
mvtString (17) | String | String |
mvtSymbol (18) | Symbolic value | ASCII string |
mvtJson (19) | Composite data | Composite data JSON structured according to the schema shown in the SendMessage method's documentation |
The index parameter specifies the index of the item in the array. The size of the array is controlled by the IncomingMessageCount property.
This property is read-only and not available at design time.
Data Type
Integer