Struct ipworksmq::STOMP

Properties   Methods   Events   Config Settings   Errors  

A simple but powerful STOMP client implementation.

Syntax

ipworksmq::STOMP

Remarks

The STOMP struct provides an easy-to-use STOMP client implementation that supports STOMP versions 1.1 and 1.2. The struct 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_to method, passing the server's hostname and port number.

When connecting to a STOMP server, the struct 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 struct 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

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.

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksMQ. Due to this, the STOMP struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of STOMP when you have finished using the instance.

Property List

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

Method List

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

Event List

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

Config Settings

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

connected property (STOMP Struct)

Whether the struct is connected.

Syntax

fn connected(&self ) -> Result<bool, IPWorksMQError> 

Default Value

false

Remarks

This property is used to determine whether or not the struct is connected to the remote host. When connecting to a STOMP server, the struct 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 struct advertises support for.
• VirtualHost: Controls the virtual host to connect to. If left empty (default), the value from remote_host is used.

This property is read-only.

Data Type

bool

content_type property (STOMP Struct)

The content type of the outgoing message.

Syntax

fn content_type(&self ) -> Result<String, IPWorksMQError> 
fn set_content_type(&self, value : &str) ->  Option<IPWorksMQError> 
fn set_content_type_ref(&self, value : &String) ->  Option<IPWorksMQError> 

Default Value

"text/plain"

Remarks

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

Note that this property is ignored for messages sent using send_data, 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.

Data Type

String

firewall_auto_detect property (STOMP Struct)

Whether to automatically detect and use firewall system settings, if available.

Syntax

fn firewall_auto_detect(&self ) -> Result<bool, IPWorksMQError> 
fn set_firewall_auto_detect(&self, value : bool) ->  Option<IPWorksMQError> 

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

bool

firewall_type property (STOMP Struct)

The type of firewall to connect through.

Syntax

fn firewall_type(&self ) -> Result<i32, IPWorksMQError> 
fn set_firewall_type(&self, value : i32) ->  Option<IPWorksMQError> 

Possible Values

0   // None
1   // Tunnel
2   // SOCKS4
3   // SOCKS5
10   // SOCKS4A

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

i32

firewall_host property (STOMP Struct)

The name or IP address of the firewall (optional).

Syntax

fn firewall_host(&self ) -> Result<String, IPWorksMQError> 
fn set_firewall_host(&self, value : &str) ->  Option<IPWorksMQError> 
fn set_firewall_host_ref(&self, value : &String) ->  Option<IPWorksMQError> 

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a firewall_host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the struct fails with an error.

Data Type

String

firewall_password property (STOMP Struct)

A password if authentication is to be used when connecting through the firewall.

Syntax

fn firewall_password(&self ) -> Result<String, IPWorksMQError> 
fn set_firewall_password(&self, value : &str) ->  Option<IPWorksMQError> 
fn set_firewall_password_ref(&self, value : &String) ->  Option<IPWorksMQError> 

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error.

Data Type

String

firewall_port property (STOMP Struct)

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

fn firewall_port(&self ) -> Result<i32, IPWorksMQError> 
fn set_firewall_port(&self, value : i32) ->  Option<IPWorksMQError> 

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.

NOTE: This property is set automatically when firewall_firewall_type is set to a valid value. See the description of the firewall_firewall_type property for details.

Data Type

i32

firewall_user property (STOMP Struct)

A username if authentication is to be used when connecting through a firewall.

Syntax

fn firewall_user(&self ) -> Result<String, IPWorksMQError> 
fn set_firewall_user(&self, value : &str) ->  Option<IPWorksMQError> 
fn set_firewall_user_ref(&self, value : &String) ->  Option<IPWorksMQError> 

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If firewall_host is specified, this property and the firewall_password property are used to connect and authenticate to the given Firewall. If the authentication fails, the struct fails with an error.

Data Type

String

header_count property (STOMP Struct)

The number of records in the Header arrays.

Syntax

fn header_count(&self ) -> Result<i32, IPWorksMQError> 
fn set_header_count(&self, value : i32) ->  Option<IPWorksMQError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• header_key
• header_value

The array indices start at 0 and end at header_count - 1.

Data Type

i32

header_key property (STOMP Struct)

This header's key.

Syntax

fn header_key(&self , HeaderIndex : i32) -> Result<String, IPWorksMQError> 
fn set_header_key(&self, HeaderIndex : i32, value : &str) ->  Option<IPWorksMQError> 
fn set_header_key_ref(&self, HeaderIndex : i32, value : &String) ->  Option<IPWorksMQError> 

Default Value

""

Remarks

This header's key.

This property holds this header's key (or name).

The HeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the HeaderCount property.

Data Type

String

header_value property (STOMP Struct)

This header's value.

Syntax

fn header_value(&self , HeaderIndex : i32) -> Result<String, IPWorksMQError> 
fn set_header_value(&self, HeaderIndex : i32, value : &str) ->  Option<IPWorksMQError> 
fn set_header_value_ref(&self, HeaderIndex : i32, value : &String) ->  Option<IPWorksMQError> 

Default Value

""

Remarks

This header's value.

This property holds this header's value.

The HeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the HeaderCount property.

Data Type

String

incoming_heartbeat property (STOMP Struct)

Specifies the server-to-struct heartbeat timing.

Syntax

fn incoming_heartbeat(&self ) -> Result<i32, IPWorksMQError> 
fn set_incoming_heartbeat(&self, value : i32) ->  Option<IPWorksMQError> 

Default Value

0

Remarks

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

For information about outgoing (struct-to-server) heartbeats; see the outgoing_heartbeat 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 struct 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-struct heartbeats will be sent.

After Connecting

After connecting, this property cannot be set. Instead, it reflects the incoming heartbeat interval agreed upon by the struct 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 struct requested, or may be 0 (i.e., incoming heartbeats are disabled).

Data Type

i32

local_host property (STOMP Struct)

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

Syntax

fn local_host(&self ) -> Result<String, IPWorksMQError> 
fn set_local_host(&self, value : &str) ->  Option<IPWorksMQError> 
fn set_local_host_ref(&self, value : &String) ->  Option<IPWorksMQError> 

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 struct initiate connections (or accept in the case of server structs) 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 struct is connected, the local_host 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: local_host is not persistent. You must always set it in code, and never in the property window.

Data Type

String

local_port property (STOMP Struct)

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

Syntax

fn local_port(&self ) -> Result<i32, IPWorksMQError> 
fn set_local_port(&self, value : i32) ->  Option<IPWorksMQError> 

Default Value

0

Remarks

This property must be set before a connection is attempted. It instructs the struct 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 local_port property after the connection is established.

local_port 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

i32

outgoing_heartbeat property (STOMP Struct)

Specifies the struct-to-server heartbeat timing.

Syntax

fn outgoing_heartbeat(&self ) -> Result<i32, IPWorksMQError> 
fn set_outgoing_heartbeat(&self, value : i32) ->  Option<IPWorksMQError> 

Default Value

0

Remarks

This property specifies the outgoing heartbeat interval, which is the number of seconds without any struct-to-server communication that the struct 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-struct) heartbeats; see the incoming_heartbeat 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 struct 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 struct-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 struct 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 struct's supported minimum, or may be 0 (i.e., outgoing heartbeats are disabled).

Data Type

i32

parsed_header_count property (STOMP Struct)

The number of records in the ParsedHeader arrays.

Syntax

fn parsed_header_count(&self ) -> Result<i32, IPWorksMQError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• parsed_header_key
• parsed_header_value

The array indices start at 0 and end at parsed_header_count - 1.

This property is read-only.

Data Type

i32

parsed_header_key property (STOMP Struct)

This header's key.

Syntax

fn parsed_header_key(&self , ParsedHeaderIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

This header's key.

This property holds this header's key (or name).

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only.

Data Type

String

parsed_header_value property (STOMP Struct)

This header's value.

Syntax

fn parsed_header_value(&self , ParsedHeaderIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

This header's value.

This property holds this header's value.

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only.

Data Type

String

password property (STOMP Struct)

A password if authentication is to be used.

Syntax

fn password(&self ) -> Result<String, IPWorksMQError> 
fn set_password(&self, value : &str) ->  Option<IPWorksMQError> 
fn set_password_ref(&self, value : &String) ->  Option<IPWorksMQError> 

Default Value

""

Remarks

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

Data Type

String

ready_to_send property (STOMP Struct)

Indicates whether the struct is ready to send data.

Syntax

fn ready_to_send(&self ) -> Result<bool, IPWorksMQError> 

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 send_data or send_message fails due to a WOULDBLOCK condition.

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

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

This property is read-only.

Data Type

bool

remote_host property (STOMP Struct)

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

Syntax

fn remote_host(&self ) -> Result<String, IPWorksMQError> 
fn set_remote_host(&self, value : &str) ->  Option<IPWorksMQError> 
fn set_remote_host_ref(&self, value : &String) ->  Option<IPWorksMQError> 

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 struct 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 struct will connect in plaintext. To enable SSL set ssl_enabled to True.

Data Type

String

remote_port property (STOMP Struct)

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

Syntax

fn remote_port(&self ) -> Result<i32, IPWorksMQError> 
fn set_remote_port(&self, value : i32) ->  Option<IPWorksMQError> 

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.

Data Type

i32

request_receipts property (STOMP Struct)

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

Syntax

fn request_receipts(&self ) -> Result<bool, IPWorksMQError> 
fn set_request_receipts(&self, value : bool) ->  Option<IPWorksMQError> 

Default Value

false

Remarks

This property is used to specify whether the struct should request that the server send back confirmations (known as a "receipts" in STOMP terminology) when it receives messages from the struct. 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 on_receipt_out event will fire immediately after the on_message_out event fires.

Note that, while this property only controls receipt requests for outgoing messages, the struct 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 on_receipt_in 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 struct 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

Data Type

bool

ssl_accept_server_cert_effective_date property (STOMP Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_accept_server_cert_effective_date(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_accept_server_cert_expiration_date property (STOMP Struct)

The date on which the certificate expires.

Syntax

fn ssl_accept_server_cert_expiration_date(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_accept_server_cert_extended_key_usage property (STOMP Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_accept_server_cert_extended_key_usage(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint property (STOMP Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint_sha1 property (STOMP Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

ssl_accept_server_cert_fingerprint_sha256 property (STOMP Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_accept_server_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

ssl_accept_server_cert_issuer property (STOMP Struct)

The issuer of the certificate.

Syntax

fn ssl_accept_server_cert_issuer(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

ssl_accept_server_cert_private_key property (STOMP Struct)

The private key of the certificate (if available).

Syntax

fn ssl_accept_server_cert_private_key(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The ssl_accept_server_cert_private_key may be available but not exportable. In this case, ssl_accept_server_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_accept_server_cert_private_key_available property (STOMP Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_accept_server_cert_private_key_available(&self ) -> Result<bool, IPWorksMQError> 

Default Value

false

Remarks

Whether a ssl_accept_server_cert_private_key is available for the selected certificate. If ssl_accept_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_accept_server_cert_private_key_container property (STOMP Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_accept_server_cert_private_key_container(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The name of the ssl_accept_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key property (STOMP Struct)

The public key of the certificate.

Syntax

fn ssl_accept_server_cert_public_key(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key_algorithm property (STOMP Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_accept_server_cert_public_key_algorithm(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key_length property (STOMP Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_accept_server_cert_public_key_length(&self ) -> Result<i32, IPWorksMQError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

ssl_accept_server_cert_serial_number property (STOMP Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_accept_server_cert_serial_number(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

ssl_accept_server_cert_signature_algorithm property (STOMP Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_accept_server_cert_signature_algorithm(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_accept_server_cert_store property (STOMP Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_accept_server_cert_store(&self ) -> Result<Vec<u8>, IPWorksMQError> 
fn set_ssl_accept_server_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksMQError> 
fn set_ssl_accept_server_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksMQError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_accept_server_cert_store_type property denotes the type of the certificate store specified by ssl_accept_server_cert_store. If the store is password-protected, specify the password in ssl_accept_server_cert_store_password.

ssl_accept_server_cert_store is used in conjunction with the ssl_accept_server_cert_subject property to specify client certificates. If ssl_accept_server_cert_store has a value, and ssl_accept_server_cert_subject or ssl_accept_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_accept_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Vec

ssl_accept_server_cert_store_password property (STOMP Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_accept_server_cert_store_password(&self ) -> Result<String, IPWorksMQError> 
fn set_ssl_accept_server_cert_store_password(&self, value : &str) ->  Option<IPWorksMQError> 
fn set_ssl_accept_server_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksMQError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

ssl_accept_server_cert_store_type property (STOMP Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_accept_server_cert_store_type(&self ) -> Result<i32, IPWorksMQError> 
fn set_ssl_accept_server_cert_store_type(&self, value : i32) ->  Option<IPWorksMQError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

i32

ssl_accept_server_cert_subject_alt_names property (STOMP Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_accept_server_cert_subject_alt_names(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_md5 property (STOMP Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_md5(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_sha1 property (STOMP Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_sha256 property (STOMP Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_accept_server_cert_usage property (STOMP Struct)

The text description of UsageFlags .

Syntax

fn ssl_accept_server_cert_usage(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The text description of ssl_accept_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

ssl_accept_server_cert_usage_flags property (STOMP Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_accept_server_cert_usage_flags(&self ) -> Result<i32, IPWorksMQError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_accept_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_accept_server_cert_usage property for a text representation of ssl_accept_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_accept_server_cert_version property (STOMP Struct)

The certificate's version number.

Syntax

fn ssl_accept_server_cert_version(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

ssl_accept_server_cert_subject property (STOMP Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_accept_server_cert_subject(&self ) -> Result<String, IPWorksMQError> 
fn set_ssl_accept_server_cert_subject(&self, value : &str) ->  Option<IPWorksMQError> 
fn set_ssl_accept_server_cert_subject_ref(&self, value : &String) ->  Option<IPWorksMQError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

ssl_accept_server_cert_encoded property (STOMP Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_accept_server_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksMQError> 
fn set_ssl_accept_server_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksMQError> 
fn set_ssl_accept_server_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksMQError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.

Data Type

Vec

ssl_cert_effective_date property (STOMP Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_cert_effective_date(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_cert_expiration_date property (STOMP Struct)

The date on which the certificate expires.

Syntax

fn ssl_cert_expiration_date(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_cert_extended_key_usage property (STOMP Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_cert_extended_key_usage(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

ssl_cert_fingerprint property (STOMP Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

ssl_cert_fingerprint_sha1 property (STOMP Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

ssl_cert_fingerprint_sha256 property (STOMP Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

ssl_cert_issuer property (STOMP Struct)

The issuer of the certificate.

Syntax

fn ssl_cert_issuer(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

ssl_cert_private_key property (STOMP Struct)

The private key of the certificate (if available).

Syntax

fn ssl_cert_private_key(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The ssl_cert_private_key may be available but not exportable. In this case, ssl_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_cert_private_key_available property (STOMP Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_cert_private_key_available(&self ) -> Result<bool, IPWorksMQError> 

Default Value

false

Remarks

Whether a ssl_cert_private_key is available for the selected certificate. If ssl_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_cert_private_key_container property (STOMP Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_cert_private_key_container(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The name of the ssl_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_cert_public_key property (STOMP Struct)

The public key of the certificate.

Syntax

fn ssl_cert_public_key(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

ssl_cert_public_key_algorithm property (STOMP Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_cert_public_key_algorithm(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_cert_public_key_length property (STOMP Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_cert_public_key_length(&self ) -> Result<i32, IPWorksMQError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

ssl_cert_serial_number property (STOMP Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_cert_serial_number(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

ssl_cert_signature_algorithm property (STOMP Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_cert_signature_algorithm(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_cert_store property (STOMP Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_cert_store(&self ) -> Result<Vec<u8>, IPWorksMQError> 
fn set_ssl_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksMQError> 
fn set_ssl_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksMQError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password-protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Vec

ssl_cert_store_password property (STOMP Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_cert_store_password(&self ) -> Result<String, IPWorksMQError> 
fn set_ssl_cert_store_password(&self, value : &str) ->  Option<IPWorksMQError> 
fn set_ssl_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksMQError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

ssl_cert_store_type property (STOMP Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_cert_store_type(&self ) -> Result<i32, IPWorksMQError> 
fn set_ssl_cert_store_type(&self, value : i32) ->  Option<IPWorksMQError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

i32

ssl_cert_subject_alt_names property (STOMP Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_cert_subject_alt_names(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_md5 property (STOMP Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_md5(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_sha1 property (STOMP Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_sha256 property (STOMP Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_usage property (STOMP Struct)

The text description of UsageFlags .

Syntax

fn ssl_cert_usage(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The text description of ssl_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

ssl_cert_usage_flags property (STOMP Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_cert_usage_flags(&self ) -> Result<i32, IPWorksMQError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_cert_usage_flags is a combination of the following flags:

Please see the ssl_cert_usage property for a text representation of ssl_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_cert_version property (STOMP Struct)

The certificate's version number.

Syntax

fn ssl_cert_version(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

ssl_cert_subject property (STOMP Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_cert_subject(&self ) -> Result<String, IPWorksMQError> 
fn set_ssl_cert_subject(&self, value : &str) ->  Option<IPWorksMQError> 
fn set_ssl_cert_subject_ref(&self, value : &String) ->  Option<IPWorksMQError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

ssl_cert_encoded property (STOMP Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksMQError> 
fn set_ssl_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksMQError> 
fn set_ssl_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksMQError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

Data Type

Vec

ssl_enabled property (STOMP Struct)

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

Syntax

fn ssl_enabled(&self ) -> Result<bool, IPWorksMQError> 
fn set_ssl_enabled(&self, value : bool) ->  Option<IPWorksMQError> 

Default Value

false

Remarks

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

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

Data Type

bool

ssl_provider property (STOMP Struct)

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

Syntax

fn ssl_provider(&self ) -> Result<i32, IPWorksMQError> 
fn set_ssl_provider(&self, value : i32) ->  Option<IPWorksMQError> 

Possible Values

0   // Automatic
1   // Platform
2   // Internal

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 struct 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 struct will select a provider depending on the current platform.

When Automatic is selected, on Windows, the struct will use the platform implementation. On Linux/macOS, the struct will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the struct will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

Data Type

i32

ssl_server_cert_effective_date property (STOMP Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_server_cert_effective_date(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_server_cert_expiration_date property (STOMP Struct)

The date on which the certificate expires.

Syntax

fn ssl_server_cert_expiration_date(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_server_cert_extended_key_usage property (STOMP Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_server_cert_extended_key_usage(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint property (STOMP Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint_sha1 property (STOMP Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

ssl_server_cert_fingerprint_sha256 property (STOMP Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_server_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

ssl_server_cert_issuer property (STOMP Struct)

The issuer of the certificate.

Syntax

fn ssl_server_cert_issuer(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

ssl_server_cert_private_key property (STOMP Struct)

The private key of the certificate (if available).

Syntax

fn ssl_server_cert_private_key(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The ssl_server_cert_private_key may be available but not exportable. In this case, ssl_server_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_server_cert_private_key_available property (STOMP Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_server_cert_private_key_available(&self ) -> Result<bool, IPWorksMQError> 

Default Value

false

Remarks

Whether a ssl_server_cert_private_key is available for the selected certificate. If ssl_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_server_cert_private_key_container property (STOMP Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_server_cert_private_key_container(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The name of the ssl_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_server_cert_public_key property (STOMP Struct)

The public key of the certificate.

Syntax

fn ssl_server_cert_public_key(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

ssl_server_cert_public_key_algorithm property (STOMP Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_server_cert_public_key_algorithm(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_server_cert_public_key_length property (STOMP Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_server_cert_public_key_length(&self ) -> Result<i32, IPWorksMQError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

ssl_server_cert_serial_number property (STOMP Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_server_cert_serial_number(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

ssl_server_cert_signature_algorithm property (STOMP Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_server_cert_signature_algorithm(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_server_cert_store property (STOMP Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_server_cert_store(&self ) -> Result<Vec<u8>, IPWorksMQError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_server_cert_store_type property denotes the type of the certificate store specified by ssl_server_cert_store. If the store is password-protected, specify the password in ssl_server_cert_store_password.

ssl_server_cert_store is used in conjunction with the ssl_server_cert_subject property to specify client certificates. If ssl_server_cert_store has a value, and ssl_server_cert_subject or ssl_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Vec

ssl_server_cert_store_password property (STOMP Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_server_cert_store_password(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

Data Type

String

ssl_server_cert_store_type property (STOMP Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_server_cert_store_type(&self ) -> Result<i32, IPWorksMQError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

This property is read-only.

Data Type

i32

ssl_server_cert_subject_alt_names property (STOMP Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_server_cert_subject_alt_names(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_md5 property (STOMP Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_md5(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_sha1 property (STOMP Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_sha256 property (STOMP Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_server_cert_usage property (STOMP Struct)

The text description of UsageFlags .

Syntax

fn ssl_server_cert_usage(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The text description of ssl_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

ssl_server_cert_usage_flags property (STOMP Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_server_cert_usage_flags(&self ) -> Result<i32, IPWorksMQError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_server_cert_usage property for a text representation of ssl_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_server_cert_version property (STOMP Struct)

The certificate's version number.

Syntax

fn ssl_server_cert_version(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

ssl_server_cert_subject property (STOMP Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_server_cert_subject(&self ) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

Data Type

String

ssl_server_cert_encoded property (STOMP Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_server_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksMQError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.

This property is read-only.

Data Type

Vec

subscription_count property (STOMP Struct)

The number of records in the Subscription arrays.

Syntax

fn subscription_count(&self ) -> Result<i32, IPWorksMQError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• subscription_destination
• subscription_id

The array indices start at 0 and end at subscription_count - 1.

This property is read-only.

Data Type

i32

subscription_destination property (STOMP Struct)

The destination on the server that this subscription is associated with.

Syntax

fn subscription_destination(&self , SubscriptionIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

The destination on the server that this subscription is associated with.

This property reflects the destination on the server that this subscription is associated with.

The SubscriptionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubscriptionCount property.

This property is read-only.

Data Type

String

subscription_id property (STOMP Struct)

This subscription's unique Id.

Syntax

fn subscription_id(&self , SubscriptionIndex : i32) -> Result<String, IPWorksMQError> 

Default Value

""

Remarks

This subscription's unique Id.

This property reflects the unique Id of this subscription.

The SubscriptionIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SubscriptionCount property.

This property is read-only.

Data Type

String

timeout property (STOMP Struct)

This property includes the timeout for the struct.

Syntax

fn timeout(&self ) -> Result<i32, IPWorksMQError> 
fn set_timeout(&self, value : i32) ->  Option<IPWorksMQError> 

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 struct will wait for the operation to complete before returning control. The struct will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of timeout seconds.

The struct will use do_events 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 struct 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

i32

transaction_id property (STOMP Struct)

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

Syntax

fn transaction_id(&self ) -> Result<String, IPWorksMQError> 
fn set_transaction_id(&self, value : &str) ->  Option<IPWorksMQError> 
fn set_transaction_id_ref(&self, value : &String) ->  Option<IPWorksMQError> 

Default Value

""

Remarks

This property, if not empty, is used to specify which transaction outgoing messages sent using send_message or send_data 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 on_message_in event handler.

Refer to begin_transaction for more information about transactions.

Data Type

String

user property (STOMP Struct)

A username if authentication is to be used.

Syntax

fn user(&self ) -> Result<String, IPWorksMQError> 
fn set_user(&self, value : &str) ->  Option<IPWorksMQError> 
fn set_user_ref(&self, value : &String) ->  Option<IPWorksMQError> 

Default Value

""

Remarks

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

Data Type

String

abort_transaction method (STOMP Struct)

Aborts an existing transaction.

Syntax

fn abort_transaction(&self, id : &str) -> Result<(), IPWorksMQError>

Remarks

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

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

Refer to begin_transaction for more information about transactions.

add_header method (STOMP Struct)

Adds a custom header to send with outgoing messages.

Syntax

fn add_header(&self, key : &str, value : &str) -> Result<(), IPWorksMQError>

Remarks

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

When send_message or send_data 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 struct silently ignores any user-defined headers that are already set by the struct.

begin_transaction method (STOMP Struct)

Begins a new transaction.

Syntax

fn begin_transaction(&self, id : &str) -> Result<(), IPWorksMQError>

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

commit_transaction method (STOMP Struct)

Commits an existing transaction.

Syntax

fn commit_transaction(&self, id : &str) -> Result<(), IPWorksMQError>

Remarks

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

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

Refer to begin_transaction for more information about transactions.

config method (STOMP Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, IPWorksMQError>

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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.

connect method (STOMP Struct)

Connects to the remote host.

Syntax

fn connect(&self) -> Result<(), IPWorksMQError>

Remarks

This method connects to the remote host, specified by remote_host and remote_port.

By default the struct will connect in plaintext. To enable SSL set ssl_enabled to True.

When connecting to a STOMP server, the struct 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 struct advertises support for.
• VirtualHost: Controls the virtual host to connect to. If left empty (default), the value from remote_host is used.

connect_to method (STOMP Struct)

Connects to the remote host.

Syntax

fn connect_to(&self, host : &str, port : i32) -> Result<(), IPWorksMQError>

Remarks

This method connects to the remote host specified by the Host and Port parameters. Calling this method is equivalent to setting the remote_host property to Host and setting remote_port to Port.

By default the struct will connect in plaintext. To enable SSL set ssl_enabled to True.

When connecting to a STOMP server, the struct 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 struct advertises support for.
• VirtualHost: Controls the virtual host to connect to. If left empty (default), the value from remote_host is used.

disconnect method (STOMP Struct)

This method disconnects from the remote host.

Syntax

fn disconnect(&self) -> Result<(), IPWorksMQError>

Remarks

This method disconnects from the remote host.

do_events method (STOMP Struct)

This method processes events from the internal message queue.

Syntax

fn do_events(&self) -> Result<(), IPWorksMQError>

Remarks

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

interrupt method (STOMP Struct)

Interrupt the current action and disconnects from the remote host.

Syntax

fn interrupt(&self) -> Result<(), IPWorksMQError>

Remarks

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

reset method (STOMP Struct)

This method will reset the struct.

Syntax

fn reset(&self) -> Result<(), IPWorksMQError>

Remarks

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

reset_headers method (STOMP Struct)

Clear the user-defined headers collection.

Syntax

fn reset_headers(&self) -> Result<(), IPWorksMQError>

Remarks

This method clears the headers collection property.

send_data method (STOMP Struct)

Publishes a message with a raw data payload.

Syntax

fn send_data(&self, destination : &str, data : &[u8]) -> Result<(), IPWorksMQError>

Remarks

This method publishes a STOMP message with a raw data payload to the specified Destination. The on_message_out 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 transaction_id property is populated, the transaction Id that it specifies (which associates the message with that transaction).

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

Note that no content type is defined for raw data payload messages; so the content_type 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);

send_message method (STOMP Struct)

Publishes a message with a string payload.

Syntax

fn send_message(&self, destination : &str, message : &str) -> Result<(), IPWorksMQError>

Remarks

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

The content_type property can be used to specify the content type of the payload. By default, content_type 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 transaction_id property is populated, the transaction Id that it specifies (which associates the message with that transaction).

If request_receipts is enabled when this method is called, the struct will request that the server send back a receipt to confirm it has received the message. Refer to request_receipts 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);

subscribe method (STOMP Struct)

Subscribes to a message destination on the server.

Syntax

fn subscribe(&self, destination : &str, require_acks : bool) ->  Result<String, IPWorksMQError>

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 on_subscribed event will fire and an item will be added to the subscriptions collection property. The on_message_in 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 struct to send it a message acknowledgment for each message it delivers as part of this subscription. (Refer to the on_message_in 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);

unsubscribe method (STOMP Struct)

Removes an existing subscription.

Syntax

fn unsubscribe(&self, id : &str) -> Result<(), IPWorksMQError>

Remarks

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

Once unsubscribed, the relevant item will be removed from the subscriptions collection property and the on_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);

on_connected event (STOMP Struct)

Fired immediately after a connection completes (or fails).

Syntax

// STOMPConnectedEventArgs carries the STOMP Connected event's parameters.
pub struct STOMPConnectedEventArgs {
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// STOMPConnectedEvent defines the signature of the STOMP Connected event's handler function.
pub trait STOMPConnectedEvent {
  fn on_connected(&self, sender : STOMP, e : &mut STOMPConnectedEventArgs);
}

impl <'a> STOMP<'a> {
  pub fn on_connected(&self) -> &'a dyn STOMPConnectedEvent;
  pub fn set_on_connected(&mut self, value : &'a dyn STOMPConnectedEvent);
  ...
}

Remarks

If the connection is made normally, status_code is 0 and description is "OK".

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

Please refer to the Error Codes section for more information.

on_connection_status event (STOMP Struct)

Fired to indicate changes in the connection state.

Syntax

// STOMPConnectionStatusEventArgs carries the STOMP ConnectionStatus event's parameters.
pub struct STOMPConnectionStatusEventArgs {
  fn connection_event(&self) -> &String
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// STOMPConnectionStatusEvent defines the signature of the STOMP ConnectionStatus event's handler function.
pub trait STOMPConnectionStatusEvent {
  fn on_connection_status(&self, sender : STOMP, e : &mut STOMPConnectionStatusEventArgs);
}

impl <'a> STOMP<'a> {
  pub fn on_connection_status(&self) -> &'a dyn STOMPConnectionStatusEvent;
  pub fn set_on_connection_status(&mut self, value : &'a dyn STOMPConnectionStatusEvent);
  ...
}

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 connection_event parameter indicates the type of connection event. Values may include the following:

on_disconnected event (STOMP Struct)

Fired when a connection is closed.

Syntax

// STOMPDisconnectedEventArgs carries the STOMP Disconnected event's parameters.
pub struct STOMPDisconnectedEventArgs {
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// STOMPDisconnectedEvent defines the signature of the STOMP Disconnected event's handler function.
pub trait STOMPDisconnectedEvent {
  fn on_disconnected(&self, sender : STOMP, e : &mut STOMPDisconnectedEventArgs);
}

impl <'a> STOMP<'a> {
  pub fn on_disconnected(&self) -> &'a dyn STOMPDisconnectedEvent;
  pub fn set_on_disconnected(&mut self, value : &'a dyn STOMPDisconnectedEvent);
  ...
}

Remarks

If the connection is broken normally, status_code is 0 and description is "OK".

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

Please refer to the Error Codes section for more information.

on_error event (STOMP Struct)

Fired when a struct or protocol error occurs.

Syntax

// STOMPErrorEventArgs carries the STOMP Error event's parameters.
pub struct STOMPErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
  fn data(&self) -> &[u8]
}

// STOMPErrorEvent defines the signature of the STOMP Error event's handler function.
pub trait STOMPErrorEvent {
  fn on_error(&self, sender : STOMP, e : &mut STOMPErrorEventArgs);
}

impl <'a> STOMP<'a> {
  pub fn on_error(&self) -> &'a dyn STOMPErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn STOMPErrorEvent);
  ...
}

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the struct 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 on_error event handler.

on_log event (STOMP Struct)

Fired once for each log message.

Syntax

// STOMPLogEventArgs carries the STOMP Log event's parameters.
pub struct STOMPLogEventArgs {
  fn log_level(&self) -> i32
  fn message(&self) -> &String
  fn log_type(&self) -> &String
}

// STOMPLogEvent defines the signature of the STOMP Log event's handler function.
pub trait STOMPLogEvent {
  fn on_log(&self, sender : STOMP, e : &mut STOMPLogEventArgs);
}

impl <'a> STOMP<'a> {
  pub fn on_log(&self) -> &'a dyn STOMPLogEvent;
  pub fn set_on_log(&mut self, value : &'a dyn STOMPLogEvent);
  ...
}

Remarks

This event fires once for each log message generated by the struct. 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 struct.
• Acknowledgment: Information about outgoing message acknowledgments.
• Frame: Frame content logging.

on_message_in event (STOMP Struct)

Fired when a message has been received.

Syntax

// STOMPMessageInEventArgs carries the STOMP MessageIn event's parameters.
pub struct STOMPMessageInEventArgs {
  fn message_id(&self) -> &String
  fn subscription_id(&self) -> &String
  fn destination(&self) -> &String
  fn data(&self) -> &[u8]
  fn content_type(&self) -> &String
  fn ack(&self) -> bool
  fn set_ack(&self, value : bool)
}

// STOMPMessageInEvent defines the signature of the STOMP MessageIn event's handler function.
pub trait STOMPMessageInEvent {
  fn on_message_in(&self, sender : STOMP, e : &mut STOMPMessageInEventArgs);
}

impl <'a> STOMP<'a> {
  pub fn on_message_in(&self) -> &'a dyn STOMPMessageInEvent;
  pub fn set_on_message_in(&mut self, value : &'a dyn STOMPMessageInEvent);
  ...
}

Remarks

This events fires whenever the struct has received a message.

In addition to the message details exposed by the event parameters, the parsed_headers collection property is populated with the headers parsed from the message. When the on_message_in 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 struct 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 on_message_in event handler, and will be reset when the event handler ends.
• The RequestAckReceipts configuration setting controls whether the struct will request that the server confirm receipt of the message acknowledgment. It is False by default, and can be set at any time.

on_message_out event (STOMP Struct)

Fired after a message has been sent.

Syntax

// STOMPMessageOutEventArgs carries the STOMP MessageOut event's parameters.
pub struct STOMPMessageOutEventArgs {
  fn destination(&self) -> &String
  fn data(&self) -> &[u8]
  fn content_type(&self) -> &String
}

// STOMPMessageOutEvent defines the signature of the STOMP MessageOut event's handler function.
pub trait STOMPMessageOutEvent {
  fn on_message_out(&self, sender : STOMP, e : &mut STOMPMessageOutEventArgs);
}

impl <'a> STOMP<'a> {
  pub fn on_message_out(&self) -> &'a dyn STOMPMessageOutEvent;
  pub fn set_on_message_out(&mut self, value : &'a dyn STOMPMessageOutEvent);
  ...
}

Remarks

This event fires after a message has been sent using either send_message or send_data. 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 send_data).

on_ready_to_send event (STOMP Struct)

Fired when the struct is ready to send data.

Syntax

// STOMPReadyToSendEventArgs carries the STOMP ReadyToSend event's parameters.
pub struct STOMPReadyToSendEventArgs {
}

// STOMPReadyToSendEvent defines the signature of the STOMP ReadyToSend event's handler function.
pub trait STOMPReadyToSendEvent {
  fn on_ready_to_send(&self, sender : STOMP, e : &mut STOMPReadyToSendEventArgs);
}

impl <'a> STOMP<'a> {
  pub fn on_ready_to_send(&self) -> &'a dyn STOMPReadyToSendEvent;
  pub fn set_on_ready_to_send(&mut self, value : &'a dyn STOMPReadyToSendEvent);
  ...
}

Remarks

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

on_receipt_in event (STOMP Struct)

Fires when the struct receives a receipt from the server.

Syntax

// STOMPReceiptInEventArgs carries the STOMP ReceiptIn event's parameters.
pub struct STOMPReceiptInEventArgs {
  fn receipt_id(&self) -> &String
}

// STOMPReceiptInEvent defines the signature of the STOMP ReceiptIn event's handler function.
pub trait STOMPReceiptInEvent {
  fn on_receipt_in(&self, sender : STOMP, e : &mut STOMPReceiptInEventArgs);
}

impl <'a> STOMP<'a> {
  pub fn on_receipt_in(&self) -> &'a dyn STOMPReceiptInEvent;
  pub fn set_on_receipt_in(&mut self, value : &'a dyn STOMPReceiptInEvent);
  ...
}

Remarks

This event fires anytime the struct 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 struct 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 request_receipts for more information about receipts.

on_receipt_out event (STOMP Struct)

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

Syntax

// STOMPReceiptOutEventArgs carries the STOMP ReceiptOut event's parameters.
pub struct STOMPReceiptOutEventArgs {
  fn receipt_id(&self) -> &String
}

// STOMPReceiptOutEvent defines the signature of the STOMP ReceiptOut event's handler function.
pub trait STOMPReceiptOutEvent {
  fn on_receipt_out(&self, sender : STOMP, e : &mut STOMPReceiptOutEventArgs);
}

impl <'a> STOMP<'a> {
  pub fn on_receipt_out(&self) -> &'a dyn STOMPReceiptOutEvent;
  pub fn set_on_receipt_out(&mut self, value : &'a dyn STOMPReceiptOutEvent);
  ...
}

Remarks

This event fires anytime the struct 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 on_receipt_in for details). Anytime the server sends back a receipt, the on_receipt_in event will fire.

Refer to request_receipts for more information about receipts.

on_ssl_server_authentication event (STOMP Struct)

Fired after the server presents its certificate to the client.

Syntax

// STOMPSSLServerAuthenticationEventArgs carries the STOMP SSLServerAuthentication event's parameters.
pub struct STOMPSSLServerAuthenticationEventArgs {
  fn cert_encoded(&self) -> &[u8]
  fn cert_subject(&self) -> &String
  fn cert_issuer(&self) -> &String
  fn status(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// STOMPSSLServerAuthenticationEvent defines the signature of the STOMP SSLServerAuthentication event's handler function.
pub trait STOMPSSLServerAuthenticationEvent {
  fn on_ssl_server_authentication(&self, sender : STOMP, e : &mut STOMPSSLServerAuthenticationEventArgs);
}

impl <'a> STOMP<'a> {
  pub fn on_ssl_server_authentication(&self) -> &'a dyn STOMPSSLServerAuthenticationEvent;
  pub fn set_on_ssl_server_authentication(&mut self, value : &'a dyn STOMPSSLServerAuthenticationEvent);
  ...
}

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.

on_ssl_status event (STOMP Struct)

Fired when secure connection progress messages are available.

Syntax

// STOMPSSLStatusEventArgs carries the STOMP SSLStatus event's parameters.
pub struct STOMPSSLStatusEventArgs {
  fn message(&self) -> &String
}

// STOMPSSLStatusEvent defines the signature of the STOMP SSLStatus event's handler function.
pub trait STOMPSSLStatusEvent {
  fn on_ssl_status(&self, sender : STOMP, e : &mut STOMPSSLStatusEventArgs);
}

impl <'a> STOMP<'a> {
  pub fn on_ssl_status(&self) -> &'a dyn STOMPSSLStatusEvent;
  pub fn set_on_ssl_status(&mut self, value : &'a dyn STOMPSSLStatusEvent);
  ...
}

Remarks

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

on_subscribed event (STOMP Struct)

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

Syntax

// STOMPSubscribedEventArgs carries the STOMP Subscribed event's parameters.
pub struct STOMPSubscribedEventArgs {
  fn id(&self) -> &String
  fn destination(&self) -> &String
  fn require_acks(&self) -> bool
}

// STOMPSubscribedEvent defines the signature of the STOMP Subscribed event's handler function.
pub trait STOMPSubscribedEvent {
  fn on_subscribed(&self, sender : STOMP, e : &mut STOMPSubscribedEventArgs);
}

impl <'a> STOMP<'a> {
  pub fn on_subscribed(&self) -> &'a dyn STOMPSubscribedEvent;
  pub fn set_on_subscribed(&mut self, value : &'a dyn STOMPSubscribedEvent);
  ...
}

Remarks

This event fires each time the struct 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 struct receives as a result of the subscription will require acknowledgments to be sent back to the server.

on_unsubscribed event (STOMP Struct)

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

Syntax

// STOMPUnsubscribedEventArgs carries the STOMP Unsubscribed event's parameters.
pub struct STOMPUnsubscribedEventArgs {
  fn id(&self) -> &String
  fn destination(&self) -> &String
}

// STOMPUnsubscribedEvent defines the signature of the STOMP Unsubscribed event's handler function.
pub trait STOMPUnsubscribedEvent {
  fn on_unsubscribed(&self, sender : STOMP, e : &mut STOMPUnsubscribedEventArgs);
}

impl <'a> STOMP<'a> {
  pub fn on_unsubscribed(&self) -> &'a dyn STOMPUnsubscribedEvent;
  pub fn set_on_unsubscribed(&mut self, value : &'a dyn STOMPUnsubscribedEvent);
  ...
}

Remarks

This event fires each time the struct 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.

Config Settings (STOMP Struct)

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

Trappable Errors (STOMP Struct)

STOMP Errors

TCPClient Errors

SSL Errors

TCP/IP Errors