IPWorks MQ 2020 Android Edition

Questions / Feedback?

AMQPCMessage Type

Represents an AMQP 0.9.1 message.

Remarks

This type represents an AMQP 0.9.1 message.

Fields

AppId
String

The Id of the application that created the message.

This field holds the Id of the application that created the message. It may be empty if the message does not have an application Id set.

This value must be specified as a string no longer than 255 characters.

Body
String

The message body.

This field holds the body of the message. It may be empty.

BodyB
byte []

The message body.

This field holds the body of the message. It may be empty.

ChannelName
String

The name of the channel the message is associated with.

This field reflects the name of the channel which the message is associated with; it is populated automatically by the component.

ContentEncoding
String

The content encoding of the message's body.

This field holds the content encoding of the message's body. It may be empty if the message does not have a content encoding set.

This value must be specified as a string no longer than 255 characters.

ContentType
String

The content type (MIME type) of the message's body.

This field holds the content type (MIME type) of the message's body. It may be empty if the message does not have a content type set.

This value must be specified as a string no longer than 255 characters.

CorrelationId
String

The correlation Id of the message.

This field holds the correlation Id of the message. It may be empty if the message does not have a correlation Id set.

This value must be specified as a string no longer than 255 characters.

DeliveryMode
int

The delivery mode of the message.

This field holds the delivery mode of the message; possible values are:

  • 0: Unspecified.
  • 1: Non-persistent; the message may be lost if the server encounters an error.
  • 2: Persistent; the message will not be lost, even in case of server errors.

The default is 0, which indicates that the message does not have an explicit delivery mode set.

Expiration
String

The time-to-live value for this message.

This field specifies the time-to-live (TTL) value, in milliseconds, for this message. It may be -1 if this message does not have a TTL.

Headers
String

Headers associated with the message.

This field holds additional Headers associated with the message. It may be empty if the message does not have any headers set.

This field 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 TypeDescriptionValue 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.

MessageId
String

The unique Id of the message.

This field holds the unique Id of the message. It may be empty if the message does not have a unique Id.

This value must be specified as a string no longer than 255 characters.

Priority
int

The priority of the message.

This field holds the priority of the message. Valid priority values are 0-9; any other value causes the message to have unspecified priority when sent.

ReplyTo
String

The address to send replies to for the message.

This field specifies the address to send replies to for the message. It may be empty if the message does not have a specific reply-to address set.

This value must be specified as a string no longer than 255 characters.

Timestamp
long

The message's timestamp.

This field holds the timestamp of the message, specified as milliseconds since the Unix epoch (January 1, 1970 00:00:00 UTC). It may be less than or equal to 0 (default) if the message does not have a timestamp set.

Type
String

The message's type.

This field holds the type of the message. It may be empty if the message does not have a type set.

This value must be specified as a string no longer than 255 characters.

UserId
String

The identity of the user responsible for producing the message.

This field specifies the identity of the user responsible for producing the message. It may be empty if no specific user was responsible for creating the message.

A message's user Id may be used for verification or authentication by the server and/or the final consumer.

This value must be specified as a string no longer than 255 characters.

Constructors

public AMQPCMessage();



Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks MQ 2020 Android Edition - Version 20.0 [Build 8155]