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 Value and ValueType fields must be set. All other fields 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 property's fields 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 Settled 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 property's fields 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 retrieve-based receiver link. amqp1.ReceiveMode = AmqpReceiveModes.rmRetrieve; amqp1.CreateReceiverLink("TestSession", "TestRetrieveReceiverLink", "TestSource2");

Receiving Messages

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

Regardless of whether a messages is received automatically or retrieved, any incoming message will cause the class to fire the MessageIn event and update the ReceivedMessage property's fields.

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 retrieve-based links, it's also necessary to call RetrieveMessage(). It is recommended that the // RetrieveTimeout property be set to a non-zero value (60 seconds is the default) so that the retrieve // request will eventually time out if the sender doesn't have any messages available to deliver. amqp1.RetrieveTimeout = 60; amqp1.RetrieveMessage("TestRetrieveReceiverLink");

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 ipworksmq_amqp_getauthscheme(void* lpObj);
int ipworksmq_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 indicates whether the class is connected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();

Unicode (Windows)
BOOL GetConnected();

int ipworksmq_amqp_getconnected(void* lpObj);

bool GetConnected();

Default Value

FALSE

Remarks

This property indicates whether the class is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.

This property is read-only and 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* ipworksmq_amqp_getcontainerid(void* lpObj);
int ipworksmq_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

Firewall Property (AMQP Class)

A set of properties related to firewall access.

Syntax

• C++
• C
• Qt

IPWorksMQFirewall* GetFirewall();
int SetFirewall(IPWorksMQFirewall* val);

int ipworksmq_amqp_getfirewallautodetect(void* lpObj);
int ipworksmq_amqp_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int ipworksmq_amqp_getfirewalltype(void* lpObj);
int ipworksmq_amqp_setfirewalltype(void* lpObj, int iFirewallType);

char* ipworksmq_amqp_getfirewallhost(void* lpObj);
int ipworksmq_amqp_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* ipworksmq_amqp_getfirewallpassword(void* lpObj);
int ipworksmq_amqp_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int ipworksmq_amqp_getfirewallport(void* lpObj);
int ipworksmq_amqp_setfirewallport(void* lpObj, int iFirewallPort);

char* ipworksmq_amqp_getfirewalluser(void* lpObj);
int ipworksmq_amqp_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

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

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

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

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

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

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

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

Data Type

IPWorksMQFirewall

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 ipworksmq_amqp_getidletimeout(void* lpObj);
int ipworksmq_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

IncomingMessages Property (AMQP Class)

Collection of incoming messages which have not been fully settled.

Syntax

• C++
• C
• Qt

IPWorksMQList<IPWorksMQAMQPMessage>* GetIncomingMessages();

int ipworksmq_amqp_getincomingmessagecount(void* lpObj);

int64 ipworksmq_amqp_getincomingmessageabsoluteexpirytime(void* lpObj, int incomingmessageindex);

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

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

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

int64 ipworksmq_amqp_getincomingmessagecreationtime(void* lpObj, int incomingmessageindex);

int64 ipworksmq_amqp_getincomingmessagedeliverycount(void* lpObj, int incomingmessageindex);

int ipworksmq_amqp_getincomingmessagedurable(void* lpObj, int incomingmessageindex);

int ipworksmq_amqp_getincomingmessagefirstacquirer(void* lpObj, int incomingmessageindex);

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

int64 ipworksmq_amqp_getincomingmessagegroupsequence(void* lpObj, int incomingmessageindex);

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

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

int ipworksmq_amqp_getincomingmessagepriority(void* lpObj, int incomingmessageindex);

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

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

int ipworksmq_amqp_getincomingmessagesettled(void* lpObj, int incomingmessageindex);

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

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

int64 ipworksmq_amqp_getincomingmessagettl(void* lpObj, int incomingmessageindex);

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

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

int ipworksmq_amqp_getincomingmessagevaluetype(void* lpObj, int incomingmessageindex);

int GetIncomingMessageCount();

qint64 GetIncomingMessageAbsoluteExpiryTime(int iIncomingMessageIndex);

QString GetIncomingMessageContentEncoding(int iIncomingMessageIndex);

QString GetIncomingMessageContentType(int iIncomingMessageIndex);

QString GetIncomingMessageCorrelationId(int iIncomingMessageIndex);

qint64 GetIncomingMessageCreationTime(int iIncomingMessageIndex);

qint64 GetIncomingMessageDeliveryCount(int iIncomingMessageIndex);

bool GetIncomingMessageDurable(int iIncomingMessageIndex);

bool GetIncomingMessageFirstAcquirer(int iIncomingMessageIndex);

QString GetIncomingMessageGroupId(int iIncomingMessageIndex);

qint64 GetIncomingMessageGroupSequence(int iIncomingMessageIndex);

QString GetIncomingMessageLinkName(int iIncomingMessageIndex);

QString GetIncomingMessageId(int iIncomingMessageIndex);

int GetIncomingMessagePriority(int iIncomingMessageIndex);

QString GetIncomingMessageReplyTo(int iIncomingMessageIndex);

QString GetIncomingMessageReplyToGroupId(int iIncomingMessageIndex);

bool GetIncomingMessageSettled(int iIncomingMessageIndex);

QString GetIncomingMessageSubject(int iIncomingMessageIndex);

QString GetIncomingMessageTo(int iIncomingMessageIndex);

qint64 GetIncomingMessageTTL(int iIncomingMessageIndex);

QString GetIncomingMessageUserId(int iIncomingMessageIndex);

QString GetIncomingMessageValue(int iIncomingMessageIndex);

int GetIncomingMessageValueType(int iIncomingMessageIndex);

Remarks

This collection property holds a list of AMQPMessage items, one for each incoming message that has not been fully settled by the class (and, potentially, the remote host).

Refer to ReceiveMode for more information.

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

Data Type

IPWorksMQAMQPMessage

Links Property (AMQP Class)

Collection of active links.

Syntax

• C++
• C
• Qt

IPWorksMQList<IPWorksMQAMQPLink>* GetLinks();

int ipworksmq_amqp_getlinkcount(void* lpObj);

int64 ipworksmq_amqp_getlinkavailable(void* lpObj, int linkindex);

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

int64 ipworksmq_amqp_getlinkcredit(void* lpObj, int linkindex);

int64 ipworksmq_amqp_getlinkdeliverycount(void* lpObj, int linkindex);

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

int ipworksmq_amqp_getlinkreadytosend(void* lpObj, int linkindex);

int ipworksmq_amqp_getlinkreceivemode(void* lpObj, int linkindex);

int ipworksmq_amqp_getlinkrole(void* lpObj, int linkindex);

int GetLinkCount();

qint64 GetLinkAvailable(int iLinkIndex);

QString GetLinkChannelName(int iLinkIndex);

qint64 GetLinkCredit(int iLinkIndex);

qint64 GetLinkDeliveryCount(int iLinkIndex);

QString GetLinkName(int iLinkIndex);

bool GetLinkReadyToSend(int iLinkIndex);

int GetLinkReceiveMode(int iLinkIndex);

int GetLinkRole(int iLinkIndex);

Remarks

This collection property holds a list of AMQPLink items, one for each currently active link.

Refer to CreateReceiverLink, CreateSenderLink, and CloseLink for more information.

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

Data Type

IPWorksMQAMQPLink

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* ipworksmq_amqp_getlocalhost(void* lpObj);
int ipworksmq_amqp_setlocalhost(void* lpObj, const char* lpszLocalHost);

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

Default Value

""

Remarks

This 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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

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 multihomed 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 ipworksmq_amqp_getlocalport(void* lpObj);
int ipworksmq_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 on the client side.

Data Type

Integer

Message Property (AMQP Class)

The message to send.

Syntax

• C++
• C
• Qt

IPWorksMQAMQPMessage* GetMessage();
int SetMessage(IPWorksMQAMQPMessage* val);

int64 ipworksmq_amqp_getmessageabsoluteexpirytime(void* lpObj);
int ipworksmq_amqp_setmessageabsoluteexpirytime(void* lpObj, int64 lMessageAbsoluteExpiryTime);

char* ipworksmq_amqp_getmessagecontentencoding(void* lpObj);
int ipworksmq_amqp_setmessagecontentencoding(void* lpObj, const char* lpszMessageContentEncoding);

char* ipworksmq_amqp_getmessagecontenttype(void* lpObj);
int ipworksmq_amqp_setmessagecontenttype(void* lpObj, const char* lpszMessageContentType);

char* ipworksmq_amqp_getmessagecorrelationid(void* lpObj);
int ipworksmq_amqp_setmessagecorrelationid(void* lpObj, const char* lpszMessageCorrelationId);

int64 ipworksmq_amqp_getmessagecreationtime(void* lpObj);
int ipworksmq_amqp_setmessagecreationtime(void* lpObj, int64 lMessageCreationTime);

int64 ipworksmq_amqp_getmessagedeliverycount(void* lpObj);
int ipworksmq_amqp_setmessagedeliverycount(void* lpObj, int64 lMessageDeliveryCount);

int ipworksmq_amqp_getmessagedurable(void* lpObj);
int ipworksmq_amqp_setmessagedurable(void* lpObj, int bMessageDurable);

int ipworksmq_amqp_getmessagefirstacquirer(void* lpObj);
int ipworksmq_amqp_setmessagefirstacquirer(void* lpObj, int bMessageFirstAcquirer);

char* ipworksmq_amqp_getmessagegroupid(void* lpObj);
int ipworksmq_amqp_setmessagegroupid(void* lpObj, const char* lpszMessageGroupId);

int64 ipworksmq_amqp_getmessagegroupsequence(void* lpObj);
int ipworksmq_amqp_setmessagegroupsequence(void* lpObj, int64 lMessageGroupSequence);

char* ipworksmq_amqp_getmessagelinkname(void* lpObj);

char* ipworksmq_amqp_getmessageid(void* lpObj);
int ipworksmq_amqp_setmessageid(void* lpObj, const char* lpszMessageId);

int ipworksmq_amqp_getmessagepriority(void* lpObj);
int ipworksmq_amqp_setmessagepriority(void* lpObj, int iMessagePriority);

char* ipworksmq_amqp_getmessagereplyto(void* lpObj);
int ipworksmq_amqp_setmessagereplyto(void* lpObj, const char* lpszMessageReplyTo);

char* ipworksmq_amqp_getmessagereplytogroupid(void* lpObj);
int ipworksmq_amqp_setmessagereplytogroupid(void* lpObj, const char* lpszMessageReplyToGroupId);

int ipworksmq_amqp_getmessagesettled(void* lpObj);
int ipworksmq_amqp_setmessagesettled(void* lpObj, int bMessageSettled);

char* ipworksmq_amqp_getmessagesubject(void* lpObj);
int ipworksmq_amqp_setmessagesubject(void* lpObj, const char* lpszMessageSubject);

char* ipworksmq_amqp_getmessageto(void* lpObj);
int ipworksmq_amqp_setmessageto(void* lpObj, const char* lpszMessageTo);

int64 ipworksmq_amqp_getmessagettl(void* lpObj);
int ipworksmq_amqp_setmessagettl(void* lpObj, int64 lMessageTTL);

char* ipworksmq_amqp_getmessageuserid(void* lpObj);
int ipworksmq_amqp_setmessageuserid(void* lpObj, const char* lpszMessageUserId);

char* ipworksmq_amqp_getmessagevalue(void* lpObj);
int ipworksmq_amqp_setmessagevalue(void* lpObj, const char* lpszMessageValue);

int ipworksmq_amqp_getmessagevaluetype(void* lpObj);
int ipworksmq_amqp_setmessagevaluetype(void* lpObj, int iMessageValueType);

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

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

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

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

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

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

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

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

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

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

QString GetMessageLinkName();

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

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

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

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

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

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

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

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

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

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

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

Remarks

This property holds an AMQPMessage object whose fields are used to construct a message to send when SendMessage is called.

Refer to SendMessage for more information. amqp.Message.ValueType = AMQPValueTypes.mvtString; amqp.Message.Value = "Hello World!"; amqp.SendMessage("SenderLinkName");

This property is not available at design time.

Data Type

IPWorksMQAMQPMessage

OutgoingMessages Property (AMQP Class)

Collection of outgoing messages which have not been fully settled.

Syntax

• C++
• C
• Qt

IPWorksMQList<IPWorksMQAMQPMessage>* GetOutgoingMessages();

int ipworksmq_amqp_getoutgoingmessagecount(void* lpObj);

int64 ipworksmq_amqp_getoutgoingmessageabsoluteexpirytime(void* lpObj, int outgoingmessageindex);

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

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

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

int64 ipworksmq_amqp_getoutgoingmessagecreationtime(void* lpObj, int outgoingmessageindex);

int64 ipworksmq_amqp_getoutgoingmessagedeliverycount(void* lpObj, int outgoingmessageindex);

int ipworksmq_amqp_getoutgoingmessagedurable(void* lpObj, int outgoingmessageindex);

int ipworksmq_amqp_getoutgoingmessagefirstacquirer(void* lpObj, int outgoingmessageindex);

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

int64 ipworksmq_amqp_getoutgoingmessagegroupsequence(void* lpObj, int outgoingmessageindex);

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

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

int ipworksmq_amqp_getoutgoingmessagepriority(void* lpObj, int outgoingmessageindex);

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

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

int ipworksmq_amqp_getoutgoingmessagesettled(void* lpObj, int outgoingmessageindex);

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

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

int64 ipworksmq_amqp_getoutgoingmessagettl(void* lpObj, int outgoingmessageindex);

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

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

int ipworksmq_amqp_getoutgoingmessagevaluetype(void* lpObj, int outgoingmessageindex);

int GetOutgoingMessageCount();

qint64 GetOutgoingMessageAbsoluteExpiryTime(int iOutgoingMessageIndex);

QString GetOutgoingMessageContentEncoding(int iOutgoingMessageIndex);

QString GetOutgoingMessageContentType(int iOutgoingMessageIndex);

QString GetOutgoingMessageCorrelationId(int iOutgoingMessageIndex);

qint64 GetOutgoingMessageCreationTime(int iOutgoingMessageIndex);

qint64 GetOutgoingMessageDeliveryCount(int iOutgoingMessageIndex);

bool GetOutgoingMessageDurable(int iOutgoingMessageIndex);

bool GetOutgoingMessageFirstAcquirer(int iOutgoingMessageIndex);

QString GetOutgoingMessageGroupId(int iOutgoingMessageIndex);

qint64 GetOutgoingMessageGroupSequence(int iOutgoingMessageIndex);

QString GetOutgoingMessageLinkName(int iOutgoingMessageIndex);

QString GetOutgoingMessageId(int iOutgoingMessageIndex);

int GetOutgoingMessagePriority(int iOutgoingMessageIndex);

QString GetOutgoingMessageReplyTo(int iOutgoingMessageIndex);

QString GetOutgoingMessageReplyToGroupId(int iOutgoingMessageIndex);

bool GetOutgoingMessageSettled(int iOutgoingMessageIndex);

QString GetOutgoingMessageSubject(int iOutgoingMessageIndex);

QString GetOutgoingMessageTo(int iOutgoingMessageIndex);

qint64 GetOutgoingMessageTTL(int iOutgoingMessageIndex);

QString GetOutgoingMessageUserId(int iOutgoingMessageIndex);

QString GetOutgoingMessageValue(int iOutgoingMessageIndex);

int GetOutgoingMessageValueType(int iOutgoingMessageIndex);

Remarks

This collection property holds a list of AMQPMessage items, one for each outgoing message that has not been fully settled by the class (and, potentially, the remote host).

Refer to SendMessage for more information.

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

Data Type

IPWorksMQAMQPMessage

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* ipworksmq_amqp_getpassword(void* lpObj);
int ipworksmq_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 ipworksmq_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

ReceivedMessage Property (AMQP Class)

The last message received.

Syntax

• C++
• C
• Qt

IPWorksMQAMQPMessage* GetReceivedMessage();

int64 ipworksmq_amqp_getreceivedmessageabsoluteexpirytime(void* lpObj);

char* ipworksmq_amqp_getreceivedmessagecontentencoding(void* lpObj);

char* ipworksmq_amqp_getreceivedmessagecontenttype(void* lpObj);

char* ipworksmq_amqp_getreceivedmessagecorrelationid(void* lpObj);

int64 ipworksmq_amqp_getreceivedmessagecreationtime(void* lpObj);

int64 ipworksmq_amqp_getreceivedmessagedeliverycount(void* lpObj);

int ipworksmq_amqp_getreceivedmessagedurable(void* lpObj);

int ipworksmq_amqp_getreceivedmessagefirstacquirer(void* lpObj);

char* ipworksmq_amqp_getreceivedmessagegroupid(void* lpObj);

int64 ipworksmq_amqp_getreceivedmessagegroupsequence(void* lpObj);

char* ipworksmq_amqp_getreceivedmessagelinkname(void* lpObj);

char* ipworksmq_amqp_getreceivedmessageid(void* lpObj);

int ipworksmq_amqp_getreceivedmessagepriority(void* lpObj);

char* ipworksmq_amqp_getreceivedmessagereplyto(void* lpObj);

char* ipworksmq_amqp_getreceivedmessagereplytogroupid(void* lpObj);

int ipworksmq_amqp_getreceivedmessagesettled(void* lpObj);

char* ipworksmq_amqp_getreceivedmessagesubject(void* lpObj);

char* ipworksmq_amqp_getreceivedmessageto(void* lpObj);

int64 ipworksmq_amqp_getreceivedmessagettl(void* lpObj);

char* ipworksmq_amqp_getreceivedmessageuserid(void* lpObj);

char* ipworksmq_amqp_getreceivedmessagevalue(void* lpObj);

int ipworksmq_amqp_getreceivedmessagevaluetype(void* lpObj);

qint64 GetReceivedMessageAbsoluteExpiryTime();

QString GetReceivedMessageContentEncoding();

QString GetReceivedMessageContentType();

QString GetReceivedMessageCorrelationId();

qint64 GetReceivedMessageCreationTime();

qint64 GetReceivedMessageDeliveryCount();

bool GetReceivedMessageDurable();

bool GetReceivedMessageFirstAcquirer();

QString GetReceivedMessageGroupId();

qint64 GetReceivedMessageGroupSequence();

QString GetReceivedMessageLinkName();

QString GetReceivedMessageId();

int GetReceivedMessagePriority();

QString GetReceivedMessageReplyTo();

QString GetReceivedMessageReplyToGroupId();

bool GetReceivedMessageSettled();

QString GetReceivedMessageSubject();

QString GetReceivedMessageTo();

qint64 GetReceivedMessageTTL();

QString GetReceivedMessageUserId();

QString GetReceivedMessageValue();

int GetReceivedMessageValueType();

Remarks

This property is an AMQPMessage object which represents the last message received by the class. It is set by the class automatically each time the MessageIn event fires.

Refer to MessageIn for more information.

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

Data Type

IPWorksMQAMQPMessage

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_RETRIEVE(1)

int ipworksmq_amqp_getreceivemode(void* lpObj);
int ipworksmq_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)
• rmRetrieve (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.

Retrieving Messages On-Demand

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

If RetrieveTimeout 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 field rather than by sending a message, then the class will throw an error indicating a timeout.

Refer to RetrieveMessage and RetrieveTimeout for more information. amqp.ReceiveMode = AmqpReceiveModes.rmRetrieve; 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* ipworksmq_amqp_getremotehost(void* lpObj);
int ipworksmq_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 ipworksmq_amqp_getremoteport(void* lpObj);
int ipworksmq_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

RetrieveTimeout Property (AMQP Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRetrieveTimeout();
int SetRetrieveTimeout(int iRetrieveTimeout);

Unicode (Windows)
INT GetRetrieveTimeout();
INT SetRetrieveTimeout(INT iRetrieveTimeout);

int ipworksmq_amqp_getretrievetimeout(void* lpObj);
int ipworksmq_amqp_setretrievetimeout(void* lpObj, int iRetrieveTimeout);

int GetRetrieveTimeout();
int SetRetrieveTimeout(int iRetrieveTimeout);

Default Value

60

Remarks

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

Refer to RetrieveMessage for more information.

This property is not available at design time.

Data Type

Integer

Sessions Property (AMQP Class)

Collection of active sessions.

Syntax

• C++
• C
• Qt

IPWorksMQList<IPWorksMQAMQPSession>* GetSessions();

int ipworksmq_amqp_getsessioncount(void* lpObj);

int64 ipworksmq_amqp_getsessionincomingwindow(void* lpObj, int sessionindex);

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

int64 ipworksmq_amqp_getsessionoutgoingwindow(void* lpObj, int sessionindex);

int GetSessionCount();

qint64 GetSessionIncomingWindow(int iSessionIndex);

QString GetSessionName(int iSessionIndex);

qint64 GetSessionOutgoingWindow(int iSessionIndex);

Remarks

This collection property holds a list of AMQPSession items, one for each currently active session.

Refer to CreateSession and CloseSession for more information.

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

Data Type

IPWorksMQAMQPSession

SSLAcceptServerCert Property (AMQP Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C++
• C
• Qt

IPWorksMQCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(IPWorksMQCertificate* val);

char* ipworksmq_amqp_getsslacceptservercerteffectivedate(void* lpObj);

char* ipworksmq_amqp_getsslacceptservercertexpirationdate(void* lpObj);

char* ipworksmq_amqp_getsslacceptservercertextendedkeyusage(void* lpObj);

char* ipworksmq_amqp_getsslacceptservercertfingerprint(void* lpObj);

char* ipworksmq_amqp_getsslacceptservercertfingerprintsha1(void* lpObj);

char* ipworksmq_amqp_getsslacceptservercertfingerprintsha256(void* lpObj);

char* ipworksmq_amqp_getsslacceptservercertissuer(void* lpObj);

char* ipworksmq_amqp_getsslacceptservercertprivatekey(void* lpObj);

int ipworksmq_amqp_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* ipworksmq_amqp_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* ipworksmq_amqp_getsslacceptservercertpublickey(void* lpObj);

char* ipworksmq_amqp_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int ipworksmq_amqp_getsslacceptservercertpublickeylength(void* lpObj);

char* ipworksmq_amqp_getsslacceptservercertserialnumber(void* lpObj);

char* ipworksmq_amqp_getsslacceptservercertsignaturealgorithm(void* lpObj);

int ipworksmq_amqp_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworksmq_amqp_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* ipworksmq_amqp_getsslacceptservercertstorepassword(void* lpObj);
int ipworksmq_amqp_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int ipworksmq_amqp_getsslacceptservercertstoretype(void* lpObj);
int ipworksmq_amqp_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* ipworksmq_amqp_getsslacceptservercertsubjectaltnames(void* lpObj);

char* ipworksmq_amqp_getsslacceptservercertthumbprintmd5(void* lpObj);

char* ipworksmq_amqp_getsslacceptservercertthumbprintsha1(void* lpObj);

char* ipworksmq_amqp_getsslacceptservercertthumbprintsha256(void* lpObj);

char* ipworksmq_amqp_getsslacceptservercertusage(void* lpObj);

int ipworksmq_amqp_getsslacceptservercertusageflags(void* lpObj);

char* ipworksmq_amqp_getsslacceptservercertversion(void* lpObj);

char* ipworksmq_amqp_getsslacceptservercertsubject(void* lpObj);
int ipworksmq_amqp_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int ipworksmq_amqp_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksmq_amqp_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

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

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Data Type

IPWorksMQCertificate

SSLCert Property (AMQP Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C++
• C
• Qt

IPWorksMQCertificate* GetSSLCert();
int SetSSLCert(IPWorksMQCertificate* val);

char* ipworksmq_amqp_getsslcerteffectivedate(void* lpObj);

char* ipworksmq_amqp_getsslcertexpirationdate(void* lpObj);

char* ipworksmq_amqp_getsslcertextendedkeyusage(void* lpObj);

char* ipworksmq_amqp_getsslcertfingerprint(void* lpObj);

char* ipworksmq_amqp_getsslcertfingerprintsha1(void* lpObj);

char* ipworksmq_amqp_getsslcertfingerprintsha256(void* lpObj);

char* ipworksmq_amqp_getsslcertissuer(void* lpObj);

char* ipworksmq_amqp_getsslcertprivatekey(void* lpObj);

int ipworksmq_amqp_getsslcertprivatekeyavailable(void* lpObj);

char* ipworksmq_amqp_getsslcertprivatekeycontainer(void* lpObj);

char* ipworksmq_amqp_getsslcertpublickey(void* lpObj);

char* ipworksmq_amqp_getsslcertpublickeyalgorithm(void* lpObj);

int ipworksmq_amqp_getsslcertpublickeylength(void* lpObj);

char* ipworksmq_amqp_getsslcertserialnumber(void* lpObj);

char* ipworksmq_amqp_getsslcertsignaturealgorithm(void* lpObj);

int ipworksmq_amqp_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksmq_amqp_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* ipworksmq_amqp_getsslcertstorepassword(void* lpObj);
int ipworksmq_amqp_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int ipworksmq_amqp_getsslcertstoretype(void* lpObj);
int ipworksmq_amqp_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* ipworksmq_amqp_getsslcertsubjectaltnames(void* lpObj);

char* ipworksmq_amqp_getsslcertthumbprintmd5(void* lpObj);

char* ipworksmq_amqp_getsslcertthumbprintsha1(void* lpObj);

char* ipworksmq_amqp_getsslcertthumbprintsha256(void* lpObj);

char* ipworksmq_amqp_getsslcertusage(void* lpObj);

int ipworksmq_amqp_getsslcertusageflags(void* lpObj);

char* ipworksmq_amqp_getsslcertversion(void* lpObj);

char* ipworksmq_amqp_getsslcertsubject(void* lpObj);
int ipworksmq_amqp_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int ipworksmq_amqp_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksmq_amqp_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

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

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

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

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

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

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

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Data Type

IPWorksMQCertificate

SSLEnabled Property (AMQP Class)

This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled.

Syntax

• C++
• C
• Qt

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

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

int ipworksmq_amqp_getsslenabled(void* lpObj);
int ipworksmq_amqp_setsslenabled(void* lpObj, int bSSLEnabled);

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

Default Value

FALSE

Remarks

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

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

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

This property is not available at design time.

Data Type

Boolean

SSLProvider Property (AMQP Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

• C++
• C
• Qt

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

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

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

int ipworksmq_amqp_getsslprovider(void* lpObj);
int ipworksmq_amqp_setsslprovider(void* lpObj, int iSSLProvider);

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

Default Value

0

Remarks

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

Possible values are as follows:

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

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

Data Type

Integer

SSLServerCert Property (AMQP Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

IPWorksMQCertificate* GetSSLServerCert();

char* ipworksmq_amqp_getsslservercerteffectivedate(void* lpObj);

char* ipworksmq_amqp_getsslservercertexpirationdate(void* lpObj);

char* ipworksmq_amqp_getsslservercertextendedkeyusage(void* lpObj);

char* ipworksmq_amqp_getsslservercertfingerprint(void* lpObj);

char* ipworksmq_amqp_getsslservercertfingerprintsha1(void* lpObj);

char* ipworksmq_amqp_getsslservercertfingerprintsha256(void* lpObj);

char* ipworksmq_amqp_getsslservercertissuer(void* lpObj);

char* ipworksmq_amqp_getsslservercertprivatekey(void* lpObj);

int ipworksmq_amqp_getsslservercertprivatekeyavailable(void* lpObj);

char* ipworksmq_amqp_getsslservercertprivatekeycontainer(void* lpObj);

char* ipworksmq_amqp_getsslservercertpublickey(void* lpObj);

char* ipworksmq_amqp_getsslservercertpublickeyalgorithm(void* lpObj);

int ipworksmq_amqp_getsslservercertpublickeylength(void* lpObj);

char* ipworksmq_amqp_getsslservercertserialnumber(void* lpObj);

char* ipworksmq_amqp_getsslservercertsignaturealgorithm(void* lpObj);

int ipworksmq_amqp_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* ipworksmq_amqp_getsslservercertstorepassword(void* lpObj);

int ipworksmq_amqp_getsslservercertstoretype(void* lpObj);

char* ipworksmq_amqp_getsslservercertsubjectaltnames(void* lpObj);

char* ipworksmq_amqp_getsslservercertthumbprintmd5(void* lpObj);

char* ipworksmq_amqp_getsslservercertthumbprintsha1(void* lpObj);

char* ipworksmq_amqp_getsslservercertthumbprintsha256(void* lpObj);

char* ipworksmq_amqp_getsslservercertusage(void* lpObj);

int ipworksmq_amqp_getsslservercertusageflags(void* lpObj);

char* ipworksmq_amqp_getsslservercertversion(void* lpObj);

char* ipworksmq_amqp_getsslservercertsubject(void* lpObj);

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

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

IPWorksMQCertificate

Timeout Property (AMQP Class)

This property includes the timeout for the class.

Syntax

• C++
• C
• Qt

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

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

int ipworksmq_amqp_gettimeout(void* lpObj);
int ipworksmq_amqp_settimeout(void* lpObj, int iTimeout);

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

Default Value

60

Remarks

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

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

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

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

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

User Property (AMQP Class)

A username to use for SASL authentication.

Syntax

• C++
• C
• Qt

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

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

char* ipworksmq_amqp_getuser(void* lpObj);
int ipworksmq_amqp_setuser(void* lpObj, const char* lpszUser);

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

Default Value

""

Remarks

This property contains a username to use for SASL authentication.

This property is not available at design time.

Data Type

String

CloseLink Method (AMQP Class)

Closes a link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CloseLink(const char* lpszName);

Unicode (Windows)
INT CloseLink(LPCWSTR lpszName);

int ipworksmq_amqp_closelink(void* lpObj, const char* lpszName);

int CloseLink(const QString& qsName);

Remarks

This method closes the link named Name and removes it from the Links properties. If no link with the given Name exists, an error will be thrown.

Error Handling (C++)

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

CloseSession Method (AMQP Class)

Closes a session.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CloseSession(const char* lpszName);

Unicode (Windows)
INT CloseSession(LPCWSTR lpszName);

int ipworksmq_amqp_closesession(void* lpObj, const char* lpszName);

int CloseSession(const QString& qsName);

Remarks

This method closes the session named Name and removes it from the Sessions properties. If no session with the given Name exists, an error will be thrown.

Any links open on the specified session when this method is called will be automatically closed and removed from the Links properties.

Error Handling (C++)

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

Config Method (AMQP Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworksmq_amqp_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Connect Method (AMQP Class)

This method connects to a remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Connect();

Unicode (Windows)
INT Connect();

int ipworksmq_amqp_connect(void* lpObj);

int Connect();

Remarks

This method connects to the remote host specified by RemoteHost and RemotePort. For instance: component.RemoteHost = "MyHostNameOrIP"; component.RemotePort = 7777; component.Connect();

Error Handling (C++)

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

ConnectTo Method (AMQP Class)

This method connects to a remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ConnectTo(const char* lpszHost, int iPort);

Unicode (Windows)
INT ConnectTo(LPCWSTR lpszHost, INT iPort);

int ipworksmq_amqp_connectto(void* lpObj, const char* lpszHost, int iPort);

int ConnectTo(const QString& qsHost, int iPort);

Remarks

This method connects to the remote host specified by the Host and Port parameters. For instance: component.ConnectTo("MyHostNameOrIP", 777)

Error Handling (C++)

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

CreateReceiverLink Method (AMQP Class)

Creates a new receiver link with the given name on the specified session.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateReceiverLink(const char* lpszSessionName, const char* lpszName, const char* lpszSource);

Unicode (Windows)
INT CreateReceiverLink(LPCWSTR lpszSessionName, LPCWSTR lpszName, LPCWSTR lpszSource);

int ipworksmq_amqp_createreceiverlink(void* lpObj, const char* lpszSessionName, const char* lpszName, const char* lpszSource);

int CreateReceiverLink(const QString& qsSessionName, const QString& qsName, const QString& qsSource);

Remarks

This method creates a new receiver link with the given Name on the session specified by SessionName and adds it to the Links properties. If a link (sender or receiver) with the given Name already exists, or if no session with the given SessionName exists, an error will be thrown.

Source may be set to specify the address of the node at the remote host which should act as the sender. This may not be necessary in all environments, in which case an empty string will suffice.

Receiver links can operate in one of two receive modes: automatic, where the class will work to ensure that messages are received as soon as they are available; and retrieve-based, where the class will only "retrieve" a new message when explicitly instructed to.

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

AMQP 1.0's transport protocol has three layers: an overarching connection between two containers, the sessions opened on that connection, and the links (between the containers' nodes) attached to those sessions. amqp.ReceiveMode = AmqpReceiveModes.rmRetrieve; amqp.CreateReceiverLink("SessionID", "ReceiverLinkName", "SomeTarget");

Error Handling (C++)

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

CreateSenderLink Method (AMQP Class)

Creates a new sender link with the given name on the specified session.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateSenderLink(const char* lpszSessionName, const char* lpszName, const char* lpszTarget);

Unicode (Windows)
INT CreateSenderLink(LPCWSTR lpszSessionName, LPCWSTR lpszName, LPCWSTR lpszTarget);

int ipworksmq_amqp_createsenderlink(void* lpObj, const char* lpszSessionName, const char* lpszName, const char* lpszTarget);

int CreateSenderLink(const QString& qsSessionName, const QString& qsName, const QString& qsTarget);

Remarks

This method creates a new sender link with the given Name on the session specified by SessionName and adds it to the Links properties. If a link (sender or receiver) with the given Name already exists, or if no session with the given SessionName exists, an error will be thrown.

Target may be set to specify the address of the node at the remote host which should act as the receiver. This may not be necessary in all environments, in which case an empty string will suffice.

The LinkReadyToSend event will fire when a newly-created sender link is ready to send.

Sender links are created using the Mixed settle mode by default, letting the value of the Settled field control whether each message is settled (the default) or unsettled when it is sent. The DefaultSenderSettleMode configuration setting can be used to control the settle mode that new sender links are created with. Refer to SendMessage for more information on message settlement in general.

AMQP 1.0's transport protocol has three layers: an overarching connection between two containers, the sessions opened on that connection, and the links (between the containers' nodes) attached to those sessions.

Error Handling (C++)

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

CreateSession Method (AMQP Class)

Creates a new session with the given name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateSession(const char* lpszName);

Unicode (Windows)
INT CreateSession(LPCWSTR lpszName);

int ipworksmq_amqp_createsession(void* lpObj, const char* lpszName);

int CreateSession(const QString& qsName);

Remarks

This method creates a new session with the given Name and adds it to the Sessions properties. If a session with the given Name already exists, an error will be thrown.

AMQP 1.0's transport protocol has three layers: an overarching connection between two containers, the sessions opened on that connection, and the links (between the containers' nodes) attached to those sessions.

Error Handling (C++)

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

Disconnect Method (AMQP Class)

This method disconnects from the remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Disconnect();

Unicode (Windows)
INT Disconnect();

int ipworksmq_amqp_disconnect(void* lpObj);

int Disconnect();

Remarks

This method disconnects from the remote host. Calling this method is equivalent to setting the Connected property to False.

Error Handling (C++)

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

DoEvents Method (AMQP Class)

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworksmq_amqp_doevents(void* lpObj);

int DoEvents();

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Error Handling (C++)

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

Interrupt Method (AMQP Class)

This method interrupts the current action.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int ipworksmq_amqp_interrupt(void* lpObj);

int Interrupt();

Remarks

This method interrupts the current action. If you use SendFile to upload a file, the class will run synchronously until the upload is completed. This method will allow you to stop the file from uploading without disconnecting from the host.

Error Handling (C++)

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

Reset Method (AMQP Class)

This method will reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksmq_amqp_reset(void* lpObj);

int Reset();

Remarks

This method will reset the class's properties to their default values.

Error Handling (C++)

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

ResetMessage Method (AMQP Class)

Resets the Message properties.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ResetMessage();

Unicode (Windows)
INT ResetMessage();

int ipworksmq_amqp_resetmessage(void* lpObj);

int ResetMessage();

Remarks

This method resets the Message property.

Error Handling (C++)

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

RetrieveMessage Method (AMQP Class)

Retrieves a single message over the specified receiver link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RetrieveMessage(const char* lpszLinkName);

Unicode (Windows)
INT RetrieveMessage(LPCWSTR lpszLinkName);

int ipworksmq_amqp_retrievemessage(void* lpObj, const char* lpszLinkName);

int RetrieveMessage(const QString& qsLinkName);

Remarks

When RetrieveMessage is called, the class will supply the sender with a single credit and then block until a message is received (if the RetrieveTimeout property is set to zero).

If RetrieveTimeout 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 field rather than by sending a message, then the class will throw an error indicating a timeout.

LinkName specifies the receiver link which should retrieve a message; if there is no such link, if the specified link is not a receiver link, or if the specified receiver link is not operating in rmSyncGet (1) mode, an error is thrown.

Refer to ReceiveMode and RetrieveTimeout for more information.

Error Handling (C++)

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

SendMessage Method (AMQP Class)

Sends a message on the specified link.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendMessage(const char* lpszLinkName);

Unicode (Windows)
INT SendMessage(LPCWSTR lpszLinkName);

int ipworksmq_amqp_sendmessage(void* lpObj, const char* lpszLinkName);

int SendMessage(const QString& qsLinkName);

Remarks

This method sends a message on the link specified by LinkName.

The Message property holds an AMQPMessage object whose fields are used to construct the message to send. At minimum, specify a Value and a ValueType. amqp.Message.ValueType = AMQPValueTypes.mvtString; amqp.Message.Value = "Hello World!"; amqp.SendMessage("SenderLinkName");

Message Settlement

• Settled - All messages will be sent in a settled state.
• Unsettled - All messages will be sent in an unsettled state.
• Mixed - Messages may be sent either settled or unsettled.

• First - Incoming messages will be settled immediately (and the sender will be notified that the message has been received, if the message was not already settled when sent).
• Second - Incoming messages will be settled after the sender has settled them (and the sender will be notified when a message has been received, if the message was not already settled when sent).

Together, the sender's and receiver's settle modes can form the following delivery guarantees:

It is important to note that the message settlement system has a big caveat: Whichever party opens the link can only request that the other end use a specific settle mode. For example, if the class opens a sender link, it has control over the sender settle mode it will use, but it can only request that the remote host use a specific receiver settle mode; so if the class requests that the receiver use Second, the receiver can instead choose to use First (if, e.g., it doesn't support Second).

The class currently only ever requests (and itself only supports) the First receiver settle mode since no other AMQP implementations appear to support the Second receiver settle mode at this time.

The class requests (and uses) the Mixed sender settle mode by default, but supports all of the sender settle modes (the default can be changed using the DefaultSenderSettleMode configuration setting). Sender links created with the Mixed sender use the value of the Settled field to determine whether to send messages as settled or unsettled.

Sending Composite Data

Composite Data JSON Schema

The class uses JSON with a well-defined schema to represent composite data. The composite data JSON schema consists almost entirely of "type-value" objects, which hold an AMQP typename and a value. The syntax for a type-value object is:

{
  "type": "typename",
  "value": value
}

The following table provides a complete list of valid typenames, and describes how the associated values should be represented:

Arrays, Lists, and Maps

The AMQP data model defines three data structure types: array, list, and map. In the composite data JSON schema, their value is always a JSON array that contains zero or more type-value objects. Data structure types may be nested arbitrarily to any depth.

Note that the array and map data structures each have restrictions on their content:

• The elements in an array must all be of the same type (e.g., their typenames must match).
• The elements in a map represent keys (odd-numbered elements) and values (even-numbered elements). There must be an even number of elements (or none), and the values of the "key" elements must be unique.

{
  "type": "map",
  "value": [
    { "type": "symbol", "value": "key1" },
    { "type": "string", "value": "value1" },
    { "type": "symbol", "value": "key2" },
    { "type": "int", "value": 100 }
  ]
}

Described Types

As noted above, AMQP's data model includes the idea of "described types", which is simply a normal AMQP type annotated by a descriptor. The descriptor defines what the data it is associated with represents as a whole.

In the composite data JSON schema, a described type object is just a normal type-value object with an extra "descriptor" property on it (and the "descriptor" property's value is itself a normal type-value object). The syntax for a described type object is:

{
  "descriptor": { "type": "typename", "value": value },
  "type": "typename",
  "value": value
}

Described type objects can be used anywhere that normal type-value objects can be, except as the value of the "descriptor" property for another described type object, which must be a normal type-value object.

Note that, according to the AMQP specification, the type of the descriptor itself ulong or symbol, but the class does not enforce this.

Abbreviated Value Syntax

For brevity, it is possible to abbreviate both normal type-value objects and described type objects when their value type is null, boolean, or string.

For normal type-value objects, instead of using the standard syntax (e.g., { "type": "string", "value": "Hello, world!" }), just use the raw value itself (e.g., "Hello, world!"). Keep in mind that the abbreviated value must still be valid JSON; notably, strings must still be surrounded by quotes (e.g., "value", not value).

The abbreviated syntax for a described type object is a bit different; the "descriptor" property still needs to be associated with the value using a JSON object. To abbreviate a described type object, just exclude the "type" property, like so:

{
  "descriptor": { "type": "typename", "value": value },
  "value": value
}

The abbreviated value syntax can be used anywhere that an unabbreviated type-value object or described type object would normally be used.

The class defaults to using the abbreviated syntax when returning composite data JSON. This can be configured using the SimplifiedJSONFormat configuration setting.

Composite Data JSON Example

{
  "descriptor": { "type": "symbol", "value": "nsoftware:compositeDataExample" },
  "type": "list",
  "value": [
    "Shorthand string value",
    null,
    true,
    { "type": "uuid", "value": "12345678-0000-1000-8000-00805F9B34FB" },
    {
      "type": "array",
      "value": [
        { "type": "uint", "value": 23 },
        { "type": "uint", "value": 52 },
        { "type": "uint", "value": 153325 }
      ]
    },
    {
      "type": "map",
      "value": [
        { "type": "symbol", "value": "name" },
        "Freezer temperature",
        { "type": "symbol", "value": "unit" },
        "Fahrenheit",
        { "type": "symbol", "value": "value" },
        { "type": "int", "value": -2 }
      ]
    },
    {
      "descriptor": { "type": "symbol", "value": "nsoftware:utf8Bytes" },
      "type": "binary",
      "value": "48656C6C6F2C20776F726C6421"
    }
  ]
}

Error Handling (C++)

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

Connected Event (AMQP Class)

Fired immediately after a connection completes (or fails).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnected(AMQPConnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} AMQPConnectedEventParams;


Unicode (Windows)
virtual INT FireConnected(AMQPConnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} AMQPConnectedEventParams;

#define EID_AMQP_CONNECTED 1

virtual INT IPWORKSMQ_CALL FireConnected(INT &iStatusCode, LPSTR &lpszDescription);

class AMQPConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Connected(AMQPConnectedEventParams *e);

// Or, subclass AMQP and override this emitter function.
virtual int FireConnected(AMQPConnectedEventParams *e) {...}

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (AMQP Class)

Fired to indicate changes in the connection state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionStatus(AMQPConnectionStatusEventParams *e);

typedef struct {
  const char *ConnectionEvent;
  int StatusCode;
  const char *Description;
  int reserved;
} AMQPConnectionStatusEventParams;


Unicode (Windows)
virtual INT FireConnectionStatus(AMQPConnectionStatusEventParams *e);

typedef struct {
  LPCWSTR ConnectionEvent;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} AMQPConnectionStatusEventParams;

#define EID_AMQP_CONNECTIONSTATUS 2

virtual INT IPWORKSMQ_CALL FireConnectionStatus(LPSTR &lpszConnectionEvent, INT &iStatusCode, LPSTR &lpszDescription);

class AMQPConnectionStatusEventParams {
public:
  const QString &ConnectionEvent();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ConnectionStatus(AMQPConnectionStatusEventParams *e);

// Or, subclass AMQP and override this emitter function.
virtual int FireConnectionStatus(AMQPConnectionStatusEventParams *e) {...}

Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

Disconnected Event (AMQP Class)

Fired when a connection is closed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDisconnected(AMQPDisconnectedEventParams *e);

typedef struct {
  int StatusCode;
  const char *Description;
  int reserved;
} AMQPDisconnectedEventParams;


Unicode (Windows)
virtual INT FireDisconnected(AMQPDisconnectedEventParams *e);

typedef struct {
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} AMQPDisconnectedEventParams;

#define EID_AMQP_DISCONNECTED 3

virtual INT IPWORKSMQ_CALL FireDisconnected(INT &iStatusCode, LPSTR &lpszDescription);

class AMQPDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Disconnected(AMQPDisconnectedEventParams *e);

// Or, subclass AMQP and override this emitter function.
virtual int FireDisconnected(AMQPDisconnectedEventParams *e) {...}

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

Error Event (AMQP Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(AMQPErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} AMQPErrorEventParams;


Unicode (Windows)
virtual INT FireError(AMQPErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} AMQPErrorEventParams;

#define EID_AMQP_ERROR 4

virtual INT IPWORKSMQ_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class AMQPErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(AMQPErrorEventParams *e);

// Or, subclass AMQP and override this emitter function.
virtual int FireError(AMQPErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

LinkReadyToSend Event (AMQP Class)

Fires when a sender link is ready to send messages.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLinkReadyToSend(AMQPLinkReadyToSendEventParams *e);

typedef struct {
  const char *LinkName;
  int LinkIndex;
  int reserved;
} AMQPLinkReadyToSendEventParams;


Unicode (Windows)
virtual INT FireLinkReadyToSend(AMQPLinkReadyToSendEventParams *e);

typedef struct {
  LPCWSTR LinkName;
  INT LinkIndex;
  INT reserved;
} AMQPLinkReadyToSendEventParams;

#define EID_AMQP_LINKREADYTOSEND 5

virtual INT IPWORKSMQ_CALL FireLinkReadyToSend(LPSTR &lpszLinkName, INT &iLinkIndex);

class AMQPLinkReadyToSendEventParams {
public:
  const QString &LinkName();

  int LinkIndex();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void LinkReadyToSend(AMQPLinkReadyToSendEventParams *e);

// Or, subclass AMQP and override this emitter function.
virtual int FireLinkReadyToSend(AMQPLinkReadyToSendEventParams *e) {...}

Remarks

This event fires when a sender link is ready to send messages.

LinkName is the name of the sender link.

LinkIndex is the index of the sender link in the Links properties.

Log Event (AMQP Class)

Fires once for each log message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(AMQPLogEventParams *e);

typedef struct {
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} AMQPLogEventParams;


Unicode (Windows)
virtual INT FireLog(AMQPLogEventParams *e);

typedef struct {
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} AMQPLogEventParams;

#define EID_AMQP_LOG 6

virtual INT IPWORKSMQ_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class AMQPLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Log(AMQPLogEventParams *e);

// Or, subclass AMQP and override this emitter function.
virtual int FireLog(AMQPLogEventParams *e) {...}

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of the Message. Possible values are:

LogType identifies the type of log entry. Possible values are:

• Info: General information about the class.
• Session: Session status messages.
• Frame: Frame status messages.

MessageIn Event (AMQP Class)

Fires when the class receives a message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireMessageIn(AMQPMessageInEventParams *e);

typedef struct {
  const char *SessionName;
  int SessionIndex;
  const char *LinkName;
  int LinkIndex;
  const char *MessageId;
  int State;
  int reserved;
} AMQPMessageInEventParams;


Unicode (Windows)
virtual INT FireMessageIn(AMQPMessageInEventParams *e);

typedef struct {
  LPCWSTR SessionName;
  INT SessionIndex;
  LPCWSTR LinkName;
  INT LinkIndex;
  LPCWSTR MessageId;
  INT State;
  INT reserved;
} AMQPMessageInEventParams;

#define EID_AMQP_MESSAGEIN 7

virtual INT IPWORKSMQ_CALL FireMessageIn(LPSTR &lpszSessionName, INT &iSessionIndex, LPSTR &lpszLinkName, INT &iLinkIndex, LPSTR &lpszMessageId, INT &iState);

class AMQPMessageInEventParams {
public:
  const QString &SessionName();

  int SessionIndex();

  const QString &LinkName();

  int LinkIndex();

  const QString &MessageId();

  int State();
  void SetState(int iState);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void MessageIn(AMQPMessageInEventParams *e);

// Or, subclass AMQP and override this emitter function.
virtual int FireMessageIn(AMQPMessageInEventParams *e) {...}

Remarks

This event fires whenever the class receives a message. The message itself is automatically stored in the ReceivedMessage property.

Specifying a Delivery Outcome

• 0: Accepted - The message has been processed successfully.
• 1: Rejected - The message failed to process successfully. Includes an error describing why.
• 2: Released - The message has not been (and will not be) processed.
• 3: Modified - Same as "Released", but with additional metadata for the sender.

When State is set to Rejected (1), the class will include error metadata when it informs the sender of the outcome. Set the RejectErrorCondition and RejectErrorDescription configuration settings before the event handler finishes to specify this error information.

When State is set to Modified (3), the class can include additional metadata when it informs the sender of the outcome. Set zero or more of the ModifiedDeliveryFailed, ModifiedMessageAnnotations, and ModifiedUndeliverableHere configuration settings before the event handler finishes to specify this additional metadata.

Other Parameters

SessionIndex is the index of the session in the Sessions collection property.

LinkName is the name of the link the message was transmitted on.

LinkIndex is the index of the link in the Links collection property.

MessageId is the Id of the message; it may be empty if a message Id was not set.

MessageOut Event (AMQP Class)

Fires when the class sends a message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireMessageOut(AMQPMessageOutEventParams *e);

typedef struct {
  const char *SessionName;
  int SessionIndex;
  const char *LinkName;
  int LinkIndex;
  const char *MessageId;
  int reserved;
} AMQPMessageOutEventParams;


Unicode (Windows)
virtual INT FireMessageOut(AMQPMessageOutEventParams *e);

typedef struct {
  LPCWSTR SessionName;
  INT SessionIndex;
  LPCWSTR LinkName;
  INT LinkIndex;
  LPCWSTR MessageId;
  INT reserved;
} AMQPMessageOutEventParams;

#define EID_AMQP_MESSAGEOUT 8

virtual INT IPWORKSMQ_CALL FireMessageOut(LPSTR &lpszSessionName, INT &iSessionIndex, LPSTR &lpszLinkName, INT &iLinkIndex, LPSTR &lpszMessageId);

class AMQPMessageOutEventParams {
public:
  const QString &SessionName();

  int SessionIndex();

  const QString &LinkName();

  int LinkIndex();

  const QString &MessageId();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void MessageOut(AMQPMessageOutEventParams *e);

// Or, subclass AMQP and override this emitter function.
virtual int FireMessageOut(AMQPMessageOutEventParams *e) {...}

Remarks

This event fires whenever the class sends a message.

SessionName is the name of the session the message was transmitted on.

SessionIndex is the index of the session in the Sessions collection property.

LinkName is the name of the link the message was transmitted on.

LinkIndex is the index of the link in the Links collection property.

MessageId is the Id of the message; it may be empty if a message Id was not set.

MessageOutcome Event (AMQP Class)

Fires when a message's outcome is available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireMessageOutcome(AMQPMessageOutcomeEventParams *e);

typedef struct {
  const char *SessionName;
  int SessionIndex;
  const char *LinkName;
  int LinkIndex;
  const char *MessageId;
  int Direction;
  int State;
  int reserved;
} AMQPMessageOutcomeEventParams;


Unicode (Windows)
virtual INT FireMessageOutcome(AMQPMessageOutcomeEventParams *e);

typedef struct {
  LPCWSTR SessionName;
  INT SessionIndex;
  LPCWSTR LinkName;
  INT LinkIndex;
  LPCWSTR MessageId;
  INT Direction;
  INT State;
  INT reserved;
} AMQPMessageOutcomeEventParams;

#define EID_AMQP_MESSAGEOUTCOME 9

virtual INT IPWORKSMQ_CALL FireMessageOutcome(LPSTR &lpszSessionName, INT &iSessionIndex, LPSTR &lpszLinkName, INT &iLinkIndex, LPSTR &lpszMessageId, INT &iDirection, INT &iState);

class AMQPMessageOutcomeEventParams {
public:
  const QString &SessionName();

  int SessionIndex();

  const QString &LinkName();

  int LinkIndex();

  const QString &MessageId();

  int Direction();

  int State();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void MessageOutcome(AMQPMessageOutcomeEventParams *e);

// Or, subclass AMQP and override this emitter function.
virtual int FireMessageOutcome(AMQPMessageOutcomeEventParams *e) {...}

Remarks

This event fires whenever the outcome for a message (incoming or outgoing) is available.

SessionName is the name of the session the message was transmitted on.

SessionIndex is the index of the session in the Sessions collection property.

LinkName is the name of the link the message was transmitted on.

LinkIndex is the index of the link in the Links collection property.

MessageId is the Id of the message; it may be empty if a message Id was not set.

Direction indicates whether this outcome was sent (0) or received (1).

State indicates the actual message outcome. Possible values are:

• 0: Accepted - The message has been processed successfully.
• 1: Rejected - The message failed to process successfully. Includes an error describing why.
• 2: Released - The message has not been (and will not be) processed.
• 3: Modified - Same as "Released", but with additional metadata for the sender.

When State is Rejected (1), the RejectErrorCondition and RejectErrorDescription configuration settings can be queried before the event handler finishes to retrieve the error information.

When State is Modified (3), the ModifiedDeliveryFailed, ModifiedMessageAnnotations, and ModifiedUndeliverableHere configuration settings can be queried before the event handler finishes to retrieve the additional metadata.

SSLServerAuthentication Event (AMQP Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(AMQPSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} AMQPSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(AMQPSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} AMQPSSLServerAuthenticationEventParams;

#define EID_AMQP_SSLSERVERAUTHENTICATION 10

virtual INT IPWORKSMQ_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class AMQPSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(AMQPSSLServerAuthenticationEventParams *e);

// Or, subclass AMQP and override this emitter function.
virtual int FireSSLServerAuthentication(AMQPSSLServerAuthenticationEventParams *e) {...}

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (AMQP Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(AMQPSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} AMQPSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(AMQPSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} AMQPSSLStatusEventParams;

#define EID_AMQP_SSLSTATUS 11

virtual INT IPWORKSMQ_CALL FireSSLStatus(LPSTR &lpszMessage);

class AMQPSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(AMQPSSLStatusEventParams *e);

// Or, subclass AMQP and override this emitter function.
virtual int FireSSLStatus(AMQPSSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

AMQPLink Type

Represents an AMQP link.

Syntax

IPWorksMQAMQPLink (declared in ipworksmq.h)

Remarks

This type represents an AMQP link.

Fields

Constructors

AMQPLink()

AMQPMessage Type

Represents an AMQP message.

Syntax

IPWorksMQAMQPMessage (declared in ipworksmq.h)

Remarks

This type represents an AMQP message.

Fields

Constructors

AMQPMessage()

AMQPSession Type

Represents an AMQP session.

Syntax

IPWorksMQAMQPSession (declared in ipworksmq.h)

Remarks

This type represents an AMQP session.

Fields

Constructors

AMQPSession()

Certificate Type

This is the digital certificate being used.

Syntax

IPWorksMQCertificate (declared in ipworksmq.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

Certificate()

Certificate(const char* lpEncoded, int lenEncoded)

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

Firewall Type

The firewall the component will connect through.

Syntax

IPWorksMQFirewall (declared in ipworksmq.h)

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

Firewall()

IPWorksMQList Type

Syntax

IPWorksMQList<T> (declared in ipworksmq.h)

Remarks

IPWorksMQList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the AMQP class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

T* Set(int index, T* value) {}

Config Settings (AMQP Class)

AMQP Config Settings

{
  "type": "map",
  "value": [
    { "type": "symbol", "value": "key1" },
    { "type": "string", "value": "test" },
    { "type": "symbol", "value": "key2" },
    { "type": "int", "value": 100 }
  ]
}

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Trappable Errors (AMQP Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

AMQP Errors

TCPClient Errors

SSL Errors

TCP/IP Errors