STOMP Class

Properties   Methods   Events   Config Settings   Errors  

A simple but powerful STOMP client implementation.

Syntax

STOMP

Remarks

The STOMP class provides an easy-to-use STOMP client implementation that supports STOMP versions 1.1 and 1.2. The class supports both plaintext and TLS-enabled connections over TCP.

Connecting

Connecting to a STOMP server is easy; in the simplest case just call the ConnectTo method, passing the server's hostname and port number.

When connecting to a STOMP server, the class sends information from the following properties, if populated:

• IncomingHeartbeat
• OutgoingHeartbeat
• User
• Password

In addition to the above properties, the following configuration settings can be set before connecting (though in most cases this is not necessary):

• SupportedVersions: Controls which STOMP versions the class advertises support for.
• VirtualHost: Controls the virtual host to connect to. If left empty (default), the value from RemoteHost is used.

Subscriptions & Receiving Messages

When Subscribe is called, it will return a subscription Id. To unsubscribe, pass this subscription Id to the Unsubscribe method.

After subscribing to a message destination, any messages received will cause the MessageIn event to fire.

Basic Subscriptions Example stomp1.OnMessageIn += (s, e) => { Console.WriteLine("Received message from destination '" + e.Destination + "':"); Console.WriteLine(e.Data); }; string subId = stomp1.Subscribe("test/a/b", false); // Some time later... stomp1.Unsubscribe(subId);

Refer to Subscribe, Unsubscribe, and MessageIn for more information about subscriptions and receiving messages.

Sending Messages

To send messages, use the SendMessage and SendData methods. SendMessage is used to send messages with string payloads, while SendData is used to send messages with binary payloads.

Send String Message Example stomp1.SendMessage("test/a/b", "Hello, world!");

Send Binary Message Example byte[] fileContent = File.ReadAllBytes("C:\test\stuff.dat"); stomp1.SendData("test/a/b", fileContent);

Refer to SendMessage and SendData for more information about sending messages.

Using Transactions

STOMP transactions are used to group messages together for processing on the server. Messages sent as part of a transaction will not be delivered by the server until the transaction is committed. If the transaction is aborted, the server will discard the messages without attempting to deliver them.

Basic Transaction Example // Open a new transaction. stomp1.BeginTransaction("txn1"); // Set the Transaction property to make sure that messages are sent as part of the transaction. stomp1.Transaction = "txn1"; stomp1.SendMessage("test/a/b", "Hello, world!"); stomp1.SendMessage("test/a/b", "This is a test."); stomp1.SendMessage("test/a/b", "Another test!"); // At this point, none of the messages sent above would have been delivered to any clients // subscribed to the "test/a/b" destination yet, because the transaction is still open. // If we close and commit the transaction, the server will then deliver the messages to subscribers, // queue them, or process them in another manner; the behavior is server-dependent. stomp1.CommitTransaction("txn1"); // Or, the transaction can be aborted, in which case the server will discard the messages // without delivering them to the subscribers. //stomp1.AbortTransaction("txn1"); // Reset (or change) the Transaction property after committing or aborting a transaction // so that future messages are not associated with the previous transaction. stomp1.Transaction = "";

Refer to BeginTransaction for more information about using transactions.

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.

Connected Property (STOMP Class)

Triggers a connection or disconnection.

Syntax

• C++
• C
• Qt

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

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

int ipworksiot_stomp_getconnected(void* lpObj);
int ipworksiot_stomp_setconnected(void* lpObj, int bConnected);

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

Default Value

FALSE

Remarks

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

Setting this property to False closes the connection.

When connecting to a STOMP server, the class sends information from the following properties, if populated:

• IncomingHeartbeat
• OutgoingHeartbeat
• User
• Password

In addition to the above properties, the following configuration settings can be set before connecting (though in most cases this is not necessary):

• SupportedVersions: Controls which STOMP versions the class advertises support for.
• VirtualHost: Controls the virtual host to connect to. If left empty (default), the value from RemoteHost is used.

This property is not available at design time.

Data Type

Boolean

ContentType Property (STOMP Class)

The content type of the outgoing message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetContentType();
int SetContentType(const char* lpszContentType);

Unicode (Windows)
LPWSTR GetContentType();
INT SetContentType(LPCWSTR lpszContentType);

char* ipworksiot_stomp_getcontenttype(void* lpObj);
int ipworksiot_stomp_setcontenttype(void* lpObj, const char* lpszContentType);

QString GetContentType();
int SetContentType(QString qsContentType);

Default Value

"text/plain"

Remarks

This property is used to specify the content type (MIME type) for outgoing messages sent using SendMessage. The default value is text/plain, which should be sufficient is most cases.

Note that this property is ignored for messages sent using SendData, as such messages do not have a content-type header added to them. The absence of a content-type header indicates to the server that the data should be treated as a binary blob.

This property is not available at design time.

Data Type

String

Firewall Property (STOMP Class)

A set of properties related to firewall access.

Syntax

• C++
• C
• Qt

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

int ipworksiot_stomp_getfirewallautodetect(void* lpObj);
int ipworksiot_stomp_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int ipworksiot_stomp_getfirewalltype(void* lpObj);
int ipworksiot_stomp_setfirewalltype(void* lpObj, int iFirewallType);

char* ipworksiot_stomp_getfirewallhost(void* lpObj);
int ipworksiot_stomp_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* ipworksiot_stomp_getfirewallpassword(void* lpObj);
int ipworksiot_stomp_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int ipworksiot_stomp_getfirewallport(void* lpObj);
int ipworksiot_stomp_setfirewallport(void* lpObj, int iFirewallPort);

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

IPWorksIoTFirewall

Headers Property (STOMP Class)

User-defined headers added to outgoing messages.

Syntax

• C++
• C
• Qt

IPWorksIoTList<IPWorksIoTSTOMPHeader>* GetHeaders();
int SetHeaders(IPWorksIoTList<IPWorksIoTSTOMPHeader>* val);

int ipworksiot_stomp_getheadercount(void* lpObj);
int ipworksiot_stomp_setheadercount(void* lpObj, int iHeaderCount);

char* ipworksiot_stomp_getheaderkey(void* lpObj, int headerindex);
int ipworksiot_stomp_setheaderkey(void* lpObj, int headerindex, const char* lpszHeaderKey);

char* ipworksiot_stomp_getheadervalue(void* lpObj, int headerindex);
int ipworksiot_stomp_setheadervalue(void* lpObj, int headerindex, const char* lpszHeaderValue);

int GetHeaderCount();
int SetHeaderCount(int iHeaderCount);

QString GetHeaderKey(int iHeaderIndex);
int SetHeaderKey(int iHeaderIndex, QString qsHeaderKey);

QString GetHeaderValue(int iHeaderIndex);
int SetHeaderValue(int iHeaderIndex, QString qsHeaderValue);

Remarks

This property holds a collection of STOMPHeader items representing user-defined headers. The headers in this collection are added to each outgoing message sent with SendMessage or SendData.

Note that the STOMP specification defines a number of standard headers necessary for implementing the STOMP protocol. When constructing an outgoing message, the class silently ignores any user-defined headers that are already set by the class.

This property is not available at design time.

Data Type

IPWorksIoTSTOMPHeader

IncomingHeartbeat Property (STOMP Class)

Specifies the server-to-class heartbeat timing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIncomingHeartbeat();
int SetIncomingHeartbeat(int iIncomingHeartbeat);

Unicode (Windows)
INT GetIncomingHeartbeat();
INT SetIncomingHeartbeat(INT iIncomingHeartbeat);

int ipworksiot_stomp_getincomingheartbeat(void* lpObj);
int ipworksiot_stomp_setincomingheartbeat(void* lpObj, int iIncomingHeartbeat);

int GetIncomingHeartbeat();
int SetIncomingHeartbeat(int iIncomingHeartbeat);

Default Value

0

Remarks

This property specifies the incoming heartbeat interval, which is the number of seconds without any server-to-class communication that the server will allow to elapse before sending the class a heartbeat (keepalive). If set to 0 (default), incoming heartbeats are disabled.

For information about outgoing (class-to-server) heartbeats; see the OutgoingHeartbeat property.

Before Connecting

Before connecting, this property is used to specify the desired incoming heartbeat interval (in seconds). By default, this property is set to 0 (no heartbeat).

During the connection process, the incoming heartbeat interval requested by the class is compared to the minimum interval supported by the server, and the larger of the two values is selected. If one or both sides supply 0 as their value, then no server-to-class heartbeats will be sent.

After Connecting

After connecting, this property cannot be set. Instead, it reflects the incoming heartbeat interval agreed upon by the class and the server during the connection process.

As the incoming heartbeat interval negotiation notes above imply, it is possible that the agreed-upon incoming heartbeat interval may either be larger than what the class requested, or may be 0 (i.e., incoming heartbeats are disabled).

This property is not available at design time.

Data Type

Integer

LocalHost Property (STOMP Class)

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

Syntax

• C++
• C
• Qt

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

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

char* ipworksiot_stomp_getlocalhost(void* lpObj);
int ipworksiot_stomp_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 (STOMP Class)

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

Syntax

• C++
• C
• Qt

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

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

int ipworksiot_stomp_getlocalport(void* lpObj);
int ipworksiot_stomp_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

OutgoingHeartbeat Property (STOMP Class)

Specifies the class-to-server heartbeat timing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOutgoingHeartbeat();
int SetOutgoingHeartbeat(int iOutgoingHeartbeat);

Unicode (Windows)
INT GetOutgoingHeartbeat();
INT SetOutgoingHeartbeat(INT iOutgoingHeartbeat);

int ipworksiot_stomp_getoutgoingheartbeat(void* lpObj);
int ipworksiot_stomp_setoutgoingheartbeat(void* lpObj, int iOutgoingHeartbeat);

int GetOutgoingHeartbeat();
int SetOutgoingHeartbeat(int iOutgoingHeartbeat);

Default Value

0

Remarks

This property specifies the outgoing heartbeat interval, which is the number of seconds without any class-to-server communication that the class will allow to elapse before sending the server a heartbeat (keepalive). If set to 0 (default), outgoing heartbeats are disabled.

For information about incoming (server-to-class) heartbeats; see the IncomingHeartbeat property.

Before Connecting

Before connecting, this property is used to specify the minimum supported outgoing heartbeat interval (in seconds). By default, this property is set to 0 (no heartbeat).

During the connection process, the minimum outgoing heartbeat interval supported by the class is compared to the interval requested by the server, and the larger of the two values is selected. If one or both sides supply 0 as their value, then no class-to-server heartbeats will be sent.

After Connecting

After connecting, this property cannot be set. Instead, it reflects the outgoing heartbeat interval agreed upon by the class and the server during the connection process.

As the outgoing heartbeat interval negotiation notes above imply, it is possible that the agreed-upon outgoing heartbeat interval may either be larger than the class's supported minimum, or may be 0 (i.e., outgoing heartbeats are disabled).

This property is not available at design time.

Data Type

Integer

ParsedHeaders Property (STOMP Class)

Headers parsed from incoming messages.

Syntax

• C++
• C
• Qt

IPWorksIoTList<IPWorksIoTSTOMPHeader>* GetParsedHeaders();

int ipworksiot_stomp_getparsedheadercount(void* lpObj);

char* ipworksiot_stomp_getparsedheaderkey(void* lpObj, int parsedheaderindex);

char* ipworksiot_stomp_getparsedheadervalue(void* lpObj, int parsedheaderindex);

int GetParsedHeaderCount();

QString GetParsedHeaderKey(int iParsedHeaderIndex);

QString GetParsedHeaderValue(int iParsedHeaderIndex);

Remarks

This property holds a collection of STOMPHeader items, representing both standard and user-defined headers parsed from incoming messages. It is populated each time the MessageIn event fires, and is cleared after the MessageIn event completes.

Note that the class collapses headers with duplicate key names by default for incoming messages, only keeping the first header for each unique key. This behavior can be controlled using the CollapseHeaders configuration setting.

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

Data Type

IPWorksIoTSTOMPHeader

Password Property (STOMP Class)

A password if authentication is to be used.

Syntax

• C++
• C
• Qt

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

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

char* ipworksiot_stomp_getpassword(void* lpObj);
int ipworksiot_stomp_setpassword(void* lpObj, const char* lpszPassword);

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

Default Value

""

Remarks

If this property is set when connecting, the class will send the password in the passcode header.

This property is not available at design time.

Data Type

String

ReadyToSend Property (STOMP Class)

Indicates whether the class is ready to send data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetReadyToSend();

Unicode (Windows)
BOOL GetReadyToSend();

int ipworksiot_stomp_getreadytosend(void* lpObj);

bool GetReadyToSend();

Default Value

FALSE

Remarks

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

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

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

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

Data Type

Boolean

RemoteHost Property (STOMP Class)

The address of the remote host. Domain names are resolved to IP addresses.

Syntax

• C++
• C
• Qt

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

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

char* ipworksiot_stomp_getremotehost(void* lpObj);
int ipworksiot_stomp_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 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.

By default the class will connect in plaintext. To enable SSL set SSLEnabled to True.

Data Type

String

RemotePort Property (STOMP Class)

The port of the STOMP server (default is 61613). The default port for SSL is 61612.

Syntax

• C++
• C
• Qt

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

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

int ipworksiot_stomp_getremoteport(void* lpObj);
int ipworksiot_stomp_setremoteport(void* lpObj, int iRemotePort);

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

Default Value

61613

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

RequestReceipts Property (STOMP Class)

Whether the class should request that the server provide message receipts.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRequestReceipts();
int SetRequestReceipts(int bRequestReceipts);

Unicode (Windows)
BOOL GetRequestReceipts();
INT SetRequestReceipts(BOOL bRequestReceipts);

int ipworksiot_stomp_getrequestreceipts(void* lpObj);
int ipworksiot_stomp_setrequestreceipts(void* lpObj, int bRequestReceipts);

bool GetRequestReceipts();
int SetRequestReceipts(bool bRequestReceipts);

Default Value

FALSE

Remarks

This property is used to specify whether the class should request that the server send back confirmations (known as a "receipts" in STOMP terminology) when it receives messages from the class. This is done by adding a receipt header to the outgoing frame.

When this property is set to True, and a message is sent, the ReceiptOut event will fire immediately after the MessageOut event fires.

Note that, while this property only controls receipt requests for outgoing messages, the class is capable of requesting receipts for any outgoing frame type. Use this table to determine which API members control receipt request for each outgoing frame type (all are False by default):

Received Receipt Notes

When a receipt is received, the ReceiptIn event fires.

Note that receipts are cumulative, and a STOMP server is not required to send back discrete receipts for each frame it receives that has a receipt header. For example, if the class has sent four message frames with the following receipt header values (in chronological order):

1. SEND-3
2. SEND-4
3. SEND-5
4. SEND-6

This property is not available at design time.

Data Type

Boolean

SSLAcceptServerCert Property (STOMP Class)

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

Syntax

• C++
• C
• Qt

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

char* ipworksiot_stomp_getsslacceptservercerteffectivedate(void* lpObj);

char* ipworksiot_stomp_getsslacceptservercertexpirationdate(void* lpObj);

char* ipworksiot_stomp_getsslacceptservercertextendedkeyusage(void* lpObj);

char* ipworksiot_stomp_getsslacceptservercertfingerprint(void* lpObj);

char* ipworksiot_stomp_getsslacceptservercertfingerprintsha1(void* lpObj);

char* ipworksiot_stomp_getsslacceptservercertfingerprintsha256(void* lpObj);

char* ipworksiot_stomp_getsslacceptservercertissuer(void* lpObj);

char* ipworksiot_stomp_getsslacceptservercertprivatekey(void* lpObj);

int ipworksiot_stomp_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* ipworksiot_stomp_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* ipworksiot_stomp_getsslacceptservercertpublickey(void* lpObj);

char* ipworksiot_stomp_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int ipworksiot_stomp_getsslacceptservercertpublickeylength(void* lpObj);

char* ipworksiot_stomp_getsslacceptservercertserialnumber(void* lpObj);

char* ipworksiot_stomp_getsslacceptservercertsignaturealgorithm(void* lpObj);

int ipworksiot_stomp_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworksiot_stomp_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* ipworksiot_stomp_getsslacceptservercertstorepassword(void* lpObj);
int ipworksiot_stomp_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int ipworksiot_stomp_getsslacceptservercertstoretype(void* lpObj);
int ipworksiot_stomp_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* ipworksiot_stomp_getsslacceptservercertsubjectaltnames(void* lpObj);

char* ipworksiot_stomp_getsslacceptservercertthumbprintmd5(void* lpObj);

char* ipworksiot_stomp_getsslacceptservercertthumbprintsha1(void* lpObj);

char* ipworksiot_stomp_getsslacceptservercertthumbprintsha256(void* lpObj);

char* ipworksiot_stomp_getsslacceptservercertusage(void* lpObj);

int ipworksiot_stomp_getsslacceptservercertusageflags(void* lpObj);

char* ipworksiot_stomp_getsslacceptservercertversion(void* lpObj);

char* ipworksiot_stomp_getsslacceptservercertsubject(void* lpObj);
int ipworksiot_stomp_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int ipworksiot_stomp_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworksiot_stomp_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

IPWorksIoTCertificate

SSLCert Property (STOMP Class)

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

Syntax

• C++
• C
• Qt

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

char* ipworksiot_stomp_getsslcerteffectivedate(void* lpObj);

char* ipworksiot_stomp_getsslcertexpirationdate(void* lpObj);

char* ipworksiot_stomp_getsslcertextendedkeyusage(void* lpObj);

char* ipworksiot_stomp_getsslcertfingerprint(void* lpObj);

char* ipworksiot_stomp_getsslcertfingerprintsha1(void* lpObj);

char* ipworksiot_stomp_getsslcertfingerprintsha256(void* lpObj);

char* ipworksiot_stomp_getsslcertissuer(void* lpObj);

char* ipworksiot_stomp_getsslcertprivatekey(void* lpObj);

int ipworksiot_stomp_getsslcertprivatekeyavailable(void* lpObj);

char* ipworksiot_stomp_getsslcertprivatekeycontainer(void* lpObj);

char* ipworksiot_stomp_getsslcertpublickey(void* lpObj);

char* ipworksiot_stomp_getsslcertpublickeyalgorithm(void* lpObj);

int ipworksiot_stomp_getsslcertpublickeylength(void* lpObj);

char* ipworksiot_stomp_getsslcertserialnumber(void* lpObj);

char* ipworksiot_stomp_getsslcertsignaturealgorithm(void* lpObj);

int ipworksiot_stomp_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksiot_stomp_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* ipworksiot_stomp_getsslcertstorepassword(void* lpObj);
int ipworksiot_stomp_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int ipworksiot_stomp_getsslcertstoretype(void* lpObj);
int ipworksiot_stomp_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* ipworksiot_stomp_getsslcertsubjectaltnames(void* lpObj);

char* ipworksiot_stomp_getsslcertthumbprintmd5(void* lpObj);

char* ipworksiot_stomp_getsslcertthumbprintsha1(void* lpObj);

char* ipworksiot_stomp_getsslcertthumbprintsha256(void* lpObj);

char* ipworksiot_stomp_getsslcertusage(void* lpObj);

int ipworksiot_stomp_getsslcertusageflags(void* lpObj);

char* ipworksiot_stomp_getsslcertversion(void* lpObj);

char* ipworksiot_stomp_getsslcertsubject(void* lpObj);
int ipworksiot_stomp_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int ipworksiot_stomp_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksiot_stomp_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

IPWorksIoTCertificate

SSLEnabled Property (STOMP 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 ipworksiot_stomp_getsslenabled(void* lpObj);
int ipworksiot_stomp_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.

This property is not available at design time.

Data Type

Boolean

SSLProvider Property (STOMP 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 ipworksiot_stomp_getsslprovider(void* lpObj);
int ipworksiot_stomp_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 (STOMP Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

IPWorksIoTCertificate* GetSSLServerCert();

char* ipworksiot_stomp_getsslservercerteffectivedate(void* lpObj);

char* ipworksiot_stomp_getsslservercertexpirationdate(void* lpObj);

char* ipworksiot_stomp_getsslservercertextendedkeyusage(void* lpObj);

char* ipworksiot_stomp_getsslservercertfingerprint(void* lpObj);

char* ipworksiot_stomp_getsslservercertfingerprintsha1(void* lpObj);

char* ipworksiot_stomp_getsslservercertfingerprintsha256(void* lpObj);

char* ipworksiot_stomp_getsslservercertissuer(void* lpObj);

char* ipworksiot_stomp_getsslservercertprivatekey(void* lpObj);

int ipworksiot_stomp_getsslservercertprivatekeyavailable(void* lpObj);

char* ipworksiot_stomp_getsslservercertprivatekeycontainer(void* lpObj);

char* ipworksiot_stomp_getsslservercertpublickey(void* lpObj);

char* ipworksiot_stomp_getsslservercertpublickeyalgorithm(void* lpObj);

int ipworksiot_stomp_getsslservercertpublickeylength(void* lpObj);

char* ipworksiot_stomp_getsslservercertserialnumber(void* lpObj);

char* ipworksiot_stomp_getsslservercertsignaturealgorithm(void* lpObj);

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

char* ipworksiot_stomp_getsslservercertstorepassword(void* lpObj);

int ipworksiot_stomp_getsslservercertstoretype(void* lpObj);

char* ipworksiot_stomp_getsslservercertsubjectaltnames(void* lpObj);

char* ipworksiot_stomp_getsslservercertthumbprintmd5(void* lpObj);

char* ipworksiot_stomp_getsslservercertthumbprintsha1(void* lpObj);

char* ipworksiot_stomp_getsslservercertthumbprintsha256(void* lpObj);

char* ipworksiot_stomp_getsslservercertusage(void* lpObj);

int ipworksiot_stomp_getsslservercertusageflags(void* lpObj);

char* ipworksiot_stomp_getsslservercertversion(void* lpObj);

char* ipworksiot_stomp_getsslservercertsubject(void* lpObj);

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

IPWorksIoTCertificate

Subscriptions Property (STOMP Class)

Collection of current subscriptions.

Syntax

• C++
• C
• Qt

IPWorksIoTList<IPWorksIoTSTOMPSubscription>* GetSubscriptions();

int ipworksiot_stomp_getsubscriptioncount(void* lpObj);

char* ipworksiot_stomp_getsubscriptiondestination(void* lpObj, int subscriptionindex);

char* ipworksiot_stomp_getsubscriptionid(void* lpObj, int subscriptionindex);

int GetSubscriptionCount();

QString GetSubscriptionDestination(int iSubscriptionIndex);

QString GetSubscriptionId(int iSubscriptionIndex);

Remarks

This property holds a collection of STOMPSubscription items representing the class's current subscriptions.

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

Data Type

IPWorksIoTSTOMPSubscription

Timeout Property (STOMP 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 ipworksiot_stomp_gettimeout(void* lpObj);
int ipworksiot_stomp_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

TransactionId Property (STOMP Class)

Specifies the Id of the transaction that outgoing messages are associated with.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTransactionId();
int SetTransactionId(const char* lpszTransactionId);

Unicode (Windows)
LPWSTR GetTransactionId();
INT SetTransactionId(LPCWSTR lpszTransactionId);

char* ipworksiot_stomp_gettransactionid(void* lpObj);
int ipworksiot_stomp_settransactionid(void* lpObj, const char* lpszTransactionId);

QString GetTransactionId();
int SetTransactionId(QString qsTransactionId);

Default Value

""

Remarks

This property, if not empty, is used to specify which transaction outgoing messages sent using SendMessage or SendData are associated with.

This property must either be empty, or set to the Id of a currently open transaction. The OpenTransactions configuration setting can be queried at any time to retrieve a comma-separated list of currently open transactions' Ids.

Note that this property only affects outgoing messages. It is also possible to send a message acknowledgment as part of a transaction by setting the AckTransactionId configuration setting during the MessageIn event handler.

Refer to BeginTransaction for more information about transactions.

This property is not available at design time.

Data Type

String

User Property (STOMP Class)

A username if authentication is to be used.

Syntax

• C++
• C
• Qt

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

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

char* ipworksiot_stomp_getuser(void* lpObj);
int ipworksiot_stomp_setuser(void* lpObj, const char* lpszUser);

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

Default Value

""

Remarks

If this property is set when connecting, the class will send the user in the login header.

This property is not available at design time.

Data Type

String

AbortTransaction Method (STOMP Class)

Aborts an existing transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AbortTransaction(const char* lpszId);

Unicode (Windows)
INT AbortTransaction(LPCWSTR lpszId);

int ipworksiot_stomp_aborttransaction(void* lpObj, const char* lpszId);

int AbortTransaction(const QString& qsId);

Remarks

This method aborts a transaction previously started with BeginTransaction. Id identifies the transaction to abort.

The OpenTransactions configuration setting can be queried to obtain a list of currently-open transactions.

Refer to BeginTransaction for more information about transactions.

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

AddHeader Method (STOMP Class)

Adds a custom header to send with outgoing messages.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddHeader(const char* lpszKey, const char* lpszValue);

Unicode (Windows)
INT AddHeader(LPCWSTR lpszKey, LPCWSTR lpszValue);

int ipworksiot_stomp_addheader(void* lpObj, const char* lpszKey, const char* lpszValue);

int AddHeader(const QString& qsKey, const QString& qsValue);

Remarks

This method is used to add user-defined headers to the list of headers held by the Headers collection property.

When SendMessage or SendData is called, all headers in the Headers collection property are added to the outgoing message.

Note that the STOMP specification defines a number of standard headers necessary for implementing the STOMP protocol. When constructing an outgoing message, the class silently ignores any user-defined headers that are already set by the class.

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

BeginTransaction Method (STOMP Class)

Begins a new transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int BeginTransaction(const char* lpszId);

Unicode (Windows)
INT BeginTransaction(LPCWSTR lpszId);

int ipworksiot_stomp_begintransaction(void* lpObj, const char* lpszId);

int BeginTransaction(const QString& qsId);

Remarks

This method begins a new transaction using the specified Id, which must be unique. There is no limit to how many transactions may be open at any given time.

A transaction is a group of messages and message acknowledgments which are all processed atomically when the transaction is committed or aborted.

Messages sent in a transaction will not be delivered to clients subscribed to the messages' destinations until the transaction is committed.

Since it is possible for multiple transactions to be open at any given time, the TransactionId property is used to specify which transaction (if any) messages should be sent in. Similarly, message acknowledgments can be sent in a transaction by setting the AckTransactionId configuration setting during the MessageIn event handler.

The OpenTransactions configuration setting can be queried at any time to retrieve a comma-separated list of currently open transactions' Ids.

Basic Transaction Example // Open a new transaction. stomp1.BeginTransaction("txn1"); // Set the Transaction property to make sure that messages are sent as part of the transaction. stomp1.Transaction = "txn1"; stomp1.SendMessage("test/a/b", "Hello, world!"); stomp1.SendMessage("test/a/b", "This is a test."); stomp1.SendMessage("test/a/b", "Another test!"); // At this point, none of the messages sent above would have been delivered to any clients // subscribed to the "test/a/b" destination yet, because the transaction is still open. // If we close and commit the transaction, the server will then deliver the messages to subscribers, // queue them, or process them in another manner; the behavior is server-dependent. stomp1.CommitTransaction("txn1"); // Or, the transaction can be aborted, in which case the server will discard the messages // without delivering them to the subscribers. //stomp1.AbortTransaction("txn1"); // Reset (or change) the Transaction property after committing or aborting a transaction // so that future messages are not associated with the previous transaction. stomp1.Transaction = "";

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

Commits an existing transaction.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT CommitTransaction(LPCWSTR lpszId);

int ipworksiot_stomp_committransaction(void* lpObj, const char* lpszId);

int CommitTransaction(const QString& qsId);

Remarks

This method commits a transaction previously started with BeginTransaction. Id identifies the transaction to commit.

The OpenTransactions configuration setting can be queried to obtain a list of currently-open transactions.

Refer to BeginTransaction for more information about transactions.

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 (STOMP 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* ipworksiot_stomp_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 (STOMP Class)

Connects to the remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Connect();

Unicode (Windows)
INT Connect();

int ipworksiot_stomp_connect(void* lpObj);

int Connect();

Remarks

This method connects to the remote host, specified by RemoteHost and RemotePort. Calling this method is equivalent to setting the Connected property to True.

By default the class will connect in plaintext. To enable SSL set SSLEnabled to True.

When connecting to a STOMP server, the class sends information from the following properties, if populated:

• IncomingHeartbeat
• OutgoingHeartbeat
• User
• Password

In addition to the above properties, the following configuration settings can be set before connecting (though in most cases this is not necessary):

• SupportedVersions: Controls which STOMP versions the class advertises support for.
• VirtualHost: Controls the virtual host to connect to. If left empty (default), the value from RemoteHost is used.

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

Connects to the 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 ipworksiot_stomp_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. Calling this method is equivalent to setting the RemoteHost property to Host, setting RemotePort to Port, and then setting the Connected property to True.

By default the class will connect in plaintext. To enable SSL set SSLEnabled to True.

When connecting to a STOMP server, the class sends information from the following properties, if populated:

• IncomingHeartbeat
• OutgoingHeartbeat
• User
• Password

In addition to the above properties, the following configuration settings can be set before connecting (though in most cases this is not necessary):

• SupportedVersions: Controls which STOMP versions the class advertises support for.
• VirtualHost: Controls the virtual host to connect to. If left empty (default), the value from RemoteHost is used.

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

This method disconnects from the remote host.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Disconnect();

Unicode (Windows)
INT Disconnect();

int ipworksiot_stomp_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 (STOMP Class)

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworksiot_stomp_doevents(void* lpObj);

int DoEvents();

Remarks

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

Error Handling (C++)

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

Interrupt Method (STOMP 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 ipworksiot_stomp_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.)

Reset Method (STOMP Class)

This method will reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

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

ResetHeaders Method (STOMP Class)

Clear the user-defined headers collection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ResetHeaders();

Unicode (Windows)
INT ResetHeaders();

int ipworksiot_stomp_resetheaders(void* lpObj);

int ResetHeaders();

Remarks

This method clears the Headers collection 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.)

SendData Method (STOMP Class)

Publishes a message with a raw data payload.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendData(const char* lpszDestination, const char* lpData, int lenData);

Unicode (Windows)
INT SendData(LPCWSTR lpszDestination, LPCSTR lpData, INT lenData);

int ipworksiot_stomp_senddata(void* lpObj, const char* lpszDestination, const char* lpData, int lenData);

int SendData(const QString& qsDestination, QByteArray qbaData);

Remarks

This method publishes a STOMP message with a raw data payload to the specified Destination. The MessageOut event will fire after the message has been sent.

The STOMP specification does not place any restrictions on Destination names. Instead, each STOMP server is free to define its own requirements for, and/or interpretations of, a Destination name; for example, a server might prohibit certain characters, require a specific format, or interpret some patterns in a special manner. Be sure to consult the documentation for your STOMP server to determine how to build proper Destination names.

In addition to the payload, the outgoing messages will include:

• All user-defined headers held by the Headers collection property.
• If the TransactionId property is populated, the transaction Id that it specifies (which associates the message with that transaction).

If RequestReceipts is enabled when this method is called, the class will request that the server send back a receipt to confirm it has received the message. Refer to RequestReceipts for more information.

Note that no content type is defined for raw data payload messages; so the ContentType property is ignored by this method.

Send String Message Example stomp1.SendMessage("test/a/b", "Hello, world!");

Send Binary Message Example byte[] fileContent = File.ReadAllBytes("C:\test\stuff.dat"); stomp1.SendData("test/a/b", fileContent);

Error Handling (C++)

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

SendMessage Method (STOMP Class)

Publishes a message with a string payload.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendMessage(const char* lpszDestination, const char* lpszMessage);

Unicode (Windows)
INT SendMessage(LPCWSTR lpszDestination, LPCWSTR lpszMessage);

int ipworksiot_stomp_sendmessage(void* lpObj, const char* lpszDestination, const char* lpszMessage);

int SendMessage(const QString& qsDestination, const QString& qsMessage);

Remarks

This method publishes a STOMP message with a string payload to the specified Destination. The MessageOut event will fire after the message has been sent.

The ContentType property can be used to specify the content type of the payload. By default, ContentType is set to text/plain.

The STOMP specification does not place any restrictions on Destination names. Instead, each STOMP server is free to define its own requirements for, and/or interpretations of, a Destination name; for example, a server might prohibit certain characters, require a specific format, or interpret some patterns in a special manner. Be sure to consult the documentation for your STOMP server to determine how to build proper Destination names.

In addition to the payload, the outgoing messages will include:

• All user-defined headers held by the Headers collection property.
• If the TransactionId property is populated, the transaction Id that it specifies (which associates the message with that transaction).

If RequestReceipts is enabled when this method is called, the class will request that the server send back a receipt to confirm it has received the message. Refer to RequestReceipts for more information.

Send String Message Example stomp1.SendMessage("test/a/b", "Hello, world!");

Send Binary Message Example byte[] fileContent = File.ReadAllBytes("C:\test\stuff.dat"); stomp1.SendData("test/a/b", fileContent);

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

Subscribe Method (STOMP Class)

Subscribes to a message destination on the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Subscribe(const char* lpszDestination, int bRequireAcks);

Unicode (Windows)
LPWSTR Subscribe(LPCWSTR lpszDestination, BOOL bRequireAcks);

char* ipworksiot_stomp_subscribe(void* lpObj, const char* lpszDestination, int bRequireAcks);

QString Subscribe(const QString& qsDestination, bool bRequireAcks);

Remarks

This method is used to subscribe to the specified message Destination on the server. The Id of the subscription is returned.

Once subscribed, the Subscribed event will fire and an item will be added to the Subscriptions collection property. The MessageIn event will fire anytime a message is received for any subscription.

The STOMP specification does not place any restrictions on Destination names. Instead, each STOMP server is free to define its own requirements for, and/or interpretations of, a Destination name; for example, a server might prohibit certain characters, require a specific format, or interpret some patterns in a special manner. Be sure to consult the documentation for your STOMP server to determine how to build proper Destination names.

If the RequireAcks parameter is set to True, the server will expect the class to send it a message acknowledgment for each message it delivers as part of this subscription. (Refer to the MessageIn event for more information about sending message acknowledgments).

Basic Subscriptions Example stomp1.OnMessageIn += (s, e) => { Console.WriteLine("Received message from destination '" + e.Destination + "':"); Console.WriteLine(e.Data); }; string subId = stomp1.Subscribe("test/a/b", false); // Some time later... stomp1.Unsubscribe(subId);

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.

Unsubscribe Method (STOMP Class)

Removes an existing subscription.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Unsubscribe(const char* lpszId);

Unicode (Windows)
INT Unsubscribe(LPCWSTR lpszId);

int ipworksiot_stomp_unsubscribe(void* lpObj, const char* lpszId);

int Unsubscribe(const QString& qsId);

Remarks

This method removes an existing subscription identified by the given Id, unsubscribing the class from the destination associated with the subscription.

Once unsubscribed, the relevant item will be removed from the Subscriptions collection property and the Unsubscribed event will fire.

Basic Subscriptions Example stomp1.OnMessageIn += (s, e) => { Console.WriteLine("Received message from destination '" + e.Destination + "':"); Console.WriteLine(e.Data); }; string subId = stomp1.Subscribe("test/a/b", false); // Some time later... stomp1.Unsubscribe(subId);

Error Handling (C++)

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

Connected Event (STOMP Class)

Fired immediately after a connection completes (or fails).

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_STOMP_CONNECTED 1

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

class STOMPConnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

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

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

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

Fired to indicate changes in the connection state.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_STOMP_CONNECTIONSTATUS 2

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

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

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

Fired when a connection is closed.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_STOMP_DISCONNECTED 3

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

class STOMPDisconnectedEventParams {
public:
  int StatusCode();

  const QString &Description();

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

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

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

Fired when a class or protocol error occurs.

Syntax

• C++
• C
• Qt

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

typedef struct {
  int ErrorCode;
  const char *Description;
  const char *Data;
  int lenData;
  int reserved;
} STOMPErrorEventParams;


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

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  LPCSTR Data;
  INT lenData;
  INT reserved;
} STOMPErrorEventParams;

#define EID_STOMP_ERROR 4

virtual INT IPWORKSIOT_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription, LPSTR &lpData, INT &lenData);

class STOMPErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  const QByteArray &Data();

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

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

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

Remarks

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

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

STOMP Protocol Errors

When this occurs, ErrorCode will be 600, Description will reflect the value of the ERROR frame's message header, and Data will contain the body of the ERROR frame (if one is present).

The ErrorHeaders configuration setting will also be populated with the raw headers from the ERROR frame for the duration of the Error event handler.

Log Event (STOMP Class)

Fired once for each log message.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_STOMP_LOG 5

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

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

// Or, subclass STOMP and override this emitter function.
virtual int FireLog(STOMPLogEventParams *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.
• Acknowledgment: Information about outgoing message acknowledgments.
• Frame: Frame content logging.

MessageIn Event (STOMP Class)

Fired when a message has been received.

Syntax

• C++
• C
• Qt

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

typedef struct {
  const char *MessageId;
  const char *SubscriptionId;
  const char *Destination;
  const char *Data;
  int lenData;
  const char *ContentType;
  int Ack;
  int reserved;
} STOMPMessageInEventParams;


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

typedef struct {
  LPCWSTR MessageId;
  LPCWSTR SubscriptionId;
  LPCWSTR Destination;
  LPCSTR Data;
  INT lenData;
  LPCWSTR ContentType;
  BOOL Ack;
  INT reserved;
} STOMPMessageInEventParams;

#define EID_STOMP_MESSAGEIN 6

virtual INT IPWORKSIOT_CALL FireMessageIn(LPSTR &lpszMessageId, LPSTR &lpszSubscriptionId, LPSTR &lpszDestination, LPSTR &lpData, INT &lenData, LPSTR &lpszContentType, BOOL &bAck);

class STOMPMessageInEventParams {
public:
  const QString &MessageId();

  const QString &SubscriptionId();

  const QString &Destination();

  const QByteArray &Data();

  const QString &ContentType();

  bool Ack();
  void SetAck(bool bAck);

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

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

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

Remarks

This events fires whenever the class has received a message.

In addition to the message details exposed by the event parameters, the ParsedHeaders collection property is populated with the headers parsed from the message. When the MessageIn event handler exits, the parsed headers are cleared. The following parameters are available within this event:

• MessageId: The unique Id of the message.
• SubscriptionId: The subscription Id the message is associated with.
• Destination: The message destination on the server which the message originated from.
• Data: The message's payload.
• ContentType: The content type of the message (may be empty).
• Ack: Set to True or False to control whether the class should send back a positive (True, default) or negative (False) message acknowledgment.

Message acknowledgments are only sent back to the server for messages which require them. A positive acknowledgment indicates that the message has been accepted, while a negative acknowledgment represents that the message has been rejected.

The following two configuration settings are also relevant in the context of sending back message acknowledgments for incoming messages:

• The AckTransactionId configuration setting, if not empty, specifies a transaction Id to associate the message acknowledgment with. It can only be set during the MessageIn event handler, and will be reset when the event handler ends.
• The RequestAckReceipts configuration setting controls whether the class will request that the server confirm receipt of the message acknowledgment. It is False by default, and can be set at any time.

MessageOut Event (STOMP Class)

Fired after a message has been sent.

Syntax

• C++
• C
• Qt

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

typedef struct {
  const char *Destination;
  const char *Data;
  int lenData;
  const char *ContentType;
  int reserved;
} STOMPMessageOutEventParams;


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

typedef struct {
  LPCWSTR Destination;
  LPCSTR Data;
  INT lenData;
  LPCWSTR ContentType;
  INT reserved;
} STOMPMessageOutEventParams;

#define EID_STOMP_MESSAGEOUT 7

virtual INT IPWORKSIOT_CALL FireMessageOut(LPSTR &lpszDestination, LPSTR &lpData, INT &lenData, LPSTR &lpszContentType);

class STOMPMessageOutEventParams {
public:
  const QString &Destination();

  const QByteArray &Data();

  const QString &ContentType();

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

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

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

Remarks

This event fires after a message has been sent using either SendMessage or SendData. The following parameters are available within this event:

• Destination: The destination the message was sent to.
• Data: The message's payload.
• ContentType: The content type of the message (always empty for messages sent with SendData).

ReadyToSend Event (STOMP Class)

Fired when the class is ready to send data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireReadyToSend(STOMPReadyToSendEventParams *e);

typedef struct {
  int reserved;
} STOMPReadyToSendEventParams;


Unicode (Windows)
virtual INT FireReadyToSend(STOMPReadyToSendEventParams *e);

typedef struct {
  INT reserved;
} STOMPReadyToSendEventParams;

#define EID_STOMP_READYTOSEND 8

virtual INT IPWORKSIOT_CALL FireReadyToSend();

class STOMPReadyToSendEventParams {
public:
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

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

// Or, subclass STOMP and override this emitter function.
virtual int FireReadyToSend(STOMPReadyToSendEventParams *e) {...}

Remarks

The ReadyToSend event indicates that the underlying TCP/IP subsystem is ready to accept data after a call to SendData or SendMessage fails due to a WOULDBLOCK condition. The event is also fired immediately after a connection to the remote host is established.

ReceiptIn Event (STOMP Class)

Fires when the class receives a receipt from the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireReceiptIn(STOMPReceiptInEventParams *e);

typedef struct {
  const char *ReceiptId;
  int reserved;
} STOMPReceiptInEventParams;


Unicode (Windows)
virtual INT FireReceiptIn(STOMPReceiptInEventParams *e);

typedef struct {
  LPCWSTR ReceiptId;
  INT reserved;
} STOMPReceiptInEventParams;

#define EID_STOMP_RECEIPTIN 9

virtual INT IPWORKSIOT_CALL FireReceiptIn(LPSTR &lpszReceiptId);

class STOMPReceiptInEventParams {
public:
  const QString &ReceiptId();

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

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

// Or, subclass STOMP and override this emitter function.
virtual int FireReceiptIn(STOMPReceiptInEventParams *e) {...}

Remarks

This event fires anytime the class receives a receipt (that is, a confirmation that the server has received one or more frames) from the server. The ReceiptId parameter reflects the value of the receipt-id header in the incoming RECEIPT frame.

Note that receipts are cumulative, and a STOMP server is not required to send back discrete receipts for each frame it receives that has a receipt header. For example, if the class has sent four message frames with the following receipt header values (in chronological order):

1. SEND-3
2. SEND-4
3. SEND-5
4. SEND-6

Refer to RequestReceipts for more information about receipts.

ReceiptOut Event (STOMP Class)

Fires when the class sends a STOMP frame that includes a 'receipt' header.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireReceiptOut(STOMPReceiptOutEventParams *e);

typedef struct {
  const char *ReceiptId;
  int reserved;
} STOMPReceiptOutEventParams;


Unicode (Windows)
virtual INT FireReceiptOut(STOMPReceiptOutEventParams *e);

typedef struct {
  LPCWSTR ReceiptId;
  INT reserved;
} STOMPReceiptOutEventParams;

#define EID_STOMP_RECEIPTOUT 10

virtual INT IPWORKSIOT_CALL FireReceiptOut(LPSTR &lpszReceiptId);

class STOMPReceiptOutEventParams {
public:
  const QString &ReceiptId();

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

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

// Or, subclass STOMP and override this emitter function.
virtual int FireReceiptOut(STOMPReceiptOutEventParams *e) {...}

Remarks

This event fires anytime the class sends any STOMP frame that includes a receipt header on it. The ReceiptId parameter reflects the value of the receipt header.

Having a receipt header on an outgoing frame indicates to the server that it should send back a receipt to confirm that it has received the frame (though it is not required to do so immediately; see ReceiptIn for details). Anytime the server sends back a receipt, the ReceiptIn event will fire.

Refer to RequestReceipts for more information about receipts.

SSLServerAuthentication Event (STOMP Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_STOMP_SSLSERVERAUTHENTICATION 11

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

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

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

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_STOMP_SSLSTATUS 12

virtual INT IPWORKSIOT_CALL FireSSLStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

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

Subscribed Event (STOMP Class)

Fired when the class has subscribed to a message destination on the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSubscribed(STOMPSubscribedEventParams *e);

typedef struct {
  const char *Id;
  const char *Destination;
  int RequireAcks;
  int reserved;
} STOMPSubscribedEventParams;


Unicode (Windows)
virtual INT FireSubscribed(STOMPSubscribedEventParams *e);

typedef struct {
  LPCWSTR Id;
  LPCWSTR Destination;
  BOOL RequireAcks;
  INT reserved;
} STOMPSubscribedEventParams;

#define EID_STOMP_SUBSCRIBED 13

virtual INT IPWORKSIOT_CALL FireSubscribed(LPSTR &lpszId, LPSTR &lpszDestination, BOOL &bRequireAcks);

class STOMPSubscribedEventParams {
public:
  const QString &Id();

  const QString &Destination();

  bool RequireAcks();

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

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

// Or, subclass STOMP and override this emitter function.
virtual int FireSubscribed(STOMPSubscribedEventParams *e) {...}

Remarks

This event fires each time the class has subscribed to a message destination on the server. The following parameters are available within this event:

• Id: The Id used to identify the subscription.
• Destination: The message destination on the server which the subscription is associated with.
• RequireAcks: Whether messages the class receives as a result of the subscription will require acknowledgments to be sent back to the server.

Unsubscribed Event (STOMP Class)

Fired when the class has unsubscribed from a message destination on the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireUnsubscribed(STOMPUnsubscribedEventParams *e);

typedef struct {
  const char *Id;
  const char *Destination;
  int reserved;
} STOMPUnsubscribedEventParams;


Unicode (Windows)
virtual INT FireUnsubscribed(STOMPUnsubscribedEventParams *e);

typedef struct {
  LPCWSTR Id;
  LPCWSTR Destination;
  INT reserved;
} STOMPUnsubscribedEventParams;

#define EID_STOMP_UNSUBSCRIBED 14

virtual INT IPWORKSIOT_CALL FireUnsubscribed(LPSTR &lpszId, LPSTR &lpszDestination);

class STOMPUnsubscribedEventParams {
public:
  const QString &Id();

  const QString &Destination();

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

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

// Or, subclass STOMP and override this emitter function.
virtual int FireUnsubscribed(STOMPUnsubscribedEventParams *e) {...}

Remarks

This event fires each time the class has unsubscribed from a message destination on the server. The following parameters are available within this event:

• Id: The Id that was used to identify the subscription.
• Destination: The message destination on the server which the subscription was associated with.

Certificate Type

This is the digital certificate being used.

Syntax

IPWorksIoTCertificate (declared in ipworksiot.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

IPWorksIoTFirewall (declared in ipworksiot.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()

STOMPHeader Type

A STOMP header.

Syntax

IPWorksIoTSTOMPHeader (declared in ipworksiot.h)

Remarks

This type represents a STOMP header.

Fields

Constructors

STOMPHeader()

STOMPHeader(const char* lpszKey, const char* lpszValue)

STOMPSubscription Type

A STOMP subscription.

Syntax

IPWorksIoTSTOMPSubscription (declared in ipworksiot.h)

Remarks

This type represents a STOMP subscription.

Fields

IPWorksIoTList Type

Syntax

IPWorksIoTList<T> (declared in ipworksiot.h)

Remarks

IPWorksIoTList 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 STOMP class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

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

Config Settings (STOMP Class)

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (STOMP Class)

Error Handling (C++)

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

STOMP Errors

TCPClient Errors

SSL Errors

TCP/IP Errors