AMQP Class

Properties   Methods   Events   Config Settings   Errors  

An easy-to-use AMQP 1.0 client implementation.

Syntax

AMQP

Remarks

The AMQP class provides an easy-to-use AMQP 1.0 client implementation. The class supports both plaintext and TLS-enabled connections over TCP.

Connecting

The class implements all three layers of the AMQP 1.0 transport protocol, so the first step is to initiate the overall connection. Set the ContainerId property and call the ConnectTo method, passing it the server's hostname and port number.

Once connected, the next step is to create at least one session, which can be accomplished by using the CreateSession method. The class allows creating any number of sessions, up to the limit specified by the MaxSessionCount configuration setting.

Connecting and Creating a Session amqp1.ContainerId = "testClient"; amqp1.ConnectTo("amqp.test-server.com", 5672); amqp1.CreateSession("TestSession");

After creating a session, the next step is to create one or more links (which are created in the context of a session) so that messages can be sent and/or received. Links are unidirectional, so each one has a sender on one end and a receiver on the other.

The class can function both as a sender node (by opening sender links) and as a receiver node (by opening receiver links). But keep in mind that, since the class is implemented as an AMQP 1.0 client, it must be the one to open links (said another way, the class cannot accept any link requests made by other peers).

As with sessions, the class allows creating any number of links for each session, up to the limit specified by the MaxLinkCountPerSession configuration setting.

Creating Sender Links

The LinkReadyToSend event will fire when the newly created sender link is ready to send messages.

Creating a Sender Link amqp1.OnLinkReadyToSend += (s, e) => { Console.WriteLine("Link '" + e.LinkName + "' is ready to send messages!"); }; amqp1.CreateSenderLink("TestSession", "TestSenderLink", "TestTarget");

Sending Messages

At minimum, the MessageValue and MessageValueType properties must be set. All other properties are optional, though specifying a unique value for MessageId is recommended. (If the GenerateMessageId configuration setting is enabled, the class will generate one automatically when the message is sent.)

Once the Message* properties have be assigned as desired, call the SendMessage method, passing it the name of an existing sender link on which the message should be sent.

The MessageOut event will be fired when the message has been sent (and acknowledged, if MessageSettled was set to false). The MessageOutcome event may also fire, if necessary, once the receiver reports the outcome of the message.

Refer to SendMessage, MessageOut, and MessageOutcome for more information.

Sending a Message amqp1.OnMessageOut += (s, e) => { Console.WriteLine("Message with Id '" + e.MessageId + "' has been sent on link '" + e.LinkName + "'."); }; amqp1.Message.MessageId = "TestMessageId"; amqp1.Message.Value = "Hello, world!"; amqp1.Message.ValueType = AMQPValueTypes.mvtString; amqp1.SendMessage("TestSenderLink");

The ResetMessage method can be used to reset the Message* properties to their default values.

Sending Composite AMQP Data

The class supports sending composite AMQP data in a message through the use of JSON with a well-defined schema. Refer to the SendMessage method's documentation for more information and examples.

Creating Receiver Links

The ReceiveMode property controls which receive mode newly-created receiver links will use; refer to its documentation for more information.

After ensuring that ReceiveMode is set as desired, call CreateReceiverLink, passing it the name of an existing session, a unique name for the link, and (if necessary in your environment) the name of a source for the sender to route the link creation request to.

Creating a Receiver Link // Creating an automatic receiver link. amqp1.ReceiveMode = AmqpReceiveModes.rmAutomatic; amqp1.CreateReceiverLink("TestSession", "TestAutoReceiverLink", "TestSource1"); // Creating a fetch-based receiver link. amqp1.ReceiveMode = AmqpReceiveModes.rmFetch; amqp1.CreateReceiverLink("TestSession", "TestFetchReceiverLink", "TestSource2");

Receiving Messages

For receiver links created in fetch-based mode, the class will attempt to "fetch" a message each time the FetchMessage method is called (optionally timing out after a time, if FetchTimeout is non-zero). When calling FetchMessage, pass it the name of a fetch-based receiver link.

Regardless of whether a messages is received automatically or fetched, any incoming message will cause the class to fire the MessageIn event and update the ReceivedMessage* properties.

When the MessageIn event fires, its State event parameter can be used to specify the outcome of the message, which the class will then transmit back to the sender (as well as self-report by firing the MessageOutcome event). Refer to MessageIn for more information.

Receiving a Message // For automatic receiver links, only the event handler is necessary. amqp1.OnMessageIn += (s, e) => { Console.WriteLine("Message with Id '" + e.MessageId + "' has been received on link '" + e.LinkName + "'. Value:"); Console.WriteLine(amqp1.ReceivedMessage.Value); // The message state is already set to the "Accepted" outcome by default, but we'll set it again // for the purpose of this example. e.State = 0; // 0 = Accepted. }; // For fetch-based links, it's also necessary to call FetchMessage(). It is recommended that the // FetchTimeout property be set to a non-zero value (60 seconds is the default) so that the fetch // request will eventually time out if the sender doesn't have any messages available to deliver. amqp1.FetchTimeout = 60; amqp1.FetchMessage("TestFetchReceiverLink");

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.

AuthScheme Property (AMQP 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_amqp_getauthscheme(void* lpObj);
int ipworksiot_amqp_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

Connected Property (AMQP 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_amqp_getconnected(void* lpObj);
int ipworksiot_amqp_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

ContainerId Property (AMQP Class)

The container Id the class should advertise when connecting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetContainerId();
int SetContainerId(const char* lpszContainerId);

Unicode (Windows)
LPWSTR GetContainerId();
INT SetContainerId(LPCWSTR lpszContainerId);

char* ipworksiot_amqp_getcontainerid(void* lpObj);
int ipworksiot_amqp_setcontainerid(void* lpObj, const char* lpszContainerId);

QString GetContainerId();
int SetContainerId(QString qsContainerId);

Default Value

""

Remarks

This property specifies the container Id that the class should advertise when it's connecting to the remote host.

In AMQP, the top-level organizational grouping is called a "container", and each container can contain zero or more "nodes", which are the actual entities which send and receive messages over links.

Since this class handles multiple layers of the AMQP transport protocol (the overall connection, the sessions in that connection, and the links attached to those sessions), it must be given a unique container Id.

Note: The container Id cannot be changed while connected.

This property is not available at design time.

Data Type

String

FetchTimeout Property (AMQP Class)

How long the class should wait for a message to be received after FetchMessage is called.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFetchTimeout();
int SetFetchTimeout(int iFetchTimeout);

Unicode (Windows)
INT GetFetchTimeout();
INT SetFetchTimeout(INT iFetchTimeout);

int ipworksiot_amqp_getfetchtimeout(void* lpObj);
int ipworksiot_amqp_setfetchtimeout(void* lpObj, int iFetchTimeout);

int GetFetchTimeout();
int SetFetchTimeout(int iFetchTimeout);

Default Value

60

Remarks

This property controls how long, in seconds, the class will wait for a message to be received after FetchMessage is called before timing out the request. If set to zero, the class will wait indefinitely.

Refer to FetchMessage for more information.

This property is not available at design time.

Data Type

Integer

FirewallAutoDetect Property (AMQP 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_amqp_getfirewallautodetect(void* lpObj);
int ipworksiot_amqp_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 (AMQP 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_amqp_getfirewalltype(void* lpObj);
int ipworksiot_amqp_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 (AMQP 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_amqp_getfirewallhost(void* lpObj);
int ipworksiot_amqp_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 (AMQP 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_amqp_getfirewallpassword(void* lpObj);
int ipworksiot_amqp_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 (AMQP 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_amqp_getfirewallport(void* lpObj);
int ipworksiot_amqp_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 (AMQP 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_amqp_getfirewalluser(void* lpObj);
int ipworksiot_amqp_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

IdleTimeout Property (AMQP Class)

The maximum period of inactivity the class will allow before disconnecting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdleTimeout();
int SetIdleTimeout(int iIdleTimeout);

Unicode (Windows)
INT GetIdleTimeout();
INT SetIdleTimeout(INT iIdleTimeout);

int ipworksiot_amqp_getidletimeout(void* lpObj);
int ipworksiot_amqp_setidletimeout(void* lpObj, int iIdleTimeout);

int GetIdleTimeout();
int SetIdleTimeout(int iIdleTimeout);

Default Value

0

Remarks

This property controls how long, in seconds, the class will allow the connection to sit idle before it disconnects from the remote host.

This property may be set to 0 to prevent the class from ever closing the connection due to inactivity.

Note: The idle timeout cannot be changed while connected.

This property is not available at design time.

Data Type

Integer

IncomingMessageCount Property (AMQP Class)

The number of records in the IncomingMessage arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIncomingMessageCount();

Unicode (Windows)
INT GetIncomingMessageCount();

int ipworksiot_amqp_getincomingmessagecount(void* lpObj);

int GetIncomingMessageCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• IncomingMessageAbsoluteExpiryTime
• IncomingMessageContentEncoding
• IncomingMessageContentType
• IncomingMessageCorrelationId
• IncomingMessageCreationTime
• IncomingMessageDeliveryCount
• IncomingMessageDurable
• IncomingMessageFirstAcquirer
• IncomingMessageGroupId
• IncomingMessageGroupSequence
• IncomingMessageId
• IncomingMessageLinkName
• IncomingMessagePriority
• IncomingMessageReplyTo
• IncomingMessageReplyToGroupId
• IncomingMessageSettled
• IncomingMessageSubject
• IncomingMessageTo
• IncomingMessageTTL
• IncomingMessageUserId
• IncomingMessageValue
• IncomingMessageValueType

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

IncomingMessageAbsoluteExpiryTime Property (AMQP Class)

The absolute time at which this message should be considered expired.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LONG64 GetIncomingMessageAbsoluteExpiryTime(INT iIncomingMessageIndex);

int64 ipworksiot_amqp_getincomingmessageabsoluteexpirytime(void* lpObj, int incomingmessageindex);

qint64 GetIncomingMessageAbsoluteExpiryTime(int iIncomingMessageIndex);

Default Value

0

Remarks

The absolute time at which this message should be considered expired.

This property specifies the absolute time at which this message should be considered expired. It may be -1 if this message does not have an absolute expiry time.

This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).

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

IncomingMessageContentEncoding Property (AMQP Class)

The content encoding of this message's data.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetIncomingMessageContentEncoding(INT iIncomingMessageIndex);

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

QString GetIncomingMessageContentEncoding(int iIncomingMessageIndex);

Default Value

""

Remarks

The content encoding of this message's data.

This property specifies the content encoding of this message's data. It may be empty if this message does not have a content encoding set.

When constructing a message for sending, this property is ignored if IncomingMessageValueType is not set to mvtBinary (16).

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 (AMQP Class)

The content type of this message's data.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetIncomingMessageContentType(INT iIncomingMessageIndex);

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

QString GetIncomingMessageContentType(int iIncomingMessageIndex);

Default Value

""

Remarks

The content type of this message's data.

This property specifies the content type of this message's data. It may be empty if this message does not have a content type set.

When constructing a message for sending, this property is ignored if IncomingMessageValueType is not set to mvtBinary (16).

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 (AMQP Class)

The correlation Id of this message.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetIncomingMessageCorrelationId(INT iIncomingMessageIndex);

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

QString GetIncomingMessageCorrelationId(int iIncomingMessageIndex);

Default Value

""

Remarks

The correlation Id of this message.

This property specifies the correlation Id of this message. It may be empty if this message does not have a correlation Id.

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

IncomingMessageCreationTime Property (AMQP Class)

The creation time of this message.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LONG64 GetIncomingMessageCreationTime(INT iIncomingMessageIndex);

int64 ipworksiot_amqp_getincomingmessagecreationtime(void* lpObj, int incomingmessageindex);

qint64 GetIncomingMessageCreationTime(int iIncomingMessageIndex);

Default Value

0

Remarks

The creation time of this message.

This property specifies the absolute creation time of this message. It may be -1 if this message does not have a creation time set.

This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).

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

IncomingMessageDeliveryCount Property (AMQP Class)

How many previous attempts there have been to deliver this message.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LONG64 GetIncomingMessageDeliveryCount(INT iIncomingMessageIndex);

int64 ipworksiot_amqp_getincomingmessagedeliverycount(void* lpObj, int incomingmessageindex);

qint64 GetIncomingMessageDeliveryCount(int iIncomingMessageIndex);

Default Value

0

Remarks

How many previous attempts there have been to deliver this message.

This property indicates how many (unsuccessful) previous attempts there have been to deliver this message.

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

IncomingMessageDurable Property (AMQP Class)

Whether this message is durable.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
BOOL GetIncomingMessageDurable(INT iIncomingMessageIndex);

int ipworksiot_amqp_getincomingmessagedurable(void* lpObj, int incomingmessageindex);

bool GetIncomingMessageDurable(int iIncomingMessageIndex);

Default Value

FALSE

Remarks

Whether this message is durable.

This property specifies whether this message is durable or not.

If a message is marked as durable, any intermediate nodes which cannot guarantee that the message won't be lost under any circumstances will not accept the message.

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

Boolean

IncomingMessageFirstAcquirer Property (AMQP Class)

Whether this message may have been acquired by other links previously.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
BOOL GetIncomingMessageFirstAcquirer(INT iIncomingMessageIndex);

int ipworksiot_amqp_getincomingmessagefirstacquirer(void* lpObj, int incomingmessageindex);

bool GetIncomingMessageFirstAcquirer(int iIncomingMessageIndex);

Default Value

FALSE

Remarks

Whether this message may have been acquired by other links previously.

This property specifies whether this message might have previously been acquired by other links.

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

Boolean

IncomingMessageGroupId Property (AMQP Class)

The Id of the group this message belongs to.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetIncomingMessageGroupId(INT iIncomingMessageIndex);

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

QString GetIncomingMessageGroupId(int iIncomingMessageIndex);

Default Value

""

Remarks

The Id of the group this message belongs to.

This property specifies the Id of the group that this message belongs to. It may be empty if this message does not belong to a group.

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

IncomingMessageGroupSequence Property (AMQP Class)

The position of this message within its group.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LONG64 GetIncomingMessageGroupSequence(INT iIncomingMessageIndex);

int64 ipworksiot_amqp_getincomingmessagegroupsequence(void* lpObj, int incomingmessageindex);

qint64 GetIncomingMessageGroupSequence(int iIncomingMessageIndex);

Default Value

0

Remarks

The position of this message within its group.

This property specifies the relative position of this message within its group. It may be -1 if this message does not belong to a group.

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

IncomingMessageLinkName Property (AMQP Class)

The name of the link this message is associated with.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetIncomingMessageLinkName(INT iIncomingMessageIndex);

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

QString GetIncomingMessageLinkName(int iIncomingMessageIndex);

Default Value

""

Remarks

The name of the link this message is associated with.

This property holds the name of the link which this message is being sent/was received on.

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 (AMQP Class)

The unique Id of this message.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetIncomingMessageId(INT iIncomingMessageIndex);

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

QString GetIncomingMessageId(int iIncomingMessageIndex);

Default Value

""

Remarks

The unique Id of this message.

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

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 (AMQP Class)

The priority of this message.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT GetIncomingMessagePriority(INT iIncomingMessageIndex);

int ipworksiot_amqp_getincomingmessagepriority(void* lpObj, int incomingmessageindex);

int GetIncomingMessagePriority(int iIncomingMessageIndex);

Default Value

4

Remarks

The priority of this message.

This property holds the priority of this message; the default is 4 (as defined by the AMQP specification).

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 (AMQP Class)

The address of the node to send replies to for this message.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetIncomingMessageReplyTo(INT iIncomingMessageIndex);

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

QString GetIncomingMessageReplyTo(int iIncomingMessageIndex);

Default Value

""

Remarks

The address of the node to send replies to for this message.

This property specifies the address of the node to send replies to for this message. It may be empty if this message does not have a specific reply-to node address.

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

IncomingMessageReplyToGroupId Property (AMQP Class)

The Id of the group to send replies to for this message.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetIncomingMessageReplyToGroupId(INT iIncomingMessageIndex);

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

QString GetIncomingMessageReplyToGroupId(int iIncomingMessageIndex);

Default Value

""

Remarks

The Id of the group to send replies to for this message.

This property specifies the Id of the group to send replies to for this message. It may be empty if there is not a specific reply-to group for this message.

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

IncomingMessageSettled Property (AMQP Class)

Whether this message is settled.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
BOOL GetIncomingMessageSettled(INT iIncomingMessageIndex);

int ipworksiot_amqp_getincomingmessagesettled(void* lpObj, int incomingmessageindex);

bool GetIncomingMessageSettled(int iIncomingMessageIndex);

Default Value

TRUE

Remarks

Whether this message is settled.

This property specifies whether this message is settled or not.

Note that, when constructing a message for sending, this property is ignored if the send settle mode of the link it is sent on is not Mixed (2).

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

Boolean

IncomingMessageSubject Property (AMQP Class)

The subject of this message.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetIncomingMessageSubject(INT iIncomingMessageIndex);

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

QString GetIncomingMessageSubject(int iIncomingMessageIndex);

Default Value

""

Remarks

The subject of this message.

This property specifies the subject of this message. It may be empty if this message does not have a subject 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

String

IncomingMessageTo Property (AMQP Class)

The address of the node which this message is intended for.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetIncomingMessageTo(INT iIncomingMessageIndex);

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

QString GetIncomingMessageTo(int iIncomingMessageIndex);

Default Value

""

Remarks

The address of the node which this message is intended for.

This property specifies the address of the node which this message is intended to be delivered to. It my be empty if this message is not intended for a specific destination node.

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

IncomingMessageTTL Property (AMQP Class)

The time-to-live value for this message.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LONG64 GetIncomingMessageTTL(INT iIncomingMessageIndex);

int64 ipworksiot_amqp_getincomingmessagettl(void* lpObj, int incomingmessageindex);

qint64 GetIncomingMessageTTL(int iIncomingMessageIndex);

Default Value

-1

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

Long64

IncomingMessageUserId Property (AMQP Class)

The identity of the user responsible for producing this message.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetIncomingMessageUserId(INT iIncomingMessageIndex);

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

QString GetIncomingMessageUserId(int iIncomingMessageIndex);

Default Value

""

Remarks

The identity of the user responsible for producing this message.

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

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

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

IncomingMessageValue Property (AMQP Class)

This message's value.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetIncomingMessageValue(INT iIncomingMessageIndex);

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

QString GetIncomingMessageValue(int iIncomingMessageIndex);

Default Value

""

Remarks

This message's value.

This property specifies the value to send in this message. The IncomingMessageValueType property should be used to specify the data type of the value.

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

IncomingMessageValueType Property (AMQP Class)

This message's value data type.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT GetIncomingMessageValueType(INT iIncomingMessageIndex);

MVT_NULL(0), 
MVT_BOOLEAN(1), 
MVT_UBYTE(2), 
MVT_USHORT(3), 
MVT_UINT(4), 
MVT_ULONG(5), 
MVT_BYTE(6), 
MVT_SHORT(7), 
MVT_INT(8), 
MVT_LONG(9), 
MVT_FLOAT(10), 
MVT_DOUBLE(11), 
MVT_DECIMAL(12), 
MVT_CHAR(13), 
MVT_TIMESTAMP(14), 
MVT_UUID(15), 
MVT_BINARY(16), 
MVT_STRING(17), 
MVT_SYMBOL(18), 
MVT_JSON(19)

int ipworksiot_amqp_getincomingmessagevaluetype(void* lpObj, int incomingmessageindex);

int GetIncomingMessageValueType(int iIncomingMessageIndex);

Default Value

0

Remarks

This message's value data type.

This property specifies the data type of this message's IncomingMessageValue.

The table below shows the possible value types, their descriptions, and how to format the data assigned to IncomingMessageValue. All numeric value types should use their standard string formatting (except for the mvtDecimal (12) type, which should be specified as hex-encoded bytes).

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

LinkCount Property (AMQP Class)

The number of records in the Link arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLinkCount();

Unicode (Windows)
INT GetLinkCount();

int ipworksiot_amqp_getlinkcount(void* lpObj);

int GetLinkCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• LinkAvailable
• LinkChannelName
• LinkCredit
• LinkDeliveryCount
• LinkName
• LinkReadyToSend
• LinkReceiveMode
• LinkRole

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

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

Data Type

Integer

LinkAvailable Property (AMQP Class)

The number of messages which this link's sender could send if it had credit for them.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetLinkAvailable(int iLinkIndex);

Unicode (Windows)
LONG64 GetLinkAvailable(INT iLinkIndex);

int64 ipworksiot_amqp_getlinkavailable(void* lpObj, int linkindex);

qint64 GetLinkAvailable(int iLinkIndex);

Default Value

0

Remarks

The number of messages which this link's sender could send if it had credit for them.

This property returns the number of messages which this link's sender has indicated that it could send if it had the credit to do so.

The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

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

Data Type

Long64

LinkChannelName Property (AMQP Class)

The channel name this link is using.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLinkChannelName(int iLinkIndex);

Unicode (Windows)
LPWSTR GetLinkChannelName(INT iLinkIndex);

char* ipworksiot_amqp_getlinkchannelname(void* lpObj, int linkindex);

QString GetLinkChannelName(int iLinkIndex);

Default Value

""

Remarks

The channel name this link is using.

This property holds the channel name this link is using.

The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

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

Data Type

String

LinkCredit Property (AMQP Class)

The amount of credit currently available to this link's sender.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetLinkCredit(int iLinkIndex);

Unicode (Windows)
LONG64 GetLinkCredit(INT iLinkIndex);

int64 ipworksiot_amqp_getlinkcredit(void* lpObj, int linkindex);

qint64 GetLinkCredit(int iLinkIndex);

Default Value

0

Remarks

The amount of credit currently available to this link's sender.

This property holds the amount of credit currently available to this link's sender. The sender on a link can only send messages if it has non-zero credit.

The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

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

Data Type

Long64

LinkDeliveryCount Property (AMQP Class)

The current delivery count value for this link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetLinkDeliveryCount(int iLinkIndex);

Unicode (Windows)
LONG64 GetLinkDeliveryCount(INT iLinkIndex);

int64 ipworksiot_amqp_getlinkdeliverycount(void* lpObj, int linkindex);

qint64 GetLinkDeliveryCount(int iLinkIndex);

Default Value

0

Remarks

The current delivery count value for this link.

This property holds the current delivery count value for this link.

The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

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

Data Type

Long64

LinkName Property (AMQP Class)

This link's name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLinkName(int iLinkIndex);

Unicode (Windows)
LPWSTR GetLinkName(INT iLinkIndex);

char* ipworksiot_amqp_getlinkname(void* lpObj, int linkindex);

QString GetLinkName(int iLinkIndex);

Default Value

""

Remarks

This link's name.

This property holds this link's name.

The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

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

Data Type

String

LinkReadyToSend Property (AMQP Class)

Whether this link is ready to send a message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLinkReadyToSend(int iLinkIndex);

Unicode (Windows)
BOOL GetLinkReadyToSend(INT iLinkIndex);

int ipworksiot_amqp_getlinkreadytosend(void* lpObj, int linkindex);

bool GetLinkReadyToSend(int iLinkIndex);

Default Value

FALSE

Remarks

Whether this link is ready to send a message.

This property reflects whether this link is currently ready to send a message or not; it always returns False if LinkRole is lrReceiver (1).

The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

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

Data Type

Boolean

LinkReceiveMode Property (AMQP Class)

The receive mode this link is operating in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLinkReceiveMode(int iLinkIndex);

Unicode (Windows)
INT GetLinkReceiveMode(INT iLinkIndex);

LRM_AUTOMATIC(0), 
LRM_FETCH(1)

int ipworksiot_amqp_getlinkreceivemode(void* lpObj, int linkindex);

int GetLinkReceiveMode(int iLinkIndex);

Default Value

0

Remarks

The receive mode this link is operating in.

This property reflects the receive mode which this link is operating in, if it is a receiver link. (For sender links, this property's value means nothing.) Values can be:

• lrmAutomatic - Messages will be received automatically
• lrmFetch - One message will be received after each call to the FetchMessage method.

Refer to ReceiveMode for more information.

The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

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

Data Type

Integer

LinkRole Property (AMQP Class)

The class's role on this link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLinkRole(int iLinkIndex);

Unicode (Windows)
INT GetLinkRole(INT iLinkIndex);

LR_SENDER(0), 
LR_RECEIVER(1)

int ipworksiot_amqp_getlinkrole(void* lpObj, int linkindex);

int GetLinkRole(int iLinkIndex);

Default Value

0

Remarks

The class's role on this link.

This property reflects which role the class is in for this link. Valid values are:

• lrSender (0)
• lrReceiver (1)

The LinkIndex parameter specifies the index of the item in the array. The size of the array is controlled by the LinkCount property.

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

Data Type

Integer

LocalHost Property (AMQP 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_amqp_getlocalhost(void* lpObj);
int ipworksiot_amqp_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 (AMQP 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_amqp_getlocalport(void* lpObj);
int ipworksiot_amqp_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

MessageAbsoluteExpiryTime Property (AMQP Class)

The absolute time at which this message should be considered expired.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetMessageAbsoluteExpiryTime();
int SetMessageAbsoluteExpiryTime(int64 lMessageAbsoluteExpiryTime);

Unicode (Windows)
LONG64 GetMessageAbsoluteExpiryTime();
INT SetMessageAbsoluteExpiryTime(LONG64 lMessageAbsoluteExpiryTime);

int64 ipworksiot_amqp_getmessageabsoluteexpirytime(void* lpObj);
int ipworksiot_amqp_setmessageabsoluteexpirytime(void* lpObj, int64 lMessageAbsoluteExpiryTime);

qint64 GetMessageAbsoluteExpiryTime();
int SetMessageAbsoluteExpiryTime(qint64 lMessageAbsoluteExpiryTime);

Default Value

0

Remarks

The absolute time at which this message should be considered expired.

This property specifies the absolute time at which this message should be considered expired. It may be -1 if this message does not have an absolute expiry time.

This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).

This property is not available at design time.

Data Type

Long64

MessageContentEncoding Property (AMQP Class)

The content encoding of this message's data.

Syntax

• C++
• C
• Qt

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

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

char* ipworksiot_amqp_getmessagecontentencoding(void* lpObj);
int ipworksiot_amqp_setmessagecontentencoding(void* lpObj, const char* lpszMessageContentEncoding);

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

Default Value

""

Remarks

The content encoding of this message's data.

This property specifies the content encoding of this message's data. It may be empty if this message does not have a content encoding set.

When constructing a message for sending, this property is ignored if MessageValueType is not set to mvtBinary (16).

This property is not available at design time.

Data Type

String

MessageContentType Property (AMQP Class)

The content type of this message's data.

Syntax

• C++
• C
• Qt

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

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

char* ipworksiot_amqp_getmessagecontenttype(void* lpObj);
int ipworksiot_amqp_setmessagecontenttype(void* lpObj, const char* lpszMessageContentType);

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

Default Value

""

Remarks

The content type of this message's data.

This property specifies the content type of this message's data. It may be empty if this message does not have a content type set.

When constructing a message for sending, this property is ignored if MessageValueType is not set to mvtBinary (16).

This property is not available at design time.

Data Type

String

MessageCorrelationId Property (AMQP Class)

The correlation Id of this 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_amqp_getmessagecorrelationid(void* lpObj);
int ipworksiot_amqp_setmessagecorrelationid(void* lpObj, const char* lpszMessageCorrelationId);

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

Default Value

""

Remarks

The correlation Id of this message.

This property specifies the correlation Id of this message. It may be empty if this message does not have a correlation Id.

This property is not available at design time.

Data Type

String

MessageCreationTime Property (AMQP Class)

The creation time of this message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetMessageCreationTime();
int SetMessageCreationTime(int64 lMessageCreationTime);

Unicode (Windows)
LONG64 GetMessageCreationTime();
INT SetMessageCreationTime(LONG64 lMessageCreationTime);

int64 ipworksiot_amqp_getmessagecreationtime(void* lpObj);
int ipworksiot_amqp_setmessagecreationtime(void* lpObj, int64 lMessageCreationTime);

qint64 GetMessageCreationTime();
int SetMessageCreationTime(qint64 lMessageCreationTime);

Default Value

0

Remarks

The creation time of this message.

This property specifies the absolute creation time of this message. It may be -1 if this message does not have a creation time set.

This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).

This property is not available at design time.

Data Type

Long64

MessageDeliveryCount Property (AMQP Class)

How many previous attempts there have been to deliver this message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetMessageDeliveryCount();
int SetMessageDeliveryCount(int64 lMessageDeliveryCount);

Unicode (Windows)
LONG64 GetMessageDeliveryCount();
INT SetMessageDeliveryCount(LONG64 lMessageDeliveryCount);

int64 ipworksiot_amqp_getmessagedeliverycount(void* lpObj);
int ipworksiot_amqp_setmessagedeliverycount(void* lpObj, int64 lMessageDeliveryCount);

qint64 GetMessageDeliveryCount();
int SetMessageDeliveryCount(qint64 lMessageDeliveryCount);

Default Value

0

Remarks

How many previous attempts there have been to deliver this message.

This property indicates how many (unsuccessful) previous attempts there have been to deliver this message.

This property is not available at design time.

Data Type

Long64

MessageDurable Property (AMQP Class)

Whether this message is durable.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessageDurable();
int SetMessageDurable(int bMessageDurable);

Unicode (Windows)
BOOL GetMessageDurable();
INT SetMessageDurable(BOOL bMessageDurable);

int ipworksiot_amqp_getmessagedurable(void* lpObj);
int ipworksiot_amqp_setmessagedurable(void* lpObj, int bMessageDurable);

bool GetMessageDurable();
int SetMessageDurable(bool bMessageDurable);

Default Value

FALSE

Remarks

Whether this message is durable.

This property specifies whether this message is durable or not.

If a message is marked as durable, any intermediate nodes which cannot guarantee that the message won't be lost under any circumstances will not accept the message.

This property is not available at design time.

Data Type

Boolean

MessageFirstAcquirer Property (AMQP Class)

Whether this message may have been acquired by other links previously.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessageFirstAcquirer();
int SetMessageFirstAcquirer(int bMessageFirstAcquirer);

Unicode (Windows)
BOOL GetMessageFirstAcquirer();
INT SetMessageFirstAcquirer(BOOL bMessageFirstAcquirer);

int ipworksiot_amqp_getmessagefirstacquirer(void* lpObj);
int ipworksiot_amqp_setmessagefirstacquirer(void* lpObj, int bMessageFirstAcquirer);

bool GetMessageFirstAcquirer();
int SetMessageFirstAcquirer(bool bMessageFirstAcquirer);

Default Value

FALSE

Remarks

Whether this message may have been acquired by other links previously.

This property specifies whether this message might have previously been acquired by other links.

This property is not available at design time.

Data Type

Boolean

MessageGroupId Property (AMQP Class)

The Id of the group this message belongs to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageGroupId();
int SetMessageGroupId(const char* lpszMessageGroupId);

Unicode (Windows)
LPWSTR GetMessageGroupId();
INT SetMessageGroupId(LPCWSTR lpszMessageGroupId);

char* ipworksiot_amqp_getmessagegroupid(void* lpObj);
int ipworksiot_amqp_setmessagegroupid(void* lpObj, const char* lpszMessageGroupId);

QString GetMessageGroupId();
int SetMessageGroupId(QString qsMessageGroupId);

Default Value

""

Remarks

The Id of the group this message belongs to.

This property specifies the Id of the group that this message belongs to. It may be empty if this message does not belong to a group.

This property is not available at design time.

Data Type

String

MessageGroupSequence Property (AMQP Class)

The position of this message within its group.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetMessageGroupSequence();
int SetMessageGroupSequence(int64 lMessageGroupSequence);

Unicode (Windows)
LONG64 GetMessageGroupSequence();
INT SetMessageGroupSequence(LONG64 lMessageGroupSequence);

int64 ipworksiot_amqp_getmessagegroupsequence(void* lpObj);
int ipworksiot_amqp_setmessagegroupsequence(void* lpObj, int64 lMessageGroupSequence);

qint64 GetMessageGroupSequence();
int SetMessageGroupSequence(qint64 lMessageGroupSequence);

Default Value

0

Remarks

The position of this message within its group.

This property specifies the relative position of this message within its group. It may be -1 if this message does not belong to a group.

This property is not available at design time.

Data Type

Long64

MessageLinkName Property (AMQP Class)

The name of the link this message is associated with.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageLinkName();

Unicode (Windows)
LPWSTR GetMessageLinkName();

char* ipworksiot_amqp_getmessagelinkname(void* lpObj);

QString GetMessageLinkName();

Default Value

""

Remarks

The name of the link this message is associated with.

This property holds the name of the link which this message is being sent/was received on.

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

Data Type

String

MessageId Property (AMQP Class)

The unique Id of this 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_amqp_getmessageid(void* lpObj);
int ipworksiot_amqp_setmessageid(void* lpObj, const char* lpszMessageId);

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

Default Value

""

Remarks

The unique Id of this message.

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

This property is not available at design time.

Data Type

String

MessagePriority Property (AMQP Class)

The priority of this message.

Syntax

• C++
• C
• Qt

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

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

int ipworksiot_amqp_getmessagepriority(void* lpObj);
int ipworksiot_amqp_setmessagepriority(void* lpObj, int iMessagePriority);

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

Default Value

4

Remarks

The priority of this message.

This property holds the priority of this message; the default is 4 (as defined by the AMQP specification).

This property is not available at design time.

Data Type

Integer

MessageReplyTo Property (AMQP Class)

The address of the node to send replies to for this 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_amqp_getmessagereplyto(void* lpObj);
int ipworksiot_amqp_setmessagereplyto(void* lpObj, const char* lpszMessageReplyTo);

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

Default Value

""

Remarks

The address of the node to send replies to for this message.

This property specifies the address of the node to send replies to for this message. It may be empty if this message does not have a specific reply-to node address.

This property is not available at design time.

Data Type

String

MessageReplyToGroupId Property (AMQP Class)

The Id of the group to send replies to for this message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageReplyToGroupId();
int SetMessageReplyToGroupId(const char* lpszMessageReplyToGroupId);

Unicode (Windows)
LPWSTR GetMessageReplyToGroupId();
INT SetMessageReplyToGroupId(LPCWSTR lpszMessageReplyToGroupId);

char* ipworksiot_amqp_getmessagereplytogroupid(void* lpObj);
int ipworksiot_amqp_setmessagereplytogroupid(void* lpObj, const char* lpszMessageReplyToGroupId);

QString GetMessageReplyToGroupId();
int SetMessageReplyToGroupId(QString qsMessageReplyToGroupId);

Default Value

""

Remarks

The Id of the group to send replies to for this message.

This property specifies the Id of the group to send replies to for this message. It may be empty if there is not a specific reply-to group for this message.

This property is not available at design time.

Data Type

String

MessageSettled Property (AMQP Class)

Whether this message is settled.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessageSettled();
int SetMessageSettled(int bMessageSettled);

Unicode (Windows)
BOOL GetMessageSettled();
INT SetMessageSettled(BOOL bMessageSettled);

int ipworksiot_amqp_getmessagesettled(void* lpObj);
int ipworksiot_amqp_setmessagesettled(void* lpObj, int bMessageSettled);

bool GetMessageSettled();
int SetMessageSettled(bool bMessageSettled);

Default Value

TRUE

Remarks

Whether this message is settled.

This property specifies whether this message is settled or not.

Note that, when constructing a message for sending, this property is ignored if the send settle mode of the link it is sent on is not Mixed (2).

This property is not available at design time.

Data Type

Boolean

MessageSubject Property (AMQP Class)

The subject of this message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageSubject();
int SetMessageSubject(const char* lpszMessageSubject);

Unicode (Windows)
LPWSTR GetMessageSubject();
INT SetMessageSubject(LPCWSTR lpszMessageSubject);

char* ipworksiot_amqp_getmessagesubject(void* lpObj);
int ipworksiot_amqp_setmessagesubject(void* lpObj, const char* lpszMessageSubject);

QString GetMessageSubject();
int SetMessageSubject(QString qsMessageSubject);

Default Value

""

Remarks

The subject of this message.

This property specifies the subject of this message. It may be empty if this message does not have a subject set.

This property is not available at design time.

Data Type

String

MessageTo Property (AMQP Class)

The address of the node which this message is intended for.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageTo();
int SetMessageTo(const char* lpszMessageTo);

Unicode (Windows)
LPWSTR GetMessageTo();
INT SetMessageTo(LPCWSTR lpszMessageTo);

char* ipworksiot_amqp_getmessageto(void* lpObj);
int ipworksiot_amqp_setmessageto(void* lpObj, const char* lpszMessageTo);

QString GetMessageTo();
int SetMessageTo(QString qsMessageTo);

Default Value

""

Remarks

The address of the node which this message is intended for.

This property specifies the address of the node which this message is intended to be delivered to. It my be empty if this message is not intended for a specific destination node.

This property is not available at design time.

Data Type

String

MessageTTL Property (AMQP Class)

The time-to-live value for this message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetMessageTTL();
int SetMessageTTL(int64 lMessageTTL);

Unicode (Windows)
LONG64 GetMessageTTL();
INT SetMessageTTL(LONG64 lMessageTTL);

int64 ipworksiot_amqp_getmessagettl(void* lpObj);
int ipworksiot_amqp_setmessagettl(void* lpObj, int64 lMessageTTL);

qint64 GetMessageTTL();
int SetMessageTTL(qint64 lMessageTTL);

Default Value

-1

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

Long64

MessageUserId Property (AMQP Class)

The identity of the user responsible for producing this 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_amqp_getmessageuserid(void* lpObj);
int ipworksiot_amqp_setmessageuserid(void* lpObj, const char* lpszMessageUserId);

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

Default Value

""

Remarks

The identity of the user responsible for producing this message.

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

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

This property is not available at design time.

Data Type

String

MessageValue Property (AMQP Class)

This message's value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageValue();
int SetMessageValue(const char* lpszMessageValue);

Unicode (Windows)
LPWSTR GetMessageValue();
INT SetMessageValue(LPCWSTR lpszMessageValue);

char* ipworksiot_amqp_getmessagevalue(void* lpObj);
int ipworksiot_amqp_setmessagevalue(void* lpObj, const char* lpszMessageValue);

QString GetMessageValue();
int SetMessageValue(QString qsMessageValue);

Default Value

""

Remarks

This message's value.

This property specifies the value to send in this message. The MessageValueType property should be used to specify the data type of the value.

This property is not available at design time.

Data Type

String

MessageValueType Property (AMQP Class)

This message's value data type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessageValueType();
int SetMessageValueType(int iMessageValueType);

Unicode (Windows)
INT GetMessageValueType();
INT SetMessageValueType(INT iMessageValueType);

MVT_NULL(0), 
MVT_BOOLEAN(1), 
MVT_UBYTE(2), 
MVT_USHORT(3), 
MVT_UINT(4), 
MVT_ULONG(5), 
MVT_BYTE(6), 
MVT_SHORT(7), 
MVT_INT(8), 
MVT_LONG(9), 
MVT_FLOAT(10), 
MVT_DOUBLE(11), 
MVT_DECIMAL(12), 
MVT_CHAR(13), 
MVT_TIMESTAMP(14), 
MVT_UUID(15), 
MVT_BINARY(16), 
MVT_STRING(17), 
MVT_SYMBOL(18), 
MVT_JSON(19)

int ipworksiot_amqp_getmessagevaluetype(void* lpObj);
int ipworksiot_amqp_setmessagevaluetype(void* lpObj, int iMessageValueType);

int GetMessageValueType();
int SetMessageValueType(int iMessageValueType);

Default Value

0

Remarks

This message's value data type.

This property specifies the data type of this message's MessageValue.

The table below shows the possible value types, their descriptions, and how to format the data assigned to MessageValue. All numeric value types should use their standard string formatting (except for the mvtDecimal (12) type, which should be specified as hex-encoded bytes).

This property is not available at design time.

Data Type

Integer

OutgoingMessageCount Property (AMQP Class)

The number of records in the OutgoingMessage arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOutgoingMessageCount();

Unicode (Windows)
INT GetOutgoingMessageCount();

int ipworksiot_amqp_getoutgoingmessagecount(void* lpObj);

int GetOutgoingMessageCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• OutgoingMessageAbsoluteExpiryTime
• OutgoingMessageContentEncoding
• OutgoingMessageContentType
• OutgoingMessageCorrelationId
• OutgoingMessageCreationTime
• OutgoingMessageDeliveryCount
• OutgoingMessageDurable
• OutgoingMessageFirstAcquirer
• OutgoingMessageGroupId
• OutgoingMessageGroupSequence
• OutgoingMessageId
• OutgoingMessageLinkName
• OutgoingMessagePriority
• OutgoingMessageReplyTo
• OutgoingMessageReplyToGroupId
• OutgoingMessageSettled
• OutgoingMessageSubject
• OutgoingMessageTo
• OutgoingMessageTTL
• OutgoingMessageUserId
• OutgoingMessageValue
• OutgoingMessageValueType

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

OutgoingMessageAbsoluteExpiryTime Property (AMQP Class)

The absolute time at which this message should be considered expired.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LONG64 GetOutgoingMessageAbsoluteExpiryTime(INT iOutgoingMessageIndex);

int64 ipworksiot_amqp_getoutgoingmessageabsoluteexpirytime(void* lpObj, int outgoingmessageindex);

qint64 GetOutgoingMessageAbsoluteExpiryTime(int iOutgoingMessageIndex);

Default Value

0

Remarks

The absolute time at which this message should be considered expired.

This property specifies the absolute time at which this message should be considered expired. It may be -1 if this message does not have an absolute expiry time.

This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).

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

OutgoingMessageContentEncoding Property (AMQP Class)

The content encoding of this message's data.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetOutgoingMessageContentEncoding(INT iOutgoingMessageIndex);

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

QString GetOutgoingMessageContentEncoding(int iOutgoingMessageIndex);

Default Value

""

Remarks

The content encoding of this message's data.

This property specifies the content encoding of this message's data. It may be empty if this message does not have a content encoding set.

When constructing a message for sending, this property is ignored if OutgoingMessageValueType is not set to mvtBinary (16).

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 (AMQP Class)

The content type of this message's data.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetOutgoingMessageContentType(INT iOutgoingMessageIndex);

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

QString GetOutgoingMessageContentType(int iOutgoingMessageIndex);

Default Value

""

Remarks

The content type of this message's data.

This property specifies the content type of this message's data. It may be empty if this message does not have a content type set.

When constructing a message for sending, this property is ignored if OutgoingMessageValueType is not set to mvtBinary (16).

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 (AMQP Class)

The correlation Id of this message.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetOutgoingMessageCorrelationId(INT iOutgoingMessageIndex);

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

QString GetOutgoingMessageCorrelationId(int iOutgoingMessageIndex);

Default Value

""

Remarks

The correlation Id of this message.

This property specifies the correlation Id of this message. It may be empty if this message does not have a correlation Id.

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

OutgoingMessageCreationTime Property (AMQP Class)

The creation time of this message.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LONG64 GetOutgoingMessageCreationTime(INT iOutgoingMessageIndex);

int64 ipworksiot_amqp_getoutgoingmessagecreationtime(void* lpObj, int outgoingmessageindex);

qint64 GetOutgoingMessageCreationTime(int iOutgoingMessageIndex);

Default Value

0

Remarks

The creation time of this message.

This property specifies the absolute creation time of this message. It may be -1 if this message does not have a creation time set.

This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).

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

OutgoingMessageDeliveryCount Property (AMQP Class)

How many previous attempts there have been to deliver this message.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LONG64 GetOutgoingMessageDeliveryCount(INT iOutgoingMessageIndex);

int64 ipworksiot_amqp_getoutgoingmessagedeliverycount(void* lpObj, int outgoingmessageindex);

qint64 GetOutgoingMessageDeliveryCount(int iOutgoingMessageIndex);

Default Value

0

Remarks

How many previous attempts there have been to deliver this message.

This property indicates how many (unsuccessful) previous attempts there have been to deliver this message.

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

OutgoingMessageDurable Property (AMQP Class)

Whether this message is durable.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
BOOL GetOutgoingMessageDurable(INT iOutgoingMessageIndex);

int ipworksiot_amqp_getoutgoingmessagedurable(void* lpObj, int outgoingmessageindex);

bool GetOutgoingMessageDurable(int iOutgoingMessageIndex);

Default Value

FALSE

Remarks

Whether this message is durable.

This property specifies whether this message is durable or not.

If a message is marked as durable, any intermediate nodes which cannot guarantee that the message won't be lost under any circumstances will not accept the message.

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

Boolean

OutgoingMessageFirstAcquirer Property (AMQP Class)

Whether this message may have been acquired by other links previously.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
BOOL GetOutgoingMessageFirstAcquirer(INT iOutgoingMessageIndex);

int ipworksiot_amqp_getoutgoingmessagefirstacquirer(void* lpObj, int outgoingmessageindex);

bool GetOutgoingMessageFirstAcquirer(int iOutgoingMessageIndex);

Default Value

FALSE

Remarks

Whether this message may have been acquired by other links previously.

This property specifies whether this message might have previously been acquired by other links.

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

Boolean

OutgoingMessageGroupId Property (AMQP Class)

The Id of the group this message belongs to.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetOutgoingMessageGroupId(INT iOutgoingMessageIndex);

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

QString GetOutgoingMessageGroupId(int iOutgoingMessageIndex);

Default Value

""

Remarks

The Id of the group this message belongs to.

This property specifies the Id of the group that this message belongs to. It may be empty if this message does not belong to a group.

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

OutgoingMessageGroupSequence Property (AMQP Class)

The position of this message within its group.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LONG64 GetOutgoingMessageGroupSequence(INT iOutgoingMessageIndex);

int64 ipworksiot_amqp_getoutgoingmessagegroupsequence(void* lpObj, int outgoingmessageindex);

qint64 GetOutgoingMessageGroupSequence(int iOutgoingMessageIndex);

Default Value

0

Remarks

The position of this message within its group.

This property specifies the relative position of this message within its group. It may be -1 if this message does not belong to a group.

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

OutgoingMessageLinkName Property (AMQP Class)

The name of the link this message is associated with.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetOutgoingMessageLinkName(INT iOutgoingMessageIndex);

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

QString GetOutgoingMessageLinkName(int iOutgoingMessageIndex);

Default Value

""

Remarks

The name of the link this message is associated with.

This property holds the name of the link which this message is being sent/was received on.

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 (AMQP Class)

The unique Id of this message.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetOutgoingMessageId(INT iOutgoingMessageIndex);

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

QString GetOutgoingMessageId(int iOutgoingMessageIndex);

Default Value

""

Remarks

The unique Id of this message.

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

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 (AMQP Class)

The priority of this message.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT GetOutgoingMessagePriority(INT iOutgoingMessageIndex);

int ipworksiot_amqp_getoutgoingmessagepriority(void* lpObj, int outgoingmessageindex);

int GetOutgoingMessagePriority(int iOutgoingMessageIndex);

Default Value

4

Remarks

The priority of this message.

This property holds the priority of this message; the default is 4 (as defined by the AMQP specification).

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 (AMQP Class)

The address of the node to send replies to for this message.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetOutgoingMessageReplyTo(INT iOutgoingMessageIndex);

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

QString GetOutgoingMessageReplyTo(int iOutgoingMessageIndex);

Default Value

""

Remarks

The address of the node to send replies to for this message.

This property specifies the address of the node to send replies to for this message. It may be empty if this message does not have a specific reply-to node address.

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

OutgoingMessageReplyToGroupId Property (AMQP Class)

The Id of the group to send replies to for this message.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetOutgoingMessageReplyToGroupId(INT iOutgoingMessageIndex);

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

QString GetOutgoingMessageReplyToGroupId(int iOutgoingMessageIndex);

Default Value

""

Remarks

The Id of the group to send replies to for this message.

This property specifies the Id of the group to send replies to for this message. It may be empty if there is not a specific reply-to group for this message.

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

OutgoingMessageSettled Property (AMQP Class)

Whether this message is settled.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
BOOL GetOutgoingMessageSettled(INT iOutgoingMessageIndex);

int ipworksiot_amqp_getoutgoingmessagesettled(void* lpObj, int outgoingmessageindex);

bool GetOutgoingMessageSettled(int iOutgoingMessageIndex);

Default Value

TRUE

Remarks

Whether this message is settled.

This property specifies whether this message is settled or not.

Note that, when constructing a message for sending, this property is ignored if the send settle mode of the link it is sent on is not Mixed (2).

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

Boolean

OutgoingMessageSubject Property (AMQP Class)

The subject of this message.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetOutgoingMessageSubject(INT iOutgoingMessageIndex);

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

QString GetOutgoingMessageSubject(int iOutgoingMessageIndex);

Default Value

""

Remarks

The subject of this message.

This property specifies the subject of this message. It may be empty if this message does not have a subject 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

String

OutgoingMessageTo Property (AMQP Class)

The address of the node which this message is intended for.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetOutgoingMessageTo(INT iOutgoingMessageIndex);

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

QString GetOutgoingMessageTo(int iOutgoingMessageIndex);

Default Value

""

Remarks

The address of the node which this message is intended for.

This property specifies the address of the node which this message is intended to be delivered to. It my be empty if this message is not intended for a specific destination node.

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

OutgoingMessageTTL Property (AMQP Class)

The time-to-live value for this message.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LONG64 GetOutgoingMessageTTL(INT iOutgoingMessageIndex);

int64 ipworksiot_amqp_getoutgoingmessagettl(void* lpObj, int outgoingmessageindex);

qint64 GetOutgoingMessageTTL(int iOutgoingMessageIndex);

Default Value

-1

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

Long64

OutgoingMessageUserId Property (AMQP Class)

The identity of the user responsible for producing this message.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetOutgoingMessageUserId(INT iOutgoingMessageIndex);

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

QString GetOutgoingMessageUserId(int iOutgoingMessageIndex);

Default Value

""

Remarks

The identity of the user responsible for producing this message.

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

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

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

OutgoingMessageValue Property (AMQP Class)

This message's value.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetOutgoingMessageValue(INT iOutgoingMessageIndex);

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

QString GetOutgoingMessageValue(int iOutgoingMessageIndex);

Default Value

""

Remarks

This message's value.

This property specifies the value to send in this message. The OutgoingMessageValueType property should be used to specify the data type of the value.

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

OutgoingMessageValueType Property (AMQP Class)

This message's value data type.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT GetOutgoingMessageValueType(INT iOutgoingMessageIndex);

MVT_NULL(0), 
MVT_BOOLEAN(1), 
MVT_UBYTE(2), 
MVT_USHORT(3), 
MVT_UINT(4), 
MVT_ULONG(5), 
MVT_BYTE(6), 
MVT_SHORT(7), 
MVT_INT(8), 
MVT_LONG(9), 
MVT_FLOAT(10), 
MVT_DOUBLE(11), 
MVT_DECIMAL(12), 
MVT_CHAR(13), 
MVT_TIMESTAMP(14), 
MVT_UUID(15), 
MVT_BINARY(16), 
MVT_STRING(17), 
MVT_SYMBOL(18), 
MVT_JSON(19)

int ipworksiot_amqp_getoutgoingmessagevaluetype(void* lpObj, int outgoingmessageindex);

int GetOutgoingMessageValueType(int iOutgoingMessageIndex);

Default Value

0

Remarks

This message's value data type.

This property specifies the data type of this message's OutgoingMessageValue.

The table below shows the possible value types, their descriptions, and how to format the data assigned to OutgoingMessageValue. All numeric value types should use their standard string formatting (except for the mvtDecimal (12) type, which should be specified as hex-encoded bytes).

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

Password Property (AMQP 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_amqp_getpassword(void* lpObj);
int ipworksiot_amqp_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

ReadyToSend Property (AMQP Class)

Indicates whether the class is ready to send data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReadyToSend();

Unicode (Windows)
BOOL GetReadyToSend();

int ipworksiot_amqp_getreadytosend(void* lpObj);

bool GetReadyToSend();

Default Value

FALSE

Remarks

This property indicates that the underlying TCP/IP subsystem is ready to accept data. This is True after connecting to the remote host, and will become False if a call to SendMessage fails due to a WOULDBLOCK condition.

Once data can be sent again, the ReadyToSend event will fire and this property will be True.

If a WOULDBLOCK error occurs while sending a message the class will automatically complete the transmission when sending is possible. No action needs to be taken to re-send the message. ReadyToSend will fire after the class completes any partially sent messages.

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

Data Type

Boolean

ReceivedMessageAbsoluteExpiryTime Property (AMQP Class)

The absolute time at which this message should be considered expired.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetReceivedMessageAbsoluteExpiryTime();

Unicode (Windows)
LONG64 GetReceivedMessageAbsoluteExpiryTime();

int64 ipworksiot_amqp_getreceivedmessageabsoluteexpirytime(void* lpObj);

qint64 GetReceivedMessageAbsoluteExpiryTime();

Default Value

0

Remarks

The absolute time at which this message should be considered expired.

This property specifies the absolute time at which this message should be considered expired. It may be -1 if this message does not have an absolute expiry time.

This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).

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

Data Type

Long64

ReceivedMessageContentEncoding Property (AMQP Class)

The content encoding of this message's data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReceivedMessageContentEncoding();

Unicode (Windows)
LPWSTR GetReceivedMessageContentEncoding();

char* ipworksiot_amqp_getreceivedmessagecontentencoding(void* lpObj);

QString GetReceivedMessageContentEncoding();

Default Value

""

Remarks

The content encoding of this message's data.

This property specifies the content encoding of this message's data. It may be empty if this message does not have a content encoding set.

When constructing a message for sending, this property is ignored if ReceivedMessageValueType is not set to mvtBinary (16).

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

Data Type

String

ReceivedMessageContentType Property (AMQP Class)

The content type of this message's data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReceivedMessageContentType();

Unicode (Windows)
LPWSTR GetReceivedMessageContentType();

char* ipworksiot_amqp_getreceivedmessagecontenttype(void* lpObj);

QString GetReceivedMessageContentType();

Default Value

""

Remarks

The content type of this message's data.

This property specifies the content type of this message's data. It may be empty if this message does not have a content type set.

When constructing a message for sending, this property is ignored if ReceivedMessageValueType is not set to mvtBinary (16).

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

Data Type

String

ReceivedMessageCorrelationId Property (AMQP Class)

The correlation Id of this message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReceivedMessageCorrelationId();

Unicode (Windows)
LPWSTR GetReceivedMessageCorrelationId();

char* ipworksiot_amqp_getreceivedmessagecorrelationid(void* lpObj);

QString GetReceivedMessageCorrelationId();

Default Value

""

Remarks

The correlation Id of this message.

This property specifies the correlation Id of this message. It may be empty if this message does not have a correlation Id.

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

Data Type

String

ReceivedMessageCreationTime Property (AMQP Class)

The creation time of this message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetReceivedMessageCreationTime();

Unicode (Windows)
LONG64 GetReceivedMessageCreationTime();

int64 ipworksiot_amqp_getreceivedmessagecreationtime(void* lpObj);

qint64 GetReceivedMessageCreationTime();

Default Value

0

Remarks

The creation time of this message.

This property specifies the absolute creation time of this message. It may be -1 if this message does not have a creation time set.

This property's value should be specified in milliseconds relative to the Unix epoch (January 1, 1970 00:00:00 UTC).

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

Data Type

Long64

ReceivedMessageDeliveryCount Property (AMQP Class)

How many previous attempts there have been to deliver this message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetReceivedMessageDeliveryCount();

Unicode (Windows)
LONG64 GetReceivedMessageDeliveryCount();

int64 ipworksiot_amqp_getreceivedmessagedeliverycount(void* lpObj);

qint64 GetReceivedMessageDeliveryCount();

Default Value

0

Remarks

How many previous attempts there have been to deliver this message.

This property indicates how many (unsuccessful) previous attempts there have been to deliver this message.

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

Data Type

Long64

ReceivedMessageDurable Property (AMQP Class)

Whether this message is durable.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReceivedMessageDurable();

Unicode (Windows)
BOOL GetReceivedMessageDurable();

int ipworksiot_amqp_getreceivedmessagedurable(void* lpObj);

bool GetReceivedMessageDurable();

Default Value

FALSE

Remarks

Whether this message is durable.

This property specifies whether this message is durable or not.

If a message is marked as durable, any intermediate nodes which cannot guarantee that the message won't be lost under any circumstances will not accept the message.

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

Data Type

Boolean

ReceivedMessageFirstAcquirer Property (AMQP Class)

Whether this message may have been acquired by other links previously.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReceivedMessageFirstAcquirer();

Unicode (Windows)
BOOL GetReceivedMessageFirstAcquirer();

int ipworksiot_amqp_getreceivedmessagefirstacquirer(void* lpObj);

bool GetReceivedMessageFirstAcquirer();

Default Value

FALSE

Remarks

Whether this message may have been acquired by other links previously.

This property specifies whether this message might have previously been acquired by other links.

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

Data Type

Boolean

ReceivedMessageGroupId Property (AMQP Class)

The Id of the group this message belongs to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReceivedMessageGroupId();

Unicode (Windows)
LPWSTR GetReceivedMessageGroupId();

char* ipworksiot_amqp_getreceivedmessagegroupid(void* lpObj);

QString GetReceivedMessageGroupId();

Default Value

""

Remarks

The Id of the group this message belongs to.

This property specifies the Id of the group that this message belongs to. It may be empty if this message does not belong to a group.

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

Data Type

String

ReceivedMessageGroupSequence Property (AMQP Class)

The position of this message within its group.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetReceivedMessageGroupSequence();

Unicode (Windows)
LONG64 GetReceivedMessageGroupSequence();

int64 ipworksiot_amqp_getreceivedmessagegroupsequence(void* lpObj);

qint64 GetReceivedMessageGroupSequence();

Default Value

0

Remarks

The position of this message within its group.

This property specifies the relative position of this message within its group. It may be -1 if this message does not belong to a group.

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

Data Type

Long64

ReceivedMessageLinkName Property (AMQP Class)

The name of the link this message is associated with.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReceivedMessageLinkName();

Unicode (Windows)
LPWSTR GetReceivedMessageLinkName();

char* ipworksiot_amqp_getreceivedmessagelinkname(void* lpObj);

QString GetReceivedMessageLinkName();

Default Value

""

Remarks

The name of the link this message is associated with.

This property holds the name of the link which this message is being sent/was received on.

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

Data Type

String

ReceivedMessageId Property (AMQP Class)

The unique Id of this message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReceivedMessageId();

Unicode (Windows)
LPWSTR GetReceivedMessageId();

char* ipworksiot_amqp_getreceivedmessageid(void* lpObj);

QString GetReceivedMessageId();

Default Value

""

Remarks

The unique Id of this message.

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

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

Data Type

String

ReceivedMessagePriority Property (AMQP Class)

The priority of this message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReceivedMessagePriority();

Unicode (Windows)
INT GetReceivedMessagePriority();

int ipworksiot_amqp_getreceivedmessagepriority(void* lpObj);

int GetReceivedMessagePriority();

Default Value

4

Remarks

The priority of this message.

This property holds the priority of this message; the default is 4 (as defined by the AMQP specification).

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

Data Type

Integer

ReceivedMessageReplyTo Property (AMQP Class)

The address of the node to send replies to for this message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReceivedMessageReplyTo();

Unicode (Windows)
LPWSTR GetReceivedMessageReplyTo();

char* ipworksiot_amqp_getreceivedmessagereplyto(void* lpObj);

QString GetReceivedMessageReplyTo();

Default Value

""

Remarks

The address of the node to send replies to for this message.

This property specifies the address of the node to send replies to for this message. It may be empty if this message does not have a specific reply-to node address.

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

Data Type

String

ReceivedMessageReplyToGroupId Property (AMQP Class)

The Id of the group to send replies to for this message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReceivedMessageReplyToGroupId();

Unicode (Windows)
LPWSTR GetReceivedMessageReplyToGroupId();

char* ipworksiot_amqp_getreceivedmessagereplytogroupid(void* lpObj);

QString GetReceivedMessageReplyToGroupId();

Default Value

""

Remarks

The Id of the group to send replies to for this message.

This property specifies the Id of the group to send replies to for this message. It may be empty if there is not a specific reply-to group for this message.

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

Data Type

String

ReceivedMessageSettled Property (AMQP Class)

Whether this message is settled.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReceivedMessageSettled();

Unicode (Windows)
BOOL GetReceivedMessageSettled();

int ipworksiot_amqp_getreceivedmessagesettled(void* lpObj);

bool GetReceivedMessageSettled();

Default Value

TRUE

Remarks

Whether this message is settled.

This property specifies whether this message is settled or not.

Note that, when constructing a message for sending, this property is ignored if the send settle mode of the link it is sent on is not Mixed (2).

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

Data Type

Boolean

ReceivedMessageSubject Property (AMQP Class)

The subject of this message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReceivedMessageSubject();

Unicode (Windows)
LPWSTR GetReceivedMessageSubject();

char* ipworksiot_amqp_getreceivedmessagesubject(void* lpObj);

QString GetReceivedMessageSubject();

Default Value

""

Remarks

The subject of this message.

This property specifies the subject of this message. It may be empty if this message does not have a subject set.

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

Data Type

String

ReceivedMessageTo Property (AMQP Class)

The address of the node which this message is intended for.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReceivedMessageTo();

Unicode (Windows)
LPWSTR GetReceivedMessageTo();

char* ipworksiot_amqp_getreceivedmessageto(void* lpObj);

QString GetReceivedMessageTo();

Default Value

""

Remarks

The address of the node which this message is intended for.

This property specifies the address of the node which this message is intended to be delivered to. It my be empty if this message is not intended for a specific destination node.

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

Data Type

String

ReceivedMessageTTL Property (AMQP Class)

The time-to-live value for this message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetReceivedMessageTTL();

Unicode (Windows)
LONG64 GetReceivedMessageTTL();

int64 ipworksiot_amqp_getreceivedmessagettl(void* lpObj);

qint64 GetReceivedMessageTTL();

Default Value

-1

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

Long64

ReceivedMessageUserId Property (AMQP Class)

The identity of the user responsible for producing this message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReceivedMessageUserId();

Unicode (Windows)
LPWSTR GetReceivedMessageUserId();

char* ipworksiot_amqp_getreceivedmessageuserid(void* lpObj);

QString GetReceivedMessageUserId();

Default Value

""

Remarks

The identity of the user responsible for producing this message.

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

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

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

Data Type

String

ReceivedMessageValue Property (AMQP Class)

This message's value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetReceivedMessageValue();

Unicode (Windows)
LPWSTR GetReceivedMessageValue();

char* ipworksiot_amqp_getreceivedmessagevalue(void* lpObj);

QString GetReceivedMessageValue();

Default Value

""

Remarks

This message's value.

This property specifies the value to send in this message. The ReceivedMessageValueType property should be used to specify the data type of the value.

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

Data Type

String

ReceivedMessageValueType Property (AMQP Class)

This message's value data type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReceivedMessageValueType();

Unicode (Windows)
INT GetReceivedMessageValueType();

MVT_NULL(0), 
MVT_BOOLEAN(1), 
MVT_UBYTE(2), 
MVT_USHORT(3), 
MVT_UINT(4), 
MVT_ULONG(5), 
MVT_BYTE(6), 
MVT_SHORT(7), 
MVT_INT(8), 
MVT_LONG(9), 
MVT_FLOAT(10), 
MVT_DOUBLE(11), 
MVT_DECIMAL(12), 
MVT_CHAR(13), 
MVT_TIMESTAMP(14), 
MVT_UUID(15), 
MVT_BINARY(16), 
MVT_STRING(17), 
MVT_SYMBOL(18), 
MVT_JSON(19)

int ipworksiot_amqp_getreceivedmessagevaluetype(void* lpObj);

int GetReceivedMessageValueType();

Default Value

0

Remarks

This message's value data type.

This property specifies the data type of this message's ReceivedMessageValue.

The table below shows the possible value types, their descriptions, and how to format the data assigned to ReceivedMessageValue. All numeric value types should use their standard string formatting (except for the mvtDecimal (12) type, which should be specified as hex-encoded bytes).

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

Data Type

Integer

ReceiveMode Property (AMQP Class)

Controls what mode new receiver links are created with.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReceiveMode();
int SetReceiveMode(int iReceiveMode);

Unicode (Windows)
INT GetReceiveMode();
INT SetReceiveMode(INT iReceiveMode);

RM_AUTOMATIC(0), 
RM_FETCH(1)

int ipworksiot_amqp_getreceivemode(void* lpObj);
int ipworksiot_amqp_setreceivemode(void* lpObj, int iReceiveMode);

int GetReceiveMode();
int SetReceiveMode(int iReceiveMode);

Default Value

0

Remarks

This property controls which receive mode newly created receiver links should use to receive messages from the sender. Valid values are:

• rmAutomatic (0 - default)
• rmFetch (1)

Receiving Messages Automatically

In this mode, receiver links will be created with the amount of credit, and the credit threshold, specified by the DefaultCredit and DefaultCreditThreshold configuration settings. Anytime the link's credit reaches the credit threshold, the class will automatically set it back to its initial value.

Fetching Messages On-Demand

In this mode, receiver links will be created with no credit (regardless of what DefaultCredit is set to). When FetchMessage is called, the class will supply the sender with a single credit and then block until a message is received (if the FetchTimeout property is set to zero).

If FetchTimeout is non-zero, the class will only block for the specified number of seconds; once that time expires, it will instruct the sender to consume the credit. If the sender chooses to consume the credit by incrementing the value of the LinkDeliveryCount property rather than by sending a message, then the class will throw an error indicating a timeout.

Refer to FetchMessage and FetchTimeout for more information. amqp.ReceiveMode = AmqpReceiveModes.rmFetch; amqp.CreateReceiverLink("SessionID", "ReceiverLinkName", "SomeTarget");

This property is not available at design time.

Data Type

Integer

RemoteHost Property (AMQP 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_amqp_getremotehost(void* lpObj);
int ipworksiot_amqp_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 (AMQP 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_amqp_getremoteport(void* lpObj);
int ipworksiot_amqp_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

SessionCount Property (AMQP Class)

The number of records in the Session arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSessionCount();

Unicode (Windows)
INT GetSessionCount();

int ipworksiot_amqp_getsessioncount(void* lpObj);

int GetSessionCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• SessionIncomingWindow
• SessionName
• SessionOutgoingWindow

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

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

Data Type

Integer

SessionIncomingWindow Property (AMQP Class)

The incoming window size of this session.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetSessionIncomingWindow(int iSessionIndex);

Unicode (Windows)
LONG64 GetSessionIncomingWindow(INT iSessionIndex);

int64 ipworksiot_amqp_getsessionincomingwindow(void* lpObj, int sessionindex);

qint64 GetSessionIncomingWindow(int iSessionIndex);

Default Value

0

Remarks

The incoming window size of this session.

This property holds the incoming window size (in frames) of this session.

The SessionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SessionCount property.

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

Data Type

Long64

SessionName Property (AMQP Class)

The name of this session.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSessionName(int iSessionIndex);

Unicode (Windows)
LPWSTR GetSessionName(INT iSessionIndex);

char* ipworksiot_amqp_getsessionname(void* lpObj, int sessionindex);

QString GetSessionName(int iSessionIndex);

Default Value

""

Remarks

The name of this session.

This property holds the name of this session.

The SessionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SessionCount property.

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

Data Type

String

SessionOutgoingWindow Property (AMQP Class)

The outgoing window size of this session.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetSessionOutgoingWindow(int iSessionIndex);

Unicode (Windows)
LONG64 GetSessionOutgoingWindow(INT iSessionIndex);

int64 ipworksiot_amqp_getsessionoutgoingwindow(void* lpObj, int sessionindex);

qint64 GetSessionOutgoingWindow(int iSessionIndex);

Default Value

0

Remarks

The outgoing window size of this session.

This property holds the outgoing window size (in frames) of this session.

The SessionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SessionCount property.

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

Data Type

Long64

SSLAcceptServerCertEncoded Property (AMQP 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_amqp_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksiot_amqp_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 (AMQP 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_amqp_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksiot_amqp_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 (AMQP 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_amqp_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksiot_amqp_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 (AMQP 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_amqp_getsslcertstorepassword(void* lpObj);
int ipworksiot_amqp_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 (AMQP 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_amqp_getsslcertstoretype(void* lpObj);
int ipworksiot_amqp_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 (AMQP 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_amqp_getsslcertsubject(void* lpObj);
int ipworksiot_amqp_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

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

Default Value

""

Remarks