AMQPClassic Class

Properties   Methods   Events   Config Settings   Errors  

An easy-to-use AMQP 0.9.1 client implementation, with support for RabbitMQ extensions.

Syntax

AMQPClassic

Remarks

The AMQPClassic class provides an easy-to-use AMQP 0.9.1 client implementation, and it also supports certain RabbitMQ extensions to the AMQP 0.9.1 specification. The class supports both plaintext and TLS-enabled connections over TCP.

Connecting

The AMQP 0.9.1 transport protocol has two layers: an overall connection between the client and server, and one or more channels running over that connection.

The class implements both layers, so the first step is to initiate the overall connection. Set the AuthScheme, User, Password, SSLEnabled, and VirtualHost properties if necessary, then call the ConnectTo method, passing it the server's hostname and port number. (If the server in question is not running RabbitMQ, disabling the RabbitMQCompatible configuration setting before connecting is also recommended.)

The next step is to create at least one channel, which can be accomplished by using the CreateChannel method. The class allows creating any number of channels, up to the limit specified by the MaxChannelCount configuration setting.

Connecting and Creating a Channel // The examples in this documentation use a RabbitMQ server, which requires SASL Plain auth. amqpc1.AuthScheme = AmqpclassicAuthSchemes.smSASLPlain; amqpc1.User = "guest"; amqpc1.Password = "guest"; amqpc1.SSLEnabled = true; amqpc1.ConnectTo("amqpclassic.test-server.com", 5671); amqpc1.CreateChannel("channel");

Once the class has connected to the server, and one or more channels have been opened, the class can begin manipulating exchanges and queues, publishing messages, and creating consumers.

Note that most AMQP 0.9.1 operations can themselves vary in their complexity. The examples below are intentionally simple for the sake of clarity and brevity, but links are provided for many other parts of the class's API where more detail can be found.

Declaring Exchanges

The DeclareExchange method is used to declare (i.e., create, or verify the existence of) exchanges on the server. While all AMQP servers provide a default, direct-type exchange that all queues are bound to automatically (using their name as the routing key), more complex use-cases will often require creating additional exchanges of varying types.

Declaring an Exchange // Declare a direct-type exchange. amqpc1.DeclareExchange("channel", "MyExchange", "direct", false, false, false, false);

Exchanges can also be deleted using the DeleteExchange method.

Declaring Queues

The DeclareQueue method is used to declare (i.e., create, or verify the existence of) queues on the server. Unlike with exchanges, the server does not provide any queues by default, so declaring a queue is always necessary (unless one has already been created by another client, or configured ahead-of-time on the server itself).

Declaring a Queue // Declare a queue. amqpc1.DeclareQueue("channel", "MyQueue", false, false, false, false, false);

Queues may also be deleted or purged using the DeleteQueue and PurgeQueue methods.

Binding Queues to Exchanges

The BindQueue method is used to bind a queue to an exchange. Exchanges use the information held by their queue bindings to determine which messages to forward to which queues.

Note that all AMQP 0.9.1 servers automatically bind all queues to their default exchange (which is always a direct exchange with no name) using each queue's name as the binding's routing key. This makes it easy to send a message to a specific queue without having to declare bindings; just call PublishMessage, pass empty string for ExchangeName, and the name of the desired queue for RoutingKey.

Binding a Queue to an Exchange // Bind a queue to an exchange. Messages will only be delivered to the queue if their routing key is "MyRoutingKey". amqpc1.BindQueue("channel", "MyQueue", "MyExchange", "MyRoutingKey", false);

Queues can also be unbound from exchanges using the UnbindQueue method.

Publishing Messages

To publish a message, populate the Message* properties, and then call the PublishMessage method.

Publishing a Message amqpc1.Message.Body = "Hello, world!"; // Publish a message to the server's default (no-name) exchange, using the name of a specific queue as the routing key. amqpc1.PublishMessage("channel", "", "MyQueue", false, false); // Publish a message to the "MyExchange" exchange, using the routing key "MyRoutingKey". amqpc1.PublishMessage("channel", "MyExchange", "MyRoutingKey", false, false);

Note that outgoing messages may be handled differently by the server if the channel they are sent over is in transaction or (for RabbitMQ only) "publish confirmations" mode. Refer to the EnableTransactionMode and EnablePublishConfirms methods for more information.

Receiving Messages

There are two possible ways for the class to receive a message:

• Messages can be asynchronously pushed to the class from the server. At any point in time, the server may push a message to the class from a queue that the Consume method has been used to attach a consumer to.
• Messages can be synchronously pulled from the server by the class. The FetchMessage method is used to attempt to pull (or "fetch") messages from a specific queue.

Regardless of how they are received, all incoming messages cause the ReceivedMessage* properties to be populated and the MessageIn event to fire.

Receiving a Message // MessageIn event handler. amqpc1.OnMessageIn += (s, e) => { if (e.MessageCount == -1) { // The server pushed a message to us asynchronously due to a consumer we created. Console.WriteLine("The server pushed this message to us via consumer '" + e.ConsumerTag + "':"); Console.WriteLine(amqpc1.ReceivedMessage.Body); } else if (e.DeliveryTag > 0) { // We pulled a message from a queue with the FetchMessage() method. Console.WriteLine("Message successfully pulled:"); Console.WriteLine(amqpc1.ReceivedMessage.Body); Console.WriteLine(e.MessageCount + " messages are still available to pull."); } else { // We tried to pull a message, but there were none available to pull. Console.WriteLine("No messages available to pull."); } }; // Attach a consumer to "MyQueue". amqpc1.Consume("channel", "MyQueue", "consumerTag", false, true, false, false); // Or, try to fetch a message from "MyQueue". amqpc1.FetchMessage("channel", "MyQueue", true);

Note that the MessageIn event always fires if FetchMessage is called successfully, even if there were no messages available to fetch; refer to MessageIn for more information.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

ArgumentCount Property (AMQPClassic Class)

The number of records in the Argument arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetArgumentCount();
int SetArgumentCount(int iArgumentCount);

Unicode (Windows)
INT GetArgumentCount();
INT SetArgumentCount(INT iArgumentCount);

int ipworksiot_amqpclassic_getargumentcount(void* lpObj);
int ipworksiot_amqpclassic_setargumentcount(void* lpObj, int iArgumentCount);

int GetArgumentCount();
int SetArgumentCount(int iArgumentCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• ArgumentName
• ArgumentValue
• ArgumentValueType

The array indices start at 0 and end at ArgumentCount - 1.

This property is not available at design time.

Data Type

Integer

ArgumentName Property (AMQPClassic Class)

The table property's name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetArgumentName(int iArgumentIndex);
int SetArgumentName(int iArgumentIndex, const char* lpszArgumentName);

Unicode (Windows)
LPWSTR GetArgumentName(INT iArgumentIndex);
INT SetArgumentName(INT iArgumentIndex, LPCWSTR lpszArgumentName);

char* ipworksiot_amqpclassic_getargumentname(void* lpObj, int argumentindex);
int ipworksiot_amqpclassic_setargumentname(void* lpObj, int argumentindex, const char* lpszArgumentName);

QString GetArgumentName(int iArgumentIndex);
int SetArgumentName(int iArgumentIndex, QString qsArgumentName);

Default Value

""

Remarks

The table field's name.

This property specifies the table field's name. The name must be an ASCII string that:

• Starts with an ASCII letter, $, or $ character.
• Only contains ASCII letters, digits, underscores, $, and $ characters.
• Is unique among all sibling table field ArgumentNames.
• Is no longer than 128 characters.

The ArgumentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ArgumentCount property.

This property is not available at design time.

Data Type

String

ArgumentValue Property (AMQPClassic Class)

The table property's value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetArgumentValue(int iArgumentIndex);
int SetArgumentValue(int iArgumentIndex, const char* lpszArgumentValue);

Unicode (Windows)
LPWSTR GetArgumentValue(INT iArgumentIndex);
INT SetArgumentValue(INT iArgumentIndex, LPCWSTR lpszArgumentValue);

char* ipworksiot_amqpclassic_getargumentvalue(void* lpObj, int argumentindex);
int ipworksiot_amqpclassic_setargumentvalue(void* lpObj, int argumentindex, const char* lpszArgumentValue);

QString GetArgumentValue(int iArgumentIndex);
int SetArgumentValue(int iArgumentIndex, QString qsArgumentValue);

Default Value

""

Remarks

The table field's value.

This property specifies the table field's value.

The ArgumentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ArgumentCount property.

This property is not available at design time.

Data Type

String

ArgumentValueType Property (AMQPClassic Class)

The table property's value type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetArgumentValueType(int iArgumentIndex);
int SetArgumentValueType(int iArgumentIndex, int iArgumentValueType);

Unicode (Windows)
INT GetArgumentValueType(INT iArgumentIndex);
INT SetArgumentValueType(INT iArgumentIndex, INT iArgumentValueType);

FVT_BOOLEAN(0), 
FVT_BYTE(1), 
FVT_UBYTE(2), 
FVT_SHORT(3), 
FVT_USHORT(4), 
FVT_INT(5), 
FVT_UINT(6), 
FVT_LONG(7), 
FVT_ULONG(8), 
FVT_FLOAT(9), 
FVT_DOUBLE(10), 
FVT_DECIMAL(11), 
FVT_SSTRING(12), 
FVT_STRING(13), 
FVT_ARRAY(14), 
FVT_TIMESTAMP(15), 
FVT_TABLE(16), 
FVT_NULL(17)

int ipworksiot_amqpclassic_getargumentvaluetype(void* lpObj, int argumentindex);
int ipworksiot_amqpclassic_setargumentvaluetype(void* lpObj, int argumentindex, int iArgumentValueType);

int GetArgumentValueType(int iArgumentIndex);
int SetArgumentValueType(int iArgumentIndex, int iArgumentValueType);

Default Value

17

Remarks

The table field's value type.

This property specifies the table field's value type (and thus, the format of the data in the ArgumentValue property). Acceptable value types are:

Note: The fvtUlong (8) and fvtSstring (12) value types are not supported when the RabbitMQCompatible configuration setting is enabled.

For the fvtArray (14) value type, the ArgumentValue 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 }
]

For the fvtTable (16) value type, the ArgumentValue should be specified as a JSON object containing name-type-value tuples; for example:

{
  { "name": "Test1", "type": "long", "value": 12345678901234 },
  { "name": "Test2", "type": "boolean", "value": "false" },
  { "name": "Test3", "type": "string", "value": "This is a test." }
}

Notes regarding fvtArray (14) and fvtTable (16) type ArgumentValues:

• All "type" fields in the JSON content must be set to one of the value types in the table above.
• For fvtTable (16) type ArgumentValues, all "name" fields must adhere to the rules described by the ArgumentKey documentation.
• Nesting and mixing multiple levels of arrays and tables in the JSON is allowed.

The ArgumentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ArgumentCount property.

This property is not available at design time.

Data Type

Integer

AuthScheme Property (AMQPClassic Class)

The authentication scheme to use when connecting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAuthScheme();
int SetAuthScheme(int iAuthScheme);

Unicode (Windows)
INT GetAuthScheme();
INT SetAuthScheme(INT iAuthScheme);

SM_NONE(0), 
SM_SASLANONYMOUS(1), 
SM_SASLPLAIN(2), 
SM_SASLEXTERNAL(3)

int ipworksiot_amqpclassic_getauthscheme(void* lpObj);
int ipworksiot_amqpclassic_setauthscheme(void* lpObj, int iAuthScheme);

int GetAuthScheme();
int SetAuthScheme(int iAuthScheme);

Default Value

2

Remarks

This property controls what authentication scheme the class should use when connecting to the remote host.

Valid values are:

• smNone (0)
• smSASLAnonymous (1)
• smSASLPlain (2) - Default
• smSASLExternal (3)

This property is not available at design time.

Data Type

Integer

ChannelCount Property (AMQPClassic Class)

The number of records in the Channel arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetChannelCount();

Unicode (Windows)
INT GetChannelCount();

int ipworksiot_amqpclassic_getchannelcount(void* lpObj);

int GetChannelCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• ChannelAccept
• ChannelMode
• ChannelName
• ChannelReadyToSend

The array indices start at 0 and end at ChannelCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ChannelAccept Property (AMQPClassic Class)

Whether the channel is currently accepting new messages from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetChannelAccept(int iChannelIndex);

Unicode (Windows)
BOOL GetChannelAccept(INT iChannelIndex);

int ipworksiot_amqpclassic_getchannelaccept(void* lpObj, int channelindex);

bool GetChannelAccept(int iChannelIndex);

Default Value

TRUE

Remarks

Whether the channel is currently accepting new messages from the server.

This property reflects whether the channel is currently accepting new messages from the server. When the channel is created, this property is True by default.

The SetChannelAccept method can be used to disable and re-enable message acceptance at any time; refer to that method for more information.

The ChannelIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChannelCount property.

This property is read-only and not available at design time.

Data Type

Boolean

ChannelMode Property (AMQPClassic Class)

What mode the channel is operating in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetChannelMode(int iChannelIndex);

Unicode (Windows)
INT GetChannelMode(INT iChannelIndex);

CMT_NORMAL(0), 
CMT_TRANSACTIONAL(1), 
CMT_PUBLISH_CONFIRMS(2)

int ipworksiot_amqpclassic_getchannelmode(void* lpObj, int channelindex);

int GetChannelMode(int iChannelIndex);

Default Value

0

Remarks

What mode the channel is operating in.

This property reflects what mode the channel is operating in. Possible values are:

• cmtNormal (0 - default): Normal mode.
• cmtTransactional (1): Transaction mode.
• cmtPublishConfirms (2): Publish confirmations mode.

All channels are in normal mode when they are created; there's nothing special about a channel in normal mode.

Channels can be put in transaction mode using the EnableTransactionMode method. While a channel is in transaction mode, all messages published and acknowledgements sent over it will be part of a transaction, and the server will wait to process them until the transaction is either committed or rolled back.

Channels can be put in publish confirmations mode using the EnablePublishConfirms method. While a channel is in publish confirmations mode, the server will acknowledge each message published by the class. The class will wait to fire the MessageOut event until it receives this acknowledgement. (Note that this mode is only available when the RabbitMQCompatible configuration setting is enabled.)

Note: Switching a channel to transaction or publish confirmations mode is a permanent action; the channel will then remain in that mode for the remainder of its lifetime.

The ChannelIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChannelCount property.

This property is read-only and not available at design time.

Data Type

Integer

ChannelName Property (AMQPClassic Class)

The name of the channel.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetChannelName(int iChannelIndex);

Unicode (Windows)
LPWSTR GetChannelName(INT iChannelIndex);

char* ipworksiot_amqpclassic_getchannelname(void* lpObj, int channelindex);

QString GetChannelName(int iChannelIndex);

Default Value

""

Remarks

The name of the channel.

This property reflects the name of the channel.

The ChannelIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChannelCount property.

This property is read-only and not available at design time.

Data Type

String

ChannelReadyToSend Property (AMQPClassic Class)

Whether the channel is ready to send a message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetChannelReadyToSend(int iChannelIndex);

Unicode (Windows)
BOOL GetChannelReadyToSend(INT iChannelIndex);

int ipworksiot_amqpclassic_getchannelreadytosend(void* lpObj, int channelindex);

bool GetChannelReadyToSend(int iChannelIndex);

Default Value

TRUE

Remarks

Whether the channel is ready to send a message.

This property reflects whether the channel is currently ready to send a message or not.

The ChannelIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ChannelCount property.

This property is read-only and not available at design time.

Data Type

Boolean

ClientPropertyCount Property (AMQPClassic Class)

The number of records in the ClientProperty arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientPropertyCount();
int SetClientPropertyCount(int iClientPropertyCount);

Unicode (Windows)
INT GetClientPropertyCount();
INT SetClientPropertyCount(INT iClientPropertyCount);

int ipworksiot_amqpclassic_getclientpropertycount(void* lpObj);
int ipworksiot_amqpclassic_setclientpropertycount(void* lpObj, int iClientPropertyCount);

int GetClientPropertyCount();
int SetClientPropertyCount(int iClientPropertyCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• ClientPropertyName
• ClientPropertyValue
• ClientPropertyValueType

The array indices start at 0 and end at ClientPropertyCount - 1.

This property is not available at design time.

Data Type

Integer

ClientPropertyName Property (AMQPClassic Class)

The table property's name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClientPropertyName(int iClientPropertyIndex);
int SetClientPropertyName(int iClientPropertyIndex, const char* lpszClientPropertyName);

Unicode (Windows)
LPWSTR GetClientPropertyName(INT iClientPropertyIndex);
INT SetClientPropertyName(INT iClientPropertyIndex, LPCWSTR lpszClientPropertyName);

char* ipworksiot_amqpclassic_getclientpropertyname(void* lpObj, int clientpropertyindex);
int ipworksiot_amqpclassic_setclientpropertyname(void* lpObj, int clientpropertyindex, const char* lpszClientPropertyName);

QString GetClientPropertyName(int iClientPropertyIndex);
int SetClientPropertyName(int iClientPropertyIndex, QString qsClientPropertyName);

Default Value

""

Remarks

The table field's name.

This property specifies the table field's name. The name must be an ASCII string that:

• Starts with an ASCII letter, $, or $ character.
• Only contains ASCII letters, digits, underscores, $, and $ characters.
• Is unique among all sibling table field ClientPropertyNames.
• Is no longer than 128 characters.

The ClientPropertyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClientPropertyCount property.

This property is not available at design time.

Data Type

String

ClientPropertyValue Property (AMQPClassic Class)

The table property's value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClientPropertyValue(int iClientPropertyIndex);
int SetClientPropertyValue(int iClientPropertyIndex, const char* lpszClientPropertyValue);

Unicode (Windows)
LPWSTR GetClientPropertyValue(INT iClientPropertyIndex);
INT SetClientPropertyValue(INT iClientPropertyIndex, LPCWSTR lpszClientPropertyValue);

char* ipworksiot_amqpclassic_getclientpropertyvalue(void* lpObj, int clientpropertyindex);
int ipworksiot_amqpclassic_setclientpropertyvalue(void* lpObj, int clientpropertyindex, const char* lpszClientPropertyValue);

QString GetClientPropertyValue(int iClientPropertyIndex);
int SetClientPropertyValue(int iClientPropertyIndex, QString qsClientPropertyValue);

Default Value

""

Remarks

The table field's value.

This property specifies the table field's value.

The ClientPropertyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClientPropertyCount property.

This property is not available at design time.

Data Type

String

ClientPropertyValueType Property (AMQPClassic Class)

The table property's value type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClientPropertyValueType(int iClientPropertyIndex);
int SetClientPropertyValueType(int iClientPropertyIndex, int iClientPropertyValueType);

Unicode (Windows)
INT GetClientPropertyValueType(INT iClientPropertyIndex);
INT SetClientPropertyValueType(INT iClientPropertyIndex, INT iClientPropertyValueType);

FVT_BOOLEAN(0), 
FVT_BYTE(1), 
FVT_UBYTE(2), 
FVT_SHORT(3), 
FVT_USHORT(4), 
FVT_INT(5), 
FVT_UINT(6), 
FVT_LONG(7), 
FVT_ULONG(8), 
FVT_FLOAT(9), 
FVT_DOUBLE(10), 
FVT_DECIMAL(11), 
FVT_SSTRING(12), 
FVT_STRING(13), 
FVT_ARRAY(14), 
FVT_TIMESTAMP(15), 
FVT_TABLE(16), 
FVT_NULL(17)

int ipworksiot_amqpclassic_getclientpropertyvaluetype(void* lpObj, int clientpropertyindex);
int ipworksiot_amqpclassic_setclientpropertyvaluetype(void* lpObj, int clientpropertyindex, int iClientPropertyValueType);

int GetClientPropertyValueType(int iClientPropertyIndex);
int SetClientPropertyValueType(int iClientPropertyIndex, int iClientPropertyValueType);

Default Value

17

Remarks

The table field's value type.

This property specifies the table field's value type (and thus, the format of the data in the ClientPropertyValue property). Acceptable value types are:

Note: The fvtUlong (8) and fvtSstring (12) value types are not supported when the RabbitMQCompatible configuration setting is enabled.

For the fvtArray (14) value type, the ClientPropertyValue 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 }
]

For the fvtTable (16) value type, the ClientPropertyValue should be specified as a JSON object containing name-type-value tuples; for example:

{
  { "name": "Test1", "type": "long", "value": 12345678901234 },
  { "name": "Test2", "type": "boolean", "value": "false" },
  { "name": "Test3", "type": "string", "value": "This is a test." }
}

Notes regarding fvtArray (14) and fvtTable (16) type ClientPropertyValues:

• All "type" fields in the JSON content must be set to one of the value types in the table above.
• For fvtTable (16) type ClientPropertyValues, all "name" fields must adhere to the rules described by the ClientPropertyKey documentation.
• Nesting and mixing multiple levels of arrays and tables in the JSON is allowed.

The ClientPropertyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClientPropertyCount property.

This property is not available at design time.

Data Type

Integer

Connected Property (AMQPClassic Class)

This property triggers a connection or disconnection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();
int SetConnected(int bConnected);

Unicode (Windows)
BOOL GetConnected();
INT SetConnected(BOOL bConnected);

int ipworksiot_amqpclassic_getconnected(void* lpObj);
int ipworksiot_amqpclassic_setconnected(void* lpObj, int bConnected);

bool GetConnected();
int SetConnected(bool bConnected);

Default Value

FALSE

Remarks

This property triggers a connection or disconnection. Setting this property to True makes the class attempt to connect to the host identified by the RemoteHost property. If successful, after the connection is achieved, the value of the property changes to True and the Connected event is fired.

Setting this property to False closes the connection. How and when the connection is closed is controlled by the Linger property.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property is not available at design time.

Data Type

Boolean

FirewallAutoDetect Property (AMQPClassic Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect);

Unicode (Windows)
BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);

int ipworksiot_amqpclassic_getfirewallautodetect(void* lpObj);
int ipworksiot_amqpclassic_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (AMQPClassic Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType);

Unicode (Windows)
INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

FW_NONE(0), 
FW_TUNNEL(1), 
FW_SOCKS4(2), 
FW_SOCKS5(3), 
FW_SOCKS4A(10)

int ipworksiot_amqpclassic_getfirewalltype(void* lpObj);
int ipworksiot_amqpclassic_setfirewalltype(void* lpObj, int iFirewallType);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (AMQPClassic Class)

This property contains the name or IP address of firewall (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost);

Unicode (Windows)
LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);

char* ipworksiot_amqpclassic_getfirewallhost(void* lpObj);
int ipworksiot_amqpclassic_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (AMQPClassic Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword);

Unicode (Windows)
LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);

char* ipworksiot_amqpclassic_getfirewallpassword(void* lpObj);
int ipworksiot_amqpclassic_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (AMQPClassic Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Unicode (Windows)
INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);

int ipworksiot_amqpclassic_getfirewallport(void* lpObj);
int ipworksiot_amqpclassic_setfirewallport(void* lpObj, int iFirewallPort);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (AMQPClassic Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser);

Unicode (Windows)
LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);

char* ipworksiot_amqpclassic_getfirewalluser(void* lpObj);
int ipworksiot_amqpclassic_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

Heartbeat Property (AMQPClassic Class)

The heartbeat timeout value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetHeartbeat();
int SetHeartbeat(int iHeartbeat);

Unicode (Windows)
INT GetHeartbeat();
INT SetHeartbeat(INT iHeartbeat);

int ipworksiot_amqpclassic_getheartbeat(void* lpObj);
int ipworksiot_amqpclassic_setheartbeat(void* lpObj, int iHeartbeat);

int GetHeartbeat();
int SetHeartbeat(int iHeartbeat);

Default Value

0

Remarks

This property specifies the heartbeat timeout value, in seconds. Heartbeats are disabled if set to 0 (default).

Before connecting, this property can be set to indicate the desired heartbeat timeout value. During the connection process, the class and the server will compare their desired heartbeat values and choose the lower one.

Once connected, this property will reflect the agreed-upon heartbeat value. While the connection is idle, heartbeats are sent by both the class and the server approximately once every (Heartbeat / 2) seconds. If either side has not received a heartbeat (or other transmission) for ~Heartbeat seconds, it will consider the other side unreachable and close the connection.

This setting cannot be changed while connected.

This property is not available at design time.

Data Type

Integer

IncomingMessageCount Property (AMQPClassic Class)

The number of records in the IncomingMessage arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIncomingMessageCount();

Unicode (Windows)
INT GetIncomingMessageCount();

int ipworksiot_amqpclassic_getincomingmessagecount(void* lpObj);

int GetIncomingMessageCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• IncomingMessageAppId
• IncomingMessageBody
• IncomingMessageChannelName
• IncomingMessageContentEncoding
• IncomingMessageContentType
• IncomingMessageCorrelationId
• IncomingMessageDeliveryMode
• IncomingMessageExpiration
• IncomingMessageHeaders
• IncomingMessageId
• IncomingMessagePriority
• IncomingMessageReplyTo
• IncomingMessageTimestamp
• IncomingMessageType
• IncomingMessageUserId

The array indices start at 0 and end at IncomingMessageCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

IncomingMessageAppId Property (AMQPClassic Class)

The Id of the application that created the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetIncomingMessageAppId(int iIncomingMessageIndex);

Unicode (Windows)
LPWSTR GetIncomingMessageAppId(INT iIncomingMessageIndex);

char* ipworksiot_amqpclassic_getincomingmessageappid(void* lpObj, int incomingmessageindex);

QString GetIncomingMessageAppId(int iIncomingMessageIndex);

Default Value

""

Remarks

The Id of the application that created the message.

This property 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.

The IncomingMessageIndex 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

String

IncomingMessageBody Property (AMQPClassic Class)

The message body.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIncomingMessageBody(int iIncomingMessageIndex, char* &lpIncomingMessageBody, int &lenIncomingMessageBody);

Unicode (Windows)
INT GetIncomingMessageBody(INT iIncomingMessageIndex, LPSTR &lpIncomingMessageBody, INT &lenIncomingMessageBody);

int ipworksiot_amqpclassic_getincomingmessagebody(void* lpObj, int incomingmessageindex, char** lpIncomingMessageBody, int* lenIncomingMessageBody);

QByteArray GetIncomingMessageBody(int iIncomingMessageIndex);

Default Value

""

Remarks

The message body.

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

The IncomingMessageIndex 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

Binary String

IncomingMessageChannelName Property (AMQPClassic Class)

The name of the channel the message is associated with.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetIncomingMessageChannelName(int iIncomingMessageIndex);

Unicode (Windows)
LPWSTR GetIncomingMessageChannelName(INT iIncomingMessageIndex);

char* ipworksiot_amqpclassic_getincomingmessagechannelname(void* lpObj, int incomingmessageindex);

QString GetIncomingMessageChannelName(int iIncomingMessageIndex);

Default Value

""

Remarks

The name of the channel the message is associated with.

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

The IncomingMessageIndex 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

String

IncomingMessageContentEncoding Property (AMQPClassic Class)

The content encoding of the message's body.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetIncomingMessageContentEncoding(int iIncomingMessageIndex);

Unicode (Windows)
LPWSTR GetIncomingMessageContentEncoding(INT iIncomingMessageIndex);

char* ipworksiot_amqpclassic_getincomingmessagecontentencoding(void* lpObj, int incomingmessageindex);

QString GetIncomingMessageContentEncoding(int iIncomingMessageIndex);

Default Value

""

Remarks

The content encoding of the message's body.

This property 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.

The IncomingMessageIndex 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

String

IncomingMessageContentType Property (AMQPClassic Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetIncomingMessageContentType(int iIncomingMessageIndex);

Unicode (Windows)
LPWSTR GetIncomingMessageContentType(INT iIncomingMessageIndex);

char* ipworksiot_amqpclassic_getincomingmessagecontenttype(void* lpObj, int incomingmessageindex);

QString GetIncomingMessageContentType(int iIncomingMessageIndex);

Default Value

""

Remarks

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

This property 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.

The IncomingMessageIndex 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

String

IncomingMessageCorrelationId Property (AMQPClassic Class)

The correlation Id of the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetIncomingMessageCorrelationId(int iIncomingMessageIndex);

Unicode (Windows)
LPWSTR GetIncomingMessageCorrelationId(INT iIncomingMessageIndex);

char* ipworksiot_amqpclassic_getincomingmessagecorrelationid(void* lpObj, int incomingmessageindex);

QString GetIncomingMessageCorrelationId(int iIncomingMessageIndex);

Default Value

""

Remarks

The correlation Id of the message.

This property 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.

The IncomingMessageIndex 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

String

IncomingMessageDeliveryMode Property (AMQPClassic Class)

The delivery mode of the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIncomingMessageDeliveryMode(int iIncomingMessageIndex);

Unicode (Windows)
INT GetIncomingMessageDeliveryMode(INT iIncomingMessageIndex);

int ipworksiot_amqpclassic_getincomingmessagedeliverymode(void* lpObj, int incomingmessageindex);

int GetIncomingMessageDeliveryMode(int iIncomingMessageIndex);

Default Value

0

Remarks

The delivery mode of the message.

This property 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.

The IncomingMessageIndex 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

IncomingMessageExpiration Property (AMQPClassic Class)

The time-to-live value for this message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetIncomingMessageExpiration(int iIncomingMessageIndex);

Unicode (Windows)
LPWSTR GetIncomingMessageExpiration(INT iIncomingMessageIndex);

char* ipworksiot_amqpclassic_getincomingmessageexpiration(void* lpObj, int incomingmessageindex);

QString GetIncomingMessageExpiration(int iIncomingMessageIndex);

Default Value

""

Remarks

The time-to-live value for this message.

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

The IncomingMessageIndex 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

String

IncomingMessageHeaders Property (AMQPClassic Class)

Headers associated with the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetIncomingMessageHeaders(int iIncomingMessageIndex);

Unicode (Windows)
LPWSTR GetIncomingMessageHeaders(INT iIncomingMessageIndex);

char* ipworksiot_amqpclassic_getincomingmessageheaders(void* lpObj, int incomingmessageindex);

QString GetIncomingMessageHeaders(int iIncomingMessageIndex);

Default Value

""

Remarks

Headers associated with the message.

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:

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.

The IncomingMessageIndex 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

String

IncomingMessageId Property (AMQPClassic Class)

The unique Id of the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetIncomingMessageId(int iIncomingMessageIndex);

Unicode (Windows)
LPWSTR GetIncomingMessageId(INT iIncomingMessageIndex);

char* ipworksiot_amqpclassic_getincomingmessageid(void* lpObj, int incomingmessageindex);

QString GetIncomingMessageId(int iIncomingMessageIndex);

Default Value

""

Remarks

The unique Id of the message.

This property 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.

The IncomingMessageIndex 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

String

IncomingMessagePriority Property (AMQPClassic Class)

The priority of the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIncomingMessagePriority(int iIncomingMessageIndex);

Unicode (Windows)
INT GetIncomingMessagePriority(INT iIncomingMessageIndex);

int ipworksiot_amqpclassic_getincomingmessagepriority(void* lpObj, int incomingmessageindex);

int GetIncomingMessagePriority(int iIncomingMessageIndex);

Default Value

0

Remarks

The priority of the message.

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

The IncomingMessageIndex 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

IncomingMessageReplyTo Property (AMQPClassic Class)

The address to send replies to for the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetIncomingMessageReplyTo(int iIncomingMessageIndex);

Unicode (Windows)
LPWSTR GetIncomingMessageReplyTo(INT iIncomingMessageIndex);

char* ipworksiot_amqpclassic_getincomingmessagereplyto(void* lpObj, int incomingmessageindex);

QString GetIncomingMessageReplyTo(int iIncomingMessageIndex);

Default Value

""

Remarks

The address to send replies to for the message.

This property 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.

The IncomingMessageIndex 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

String

IncomingMessageTimestamp Property (AMQPClassic Class)

The message's timestamp.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetIncomingMessageTimestamp(int iIncomingMessageIndex);

Unicode (Windows)
LONG64 GetIncomingMessageTimestamp(INT iIncomingMessageIndex);

int64 ipworksiot_amqpclassic_getincomingmessagetimestamp(void* lpObj, int incomingmessageindex);

qint64 GetIncomingMessageTimestamp(int iIncomingMessageIndex);

Default Value

0

Remarks

The message's timestamp.

This property 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.

The IncomingMessageIndex 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

Long64

IncomingMessageType Property (AMQPClassic Class)

The message's type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetIncomingMessageType(int iIncomingMessageIndex);

Unicode (Windows)
LPWSTR GetIncomingMessageType(INT iIncomingMessageIndex);

char* ipworksiot_amqpclassic_getincomingmessagetype(void* lpObj, int incomingmessageindex);

QString GetIncomingMessageType(int iIncomingMessageIndex);

Default Value

""

Remarks

The message's type.

This property 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.

The IncomingMessageIndex 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

String

IncomingMessageUserId Property (AMQPClassic Class)

The identity of the user responsible for producing the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetIncomingMessageUserId(int iIncomingMessageIndex);

Unicode (Windows)
LPWSTR GetIncomingMessageUserId(INT iIncomingMessageIndex);

char* ipworksiot_amqpclassic_getincomingmessageuserid(void* lpObj, int incomingmessageindex);

QString GetIncomingMessageUserId(int iIncomingMessageIndex);

Default Value

""

Remarks

The identity of the user responsible for producing the message.

This property 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.

The IncomingMessageIndex 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

String

LocalHost Property (AMQPClassic Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* ipworksiot_amqpclassic_getlocalhost(void* lpObj);
int ipworksiot_amqpclassic_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

""

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

LocalPort Property (AMQPClassic Class)

The TCP port in the local host where the class binds.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLocalPort();
int SetLocalPort(int iLocalPort);

Unicode (Windows)
INT GetLocalPort();
INT SetLocalPort(INT iLocalPort);

int ipworksiot_amqpclassic_getlocalport(void* lpObj);
int ipworksiot_amqpclassic_setlocalport(void* lpObj, int iLocalPort);

int GetLocalPort();
int SetLocalPort(int iLocalPort);

Default Value

0

Remarks

This property must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this property to 0 (default) enables the system to choose an open port at random. The chosen port will be returned by the LocalPort property after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this property when a connection is active will generate an error.

This property is useful when trying to connect to services that require a trusted port in the client side.

Data Type

Integer

MessageAppId Property (AMQPClassic Class)

The Id of the application that created the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageAppId();
int SetMessageAppId(const char* lpszMessageAppId);

Unicode (Windows)
LPWSTR GetMessageAppId();
INT SetMessageAppId(LPCWSTR lpszMessageAppId);

char* ipworksiot_amqpclassic_getmessageappid(void* lpObj);
int ipworksiot_amqpclassic_setmessageappid(void* lpObj, const char* lpszMessageAppId);

QString GetMessageAppId();
int SetMessageAppId(QString qsMessageAppId);

Default Value

""

Remarks

The Id of the application that created the message.

This property 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.

This property is not available at design time.

Data Type

String

MessageBody Property (AMQPClassic Class)

The message body.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessageBody(char* &lpMessageBody, int &lenMessageBody);
int SetMessageBody(const char* lpMessageBody, int lenMessageBody);

Unicode (Windows)
INT GetMessageBody(LPSTR &lpMessageBody, INT &lenMessageBody);
INT SetMessageBody(LPCSTR lpMessageBody, INT lenMessageBody);

int ipworksiot_amqpclassic_getmessagebody(void* lpObj, char** lpMessageBody, int* lenMessageBody);
int ipworksiot_amqpclassic_setmessagebody(void* lpObj, const char* lpMessageBody, int lenMessageBody);

QByteArray GetMessageBody();
int SetMessageBody(QByteArray qbaMessageBody);

Default Value

""

Remarks

The message body.

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

This property is not available at design time.

Data Type

Binary String

MessageChannelName Property (AMQPClassic Class)

The name of the channel the message is associated with.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageChannelName();

Unicode (Windows)
LPWSTR GetMessageChannelName();

char* ipworksiot_amqpclassic_getmessagechannelname(void* lpObj);

QString GetMessageChannelName();

Default Value

""

Remarks

The name of the channel the message is associated with.

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

This property is read-only and not available at design time.

Data Type

String

MessageContentEncoding Property (AMQPClassic Class)

The content encoding of the message's body.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageContentEncoding();
int SetMessageContentEncoding(const char* lpszMessageContentEncoding);

Unicode (Windows)
LPWSTR GetMessageContentEncoding();
INT SetMessageContentEncoding(LPCWSTR lpszMessageContentEncoding);

char* ipworksiot_amqpclassic_getmessagecontentencoding(void* lpObj);
int ipworksiot_amqpclassic_setmessagecontentencoding(void* lpObj, const char* lpszMessageContentEncoding);

QString GetMessageContentEncoding();
int SetMessageContentEncoding(QString qsMessageContentEncoding);

Default Value

""

Remarks

The content encoding of the message's body.

This property 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.

This property is not available at design time.

Data Type

String

MessageContentType Property (AMQPClassic Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageContentType();
int SetMessageContentType(const char* lpszMessageContentType);

Unicode (Windows)
LPWSTR GetMessageContentType();
INT SetMessageContentType(LPCWSTR lpszMessageContentType);

char* ipworksiot_amqpclassic_getmessagecontenttype(void* lpObj);
int ipworksiot_amqpclassic_setmessagecontenttype(void* lpObj, const char* lpszMessageContentType);

QString GetMessageContentType();
int SetMessageContentType(QString qsMessageContentType);

Default Value

""

Remarks

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

This property 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.

This property is not available at design time.

Data Type

String

MessageCorrelationId Property (AMQPClassic Class)

The correlation Id of the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageCorrelationId();
int SetMessageCorrelationId(const char* lpszMessageCorrelationId);

Unicode (Windows)
LPWSTR GetMessageCorrelationId();
INT SetMessageCorrelationId(LPCWSTR lpszMessageCorrelationId);

char* ipworksiot_amqpclassic_getmessagecorrelationid(void* lpObj);
int ipworksiot_amqpclassic_setmessagecorrelationid(void* lpObj, const char* lpszMessageCorrelationId);

QString GetMessageCorrelationId();
int SetMessageCorrelationId(QString qsMessageCorrelationId);

Default Value

""

Remarks

The correlation Id of the message.

This property 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.

This property is not available at design time.

Data Type

String

MessageDeliveryMode Property (AMQPClassic Class)

The delivery mode of the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessageDeliveryMode();
int SetMessageDeliveryMode(int iMessageDeliveryMode);

Unicode (Windows)
INT GetMessageDeliveryMode();
INT SetMessageDeliveryMode(INT iMessageDeliveryMode);

int ipworksiot_amqpclassic_getmessagedeliverymode(void* lpObj);
int ipworksiot_amqpclassic_setmessagedeliverymode(void* lpObj, int iMessageDeliveryMode);

int GetMessageDeliveryMode();
int SetMessageDeliveryMode(int iMessageDeliveryMode);

Default Value

0

Remarks

The delivery mode of the message.

This property 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.

This property is not available at design time.

Data Type

Integer

MessageExpiration Property (AMQPClassic Class)

The time-to-live value for this message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageExpiration();
int SetMessageExpiration(const char* lpszMessageExpiration);

Unicode (Windows)
LPWSTR GetMessageExpiration();
INT SetMessageExpiration(LPCWSTR lpszMessageExpiration);

char* ipworksiot_amqpclassic_getmessageexpiration(void* lpObj);
int ipworksiot_amqpclassic_setmessageexpiration(void* lpObj, const char* lpszMessageExpiration);

QString GetMessageExpiration();
int SetMessageExpiration(QString qsMessageExpiration);

Default Value

""

Remarks

The time-to-live value for this message.

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

This property is not available at design time.

Data Type

String

MessageHeaders Property (AMQPClassic Class)

Headers associated with the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageHeaders();
int SetMessageHeaders(const char* lpszMessageHeaders);

Unicode (Windows)
LPWSTR GetMessageHeaders();
INT SetMessageHeaders(LPCWSTR lpszMessageHeaders);

char* ipworksiot_amqpclassic_getmessageheaders(void* lpObj);
int ipworksiot_amqpclassic_setmessageheaders(void* lpObj, const char* lpszMessageHeaders);

QString GetMessageHeaders();
int SetMessageHeaders(QString qsMessageHeaders);

Default Value

""

Remarks

Headers associated with the message.

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:

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.

This property is not available at design time.

Data Type

String

MessageId Property (AMQPClassic Class)

The unique Id of the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageId();
int SetMessageId(const char* lpszMessageId);

Unicode (Windows)
LPWSTR GetMessageId();
INT SetMessageId(LPCWSTR lpszMessageId);

char* ipworksiot_amqpclassic_getmessageid(void* lpObj);
int ipworksiot_amqpclassic_setmessageid(void* lpObj, const char* lpszMessageId);

QString GetMessageId();
int SetMessageId(QString qsMessageId);

Default Value

""

Remarks

The unique Id of the message.

This property 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.

This property is not available at design time.

Data Type

String

MessagePriority Property (AMQPClassic Class)

The priority of the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessagePriority();
int SetMessagePriority(int iMessagePriority);

Unicode (Windows)
INT GetMessagePriority();
INT SetMessagePriority(INT iMessagePriority);

int ipworksiot_amqpclassic_getmessagepriority(void* lpObj);
int ipworksiot_amqpclassic_setmessagepriority(void* lpObj, int iMessagePriority);

int GetMessagePriority();
int SetMessagePriority(int iMessagePriority);

Default Value

0

Remarks

The priority of the message.

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

This property is not available at design time.

Data Type

Integer

MessageReplyTo Property (AMQPClassic Class)

The address to send replies to for the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageReplyTo();
int SetMessageReplyTo(const char* lpszMessageReplyTo);

Unicode (Windows)
LPWSTR GetMessageReplyTo();
INT SetMessageReplyTo(LPCWSTR lpszMessageReplyTo);

char* ipworksiot_amqpclassic_getmessagereplyto(void* lpObj);
int ipworksiot_amqpclassic_setmessagereplyto(void* lpObj, const char* lpszMessageReplyTo);

QString GetMessageReplyTo();
int SetMessageReplyTo(QString qsMessageReplyTo);

Default Value

""

Remarks

The address to send replies to for the message.

This property 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.

This property is not available at design time.

Data Type

String

MessageTimestamp Property (AMQPClassic Class)

The message's timestamp.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetMessageTimestamp();
int SetMessageTimestamp(int64 lMessageTimestamp);

Unicode (Windows)
LONG64 GetMessageTimestamp();
INT SetMessageTimestamp(LONG64 lMessageTimestamp);

int64 ipworksiot_amqpclassic_getmessagetimestamp(void* lpObj);
int ipworksiot_amqpclassic_setmessagetimestamp(void* lpObj, int64 lMessageTimestamp);

qint64 GetMessageTimestamp();
int SetMessageTimestamp(qint64 lMessageTimestamp);

Default Value

0

Remarks

The message's timestamp.

This property 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.

This property is not available at design time.

Data Type

Long64

MessageType Property (AMQPClassic Class)

The message's type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageType();
int SetMessageType(const char* lpszMessageType);

Unicode (Windows)
LPWSTR GetMessageType();
INT SetMessageType(LPCWSTR lpszMessageType);

char* ipworksiot_amqpclassic_getmessagetype(void* lpObj);
int ipworksiot_amqpclassic_setmessagetype(void* lpObj, const char* lpszMessageType);

QString GetMessageType();
int SetMessageType(QString qsMessageType);

Default Value

""

Remarks

The message's type.

This property 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.

This property is not available at design time.

Data Type

String

MessageUserId Property (AMQPClassic Class)

The identity of the user responsible for producing the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageUserId();
int SetMessageUserId(const char* lpszMessageUserId);

Unicode (Windows)
LPWSTR GetMessageUserId();
INT SetMessageUserId(LPCWSTR lpszMessageUserId);

char* ipworksiot_amqpclassic_getmessageuserid(void* lpObj);
int ipworksiot_amqpclassic_setmessageuserid(void* lpObj, const char* lpszMessageUserId);

QString GetMessageUserId();
int SetMessageUserId(QString qsMessageUserId);

Default Value

""

Remarks

The identity of the user responsible for producing the message.

This property 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.

This property is not available at design time.

Data Type

String

OutgoingMessageCount Property (AMQPClassic Class)

The number of records in the OutgoingMessage arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOutgoingMessageCount();

Unicode (Windows)
INT GetOutgoingMessageCount();

int ipworksiot_amqpclassic_getoutgoingmessagecount(void* lpObj);

int GetOutgoingMessageCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• OutgoingMessageAppId
• OutgoingMessageBody
• OutgoingMessageChannelName
• OutgoingMessageContentEncoding
• OutgoingMessageContentType
• OutgoingMessageCorrelationId
• OutgoingMessageDeliveryMode
• OutgoingMessageExpiration
• OutgoingMessageHeaders
• OutgoingMessageId
• OutgoingMessagePriority
• OutgoingMessageReplyTo
• OutgoingMessageTimestamp
• OutgoingMessageType
• OutgoingMessageUserId

The array indices start at 0 and end at OutgoingMessageCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

OutgoingMessageAppId Property (AMQPClassic Class)

The Id of the application that created the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutgoingMessageAppId(int iOutgoingMessageIndex);

Unicode (Windows)
LPWSTR GetOutgoingMessageAppId(INT iOutgoingMessageIndex);

char* ipworksiot_amqpclassic_getoutgoingmessageappid(void* lpObj, int outgoingmessageindex);

QString GetOutgoingMessageAppId(int iOutgoingMessageIndex);

Default Value

""

Remarks

The Id of the application that created the message.

This property 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.

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only and not available at design time.

Data Type

String

OutgoingMessageBody Property (AMQPClassic Class)

The message body.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOutgoingMessageBody(int iOutgoingMessageIndex, char* &lpOutgoingMessageBody, int &lenOutgoingMessageBody);

Unicode (Windows)
INT GetOutgoingMessageBody(INT iOutgoingMessageIndex, LPSTR &lpOutgoingMessageBody, INT &lenOutgoingMessageBody);

int ipworksiot_amqpclassic_getoutgoingmessagebody(void* lpObj, int outgoingmessageindex, char** lpOutgoingMessageBody, int* lenOutgoingMessageBody);

QByteArray GetOutgoingMessageBody(int iOutgoingMessageIndex);

Default Value

""

Remarks

The message body.

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

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only and not available at design time.

Data Type

Binary String

OutgoingMessageChannelName Property (AMQPClassic Class)

The name of the channel the message is associated with.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutgoingMessageChannelName(int iOutgoingMessageIndex);

Unicode (Windows)
LPWSTR GetOutgoingMessageChannelName(INT iOutgoingMessageIndex);

char* ipworksiot_amqpclassic_getoutgoingmessagechannelname(void* lpObj, int outgoingmessageindex);

QString GetOutgoingMessageChannelName(int iOutgoingMessageIndex);

Default Value

""

Remarks

The name of the channel the message is associated with.

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

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only and not available at design time.

Data Type

String

OutgoingMessageContentEncoding Property (AMQPClassic Class)

The content encoding of the message's body.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutgoingMessageContentEncoding(int iOutgoingMessageIndex);

Unicode (Windows)
LPWSTR GetOutgoingMessageContentEncoding(INT iOutgoingMessageIndex);

char* ipworksiot_amqpclassic_getoutgoingmessagecontentencoding(void* lpObj, int outgoingmessageindex);

QString GetOutgoingMessageContentEncoding(int iOutgoingMessageIndex);

Default Value

""

Remarks

The content encoding of the message's body.

This property 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.

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only and not available at design time.

Data Type

String

OutgoingMessageContentType Property (AMQPClassic Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutgoingMessageContentType(int iOutgoingMessageIndex);

Unicode (Windows)
LPWSTR GetOutgoingMessageContentType(INT iOutgoingMessageIndex);

char* ipworksiot_amqpclassic_getoutgoingmessagecontenttype(void* lpObj, int outgoingmessageindex);

QString GetOutgoingMessageContentType(int iOutgoingMessageIndex);

Default Value

""

Remarks

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

This property 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.

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only and not available at design time.

Data Type

String

OutgoingMessageCorrelationId Property (AMQPClassic Class)

The correlation Id of the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutgoingMessageCorrelationId(int iOutgoingMessageIndex);

Unicode (Windows)
LPWSTR GetOutgoingMessageCorrelationId(INT iOutgoingMessageIndex);

char* ipworksiot_amqpclassic_getoutgoingmessagecorrelationid(void* lpObj, int outgoingmessageindex);

QString GetOutgoingMessageCorrelationId(int iOutgoingMessageIndex);

Default Value

""

Remarks

The correlation Id of the message.

This property 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.

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only and not available at design time.

Data Type

String

OutgoingMessageDeliveryMode Property (AMQPClassic Class)

The delivery mode of the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOutgoingMessageDeliveryMode(int iOutgoingMessageIndex);

Unicode (Windows)
INT GetOutgoingMessageDeliveryMode(INT iOutgoingMessageIndex);

int ipworksiot_amqpclassic_getoutgoingmessagedeliverymode(void* lpObj, int outgoingmessageindex);

int GetOutgoingMessageDeliveryMode(int iOutgoingMessageIndex);

Default Value

0

Remarks

The delivery mode of the message.

This property 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.

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only and not available at design time.

Data Type

Integer

OutgoingMessageExpiration Property (AMQPClassic Class)

The time-to-live value for this message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutgoingMessageExpiration(int iOutgoingMessageIndex);

Unicode (Windows)
LPWSTR GetOutgoingMessageExpiration(INT iOutgoingMessageIndex);

char* ipworksiot_amqpclassic_getoutgoingmessageexpiration(void* lpObj, int outgoingmessageindex);

QString GetOutgoingMessageExpiration(int iOutgoingMessageIndex);

Default Value

""

Remarks

The time-to-live value for this message.

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

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only and not available at design time.

Data Type

String

OutgoingMessageHeaders Property (AMQPClassic Class)

Headers associated with the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutgoingMessageHeaders(int iOutgoingMessageIndex);

Unicode (Windows)
LPWSTR GetOutgoingMessageHeaders(INT iOutgoingMessageIndex);

char* ipworksiot_amqpclassic_getoutgoingmessageheaders(void* lpObj, int outgoingmessageindex);

QString GetOutgoingMessageHeaders(int iOutgoingMessageIndex);

Default Value

""

Remarks

Headers associated with the message.

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:

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.

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only and not available at design time.

Data Type

String

OutgoingMessageId Property (AMQPClassic Class)

The unique Id of the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutgoingMessageId(int iOutgoingMessageIndex);

Unicode (Windows)
LPWSTR GetOutgoingMessageId(INT iOutgoingMessageIndex);

char* ipworksiot_amqpclassic_getoutgoingmessageid(void* lpObj, int outgoingmessageindex);

QString GetOutgoingMessageId(int iOutgoingMessageIndex);

Default Value

""

Remarks

The unique Id of the message.

This property 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.

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only and not available at design time.

Data Type

String

OutgoingMessagePriority Property (AMQPClassic Class)

The priority of the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOutgoingMessagePriority(int iOutgoingMessageIndex);

Unicode (Windows)
INT GetOutgoingMessagePriority(INT iOutgoingMessageIndex);

int ipworksiot_amqpclassic_getoutgoingmessagepriority(void* lpObj, int outgoingmessageindex);

int GetOutgoingMessagePriority(int iOutgoingMessageIndex);

Default Value

0

Remarks

The priority of the message.

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

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only and not available at design time.

Data Type

Integer

OutgoingMessageReplyTo Property (AMQPClassic Class)

The address to send replies to for the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutgoingMessageReplyTo(int iOutgoingMessageIndex);

Unicode (Windows)
LPWSTR GetOutgoingMessageReplyTo(INT iOutgoingMessageIndex);

char* ipworksiot_amqpclassic_getoutgoingmessagereplyto(void* lpObj, int outgoingmessageindex);

QString GetOutgoingMessageReplyTo(int iOutgoingMessageIndex);

Default Value

""

Remarks

The address to send replies to for the message.

This property 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.

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only and not available at design time.

Data Type

String

OutgoingMessageTimestamp Property (AMQPClassic Class)

The message's timestamp.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetOutgoingMessageTimestamp(int iOutgoingMessageIndex);

Unicode (Windows)
LONG64 GetOutgoingMessageTimestamp(INT iOutgoingMessageIndex);

int64 ipworksiot_amqpclassic_getoutgoingmessagetimestamp(void* lpObj, int outgoingmessageindex);

qint64 GetOutgoingMessageTimestamp(int iOutgoingMessageIndex);

Default Value

0

Remarks

The message's timestamp.

This property 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.

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only and not available at design time.

Data Type

Long64

OutgoingMessageType Property (AMQPClassic Class)

The message's type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutgoingMessageType(int iOutgoingMessageIndex);

Unicode (Windows)
LPWSTR GetOutgoingMessageType(INT iOutgoingMessageIndex);

char* ipworksiot_amqpclassic_getoutgoingmessagetype(void* lpObj, int outgoingmessageindex);

QString GetOutgoingMessageType(int iOutgoingMessageIndex);

Default Value

""

Remarks

The message's type.

This property 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.

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only and not available at design time.

Data Type

String

OutgoingMessageUserId Property (AMQPClassic Class)

The identity of the user responsible for producing the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutgoingMessageUserId(int iOutgoingMessageIndex);

Unicode (Windows)
LPWSTR GetOutgoingMessageUserId(INT iOutgoingMessageIndex);

char* ipworksiot_amqpclassic_getoutgoingmessageuserid(void* lpObj, int outgoingmessageindex);

QString GetOutgoingMessageUserId(int iOutgoingMessageIndex);

Default Value

""

Remarks

The identity of the user responsible for producing the message.

This property 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.

The OutgoingMessageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutgoingMessageCount property.

This property is read-only and not available at design time.

Data Type

String

Password Property (AMQPClassic Class)

A password to use for SASL authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* ipworksiot_amqpclassic_getpassword(void* lpObj);
int ipworksiot_amqpclassic_setpassword(void* lpObj, const char* lpszPassword);

QString GetPassword();
int SetPassword(QString qsPassword);

Default Value

""

Remarks

This property contains a password to use for SASL authentication.

This property is not available at design time.

Data Type

String

QueueMessageCount Property (AMQPClassic Class)

The message count returned by various queue operations.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetQueueMessageCount();

Unicode (Windows)
INT GetQueueMessageCount();

int ipworksiot_amqpclassic_getqueuemessagecount(void* lpObj);

int GetQueueMessageCount();

Default Value

0

Remarks

This property is populated with a message count after calling certain queue-related methods.

This property is read-only and not available at design time.

Data Type

Integer

ReceivedMessageAppId Property (AMQPClassic Class)

The Id of the application that created the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReceivedMessageAppId();

Unicode (Windows)
LPWSTR GetReceivedMessageAppId();

char* ipworksiot_amqpclassic_getreceivedmessageappid(void* lpObj);

QString GetReceivedMessageAppId();

Default Value

""

Remarks

The Id of the application that created the message.

This property 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.

This property is read-only and not available at design time.

Data Type

String

ReceivedMessageBody Property (AMQPClassic Class)

The message body.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReceivedMessageBody(char* &lpReceivedMessageBody, int &lenReceivedMessageBody);

Unicode (Windows)
INT GetReceivedMessageBody(LPSTR &lpReceivedMessageBody, INT &lenReceivedMessageBody);

int ipworksiot_amqpclassic_getreceivedmessagebody(void* lpObj, char** lpReceivedMessageBody, int* lenReceivedMessageBody);

QByteArray GetReceivedMessageBody();

Default Value

""

Remarks

The message body.

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

This property is read-only and not available at design time.

Data Type

Binary String

ReceivedMessageChannelName Property (AMQPClassic Class)

The name of the channel the message is associated with.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReceivedMessageChannelName();

Unicode (Windows)
LPWSTR GetReceivedMessageChannelName();

char* ipworksiot_amqpclassic_getreceivedmessagechannelname(void* lpObj);

QString GetReceivedMessageChannelName();

Default Value

""

Remarks

The name of the channel the message is associated with.

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

This property is read-only and not available at design time.

Data Type

String

ReceivedMessageContentEncoding Property (AMQPClassic Class)

The content encoding of the message's body.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReceivedMessageContentEncoding();

Unicode (Windows)
LPWSTR GetReceivedMessageContentEncoding();

char* ipworksiot_amqpclassic_getreceivedmessagecontentencoding(void* lpObj);

QString GetReceivedMessageContentEncoding();

Default Value

""

Remarks

The content encoding of the message's body.

This property 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.

This property is read-only and not available at design time.

Data Type

String

ReceivedMessageContentType Property (AMQPClassic Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReceivedMessageContentType();

Unicode (Windows)
LPWSTR GetReceivedMessageContentType();

char* ipworksiot_amqpclassic_getreceivedmessagecontenttype(void* lpObj);

QString GetReceivedMessageContentType();

Default Value

""

Remarks

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

This property 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.

This property is read-only and not available at design time.

Data Type

String

ReceivedMessageCorrelationId Property (AMQPClassic Class)

The correlation Id of the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReceivedMessageCorrelationId();

Unicode (Windows)
LPWSTR GetReceivedMessageCorrelationId();

char* ipworksiot_amqpclassic_getreceivedmessagecorrelationid(void* lpObj);

QString GetReceivedMessageCorrelationId();

Default Value

""

Remarks

The correlation Id of the message.

This property 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.

This property is read-only and not available at design time.

Data Type

String

ReceivedMessageDeliveryMode Property (AMQPClassic Class)

The delivery mode of the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReceivedMessageDeliveryMode();

Unicode (Windows)
INT GetReceivedMessageDeliveryMode();

int ipworksiot_amqpclassic_getreceivedmessagedeliverymode(void* lpObj);

int GetReceivedMessageDeliveryMode();

Default Value

0

Remarks

The delivery mode of the message.

This property 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.

This property is read-only and not available at design time.

Data Type

Integer

ReceivedMessageExpiration Property (AMQPClassic Class)

The time-to-live value for this message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReceivedMessageExpiration();

Unicode (Windows)
LPWSTR GetReceivedMessageExpiration();

char* ipworksiot_amqpclassic_getreceivedmessageexpiration(void* lpObj);

QString GetReceivedMessageExpiration();

Default Value

""

Remarks

The time-to-live value for this message.

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

This property is read-only and not available at design time.

Data Type

String

ReceivedMessageHeaders Property (AMQPClassic Class)

Headers associated with the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReceivedMessageHeaders();

Unicode (Windows)
LPWSTR GetReceivedMessageHeaders();

char* ipworksiot_amqpclassic_getreceivedmessageheaders(void* lpObj);

QString GetReceivedMessageHeaders();

Default Value

""

Remarks

Headers associated with the message.

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:

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.

This property is read-only and not available at design time.

Data Type

String

ReceivedMessageId Property (AMQPClassic Class)

The unique Id of the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReceivedMessageId();

Unicode (Windows)
LPWSTR GetReceivedMessageId();

char* ipworksiot_amqpclassic_getreceivedmessageid(void* lpObj);

QString GetReceivedMessageId();

Default Value

""

Remarks

The unique Id of the message.

This property 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.

This property is read-only and not available at design time.

Data Type

String

ReceivedMessagePriority Property (AMQPClassic Class)

The priority of the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReceivedMessagePriority();

Unicode (Windows)
INT GetReceivedMessagePriority();

int ipworksiot_amqpclassic_getreceivedmessagepriority(void* lpObj);

int GetReceivedMessagePriority();

Default Value

0

Remarks

The priority of the message.

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

This property is read-only and not available at design time.

Data Type

Integer

ReceivedMessageReplyTo Property (AMQPClassic Class)

The address to send replies to for the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReceivedMessageReplyTo();

Unicode (Windows)
LPWSTR GetReceivedMessageReplyTo();

char* ipworksiot_amqpclassic_getreceivedmessagereplyto(void* lpObj);

QString GetReceivedMessageReplyTo();

Default Value

""

Remarks

The address to send replies to for the message.

This property 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.

This property is read-only and not available at design time.

Data Type

String

ReceivedMessageTimestamp Property (AMQPClassic Class)

The message's timestamp.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetReceivedMessageTimestamp();

Unicode (Windows)
LONG64 GetReceivedMessageTimestamp();

int64 ipworksiot_amqpclassic_getreceivedmessagetimestamp(void* lpObj);

qint64 GetReceivedMessageTimestamp();

Default Value

0

Remarks

The message's timestamp.

This property 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.

This property is read-only and not available at design time.

Data Type

Long64

ReceivedMessageType Property (AMQPClassic Class)

The message's type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReceivedMessageType();

Unicode (Windows)
LPWSTR GetReceivedMessageType();

char* ipworksiot_amqpclassic_getreceivedmessagetype(void* lpObj);

QString GetReceivedMessageType();

Default Value

""

Remarks

The message's type.

This property 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.

This property is read-only and not available at design time.

Data Type

String

ReceivedMessageUserId Property (AMQPClassic Class)

The identity of the user responsible for producing the message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReceivedMessageUserId();

Unicode (Windows)
LPWSTR GetReceivedMessageUserId();

char* ipworksiot_amqpclassic_getreceivedmessageuserid(void* lpObj);

QString GetReceivedMessageUserId();

Default Value

""

Remarks

The identity of the user responsible for producing the message.

This property 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.

This property is read-only and not available at design time.

Data Type

String

RemoteHost Property (AMQPClassic Class)

This property includes the address of the remote host. Domain names are resolved to IP addresses.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRemoteHost();
int SetRemoteHost(const char* lpszRemoteHost);

Unicode (Windows)
LPWSTR GetRemoteHost();
INT SetRemoteHost(LPCWSTR lpszRemoteHost);

char* ipworksiot_amqpclassic_getremotehost(void* lpObj);
int ipworksiot_amqpclassic_setremotehost(void* lpObj, const char* lpszRemoteHost);

QString GetRemoteHost();
int SetRemoteHost(QString qsRemoteHost);

Default Value

""

Remarks

This property specifies the IP address (IP number in dotted internet format) or the domain name of the remote host. It is set before a connection is attempted and cannot be changed once a connection is established.

If this property is set to a domain name, a DNS request is initiated, and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.

If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

Example. Connecting:

TCPClientControl.RemoteHost = "MyHostNameOrIP" TCPClientControl.RemotePort = 777 TCPClientControl.Connected = true

Data Type

String

RemotePort Property (AMQPClassic Class)

The port of the AQMP server (default is 5672). The default port for SSL is 5671.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRemotePort();
int SetRemotePort(int iRemotePort);

Unicode (Windows)
INT GetRemotePort();
INT SetRemotePort(INT iRemotePort);

int ipworksiot_amqpclassic_getremoteport(void* lpObj);
int ipworksiot_amqpclassic_setremoteport(void* lpObj, int iRemotePort);

int GetRemotePort();
int SetRemotePort(int iRemotePort);

Default Value

5672

Remarks

This property specifies a service port on the remote host to connect to.

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

This property is not available at design time.

Data Type

Integer

ServerPropertyCount Property (AMQPClassic Class)

The number of records in the ServerProperty arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerPropertyCount();

Unicode (Windows)
INT GetServerPropertyCount();

int ipworksiot_amqpclassic_getserverpropertycount(void* lpObj);

int GetServerPropertyCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• ServerPropertyName
• ServerPropertyValue
• ServerPropertyValueType

The array indices start at 0 and end at ServerPropertyCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ServerPropertyName Property (AMQPClassic Class)

The table property's name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerPropertyName(int iServerPropertyIndex);

Unicode (Windows)
LPWSTR GetServerPropertyName(INT iServerPropertyIndex);

char* ipworksiot_amqpclassic_getserverpropertyname(void* lpObj, int serverpropertyindex);

QString GetServerPropertyName(int iServerPropertyIndex);

Default Value

""

Remarks

The table field's name.

This property specifies the table field's name. The name must be an ASCII string that:

• Starts with an ASCII letter, $, or $ character.
• Only contains ASCII letters, digits, underscores, $, and $ characters.
• Is unique among all sibling table field ServerPropertyNames.
• Is no longer than 128 characters.

The ServerPropertyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerPropertyCount property.

This property is read-only and not available at design time.

Data Type

String

ServerPropertyValue Property (AMQPClassic Class)

The table property's value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServerPropertyValue(int iServerPropertyIndex);

Unicode (Windows)
LPWSTR GetServerPropertyValue(INT iServerPropertyIndex);

char* ipworksiot_amqpclassic_getserverpropertyvalue(void* lpObj, int serverpropertyindex);

QString GetServerPropertyValue(int iServerPropertyIndex);

Default Value

""

Remarks

The table field's value.

This property specifies the table field's value.

The ServerPropertyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerPropertyCount property.

This property is read-only and not available at design time.

Data Type

String

ServerPropertyValueType Property (AMQPClassic Class)

The table property's value type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServerPropertyValueType(int iServerPropertyIndex);

Unicode (Windows)
INT GetServerPropertyValueType(INT iServerPropertyIndex);

FVT_BOOLEAN(0), 
FVT_BYTE(1), 
FVT_UBYTE(2), 
FVT_SHORT(3), 
FVT_USHORT(4), 
FVT_INT(5), 
FVT_UINT(6), 
FVT_LONG(7), 
FVT_ULONG(8), 
FVT_FLOAT(9), 
FVT_DOUBLE(10), 
FVT_DECIMAL(11), 
FVT_SSTRING(12), 
FVT_STRING(13), 
FVT_ARRAY(14), 
FVT_TIMESTAMP(15), 
FVT_TABLE(16), 
FVT_NULL(17)

int ipworksiot_amqpclassic_getserverpropertyvaluetype(void* lpObj, int serverpropertyindex);

int GetServerPropertyValueType(int iServerPropertyIndex);

Default Value

17

Remarks

The table field's value type.

This property specifies the table field's value type (and thus, the format of the data in the ServerPropertyValue property). Acceptable value types are:

Note: The fvtUlong (8) and fvtSstring (12) value types are not supported when the RabbitMQCompatible configuration setting is enabled.

For the fvtArray (14) value type, the ServerPropertyValue 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 }
]

For the fvtTable (16) value type, the ServerPropertyValue should be specified as a JSON object containing name-type-value tuples; for example:

{
  { "name": "Test1", "type": "long", "value": 12345678901234 },
  { "name": "Test2", "type": "boolean", "value": "false" },
  { "name": "Test3", "type": "string", "value": "This is a test." }
}

Notes regarding fvtArray (14) and fvtTable (16) type ServerPropertyValues:

• All "type" fields in the JSON content must be set to one of the value types in the table above.
• For fvtTable (16) type ServerPropertyValues, all "name" fields must adhere to the rules described by the ServerPropertyKey documentation.
• Nesting and mixing multiple levels of arrays and tables in the JSON is allowed.

The ServerPropertyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ServerPropertyCount property.

This property is read-only and not available at design time.

Data Type

Integer

SSLAcceptServerCertEncoded Property (AMQPClassic Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int ipworksiot_amqpclassic_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksiot_amqpclassic_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (AMQPClassic Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int ipworksiot_amqpclassic_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksiot_amqpclassic_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (AMQPClassic Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int ipworksiot_amqpclassic_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksiot_amqpclassic_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (AMQPClassic Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* ipworksiot_amqpclassic_getsslcertstorepassword(void* lpObj);
int ipworksiot_amqpclassic_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (AMQPClassic Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int ipworksiot_amqpclassic_getsslcertstoretype(void* lpObj);
int ipworksiot_amqpclassic_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (AMQPClassic Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* ipworksiot_amqpclassic_getsslcertsubject(void* lpObj);
int ipworksiot_amqpclassic_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLEnabled Property (AMQPClassic Class)

Whether TLS/SSL is enabled.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLEnabled();
int SetSSLEnabled(int bSSLEnabled);

Unicode (Windows)
BOOL GetSSLEnabled();
INT SetSSLEnabled(BOOL bSSLEnabled);

int ipworksiot_amqpclassic_getsslenabled(void* lpObj);
int ipworksiot_amqpclassic_setsslenabled(void* lpObj, int bSSLEnabled);

bool GetSSLEnabled();
int SetSSLEnabled(bool bSSLEnabled);

Default Value

FALSE

Remarks

This setting specifies whether TLS/SSL is enabled in the class. When False (default) the class operates in plaintext mode. When True TLS/SSL is enabled.

TLS/SSL may also be enabled by setting SSLStartMode. Setting SSLStartMode will automatically update this property value.

If the default port (5672) is selected when SSLEnabled is set to true, the port will automatically be changed to the default port for AMQP with SSL (5671). Likewise, if port 5671 is selected when SSLEnabled is set to false, the port will automatically be changed to the default port. If the port has been set to any value other than the default values, it will remain the same when the value of SSLEnabled changes.

This property is not available at design time.

Data Type

Boolean

SSLProvider Property (AMQPClassic Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int ipworksiot_amqpclassic_getsslprovider(void* lpObj);
int ipworksiot_amqpclassic_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (AMQPClassic Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

int ipworksiot_amqpclassic_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Binary String

Timeout Property (AMQPClassic Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int ipworksiot_amqpclassic_gettimeout(void* lpObj);
int ipworksiot_amqpclassic_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

60

Remarks

If the Timeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.

If Timeout is set to a positive value, data is sent in a blocking manner and the class will wait for the operation to complete before returning control. The class will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

User Property (AMQPClassic Class)

A username to use for SASL authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetUser();
int SetUser(const char* lpszUser);

Unicode (Windows)
LPWSTR GetUser();
INT SetUser(LPCWSTR lpszUser);

char* ipworksiot_amqpclassic_getuser(void* lpObj);
int ipworksiot_amqpclassic_setuser(void* lpObj, const char* lpszUser);

QString GetUser();
int SetUser(QString qsUser);

Default Value

""

Remarks

This property contains a username to use for SASL authentication.

This property is not available at design time.

Data Type

String

VirtualHost Property (AMQPClassic Class)

The virtual host to connect to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetVirtualHost();
int SetVirtualHost(const char* lpszVirtualHost);

Unicode (Windows)
LPWSTR GetVirtualHost();
INT SetVirtualHost(LPCWSTR lpszVirtualHost);

char* ipworksiot_amqpclassic_getvirtualhost(void* lpObj);
int ipworksiot_amqpclassic_setvirtualhost(void* lpObj, const char* lpszVirtualHost);

QString GetVirtualHost();
int SetVirtualHost(QString qsVirtualHost);

Default Value

"/"

Remarks

This property specifies the virtual host to connect to on the server, and is set to / by default.

Note that the configuration of the server defines what virtual hosts are available.

This setting cannot be changed while connected.

This property is not available at design time.

Data Type

String

BindQueue Method (AMQPClassic Class)

Binds a queue to an exchange.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int BindQueue(const char* lpszChannelName, const char* lpszQueueName, const char* lpszExchangeName, const char* lpszRoutingKey, int bNoWait);

Unicode (Windows)
INT BindQueue(LPCWSTR lpszChannelName, LPCWSTR lpszQueueName, LPCWSTR lpszExchangeName, LPCWSTR lpszRoutingKey, BOOL bNoWait);

int ipworksiot_amqpclassic_bindqueue(void* lpObj, const char* lpszChannelName, const char* lpszQueueName, const char* lpszExchangeName, const char* lpszRoutingKey, int bNoWait);

int BindQueue(const QString& qsChannelName, const QString& qsQueueName, const QString& qsExchangeName, const QString& qsRoutingKey, bool bNoWait);

Remarks

This method is used to bind the queue named QueueName to the exchange named ExchangeName. Exchanges use bindings to determine which queues to route messages to.

Multiple bindings between the same queue and exchange with different RoutingKeys and/or arguments are allowed; requests that would create a duplicate binding are ignored. No queue will ever receive duplicate copies of any message, regardless of what bindings are present on the server.

Note that all AMQP 0.9.1 servers automatically bind all queues to their default exchange (which is always a direct exchange with no name) using each queue's name as the binding's routing key. This makes it easy to send a message to a specific queue without having to declare bindings; just call PublishMessage, pass empty string for ExchangeName, and the name of the desired queue for RoutingKey.

ChannelName controls what channel the class will send the request over. While any channel can technically be used, keep in mind that the server will close it if a channel error occurs. For this reason, it is good practice to make requests such as this one using a channel that is not involved in message publishing or consumption.

QueueName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters.

The server's default exchange may be specified by passing empty string for ExchangeName. Otherwise, ExchangeName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters.

The RoutingKey parameter specifies the binding's routing key. Exchanges that use routing-key-based logic make some sort of comparison between the routing keys of incoming messages and this value to decide which messages should be forwarded to the specified queue. Examples of exchange types which use routing keys include:

• direct exchanges, which compare (for equality) the routing keys of incoming messages to the routing keys of each queue bound to them.
• topic exchanges, which match the routing keys of incoming messages against the routing pattern of each queue bound to them.

Not all exchange types make use of routing keys, in which case empty string can be passed for the RoutingKey parameter. Examples of exchange types which don't use routing keys include:

• fanout exchanges simply forward incoming messages to all queues bound to them, unconditionally.
• header exchanges only forward messages that include certain headers. When binding a queue to a header exchange, add items to the Argument* properties to describe the headers that eligible messages must have, and whether they must have any or all of those headers.

Note that the format of the RoutingKey parameter and/or the content of the Argument* properties may differ slightly between server implementations. Refer to your server's documentation to determine what it expects to receive for each exchange type that it supports.

The NoWait parameter, if True, will cause the server to execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error.

An exception is thrown if no channel with the given ChannelName exists, or if the server returns an error because:

• No queue with the given QueueName exists.
• No exchange with the given ExchangeName exists.

Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic class's Error Codes page includes AMQP's various connection and channel errors.

Binding a Queue to an Exchange // Bind a queue to an exchange. Messages will only be delivered to the queue if their routing key is "MyRoutingKey". amqpc1.BindQueue("channel", "MyQueue", "MyExchange", "MyRoutingKey", false);

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CancelConsume Method (AMQPClassic Class)

Cancels an existing consumer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CancelConsume(const char* lpszChannelName, const char* lpszConsumerTag, int bNoWait);

Unicode (Windows)
INT CancelConsume(LPCWSTR lpszChannelName, LPCWSTR lpszConsumerTag, BOOL bNoWait);

int ipworksiot_amqpclassic_cancelconsume(void* lpObj, const char* lpszChannelName, const char* lpszConsumerTag, int bNoWait);

int CancelConsume(const QString& qsChannelName, const QString& qsConsumerTag, bool bNoWait);

Remarks

This method requests that the server cancel the consumer identified by the given ConsumerTag on the channel specified by ChannelName.

The NoWait parameter, if True, will cause the server to execute the request asynchronously. For asynchronous request handling, the server only sends back a response in case of an error.

An exception is thrown if no channel with the given ChannelName exists, or if the server returns an error because no consumer with the given ConsumerTag exists.

Note that in AMQP, server errors are grouped into "connection errors" and "channel errors", and both are fatal. That is, if the server returns a channel error, it will then close the channel which caused the error; and if it returns a connection error, it will then close the connection. The AMQPClassic class's Error Codes page includes AMQP's various connection and channel errors.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CloseChannel Method (AMQPClassic Class)

Closes a channel.

Syntax

• C++
• C
• Qt