STOMP Class

Properties   Methods   Events   Configuration Settings   Errors  

A simple but powerful STOMP client implementation.

Syntax

class ipworksmq.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 connect 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:

• incoming_heartbeat
• outgoing_heartbeat
• 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 remote_host is used.

Subscriptions & Receiving Messages

The subscribe and unsubscribe methods are used to subscribe to and unsubscribe from message destinations on the server.

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 on_message_in 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 on_message_in for more information about subscriptions and receiving messages.

Sending Messages

To send messages, use the send_message and send_data methods. send_message is used to send messages with string payloads, while send_data 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 send_message and send_data 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 begin_transaction 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.

connected	Triggers a connection or disconnection.
content_type	The content type of the outgoing message.
firewall_auto_detect	This property tells the class whether or not to automatically detect and use firewall system settings, if available.
firewall_type	This property determines the type of firewall to connect through.
firewall_host	This property contains the name or IP address of firewall (optional).
firewall_password	This property contains a password if authentication is to be used when connecting through the firewall.
firewall_port	This property contains the TCP port for the firewall Host .
firewall_user	This property contains a user name if authentication is to be used connecting through a firewall.
header_count	The number of records in the Header arrays.
header_key	This header's key.
header_value	This header's value.
incoming_heartbeat	Specifies the server-to-class heartbeat timing.
local_host	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
local_port	The TCP port in the local host where the class binds.
outgoing_heartbeat	Specifies the class-to-server heartbeat timing.
parsed_header_count	The number of records in the ParsedHeader arrays.
parsed_header_key	This header's key.
parsed_header_value	This header's value.
password	A password if authentication is to be used.
ready_to_send	Indicates whether the class is ready to send data.
remote_host	The address of the remote host. Domain names are resolved to IP addresses.
remote_port	The port of the STOMP server (default is 61613). The default port for SSL is 61612.
request_receipts	Whether the class should request that the server provide message receipts.
ssl_accept_server_cert_encoded	The certificate (PEM/base64 encoded).
ssl_cert_encoded	The certificate (PEM/base64 encoded).
ssl_cert_store	The name of the certificate store for the client certificate.
ssl_cert_store_password	If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
ssl_cert_store_type	The type of certificate store for this certificate.
ssl_cert_subject	The subject of the certificate used for client authentication.
ssl_enabled	Whether TLS/SSL is enabled.
ssl_server_cert_encoded	The certificate (PEM/base64 encoded).
subscription_count	The number of records in the Subscription arrays.
subscription_destination	The destination on the server that this subscription is associated with.
subscription_id	This subscription's unique Id.
timeout	A timeout for the class.
transaction_id	Specifies the Id of the transaction that outgoing messages are associated with.
user	A username if authentication is to be used.

Method List

---

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

abort_transaction	Aborts an existing transaction.
add_header	Adds a custom header to send with outgoing messages.
begin_transaction	Begins a new transaction.
commit_transaction	Commits an existing transaction.
config	Sets or retrieves a configuration setting.
connect	Connects to the remote host.
disconnect	Disconnects from the remote host.
do_events	Processes events from the internal message queue.
interrupt	Interrupt the current action and disconnects from the remote host.
reset	Reset the class.
reset_headers	Clear the user-defined headers collection.
send_data	Publishes a message with a raw data payload.
send_message	Publishes a message with a string payload.
subscribe	Subscribes to a message destination on the server.
unsubscribe	Removes an existing subscription.

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.

on_connected	Fired immediately after a connection completes (or fails).
on_connection_status	Fired to indicate changes in connection state.
on_disconnected	Fired when a connection is closed.
on_error	Fired when a class or protocol error occurs.
on_log	Fired once for each log message.
on_message_in	Fired when a message has been received.
on_message_out	Fired after a message has been sent.
on_ready_to_send	Fired when the class is ready to send data.
on_receipt_in	Fires when the class receives a receipt from the server.
on_receipt_out	Fires when the class sends a STOMP frame that includes a 'receipt' header.
on_ssl_server_authentication	Fired after the server presents its certificate to the client.
on_ssl_status	Shows the progress of the secure connection.
on_subscribed	Fired when the class has subscribed to a message destination on the server.
on_unsubscribed	Fired when the class has unsubscribed from a message destination on the server.

Configuration Settings

---

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

AckTransactionId	The transaction Id to include when sending a message acknowledgment.
CollapseHeaders	Whether the class should collapse headers on incoming messages.
ErrorHeaders	Raw headers from a STOMP 'ERROR' frame.
LogLevel	The level of detail that is logged.
OpenTransactions	A comma-separated list of currently open transactions.
ProtocolVersion	The agreed-upon STOMP protocol version that the class is using.
RequestAckReceipts	Whether the class should request receipts for any message acknowledgments that are sent.
RequestSubscriptionReceipts	Whether the class should request receipts when sending subscribe and unsubscribe requests.
RequestTransactionReceipts	Whether the class should request receipts when sending begin, commit, and abort transaction requests.
SendCustomFrame	Sends a frame constructed using the supplied hex byte string.
ServerInfo	Information about the currently connected server.
SessionId	The server-assigned session Id.
SupportedVersions	Which STOMP protocol versions the class should advertise support for when connecting.
VirtualHost	The virtual host to connect to.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the class binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACertFilePaths	The paths to CA certificate files on Unix/Linux.
SSLCACerts	A newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRL	Whether to check the Certificate Revocation List for the server certificate.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLNegotiatedCipher	Returns the negotiated ciphersuite.
SSLNegotiatedCipherStrength	Returns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuite	Returns the negotiated ciphersuite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedProtocol	Returns the negotiated protocol version.
SSLProvider	The name of the security provider to use.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.