AMQPClassic Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

AMQPClassic

Remarks

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

Connecting

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

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

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

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

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

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

Declaring Exchanges

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

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

Exchanges can also be deleted using the DeleteExchange method.

Declaring Queues

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

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

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

Binding Queues to Exchanges

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

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

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

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

Publishing Messages

To publish a message, populate the Message property's fields, and then call the PublishMessage method.

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

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

Receiving Messages

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

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

Regardless of how they are received, all incoming messages cause the ReceivedMessage property's fields to be populated and the MessageIn event to fire.

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

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

Property List

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

Method List

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

Event List

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

Config Settings

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

Arguments Property (AMQPClassic Class)

A collection of table fields that specify arguments to send to the server when calling certain methods.

Syntax

• C++
• C
• Qt

IPWorksMQList<IPWorksMQAMQPCTableField>* GetArguments();
int SetArguments(IPWorksMQList<IPWorksMQAMQPCTableField>* val);

int ipworksmq_amqpclassic_getargumentcount(void* lpObj);
int ipworksmq_amqpclassic_setargumentcount(void* lpObj, int iArgumentCount);

char* ipworksmq_amqpclassic_getargumentname(void* lpObj, int argumentindex);
int ipworksmq_amqpclassic_setargumentname(void* lpObj, int argumentindex, const char* lpszArgumentName);

char* ipworksmq_amqpclassic_getargumentvalue(void* lpObj, int argumentindex);
int ipworksmq_amqpclassic_setargumentvalue(void* lpObj, int argumentindex, const char* lpszArgumentValue);

int ipworksmq_amqpclassic_getargumentvaluetype(void* lpObj, int argumentindex);
int ipworksmq_amqpclassic_setargumentvaluetype(void* lpObj, int argumentindex, int iArgumentValueType);

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

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

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

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

Remarks

This property holds a collection of AMQPCTableField objects representing additional arguments sent when one of the following methods is called:

• Consume
• DeclareExchange
• DeclareQueue
• BindQueue
• UnbindQueue

Arguments are typically server-dependent; refer to your server's documentation to determine what, if any, arguments are supported for each of the above methods.

This property is not available at design time.

Data Type

IPWorksMQAMQPCTableField

AuthScheme Property (AMQPClassic Class)

The authentication scheme to use when connecting.

Syntax

• C++
• C
• Qt

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

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

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

int ipworksmq_amqpclassic_getauthscheme(void* lpObj);
int ipworksmq_amqpclassic_setauthscheme(void* lpObj, int iAuthScheme);

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

Default Value

2

Remarks

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

Valid values are:

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

This property is not available at design time.

Data Type

Integer

Channels Property (AMQPClassic Class)

Collection of active channels.

Syntax

• C++
• C
• Qt

IPWorksMQList<IPWorksMQAMQPCChannel>* GetChannels();

int ipworksmq_amqpclassic_getchannelcount(void* lpObj);

int ipworksmq_amqpclassic_getchannelaccept(void* lpObj, int channelindex);

int ipworksmq_amqpclassic_getchannelmode(void* lpObj, int channelindex);

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

int ipworksmq_amqpclassic_getchannelreadytosend(void* lpObj, int channelindex);

int GetChannelCount();

bool GetChannelAccept(int iChannelIndex);

int GetChannelMode(int iChannelIndex);

QString GetChannelName(int iChannelIndex);

bool GetChannelReadyToSend(int iChannelIndex);

Remarks

This collection property holds a list of AMQPCChannel items, one for each currently active channel.

Refer to CreateChannel and CloseChannel for more information.

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

Data Type

IPWorksMQAMQPCChannel

ClientProperties Property (AMQPClassic Class)

A collection of table fields that describe properties of the client.

Syntax

• C++
• C
• Qt

IPWorksMQList<IPWorksMQAMQPCTableField>* GetClientProperties();
int SetClientProperties(IPWorksMQList<IPWorksMQAMQPCTableField>* val);

int ipworksmq_amqpclassic_getclientpropertycount(void* lpObj);
int ipworksmq_amqpclassic_setclientpropertycount(void* lpObj, int iClientPropertyCount);

char* ipworksmq_amqpclassic_getclientpropertyname(void* lpObj, int clientpropertyindex);
int ipworksmq_amqpclassic_setclientpropertyname(void* lpObj, int clientpropertyindex, const char* lpszClientPropertyName);

char* ipworksmq_amqpclassic_getclientpropertyvalue(void* lpObj, int clientpropertyindex);
int ipworksmq_amqpclassic_setclientpropertyvalue(void* lpObj, int clientpropertyindex, const char* lpszClientPropertyValue);

int ipworksmq_amqpclassic_getclientpropertyvaluetype(void* lpObj, int clientpropertyindex);
int ipworksmq_amqpclassic_setclientpropertyvaluetype(void* lpObj, int clientpropertyindex, int iClientPropertyValueType);

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

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

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

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

Remarks

This property holds a collection of AMQPCTableField objects representing client properties. During the connection process, these properties will be sent to the server.

While the class does not send any client properties by default, it is common for AMQP clients to send "product", "version", and "platform" properties to help identify themselves.

This property is not available at design time.

Data Type

IPWorksMQAMQPCTableField

Connected Property (AMQPClassic Class)

This property indicates whether the class is connected.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnected();

Unicode (Windows)
BOOL GetConnected();

int ipworksmq_amqpclassic_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

Firewall Property (AMQPClassic Class)

A set of properties related to firewall access.

Syntax

• C++
• C
• Qt

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

int ipworksmq_amqpclassic_getfirewallautodetect(void* lpObj);
int ipworksmq_amqpclassic_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int ipworksmq_amqpclassic_getfirewalltype(void* lpObj);
int ipworksmq_amqpclassic_setfirewalltype(void* lpObj, int iFirewallType);

char* ipworksmq_amqpclassic_getfirewallhost(void* lpObj);
int ipworksmq_amqpclassic_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* ipworksmq_amqpclassic_getfirewallpassword(void* lpObj);
int ipworksmq_amqpclassic_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int ipworksmq_amqpclassic_getfirewallport(void* lpObj);
int ipworksmq_amqpclassic_setfirewallport(void* lpObj, int iFirewallPort);

char* ipworksmq_amqpclassic_getfirewalluser(void* lpObj);
int ipworksmq_amqpclassic_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

Heartbeat Property (AMQPClassic Class)

The heartbeat timeout value.

Syntax

• C++
• C
• Qt

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

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

int ipworksmq_amqpclassic_getheartbeat(void* lpObj);
int ipworksmq_amqpclassic_setheartbeat(void* lpObj, int iHeartbeat);

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

Default Value

0

Remarks

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

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

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

This setting cannot be changed while connected.

This property is not available at design time.

Data Type

Integer

IncomingMessages Property (AMQPClassic Class)

Collection of incoming messages which are waiting for acknowledgment.

Syntax

• C++
• C
• Qt

IPWorksMQList<IPWorksMQAMQPCMessage>* GetIncomingMessages();

int ipworksmq_amqpclassic_getincomingmessagecount(void* lpObj);

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

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

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

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

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

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

int ipworksmq_amqpclassic_getincomingmessagedeliverymode(void* lpObj, int incomingmessageindex);

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

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

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

int ipworksmq_amqpclassic_getincomingmessagepriority(void* lpObj, int incomingmessageindex);

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

int64 ipworksmq_amqpclassic_getincomingmessagetimestamp(void* lpObj, int incomingmessageindex);

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

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

int GetIncomingMessageCount();

QString GetIncomingMessageAppId(int iIncomingMessageIndex);

QByteArray GetIncomingMessageBody(int iIncomingMessageIndex);

QString GetIncomingMessageChannelName(int iIncomingMessageIndex);

QString GetIncomingMessageContentEncoding(int iIncomingMessageIndex);

QString GetIncomingMessageContentType(int iIncomingMessageIndex);

QString GetIncomingMessageCorrelationId(int iIncomingMessageIndex);

int GetIncomingMessageDeliveryMode(int iIncomingMessageIndex);

QString GetIncomingMessageExpiration(int iIncomingMessageIndex);

QString GetIncomingMessageHeaders(int iIncomingMessageIndex);

QString GetIncomingMessageId(int iIncomingMessageIndex);

int GetIncomingMessagePriority(int iIncomingMessageIndex);

QString GetIncomingMessageReplyTo(int iIncomingMessageIndex);

qint64 GetIncomingMessageTimestamp(int iIncomingMessageIndex);

QString GetIncomingMessageType(int iIncomingMessageIndex);

QString GetIncomingMessageUserId(int iIncomingMessageIndex);

Remarks

This property holds a collection of AMQPCMessage objects that represent incoming messages the class has yet to send acknowledgements to the server for.

Refer to the MessageIn event for more information about message acknowledgements.

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

Data Type

IPWorksMQAMQPCMessage

LocalHost Property (AMQPClassic Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksmq_amqpclassic_getlocalhost(void* lpObj);
int ipworksmq_amqpclassic_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 (AMQPClassic Class)

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

Syntax

• C++
• C
• Qt

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

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

int ipworksmq_amqpclassic_getlocalport(void* lpObj);
int ipworksmq_amqpclassic_setlocalport(void* lpObj, int iLocalPort);

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

Default Value

0

Remarks

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

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

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

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

Data Type

Integer

Message Property (AMQPClassic Class)

The message to send.

Syntax

• C++
• C
• Qt

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

char* ipworksmq_amqpclassic_getmessageappid(void* lpObj);
int ipworksmq_amqpclassic_setmessageappid(void* lpObj, const char* lpszMessageAppId);

int ipworksmq_amqpclassic_getmessagebody(void* lpObj, char** lpMessageBody, int* lenMessageBody);
int ipworksmq_amqpclassic_setmessagebody(void* lpObj, const char* lpMessageBody, int lenMessageBody);

char* ipworksmq_amqpclassic_getmessagechannelname(void* lpObj);

char* ipworksmq_amqpclassic_getmessagecontentencoding(void* lpObj);
int ipworksmq_amqpclassic_setmessagecontentencoding(void* lpObj, const char* lpszMessageContentEncoding);

char* ipworksmq_amqpclassic_getmessagecontenttype(void* lpObj);
int ipworksmq_amqpclassic_setmessagecontenttype(void* lpObj, const char* lpszMessageContentType);

char* ipworksmq_amqpclassic_getmessagecorrelationid(void* lpObj);
int ipworksmq_amqpclassic_setmessagecorrelationid(void* lpObj, const char* lpszMessageCorrelationId);

int ipworksmq_amqpclassic_getmessagedeliverymode(void* lpObj);
int ipworksmq_amqpclassic_setmessagedeliverymode(void* lpObj, int iMessageDeliveryMode);

char* ipworksmq_amqpclassic_getmessageexpiration(void* lpObj);
int ipworksmq_amqpclassic_setmessageexpiration(void* lpObj, const char* lpszMessageExpiration);

char* ipworksmq_amqpclassic_getmessageheaders(void* lpObj);
int ipworksmq_amqpclassic_setmessageheaders(void* lpObj, const char* lpszMessageHeaders);

char* ipworksmq_amqpclassic_getmessageid(void* lpObj);
int ipworksmq_amqpclassic_setmessageid(void* lpObj, const char* lpszMessageId);

int ipworksmq_amqpclassic_getmessagepriority(void* lpObj);
int ipworksmq_amqpclassic_setmessagepriority(void* lpObj, int iMessagePriority);

char* ipworksmq_amqpclassic_getmessagereplyto(void* lpObj);
int ipworksmq_amqpclassic_setmessagereplyto(void* lpObj, const char* lpszMessageReplyTo);

int64 ipworksmq_amqpclassic_getmessagetimestamp(void* lpObj);
int ipworksmq_amqpclassic_setmessagetimestamp(void* lpObj, int64 lMessageTimestamp);

char* ipworksmq_amqpclassic_getmessagetype(void* lpObj);
int ipworksmq_amqpclassic_setmessagetype(void* lpObj, const char* lpszMessageType);

char* ipworksmq_amqpclassic_getmessageuserid(void* lpObj);
int ipworksmq_amqpclassic_setmessageuserid(void* lpObj, const char* lpszMessageUserId);

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

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

QString GetMessageChannelName();

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

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

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

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

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

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

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

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

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

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

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

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

Remarks

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

Refer to PublishMessage for more information.

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

This property is not available at design time.

Data Type

IPWorksMQAMQPCMessage

OutgoingMessages Property (AMQPClassic Class)

Collection of outgoing messages which are waiting for acknowledgment.

Syntax

• C++
• C
• Qt

IPWorksMQList<IPWorksMQAMQPCMessage>* GetOutgoingMessages();

int ipworksmq_amqpclassic_getoutgoingmessagecount(void* lpObj);

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

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

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

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

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

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

int ipworksmq_amqpclassic_getoutgoingmessagedeliverymode(void* lpObj, int outgoingmessageindex);

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

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

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

int ipworksmq_amqpclassic_getoutgoingmessagepriority(void* lpObj, int outgoingmessageindex);

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

int64 ipworksmq_amqpclassic_getoutgoingmessagetimestamp(void* lpObj, int outgoingmessageindex);

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

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

int GetOutgoingMessageCount();

QString GetOutgoingMessageAppId(int iOutgoingMessageIndex);

QByteArray GetOutgoingMessageBody(int iOutgoingMessageIndex);

QString GetOutgoingMessageChannelName(int iOutgoingMessageIndex);

QString GetOutgoingMessageContentEncoding(int iOutgoingMessageIndex);

QString GetOutgoingMessageContentType(int iOutgoingMessageIndex);

QString GetOutgoingMessageCorrelationId(int iOutgoingMessageIndex);

int GetOutgoingMessageDeliveryMode(int iOutgoingMessageIndex);

QString GetOutgoingMessageExpiration(int iOutgoingMessageIndex);

QString GetOutgoingMessageHeaders(int iOutgoingMessageIndex);

QString GetOutgoingMessageId(int iOutgoingMessageIndex);

int GetOutgoingMessagePriority(int iOutgoingMessageIndex);

QString GetOutgoingMessageReplyTo(int iOutgoingMessageIndex);

qint64 GetOutgoingMessageTimestamp(int iOutgoingMessageIndex);

QString GetOutgoingMessageType(int iOutgoingMessageIndex);

QString GetOutgoingMessageUserId(int iOutgoingMessageIndex);

Remarks

This property holds a collection of AMQPCMessage objects that represent outgoing messages the class has yet to receive acknowledgements from the server for.

Refer to the PublishMessage method for more information.

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

Data Type

IPWorksMQAMQPCMessage

Password Property (AMQPClassic Class)

A password to use for SASL authentication.

Syntax

• C++
• C
• Qt

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

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

char* ipworksmq_amqpclassic_getpassword(void* lpObj);
int ipworksmq_amqpclassic_setpassword(void* lpObj, const char* lpszPassword);

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

Default Value

""

Remarks

This property contains a password to use for SASL authentication.

This property is not available at design time.

Data Type

String

QueueMessageCount Property (AMQPClassic Class)

The message count returned by various queue operations.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetQueueMessageCount();

Unicode (Windows)
INT GetQueueMessageCount();

int ipworksmq_amqpclassic_getqueuemessagecount(void* lpObj);

int GetQueueMessageCount();

Default Value

0

Remarks

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

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

Data Type

Integer

ReceivedMessage Property (AMQPClassic Class)

The last message received.

Syntax

• C++
• C
• Qt

IPWorksMQAMQPCMessage* GetReceivedMessage();

char* ipworksmq_amqpclassic_getreceivedmessageappid(void* lpObj);

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

char* ipworksmq_amqpclassic_getreceivedmessagechannelname(void* lpObj);

char* ipworksmq_amqpclassic_getreceivedmessagecontentencoding(void* lpObj);

char* ipworksmq_amqpclassic_getreceivedmessagecontenttype(void* lpObj);

char* ipworksmq_amqpclassic_getreceivedmessagecorrelationid(void* lpObj);

int ipworksmq_amqpclassic_getreceivedmessagedeliverymode(void* lpObj);

char* ipworksmq_amqpclassic_getreceivedmessageexpiration(void* lpObj);

char* ipworksmq_amqpclassic_getreceivedmessageheaders(void* lpObj);

char* ipworksmq_amqpclassic_getreceivedmessageid(void* lpObj);

int ipworksmq_amqpclassic_getreceivedmessagepriority(void* lpObj);

char* ipworksmq_amqpclassic_getreceivedmessagereplyto(void* lpObj);

int64 ipworksmq_amqpclassic_getreceivedmessagetimestamp(void* lpObj);

char* ipworksmq_amqpclassic_getreceivedmessagetype(void* lpObj);

char* ipworksmq_amqpclassic_getreceivedmessageuserid(void* lpObj);

QString GetReceivedMessageAppId();

QByteArray GetReceivedMessageBody();

QString GetReceivedMessageChannelName();

QString GetReceivedMessageContentEncoding();

QString GetReceivedMessageContentType();

QString GetReceivedMessageCorrelationId();

int GetReceivedMessageDeliveryMode();

QString GetReceivedMessageExpiration();

QString GetReceivedMessageHeaders();

QString GetReceivedMessageId();

int GetReceivedMessagePriority();

QString GetReceivedMessageReplyTo();

qint64 GetReceivedMessageTimestamp();

QString GetReceivedMessageType();

QString GetReceivedMessageUserId();

Remarks

This property is an AMQPCMessage object which represents the last message received by the class. It is populated by the class automatically each time a message is received.

Refer to Consume, RetrieveMessage, and MessageIn for more information.

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

Data Type

IPWorksMQAMQPCMessage

RemoteHost Property (AMQPClassic Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksmq_amqpclassic_getremotehost(void* lpObj);
int ipworksmq_amqpclassic_setremotehost(void* lpObj, const char* lpszRemoteHost);

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

Default Value

""

Remarks

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

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

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

Example. Connecting:

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

Data Type

String

RemotePort Property (AMQPClassic Class)

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

Syntax

• C++
• C
• Qt

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

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

int ipworksmq_amqpclassic_getremoteport(void* lpObj);
int ipworksmq_amqpclassic_setremoteport(void* lpObj, int iRemotePort);

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

Default Value

5672

Remarks

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

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

This property is not available at design time.

Data Type

Integer

ServerProperties Property (AMQPClassic Class)

A collection of table fields that describe properties of the server.

Syntax

• C++
• C
• Qt

IPWorksMQList<IPWorksMQAMQPCTableField>* GetServerProperties();

int ipworksmq_amqpclassic_getserverpropertycount(void* lpObj);

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

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

int ipworksmq_amqpclassic_getserverpropertyvaluetype(void* lpObj, int serverpropertyindex);

int GetServerPropertyCount();

QString GetServerPropertyName(int iServerPropertyIndex);

QString GetServerPropertyValue(int iServerPropertyIndex);

int GetServerPropertyValueType(int iServerPropertyIndex);

Remarks

After connecting, this property will hold a collection of AMQPCTableField objects representing server properties.

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

Data Type

IPWorksMQAMQPCTableField

SSLAcceptServerCert Property (AMQPClassic 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_amqpclassic_getsslacceptservercerteffectivedate(void* lpObj);

char* ipworksmq_amqpclassic_getsslacceptservercertexpirationdate(void* lpObj);

char* ipworksmq_amqpclassic_getsslacceptservercertextendedkeyusage(void* lpObj);

char* ipworksmq_amqpclassic_getsslacceptservercertfingerprint(void* lpObj);

char* ipworksmq_amqpclassic_getsslacceptservercertfingerprintsha1(void* lpObj);

char* ipworksmq_amqpclassic_getsslacceptservercertfingerprintsha256(void* lpObj);

char* ipworksmq_amqpclassic_getsslacceptservercertissuer(void* lpObj);

char* ipworksmq_amqpclassic_getsslacceptservercertprivatekey(void* lpObj);

int ipworksmq_amqpclassic_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* ipworksmq_amqpclassic_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* ipworksmq_amqpclassic_getsslacceptservercertpublickey(void* lpObj);

char* ipworksmq_amqpclassic_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int ipworksmq_amqpclassic_getsslacceptservercertpublickeylength(void* lpObj);

char* ipworksmq_amqpclassic_getsslacceptservercertserialnumber(void* lpObj);

char* ipworksmq_amqpclassic_getsslacceptservercertsignaturealgorithm(void* lpObj);

int ipworksmq_amqpclassic_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworksmq_amqpclassic_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* ipworksmq_amqpclassic_getsslacceptservercertstorepassword(void* lpObj);
int ipworksmq_amqpclassic_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int ipworksmq_amqpclassic_getsslacceptservercertstoretype(void* lpObj);
int ipworksmq_amqpclassic_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* ipworksmq_amqpclassic_getsslacceptservercertsubjectaltnames(void* lpObj);

char* ipworksmq_amqpclassic_getsslacceptservercertthumbprintmd5(void* lpObj);

char* ipworksmq_amqpclassic_getsslacceptservercertthumbprintsha1(void* lpObj);

char* ipworksmq_amqpclassic_getsslacceptservercertthumbprintsha256(void* lpObj);

char* ipworksmq_amqpclassic_getsslacceptservercertusage(void* lpObj);

int ipworksmq_amqpclassic_getsslacceptservercertusageflags(void* lpObj);

char* ipworksmq_amqpclassic_getsslacceptservercertversion(void* lpObj);

char* ipworksmq_amqpclassic_getsslacceptservercertsubject(void* lpObj);
int ipworksmq_amqpclassic_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int ipworksmq_amqpclassic_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksmq_amqpclassic_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 (AMQPClassic Class)

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

Syntax

• C++
• C
• Qt

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

char* ipworksmq_amqpclassic_getsslcerteffectivedate(void* lpObj);

char* ipworksmq_amqpclassic_getsslcertexpirationdate(void* lpObj);

char* ipworksmq_amqpclassic_getsslcertextendedkeyusage(void* lpObj);

char* ipworksmq_amqpclassic_getsslcertfingerprint(void* lpObj);

char* ipworksmq_amqpclassic_getsslcertfingerprintsha1(void* lpObj);

char* ipworksmq_amqpclassic_getsslcertfingerprintsha256(void* lpObj);

char* ipworksmq_amqpclassic_getsslcertissuer(void* lpObj);

char* ipworksmq_amqpclassic_getsslcertprivatekey(void* lpObj);

int ipworksmq_amqpclassic_getsslcertprivatekeyavailable(void* lpObj);

char* ipworksmq_amqpclassic_getsslcertprivatekeycontainer(void* lpObj);

char* ipworksmq_amqpclassic_getsslcertpublickey(void* lpObj);

char* ipworksmq_amqpclassic_getsslcertpublickeyalgorithm(void* lpObj);

int ipworksmq_amqpclassic_getsslcertpublickeylength(void* lpObj);

char* ipworksmq_amqpclassic_getsslcertserialnumber(void* lpObj);

char* ipworksmq_amqpclassic_getsslcertsignaturealgorithm(void* lpObj);

int ipworksmq_amqpclassic_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksmq_amqpclassic_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* ipworksmq_amqpclassic_getsslcertstorepassword(void* lpObj);
int ipworksmq_amqpclassic_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int ipworksmq_amqpclassic_getsslcertstoretype(void* lpObj);
int ipworksmq_amqpclassic_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* ipworksmq_amqpclassic_getsslcertsubjectaltnames(void* lpObj);

char* ipworksmq_amqpclassic_getsslcertthumbprintmd5(void* lpObj);

char* ipworksmq_amqpclassic_getsslcertthumbprintsha1(void* lpObj);

char* ipworksmq_amqpclassic_getsslcertthumbprintsha256(void* lpObj);

char* ipworksmq_amqpclassic_getsslcertusage(void* lpObj);

int ipworksmq_amqpclassic_getsslcertusageflags(void* lpObj);

char* ipworksmq_amqpclassic_getsslcertversion(void* lpObj);

char* ipworksmq_amqpclassic_getsslcertsubject(void* lpObj);
int ipworksmq_amqpclassic_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int ipworksmq_amqpclassic_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksmq_amqpclassic_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 (AMQPClassic 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_amqpclassic_getsslenabled(void* lpObj);
int ipworksmq_amqpclassic_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 (AMQPClassic 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_amqpclassic_getsslprovider(void* lpObj);
int ipworksmq_amqpclassic_setsslprovider(void* lpObj, int iSSLProvider);

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

Default Value

0

Remarks

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

Possible values are 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 (AMQPClassic Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

IPWorksMQCertificate* GetSSLServerCert();

char* ipworksmq_amqpclassic_getsslservercerteffectivedate(void* lpObj);

char* ipworksmq_amqpclassic_getsslservercertexpirationdate(void* lpObj);

char* ipworksmq_amqpclassic_getsslservercertextendedkeyusage(void* lpObj);

char* ipworksmq_amqpclassic_getsslservercertfingerprint(void* lpObj);

char* ipworksmq_amqpclassic_getsslservercertfingerprintsha1(void* lpObj);

char* ipworksmq_amqpclassic_getsslservercertfingerprintsha256(void* lpObj);

char* ipworksmq_amqpclassic_getsslservercertissuer(void* lpObj);

char* ipworksmq_amqpclassic_getsslservercertprivatekey(void* lpObj);

int ipworksmq_amqpclassic_getsslservercertprivatekeyavailable(void* lpObj);

char* ipworksmq_amqpclassic_getsslservercertprivatekeycontainer(void* lpObj);

char* ipworksmq_amqpclassic_getsslservercertpublickey(void* lpObj);

char* ipworksmq_amqpclassic_getsslservercertpublickeyalgorithm(void* lpObj);

int ipworksmq_amqpclassic_getsslservercertpublickeylength(void* lpObj);

char* ipworksmq_amqpclassic_getsslservercertserialnumber(void* lpObj);

char* ipworksmq_amqpclassic_getsslservercertsignaturealgorithm(void* lpObj);

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

char* ipworksmq_amqpclassic_getsslservercertstorepassword(void* lpObj);

int ipworksmq_amqpclassic_getsslservercertstoretype(void* lpObj);

char* ipworksmq_amqpclassic_getsslservercertsubjectaltnames(void* lpObj);

char* ipworksmq_amqpclassic_getsslservercertthumbprintmd5(void* lpObj);

char* ipworksmq_amqpclassic_getsslservercertthumbprintsha1(void* lpObj);

char* ipworksmq_amqpclassic_getsslservercertthumbprintsha256(void* lpObj);

char* ipworksmq_amqpclassic_getsslservercertusage(void* lpObj);

int ipworksmq_amqpclassic_getsslservercertusageflags(void* lpObj);

char* ipworksmq_amqpclassic_getsslservercertversion(void* lpObj);

char* ipworksmq_amqpclassic_getsslservercertsubject(void* lpObj);

int ipworksmq_amqpclassic_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 (AMQPClassic 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_amqpclassic_gettimeout(void* lpObj);
int ipworksmq_amqpclassic_settimeout(void* lpObj, int iTimeout);

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

Default Value

60

Remarks

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

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

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

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

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

A username to use for SASL authentication.

Syntax

• C++
• C
• Qt

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

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

char* ipworksmq_amqpclassic_getuser(void* lpObj);
int ipworksmq_amqpclassic_setuser(void* lpObj, const char* lpszUser);

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

Default Value

""

Remarks

This property contains a username to use for SASL authentication.

This property is not available at design time.

Data Type

String

VirtualHost Property (AMQPClassic Class)

The virtual host to connect to.

Syntax

• C++
• C
• Qt

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

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

char* ipworksmq_amqpclassic_getvirtualhost(void* lpObj);
int ipworksmq_amqpclassic_setvirtualhost(void* lpObj, const char* lpszVirtualHost);

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

Default Value

"/"

Remarks

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

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

This setting cannot be changed while connected.

This property is not available at design time.

Data Type

String

BindQueue Method (AMQPClassic Class)

Binds a queue to an exchange.

Syntax

• C++
• C
• Qt

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

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

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

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

Remarks

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Error Handling (C++)

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

CancelConsume Method (AMQPClassic Class)

Cancels an existing consumer.

Syntax

• C++
• C
• Qt

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

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

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

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

Remarks

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

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

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

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

Error Handling (C++)

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

CloseChannel Method (AMQPClassic Class)

Closes a channel.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CloseChannel(const char* lpszChannelName);

Unicode (Windows)
INT CloseChannel(LPCWSTR lpszChannelName);

int ipworksmq_amqpclassic_closechannel(void* lpObj, const char* lpszChannelName);

int CloseChannel(const QString& qsChannelName);

Remarks

This method closes the channel named ChannelName and removes it from the Channels properties.

If no channel with the given ChannelName exists, an exception 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.)

CommitTransaction Method (AMQPClassic Class)

Commits the current transaction for a channel.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CommitTransaction(const char* lpszChannelName);

Unicode (Windows)
INT CommitTransaction(LPCWSTR lpszChannelName);

int ipworksmq_amqpclassic_committransaction(void* lpObj, const char* lpszChannelName);

int CommitTransaction(const QString& qsChannelName);

Remarks

This method commits the current transaction for the channel with the given ChannelName. A new transaction is started immediately after the current one is committed.

Refer to EnableTransactionMode for more information about transactions.

An exception is thrown if a channel with the given ChannelName doesn't exist, or if the server returns an error because the channel does not have transaction mode enabled.

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

Error Handling (C++)

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

Config Method (AMQPClassic 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_amqpclassic_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 (AMQPClassic Class)

This method connects to a remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Connect();

Unicode (Windows)
INT Connect();

int ipworksmq_amqpclassic_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 (AMQPClassic 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_amqpclassic_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.)

Consume Method (AMQPClassic Class)

Starts a new consumer for a given queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Consume(const char* lpszChannelName, const char* lpszQueueName, const char* lpszConsumerTag, int bNoLocal, int bNoAck, int bExclusive, int bNoWait);

Unicode (Windows)
INT Consume(LPCWSTR lpszChannelName, LPCWSTR lpszQueueName, LPCWSTR lpszConsumerTag, BOOL bNoLocal, BOOL bNoAck, BOOL bExclusive, BOOL bNoWait);

int ipworksmq_amqpclassic_consume(void* lpObj, const char* lpszChannelName, const char* lpszQueueName, const char* lpszConsumerTag, int bNoLocal, int bNoAck, int bExclusive, int bNoWait);

int Consume(const QString& qsChannelName, const QString& qsQueueName, const QString& qsConsumerTag, bool bNoLocal, bool bNoAck, bool bExclusive, bool bNoWait);

Remarks

This method instructs the server to start a new consumer on the queue named QueueName; once the consumer is created, it will cause messages enqueued to the specified queue to be delivered to the class over the channel specified by ChannelName.

Consumers last as long as the channel they were created on, or until they are cancelled using the CancelConsume method. Each time a message is delivered to the class, it is immediately added to the IncomingMessages collection, the ReceivedMessage property is populated, and the MessageIn event fires.

ConsumerTag is a string which uniquely identifies the new consumer on the specified channel. If empty string is passed for ConsumerTag, the server will generate a consumer tag automatically when it creates the . this auto-generated consumer tag can then be retrieved by querying the ConsumerTag configuration setting after this method returns.

The NoLocal parameter, if True, ensures that the consumer never consumes messages published on the same channel. (Note that this functionality is not available on RabbitMQ servers, which ignore the NoLocal parameter).

The NoAck parameter controls whether the server will expect the class to acknowledge the each message delivered. Refer to MessageIn for more information about acknowledging messages.

The Exclusive parameter, if True, will cause the class to request that the server create an exclusive consumer. Attaching an exclusive consumer to a queue prevents any other consumers from consuming messages from that queue.

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

Additional arguments may be sent with this request by adding them to the Arguments collection. Arguments are server-dependent; refer to your server's documentation to determine if any additional arguments apply for this request.

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

• No queue with the given QueueName exists.
• The given ConsumerTag is already in use on the specified channel.
• An exclusive consumer was requested for a queue which already has consumers attached to it.

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

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

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.)

CreateChannel Method (AMQPClassic Class)

Creates a new channel.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateChannel(const char* lpszChannelName);

Unicode (Windows)
INT CreateChannel(LPCWSTR lpszChannelName);

int ipworksmq_amqpclassic_createchannel(void* lpObj, const char* lpszChannelName);

int CreateChannel(const QString& qsChannelName);

Remarks

This method creates a new channel with the name ChannelName and adds it to the Channels properties. If a channel with the given ChannelName already exists, an error will be thrown.

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

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.)

DeclareExchange Method (AMQPClassic Class)

Verifies that an exchange exists, potentially creating it if necessary.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeclareExchange(const char* lpszChannelName, const char* lpszExchangeName, const char* lpszExchangeType, int bPassive, int bDurable, int bAutoDelete, int bNoWait);

Unicode (Windows)
INT DeclareExchange(LPCWSTR lpszChannelName, LPCWSTR lpszExchangeName, LPCWSTR lpszExchangeType, BOOL bPassive, BOOL bDurable, BOOL bAutoDelete, BOOL bNoWait);

int ipworksmq_amqpclassic_declareexchange(void* lpObj, const char* lpszChannelName, const char* lpszExchangeName, const char* lpszExchangeType, int bPassive, int bDurable, int bAutoDelete, int bNoWait);

int DeclareExchange(const QString& qsChannelName, const QString& qsExchangeName, const QString& qsExchangeType, bool bPassive, bool bDurable, bool bAutoDelete, bool bNoWait);

Remarks

This method is used to verify that an exchange named ExchangeName exists; and potentially creates it if no such exchange exists.

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

ExchangeName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters, and must not begin with amq. unless the Passive parameter is True.

ExchangeType specifies the exchange type. All servers support the direct and fanout exchange types, and most should also support the topic and header exchange types. Some servers may support additional, custom exchange types as well. Refer to your server's documentation for more information about each exchange type, and to determine what exchange types it supports other than direct and fanout.

If Passive is True, the server will only verify that an exchange with the given ExchangeName actually exists (regardless of how it is configured).

If Passive is False, and no exchange named ExchangeName currently exists, the server will create one.

If Passive is False, and there is a preexisting exchange named ExchangeName, the server will verify that its current configuration matches the given parameters and arguments.

Durable specifies what happens to the exchange in the event of a server restart. Durable exchanges will be recreated, while non-durable (transient) exchanges will not.

AutoDelete specifies whether the server should automatically delete the exchange when all queues have been unbound from it. Note that this parameter is only sent if the RabbitMQCompatible configuration setting is enabled; it is ignored otherwise.

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

Additional arguments may be sent with this request by adding them to the Arguments collection. Arguments are server-dependent; refer to your server's documentation to determine if any additional arguments apply for this request.

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

• One of the parameter constraints described above was violated.
• One of the verification cases described above fails.
• The value passed for ExchangeType did not correspond to an exchange type supported by the server.

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

Declaring an Exchange // Declare a direct-type exchange. amqpc1.DeclareExchange("channel", "MyExchange", "direct", false, false, false, 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.)

DeclareQueue Method (AMQPClassic Class)

Verifies that a queue exists, potentially creating it if necessary.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeclareQueue(const char* lpszChannelName, const char* lpszQueueName, int bPassive, int bDurable, int bExclusive, int bAutoDelete, int bNoWait);

Unicode (Windows)
INT DeclareQueue(LPCWSTR lpszChannelName, LPCWSTR lpszQueueName, BOOL bPassive, BOOL bDurable, BOOL bExclusive, BOOL bAutoDelete, BOOL bNoWait);

int ipworksmq_amqpclassic_declarequeue(void* lpObj, const char* lpszChannelName, const char* lpszQueueName, int bPassive, int bDurable, int bExclusive, int bAutoDelete, int bNoWait);

int DeclareQueue(const QString& qsChannelName, const QString& qsQueueName, bool bPassive, bool bDurable, bool bExclusive, bool bAutoDelete, bool bNoWait);

Remarks

This method is used to verify that a queue named QueueName exists; and potentially creates it if no such queue exists.

After each successful call to this method, the class populates the QueueMessageCount property, as well as the QueueConsumerCount and QueueName configuration settings. Refer to each one for more information.

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

If creating a new queue, empty string can be passed for QueueName to have the server automatically generate a name for the new queue (which can then be retrieved using the QueueName configuration setting). In all other cases, QueueName must be a non-empty string consisting only of letters, digits, hyphens, underscores, periods, and colons. It must be no longer than 255 characters, and must not begin with amq. unless the Passive parameter is True.

If Passive is True, the server will only verify that a queue with the given QueueName actually exists (regardless of how it is configured).

If Passive is False, and no queue named QueueName currently exists, the server will create one.

If Passive is False, and there is a preexisting queue named QueueName, the server will verify that its current configuration matches the given parameters and arguments.

Durable specifies what happens to the queue in the event of a server restart. Durable queue will be recreated, while non-durable (transient) queue will not. (Note that the messages in durable queues will still be lost unless they are marked as persistent.)

Exclusive, if True, indicates that the queue may only be accessed by the current connection. Exclusive queues are deleted when the current connection closes.

AutoDelete specifies whether the server should automatically delete the queue when all consumers have finished using it. (Note that auto-delete queues aren't eligible for deletion until after a consumer attaches to them for the first time.)

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

Additional arguments may be sent with this request by adding them to the Arguments collection. Arguments are server-dependent; refer to your server's documentation to determine if any additional arguments apply for this request.

An exception is thrown if no channel with the given ChannelName exists, if QueueName empty string and NoWait is True, or if the server returns an error because:

• One of the parameter constraints described above was violated.
• One of the verification cases described above fails.
• An attempt was made to verify (i.e., the Passive parameter was True) another connection's exclusive queue.

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

Declaring a Queue // Declare a queue. amqpc1.DeclareQueue("channel", "MyQueue", false, false, false, false, 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.)

DeleteExchange Method (AMQPClassic Class)

Deletes an exchange.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteExchange(const char* lpszChannelName, const char* lpszExchangeName, int bIfUnused, int bNoWait);

Unicode (Windows)
INT DeleteExchange(LPCWSTR lpszChannelName, LPCWSTR lpszExchangeName, BOOL bIfUnused, BOOL bNoWait);

int ipworksmq_amqpclassic_deleteexchange(void* lpObj, const char* lpszChannelName, const char* lpszExchangeName, int bIfUnused, int bNoWait);

int DeleteExchange(const QString& qsChannelName, const QString& qsExchangeName, bool bIfUnused, bool bNoWait);

Remarks

This method is used to delete an exchange.

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

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

When IfUnused is True, the server will only delete the exchange if no queues are bound to it.

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

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

• The value passed for ExchangeName fails one or more of the constraints described above.
• No exchange named ExchangeName exists. (This does not apply for RabbitMQ; attempting to delete a non-existent exchange will always succeed.)
• The IfUnused parameter was True, but the exchange still had one or more queues bound to it.

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

Error Handling (C++)

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

DeleteQueue Method (AMQPClassic Class)

Deletes a queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteQueue(const char* lpszChannelName, const char* lpszQueueName, int bIfUnused, int bIfEmpty, int bNoWait);

Unicode (Windows)
INT DeleteQueue(LPCWSTR lpszChannelName, LPCWSTR lpszQueueName, BOOL bIfUnused, BOOL bIfEmpty, BOOL bNoWait);

int ipworksmq_amqpclassic_deletequeue(void* lpObj, const char* lpszChannelName, const char* lpszQueueName, int bIfUnused, int bIfEmpty, int bNoWait);

int DeleteQueue(const QString& qsChannelName, const QString& qsQueueName, bool bIfUnused, bool bIfEmpty, bool bNoWait);

Remarks

This method is used to delete the queue named QueueName.

After each successful call to this method, the class populates the QueueMessageCount property with the number of messages deleted along with the queue. (Note that this does not occur if the NoWait parameter is set to True.)

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

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

When IfUnused is True, the server will only delete the queue if no consumers are attached to it.

When IfEmpty is True, the server will only delete the queue if it has no messages in it. (When IfEmpty is False, servers will typically move any remaining messages to a dead-letter queue, if one is available.)

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

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

• The value passed for QueueName fails one or more of the constraints described above.
• No queue named QueueName exists. (This does not apply for RabbitMQ; attempting to delete a non-existent queue will always succeed.)
• The IfUnused parameter was True, but the queue still had one or more consumers attached to it.
• The IfEmpty parameter was True, but the queue still had one or more messages in it.

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

Error Handling (C++)

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

Disconnect Method (AMQPClassic Class)

This method disconnects from the remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Disconnect();

Unicode (Windows)
INT Disconnect();

int ipworksmq_amqpclassic_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 (AMQPClassic 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_amqpclassic_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.)

EnablePublishConfirms Method (AMQPClassic Class)

Enables publish confirmations mode for a channel.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT EnablePublishConfirms(LPCWSTR lpszChannelName, BOOL bNoWait);

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

int EnablePublishConfirms(const QString& qsChannelName, bool bNoWait);

Remarks

This method enables publish confirmations mode for the channel with the given ChannelName.

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

Note that a channel will stay in publish confirmations mode, once enabled, until it is deleted.

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

An exception is thrown if the RabbitMQCompatible configuration setting is currently False, if no channel with the given ChannelName exists, or if EnableTransactionMode has been called for the specified channel previously.

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.)

EnableTransactionMode Method (AMQPClassic Class)

Enables transaction mode for a channel.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int EnableTransactionMode(const char* lpszChannelName);

Unicode (Windows)
INT EnableTransactionMode(LPCWSTR lpszChannelName);

int ipworksmq_amqpclassic_enabletransactionmode(void* lpObj, const char* lpszChannelName);

int EnableTransactionMode(const QString& qsChannelName);

Remarks

This method enables transaction mode for the channel with the given ChannelName.

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

To commit the current transaction on a channel, call CommitTransaction; and to roll it back (and discard the messages and acknowledgements that were part of it), call RollbackTransaction.

Keep in mind that, according to the AMQP 0.9.1 specification:

• A new transaction is always started immediately after committing or rolling back the current one, which means that...
• ...a channel will stay in transaction mode, once enabled, until it is deleted.
• Transactions are only guaranteed to be atomic if all messages published and acknowledgements sent affect a single queue.
• Any messages published on a channel in transaction mode that have the Mandatory or Immediate flags set are not guaranteed to be included in the transaction.

An exception is thrown if no channel with the given ChannelName exists, or if EnablePublishConfirms has been called for the specified channel previously.

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

Interrupt the current action and disconnects from the remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int ipworksmq_amqpclassic_interrupt(void* lpObj);

int Interrupt();

Remarks

This method will interrupt the current method (if applicable) and cause the class to disconnect from the remote 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.)

PublishMessage Method (AMQPClassic Class)

Publishes a message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int PublishMessage(const char* lpszChannelName, const char* lpszExchangeName, const char* lpszRoutingKey, int bMandatory, int bImmediate);

Unicode (Windows)
INT PublishMessage(LPCWSTR lpszChannelName, LPCWSTR lpszExchangeName, LPCWSTR lpszRoutingKey, BOOL bMandatory, BOOL bImmediate);

int ipworksmq_amqpclassic_publishmessage(void* lpObj, const char* lpszChannelName, const char* lpszExchangeName, const char* lpszRoutingKey, int bMandatory, int bImmediate);

int PublishMessage(const QString& qsChannelName, const QString& qsExchangeName, const QString& qsRoutingKey, bool bMandatory, bool bImmediate);

Remarks

This method is used to publish the message specified by the Message property to the exchange named ExchangeName over the channel specified by ChannelName.

When this method is called, the message to publish is immediately added to the OutgoingMessages collection, and the MessageOut event fires once it has been sent (or, if the specified channel is in "publish confirmations" mode, after the server has acknowledged it).

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

Note that messages published over channels which are in either transaction or "publish confirmations" mode may be handled differently than they would be on a channel in normal mode. Refer to the EnableTransactionMode and EnablePublishConfirms methods for more information about what each mode entails.

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

The RoutingKey parameter specifies the message's routing key. Whether this parameter needs to be non-empty, and what format it should have if so, depends on the type of exchange it is being sent to. Some exchange types may use information included with the message, such as its Headers. Refer to BindQueue for more information about how routing keys are used, and to your server's documentation for information on what it expects.

The Mandatory parameter controls what the server should do if the message can't be routed to any queue (either because it isn't eligible for any of the queues bound to the specified exchange because of how their bindings are configured, or because no queues are bound to the exchange in the first place). If True, the server will return the message, at which point the MessageReturned event will be fired. If False, the server will drop the message.

The Immediate parameter controls what the server should do if the message can't be immediately delivered to any consumer (either because it cannot be routed to a queue, or because the queues it can be routed to have no active consumers attached to them). If True, the server will return the message, at which point the MessageReturned event will be fired. If False, the server will queue the message if possible, or drop it if not.

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

• The value passed for ExchangeName fails one or more of the constraints described above.
• No exchange named ExchangeName exists.
• The message is rejected for some reason.

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

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

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.)

PurgeQueue Method (AMQPClassic Class)

Purges all messages from a queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int PurgeQueue(const char* lpszChannelName, const char* lpszQueueName, int bNoWait);

Unicode (Windows)
INT PurgeQueue(LPCWSTR lpszChannelName, LPCWSTR lpszQueueName, BOOL bNoWait);

int ipworksmq_amqpclassic_purgequeue(void* lpObj, const char* lpszChannelName, const char* lpszQueueName, int bNoWait);

int PurgeQueue(const QString& qsChannelName, const QString& qsQueueName, bool bNoWait);

Remarks

This method purges all messages from the queue named QueueName. Messages which have been sent but are awaiting acknowledgment are not affected.

After each successful call to this method, the class populates the QueueMessageCount property with the number of messages purged from the queue. (Note that this does not occur if the NoWait parameter is set to True.)

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

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

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

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

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

Error Handling (C++)

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

Recover Method (AMQPClassic Class)

Request that the server redeliver all messages on a given channel that have not been acknowledged.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Recover(const char* lpszChannelName, int bRequeue);

Unicode (Windows)
INT Recover(LPCWSTR lpszChannelName, BOOL bRequeue);

int ipworksmq_amqpclassic_recover(void* lpObj, const char* lpszChannelName, int bRequeue);

int Recover(const QString& qsChannelName, bool bRequeue);

Remarks

This method is used to request that the server redeliver all messages that it previously sent to the class on the channel specified by ChannelName which are still awaiting acknowledgment.

A call to this method may cause the server to redeliver zero or more messages over the channel specified by ChannelName. Those messages will cause the MessageIn event to fire with its Redelivered event parameter set to True.

The Requeue parameter controls how the server should attempt to redeliver the messages awaiting acknowledgment. If set to True, the server will simple put the messages back on their original queues, and they will be delivered like any other queued messages (potentially to other consumers). If set to False, the server will redeliver the messages to the class directly.

An exception is thrown if no channel with the given ChannelName exists, or (for RabbitMQ only) if the server returns an error because Requeue was False. (RabbitMQ only supports setting Requeue to True.)

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

Error Handling (C++)

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

Reset Method (AMQPClassic Class)

This method will reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksmq_amqpclassic_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 (AMQPClassic Class)

Resets the Message properties.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ResetMessage();

Unicode (Windows)
INT ResetMessage();

int ipworksmq_amqpclassic_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 (AMQPClassic Class)

Attempts to retrieve a message from a given queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RetrieveMessage(const char* lpszChannelName, const char* lpszQueueName, int bNoAck);

Unicode (Windows)
INT RetrieveMessage(LPCWSTR lpszChannelName, LPCWSTR lpszQueueName, BOOL bNoAck);

int ipworksmq_amqpclassic_retrievemessage(void* lpObj, const char* lpszChannelName, const char* lpszQueueName, int bNoAck);

int RetrieveMessage(const QString& qsChannelName, const QString& qsQueueName, bool bNoAck);

Remarks

This method attempts to retrieve a message from the queue named QueueName over the channel named ChannelName.

If a message is retrieved as a result of this method being called, it is immediately added to the IncomingMessages collection, the ReceivedMessage property is populated, and the MessageIn event fires.

Even if no message gets retrieved, the MessageIn event will still fire as long as the request was successful. The server returns the number of available messages in the specified queue in response to all successful retrieve requests, and that count is exposed by MessageIn event's MessageCount parameter. Refer to the MessageIn event for more information.

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

The NoAck parameter controls whether the server will expect the class to acknowledge the retrieved message. Refer to MessageIn for more information about acknowledging messages.

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

• No queue with the given QueueName exists.
• The specified queue exists, but is locked or otherwise unavailable to consume from (e.g., an exclusive consumer might be attached to it).

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

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

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.)

RollbackTransaction Method (AMQPClassic Class)

Rolls back the current transaction for a channel.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RollbackTransaction(const char* lpszChannelName);

Unicode (Windows)
INT RollbackTransaction(LPCWSTR lpszChannelName);

int ipworksmq_amqpclassic_rollbacktransaction(void* lpObj, const char* lpszChannelName);

int RollbackTransaction(const QString& qsChannelName);

Remarks

This method rolls back the current transaction for the channel with the given ChannelName. A new transaction is started immediately after the current one is rolled back.

Refer to EnableTransactionMode for more information about transactions.

An exception is thrown if a channel with the given ChannelName doesn't exist, or if the server returns an error because the channel does not have transaction mode enabled.

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

Error Handling (C++)

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

SetChannelAccept Method (AMQPClassic Class)

Disables or enables message acceptance for a given channel.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetChannelAccept(const char* lpszChannelName, int bAccept);

Unicode (Windows)
INT SetChannelAccept(LPCWSTR lpszChannelName, BOOL bAccept);

int ipworksmq_amqpclassic_setchannelaccept(void* lpObj, const char* lpszChannelName, int bAccept);

int SetChannelAccept(const QString& qsChannelName, bool bAccept);

Remarks

This method is used to disable and enable message acceptance for the channel specified by ChannelName.

A channel is always configured to accept messages when first created, allowing the server to freely deliver messages to the class for any consumers that have been created on that channel using the Consume method.

Disabling message acceptance for a channel prevents the server from automatically delivering messages to the class over it; however, it is still possible to use the RetrieveMessage method to synchronously attempt to retrieve a message on a channel with message acceptance disabled.

An exception is thrown if no channel with the given ChannelName exists, or (for RabbitMQ only) if the server returns an error because Accept was False. (RabbitMQ does not support disabling message acceptance.)

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

Error Handling (C++)

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

SetQoS Method (AMQPClassic Class)

Requests a specific quality of service (QoS).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetQoS(const char* lpszChannelName, int iPrefetchSize, int iPrefetchCount, int bGlobal);

Unicode (Windows)
INT SetQoS(LPCWSTR lpszChannelName, INT iPrefetchSize, INT iPrefetchCount, BOOL bGlobal);

int ipworksmq_amqpclassic_setqos(void* lpObj, const char* lpszChannelName, int iPrefetchSize, int iPrefetchCount, int bGlobal);

int SetQoS(const QString& qsChannelName, int iPrefetchSize, int iPrefetchCount, bool bGlobal);

Remarks

This method is used to request a specific quality of service for a certain scope. When the PrefetchSize and/or PrefetchCount are set for a certain scope, the server will limit how many messages it sends to the class before stopping to wait for one or more of them to be acknowledged.

ChannelName is the name of the channel which is used to send the request. Depending on the server and what Global is set to, it may also be significant to the request itself (refer to the Global parameter's description, below, for more information).

PrefetchSize specifies a window size in bytes; i.e., the server will stop sending messages if the total size of all of the currently unacknowledged messages already sent, plus the size of the next message that could be sent, exceeds PrefetchSize bytes. A PrefetchSize of 0 indicates no limit. (Note that RabbitMQ does not support prefetch size limits.)

PrefetchCount specifies the number of unacknowledged messages the server will limit itself to sending. A PrefetchCount of 0 indicates no limit.

Global specifies the scope which the QoS request should apply to. It is interpreted differently based on whether the server is RabbitMQ or not. Refer to this table:

Keep the following things in mind when using QoS:

• The limits specified by a QoS request only affect messages that require acknowledgment.
• How the server chooses to handle interactions between QoS settings at different scopes is server-dependent.

An exception is thrown if no channel with the given ChannelName exists, or if the server returns an error for any reason.

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

Error Handling (C++)

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

UnbindQueue Method (AMQPClassic Class)

Removes a previously-created queue binding.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT UnbindQueue(LPCWSTR lpszChannelName, LPCWSTR lpszQueueName, LPCWSTR lpszExchangeName, LPCWSTR lpszRoutingKey);

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

int UnbindQueue(const QString& qsChannelName, const QString& qsQueueName, const QString& qsExchangeName, const QString& qsRoutingKey);

Remarks

This method removes a previously-created queue binding.

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

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

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

RoutingKey should be the same routing key used when originally creating the binding that is to be removed. For bindings created using arguments instead of a routing key, the Arguments collection must contain the same items used originally instead.

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

• No queue with the given QueueName exists. (Does not apply to RabbitMQ.)
• No exchange with the given ExchangeName exists. (Does not apply to RabbitMQ.)

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

Error Handling (C++)

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

ChannelReadyToSend Event (AMQPClassic Class)

Fires when a channel is ready to send messages.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireChannelReadyToSend(AMQPClassicChannelReadyToSendEventParams *e);

typedef struct {
  const char *ChannelName;
  int reserved;
} AMQPClassicChannelReadyToSendEventParams;


Unicode (Windows)
virtual INT FireChannelReadyToSend(AMQPClassicChannelReadyToSendEventParams *e);

typedef struct {
  LPCWSTR ChannelName;
  INT reserved;
} AMQPClassicChannelReadyToSendEventParams;

#define EID_AMQPCLASSIC_CHANNELREADYTOSEND 1

virtual INT IPWORKSMQ_CALL FireChannelReadyToSend(LPSTR &lpszChannelName);

class AMQPClassicChannelReadyToSendEventParams {
public:
  const QString &ChannelName();

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

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

// Or, subclass AMQPClassic and override this emitter function.
virtual int FireChannelReadyToSend(AMQPClassicChannelReadyToSendEventParams *e) {...}

Remarks

This event fires when a channel is ready to send messages.

ChannelName is the name of the channel.

Connected Event (AMQPClassic Class)

Fired immediately after a connection completes (or fails).

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AMQPCLASSIC_CONNECTED 2

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

class AMQPClassicConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

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

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

// Or, subclass AMQPClassic and override this emitter function.
virtual int FireConnected(AMQPClassicConnectedEventParams *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 (AMQPClassic Class)

Fired to indicate changes in the connection state.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AMQPCLASSIC_CONNECTIONSTATUS 3

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

class AMQPClassicConnectionStatusEventParams {
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(AMQPClassicConnectionStatusEventParams *e);

// Or, subclass AMQPClassic and override this emitter function.
virtual int FireConnectionStatus(AMQPClassicConnectionStatusEventParams *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 (AMQPClassic Class)

Fired when a connection is closed.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AMQPCLASSIC_DISCONNECTED 4

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

class AMQPClassicDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

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

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

// Or, subclass AMQPClassic and override this emitter function.
virtual int FireDisconnected(AMQPClassicDisconnectedEventParams *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 (AMQPClassic Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AMQPCLASSIC_ERROR 5

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

class AMQPClassicErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass AMQPClassic and override this emitter function.
virtual int FireError(AMQPClassicErrorEventParams *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.

Log Event (AMQPClassic Class)

Fires once for each log message.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AMQPCLASSIC_LOG 6

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

class AMQPClassicLogEventParams {
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(AMQPClassicLogEventParams *e);

// Or, subclass AMQPClassic and override this emitter function.
virtual int FireLog(AMQPClassicLogEventParams *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.
• Frame: Frame status messages.

MessageIn Event (AMQPClassic Class)

Fires when a message is received; as well as when an attempt is made to fetch a message from a currently empty queue.

Syntax

• C++
• C
• Qt

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

typedef struct {
  const char *ChannelName;
  const char *ConsumerTag;
  int64 DeliveryTag;
  int Redelivered;
  const char *ExchangeName;
  const char *RoutingKey;
  int MessageCount;
  int Accept;
  int reserved;
} AMQPClassicMessageInEventParams;


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

typedef struct {
  LPCWSTR ChannelName;
  LPCWSTR ConsumerTag;
  LONG64 DeliveryTag;
  BOOL Redelivered;
  LPCWSTR ExchangeName;
  LPCWSTR RoutingKey;
  INT MessageCount;
  INT Accept;
  INT reserved;
} AMQPClassicMessageInEventParams;

#define EID_AMQPCLASSIC_MESSAGEIN 7

virtual INT IPWORKSMQ_CALL FireMessageIn(LPSTR &lpszChannelName, LPSTR &lpszConsumerTag, LONG64 &lDeliveryTag, BOOL &bRedelivered, LPSTR &lpszExchangeName, LPSTR &lpszRoutingKey, INT &iMessageCount, INT &iAccept);

class AMQPClassicMessageInEventParams {
public:
  const QString &ChannelName();

  const QString &ConsumerTag();

  qint64 DeliveryTag();

  bool Redelivered();

  const QString &ExchangeName();

  const QString &RoutingKey();

  int MessageCount();

  int Accept();
  void SetAccept(int iAccept);

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

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

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

Remarks

This event fires anytime a message is received. There are two possible ways for the class to receive a message:

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

This event also fires anytime RetrieveMessage is called against a queue that currently has no messages available to pull. This is a special case, and results in only the ChannelName and MessageCount event parameters being populated.

Other than that special case, and any exceptions noted below, this event's parameters are populated the same way regardless of the manner in which messages are received.

ChannelName always reflects the name of the associated channel.

ConsumerTag reflects the consumer tag associated with the consumer that caused the server to push the message to the class. (ConsumerTag is always empty for messages pulled from the server by RetrieveMessage since no consumers are involved.)

DeliveryTag reflects the server-assigned, channel-specific delivery tag number for the incoming message.

Redelivered reflects whether the server is redelivering a message that is has delivered previously.

ExchangeName reflects the name of the exchange to which the incoming message was originally published. (If the message was originally published to the server's default exchange, whose name is always the empty string, ExchangeName will also be empty.)

RoutingKey reflects the routing key that the message was originally published with.

MessageCount is always -1 when this event fires due to a message being pushed to the class by the server. When this event fires as a result of RetrieveMessage being called, MessageCount reflects the number of messages still available in the queue the class tried to pull a message from (even if there were no messages available to pull).

The Accept parameter can be set to control how the class responds to the incoming message, if it needs to be acknowledged (if the message doesn't need to be acknowledged, the value set to the Accept parameter is ignored). Valid values are:

• 0 - default: Accept the message; send a positive acknowledgment.
• 1: Silently accept the message; don't send any acknowledgment.
• 2: Accept the message; send a cumulative positive acknowledgment coving this, and all previously unacknowledged, messages.
• 3: Reject the message; send a negative acknowledgment for it, and instruct the server not to return it to the queue.
• 4: Reject the message; send a negative acknowledgment for it, and instruct the server to return it to the queue.

If the value provided for the Accept parameter isn't one of those described above, the default (0) will be used instead.

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

MessageOut Event (AMQPClassic Class)

Fires when a message is published.

Syntax

• C++
• C
• Qt

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

typedef struct {
  const char *ChannelName;
  const char *ExchangeName;
  const char *RoutingKey;
  const char *MessageId;
  int64 DeliveryTag;
  int Accepted;
  int reserved;
} AMQPClassicMessageOutEventParams;


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

typedef struct {
  LPCWSTR ChannelName;
  LPCWSTR ExchangeName;
  LPCWSTR RoutingKey;
  LPCWSTR MessageId;
  LONG64 DeliveryTag;
  BOOL Accepted;
  INT reserved;
} AMQPClassicMessageOutEventParams;

#define EID_AMQPCLASSIC_MESSAGEOUT 8

virtual INT IPWORKSMQ_CALL FireMessageOut(LPSTR &lpszChannelName, LPSTR &lpszExchangeName, LPSTR &lpszRoutingKey, LPSTR &lpszMessageId, LONG64 &lDeliveryTag, BOOL &bAccepted);

class AMQPClassicMessageOutEventParams {
public:
  const QString &ChannelName();

  const QString &ExchangeName();

  const QString &RoutingKey();

  const QString &MessageId();

  qint64 DeliveryTag();

  bool Accepted();

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

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

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

Remarks

This event fires anytime a message is published; or after an outgoing message has been acknowledged by the server, if the channel it was published on is in "publish confirmations" mode.

ChannelName reflects the name of the channel the message was published on.

ExchangeName reflects the name of the exchange the message was published to. (If the message was published to the server's default exchange, whose name is always the empty string, ExchangeName will also be empty.)

RoutingKey reflects the routing key that the message was published with.

MessageId reflects the message's unique Id, if one was set.

DeliveryTag reflects the channel-specific delivery tag number for the message. (Note that this is only populated for messages published on a channel in "publish confirmations" mode; otherwise it will be set to -1.)

Accepted indicates whether the server published back a positive True or negative False acknowledgment for the outgoing message. Note that this is only valid for messages published on a channel in "publish confirmations" mode; Accepted will always be True messages published on a channel in normal or transaction mode.

Refer to EnablePublishConfirms for more information about channels in "publish confirmations" mode.

MessageReturned Event (AMQPClassic Class)

Fires if a previously published message is returned by the server due to it being undeliverable.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireMessageReturned(AMQPClassicMessageReturnedEventParams *e);

typedef struct {
  const char *ChannelName;
  int ReplyCode;
  const char *ReplyText;
  const char *ExchangeName;
  const char *RoutingKey;
  int reserved;
} AMQPClassicMessageReturnedEventParams;


Unicode (Windows)
virtual INT FireMessageReturned(AMQPClassicMessageReturnedEventParams *e);

typedef struct {
  LPCWSTR ChannelName;
  INT ReplyCode;
  LPCWSTR ReplyText;
  LPCWSTR ExchangeName;
  LPCWSTR RoutingKey;
  INT reserved;
} AMQPClassicMessageReturnedEventParams;

#define EID_AMQPCLASSIC_MESSAGERETURNED 9

virtual INT IPWORKSMQ_CALL FireMessageReturned(LPSTR &lpszChannelName, INT &iReplyCode, LPSTR &lpszReplyText, LPSTR &lpszExchangeName, LPSTR &lpszRoutingKey);

class AMQPClassicMessageReturnedEventParams {
public:
  const QString &ChannelName();

  int ReplyCode();

  const QString &ReplyText();

  const QString &ExchangeName();

  const QString &RoutingKey();

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

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

// Or, subclass AMQPClassic and override this emitter function.
virtual int FireMessageReturned(AMQPClassicMessageReturnedEventParams *e) {...}

Remarks

This event fires if the server returns a previously published message because it could not deliver it. Typically, messages are only undeliverable in one of the following situations:

• The message was originally published with the Mandatory option enabled, but there were no queues it could be routed to.
• The message was originally published with the Immediate option enabled, but there were no consumers it could be delivered to immediately on any queue it was routed to (or there were no queues it could be routed to).

The ReceivedMessage property will be populated with the returned message.

ChannelName reflects the name of the channel the message was originally published on.

ReplyCode will be an AMQP error code that indicates the reason why the message was returned. (Tip: The AMQPClassic class's Error Codes page includes the various AMQP error codes.)

ReplyText will be a message with further details about why the message was returned.

ExchangeName reflects the name of the exchange to which the message was originally published. (If the message was originally published to the server's default exchange, whose name is always the empty string, ExchangeName will also be empty.)

RoutingKey reflects the routing key that the message was originally published with.

SSLServerAuthentication Event (AMQPClassic Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AMQPCLASSIC_SSLSERVERAUTHENTICATION 10

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

class AMQPClassicSSLServerAuthenticationEventParams {
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(AMQPClassicSSLServerAuthenticationEventParams *e);

// Or, subclass AMQPClassic and override this emitter function.
virtual int FireSSLServerAuthentication(AMQPClassicSSLServerAuthenticationEventParams *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 (AMQPClassic Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AMQPCLASSIC_SSLSTATUS 11

virtual INT IPWORKSMQ_CALL FireSSLStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

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

AMQPCChannel Type

Represents an AMQP 0.9.1 channel.

Syntax

IPWorksMQAMQPCChannel (declared in ipworksmq.h)

Remarks

This type represents an AMQP 0.9.1 channel.

Fields

Constructors

AMQPCChannel()

AMQPCMessage Type

Represents an AMQP 0.9.1 message.

Syntax

IPWorksMQAMQPCMessage (declared in ipworksmq.h)

Remarks

This type represents an AMQP 0.9.1 message.

Fields

[
  { "name": "Header1", "type": "long", "value": 12345678901234 },
  { "name": "Header2", "type": "boolean", "value": "false" },
  { "name": "Header3", "type": "string", "value": "This is a test." }
]

[
  { "type": "int", "value": 23 },
  { "type": "int", "value": -52 },
  { "type": "int", "value": 153325 }
]

Constructors

AMQPCMessage()

AMQPCTableField Type

Represents an AMQP 0.9.1 table field.

Syntax

IPWorksMQAMQPCTableField (declared in ipworksmq.h)

Remarks

This type represents an AMQP 0.9.1 table field.

Fields

[
  { "type": "int", "value": 23 },
  { "type": "int", "value": -52 },
  { "type": "int", "value": 153325 }
]

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

Constructors

AMQPCTableField()

AMQPCTableField(const char* lpszName, const char* lpszValue, int iValueType)

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 AMQPClassic class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

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

Config Settings (AMQPClassic Class)

AMQPClassic Config Settings

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