STOMP Class

Properties   Methods   Events   Config Settings   Errors  

A simple but powerful STOMP client implementation.

Syntax

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

STOMP.Connected Property

Triggers a connection or disconnection.

Syntax

isConnected(): boolean;

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.

STOMP.ContentType Property

The content type of the outgoing message.

Syntax

getContentType(): string;
setContentType(contentType: string): void;

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.

STOMP.Firewall Property

A set of properties related to firewall access.

Syntax

getFirewall(): Firewall;
setFirewall(firewall: Firewall): void;

Default Value

Remarks

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

STOMP.Headers Property

User-defined headers added to outgoing messages.

Syntax

getHeaders(): STOMPHeaderList;
setHeaders(headers: STOMPHeaderList): void;

Default Value

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.

STOMP.IncomingHeartbeat Property

Specifies the server-to-class heartbeat timing.

Syntax

getIncomingHeartbeat(): number;
setIncomingHeartbeat(incomingHeartbeat: number): void;

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.

STOMP.LocalHost Property

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

Syntax

getLocalHost(): string;
setLocalHost(localHost: string): void;

Default Value

""

Remarks

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

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

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

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

STOMP.LocalPort Property

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

Syntax

getLocalPort(): number;
setLocalPort(localPort: number): void;

Default Value

0

Remarks

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

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

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

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

STOMP.OutgoingHeartbeat Property

Specifies the class-to-server heartbeat timing.

Syntax

getOutgoingHeartbeat(): number;
setOutgoingHeartbeat(outgoingHeartbeat: number): void;

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.

STOMP.ParsedHeaders Property

Headers parsed from incoming messages.

Syntax

getParsedHeaders(): STOMPHeaderList;

Default Value

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.

STOMP.Password Property

A password if authentication is to be used.

Syntax

getPassword(): string;
setPassword(password: string): void;

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.

STOMP.ReadyToSend Property

Indicates whether the class is ready to send data.

Syntax

isReadyToSend(): boolean;

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.

STOMP.RemoteHost Property

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

Syntax

getRemoteHost(): string;
setRemoteHost(remoteHost: string): void;

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.

STOMP.RemotePort Property

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

Syntax

getRemotePort(): number;
setRemotePort(remotePort: number): void;

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.

STOMP.RequestReceipts Property

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

Syntax

isRequestReceipts(): boolean;
setRequestReceipts(requestReceipts: boolean): void;

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.

STOMP.SSLAcceptServerCert Property

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

Syntax

getSSLAcceptServerCert(): Certificate;
setSSLAcceptServerCert(SSLAcceptServerCert: Certificate): void;

Default Value

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.

Please note that this functionality is provided only for cases where 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.

STOMP.SSLCert Property

The certificate to be used during SSL negotiation.

Syntax

getSSLCert(): Certificate;
setSSLCert(SSLCert: Certificate): void;

Default Value

Remarks

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 field to the encoded certificate. To select a certificate, use the store and subject fields.

STOMP.SSLEnabled Property

Whether TLS/SSL is enabled.

Syntax

isSSLEnabled(): boolean;
setSSLEnabled(SSLEnabled: boolean): void;

Default Value

FALSE

Remarks

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

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

This property is not available at design time.

STOMP.SSLProvider Property

This specifies the SSL/TLS implementation to use.

Syntax

getSSLProvider(): StompSSLProviders;
setSSLProvider(SSLProvider: StompSSLProviders): void;

enum StompSSLProviders {
  sslpAutomatic,
  sslpPlatform,
  sslpInternal
}

Default Value

0

Remarks

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

Possible values are:

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

When Automatic is selected the platform implementation will be used by default in all cases in the JavaScript edition.

Note: The Internal provider is not support at this time.

STOMP.SSLServerCert Property

The server certificate for the last established connection.

Syntax

getSSLServerCert(): Certificate;

Default Value

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

STOMP.Subscriptions Property

Collection of current subscriptions.

Syntax

getSubscriptions(): STOMPSubscriptionList;

Default Value

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.

STOMP.Timeout Property

A timeout for the class.

Syntax

getTimeout(): number;
setTimeout(timeout: number): void;

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 .

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

The default value for the Timeout property is 60 seconds.

STOMP.TransactionId Property

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

Syntax

getTransactionId(): string;
setTransactionId(transactionId: string): void;

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.

STOMP.User Property

A username if authentication is to be used.

Syntax

getUser(): string;
setUser(user: string): void;

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.

STOMP.abortTransaction Method

Aborts an existing transaction.

Syntax

async stomp.abortTransaction(id : string): Promise<void>

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.

STOMP.addHeader Method

Adds a custom header to send with outgoing messages.

Syntax

async stomp.addHeader(key : string, value : string): Promise<void>

Remarks

This method is used to add user-defined headers to the list of headers held by the Header* properties.

When SendMessage or SendData is called, all headers in the Header* properties 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.

STOMP.beginTransaction Method

Begins a new transaction.

Syntax

async stomp.beginTransaction(id : string): Promise<void>

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 = "";

STOMP.commitTransaction Method

Commits an existing transaction.

Syntax

async stomp.commitTransaction(id : string): Promise<void>

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.

STOMP.config Method

Sets or retrieves a configuration setting.

Syntax

async stomp.config(configurationString : string): Promise<string>

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.

STOMP.connect Method

Connects to the remote host.

Syntax

async stomp.connect(): Promise<void>

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.

STOMP.connectTo Method

Connects to the remote host.

Syntax

async stomp.connectTo(host : string, port : number): Promise<void>

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.

STOMP.disconnect Method

This method disconnects from the remote host.

Syntax

async stomp.disconnect(): Promise<void>

Remarks

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

STOMP.doEvents Method

Processes events from the internal message queue.

Syntax

async stomp.doEvents(): Promise<void>

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.

STOMP.interrupt Method

Interrupt the current action and disconnects from the remote host.

Syntax

async stomp.interrupt(): Promise<void>

Remarks

This method will interrupt the current method (if applicable) and cause the class to disconnect from the remote host.

STOMP.reset Method

Reset the class.

Syntax

async stomp.reset(): Promise<void>

Remarks

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

STOMP.resetHeaders Method

Clear the user-defined headers collection.

Syntax

async stomp.resetHeaders(): Promise<void>

Remarks

This method clears the Header* properties.

STOMP.sendData Method

Publishes a message with a raw data payload.

Syntax

async stomp.sendData(destination : string, data : Uint8Array): Promise<void>

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 Header* properties.
• 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);

STOMP.sendMessage Method

Publishes a message with a string payload.

Syntax

async stomp.sendMessage(destination : string, message : string): Promise<void>

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 Header* properties.
• 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);

STOMP.subscribe Method

Subscribes to a message destination on the server.

Syntax

async stomp.subscribe(destination : string, requireAcks : boolean): Promise<string>

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 Subscription* properties. 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);

STOMP.unsubscribe Method

Removes an existing subscription.

Syntax

async stomp.unsubscribe(id : string): Promise<void>

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 Subscription* properties 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);

STOMP.Connected Event

This event is fired immediately after a connection completes (or fails).

Syntax

stomp.on('Connected', listener: (e: {readonly statusCode: number, readonly description: string}) => void )

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.

STOMP.ConnectionStatus Event

This event is fired to indicate changes in the connection state.

Syntax

stomp.on('ConnectionStatus', listener: (e: {readonly connectionEvent: string, readonly statusCode: number, readonly description: string}) => void )

Remarks

The ConnectionStatus 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:

STOMP.Disconnected Event

This event is fired when a connection is closed.

Syntax

stomp.on('Disconnected', listener: (e: {readonly statusCode: number, readonly description: string}) => void )

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.

STOMP.Error Event

Fired when a class or protocol error occurs.

Syntax

stomp.on('Error', listener: (e: {readonly errorCode: number, readonly description: string, readonly data: string, readonly dataB: Uint8Array}) => void )

Remarks

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

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.

STOMP.Log Event

Fired once for each log message.

Syntax

stomp.on('Log', listener: (e: {readonly logLevel: number, readonly message: string, readonly logType: string}) => void )

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.

STOMP.MessageIn Event

Fired when a message has been received.

Syntax

stomp.on('MessageIn', listener: (e: {readonly messageId: string, readonly subscriptionId: string, readonly destination: string, readonly data: string, readonly dataB: Uint8Array, readonly contentType: string, ack: boolean}) => void )

Remarks

This events fires whenever the class has received a message.

In addition to the message details exposed by the event parameters, the ParsedHeader* properties are 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.

STOMP.MessageOut Event

Fired after a message has been sent.

Syntax

stomp.on('MessageOut', listener: (e: {readonly destination: string, readonly data: string, readonly dataB: Uint8Array, readonly contentType: string}) => void )

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

STOMP.ReadyToSend Event

Fired when the class is ready to send data.

Syntax

stomp.on('ReadyToSend', listener: (e: {}) => void )

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.

STOMP.ReceiptIn Event

Fires when the class receives a receipt from the server.

Syntax

stomp.on('ReceiptIn', listener: (e: {readonly receiptId: string}) => void )

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.

STOMP.ReceiptOut Event

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

Syntax

stomp.on('ReceiptOut', listener: (e: {readonly receiptId: string}) => void )

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.

STOMP.SSLServerAuthentication Event

Fired after the server presents its certificate to the client.

Syntax

stomp.on('SSLServerAuthentication', listener: (e: {readonly certEncoded: string, readonly certEncodedB: Uint8Array, readonly certSubject: string, readonly certIssuer: string, readonly status: string, accept: boolean}) => void )

Remarks

This event fires with information about the server certificate. The Status property shows why verification failed (otherwise, Status contains the string OK). To manually accept an untrusted certificate, the SSLAcceptAnyServerCert setting must be set to True before initiating the connection.

STOMP.SSLStatus Event

Shows the progress of the secure connection.

Syntax

stomp.on('SSLStatus', listener: (e: {readonly message: string}) => void )

Remarks

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

STOMP.Subscribed Event

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

Syntax

stomp.on('Subscribed', listener: (e: {readonly id: string, readonly destination: string, readonly requireAcks: boolean}) => void )

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.

STOMP.Unsubscribed Event

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

Syntax

stomp.on('Unsubscribed', listener: (e: {readonly id: string, readonly destination: string}) => void )

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.

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

public Certificate();

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

public Certificate(String certificateFile);

Opens CertificateFile and reads out the contents as an X509 public key.

public Certificate(byte[] certificateData);

Parses CertificateData as an X509 public key.

public Certificate(int certStoreType, String store, String storePassword, String subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, String store, String storePassword, String subject, String configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CyrptoAPI option. The default value is True (the key is persisted). "Thumbprint" - a MD5, SHA1, or SHA256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, String store, String storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, String subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, String subject, String configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

Firewall Type

This is the firewall the class will connect through.

Remarks

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

Fields

Constructors

public Firewall();

STOMPHeader Type

A STOMP header.

Remarks

This type represents a STOMP header.

Fields

Constructors

public STOMPHeader();

public STOMPHeader(String key, String value);

STOMPSubscription Type

A STOMP subscription.

Remarks

This type represents a STOMP subscription.

Fields

Config Settings (class ipworksiot.stomp)

STOMP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (class ipworksiot.stomp)

STOMP Errors

TCPClient Errors

SSL Errors

TCP/IP Errors