# STOMP Class

A simple but powerful STOMP client implementation.

## Class Name

**IPWorksIoT_STOMP**

## Procedural Interface

```text
 ipworksiot_stomp_open();
 ipworksiot_stomp_close($res);
 ipworksiot_stomp_register_callback($res, $id, $function);
 ipworksiot_stomp_get_last_error($res);
 ipworksiot_stomp_get_last_error_code($res);
 ipworksiot_stomp_set($res, $id, $index, $value);
 ipworksiot_stomp_get($res, $id, $index);
 ipworksiot_stomp_do_aborttransaction($res, $id);
 ipworksiot_stomp_do_addheader($res, $key, $value);
 ipworksiot_stomp_do_begintransaction($res, $id);
 ipworksiot_stomp_do_committransaction($res, $id);
 ipworksiot_stomp_do_config($res, $configurationstring);
 ipworksiot_stomp_do_connect($res);
 ipworksiot_stomp_do_connectto($res, $host, $port);
 ipworksiot_stomp_do_disconnect($res);
 ipworksiot_stomp_do_doevents($res);
 ipworksiot_stomp_do_interrupt($res);
 ipworksiot_stomp_do_reset($res);
 ipworksiot_stomp_do_resetheaders($res);
 ipworksiot_stomp_do_senddata($res, $destination, $data);
 ipworksiot_stomp_do_sendmessage($res, $destination, $message);
 ipworksiot_stomp_do_subscribe($res, $destination, $requireacks);
 ipworksiot_stomp_do_unsubscribe($res, $id);
```

## Remarks

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

### Connecting

Connecting to a STOMP server is easy; in the simplest case just call the [ConnectTo](#connectto-method-ipworksiot_stomp-class) method, passing the server's hostname and port number.

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

- [IncomingHeartbeat](#incomingheartbeat-property-ipworksiot_stomp-class)
- [OutgoingHeartbeat](#outgoingheartbeat-property-ipworksiot_stomp-class)
- [User](#user-property-ipworksiot_stomp-class)
- [Password](#password-property-ipworksiot_stomp-class)

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

- [SupportedVersions](#SupportedVersions): Controls which STOMP versions the class advertises support for.
- [VirtualHost](#VirtualHost): Controls the virtual host to connect to. If left empty (default), the value from [RemoteHost](#remotehost-property-ipworksiot_stomp-class) is used.

### Subscriptions & Receiving Messages

 The [Subscribe](#subscribe-method-ipworksiot_stomp-class) and [Unsubscribe](#unsubscribe-method-ipworksiot_stomp-class) methods are used to subscribe to and unsubscribe from message destinations on the server.

When [Subscribe](#subscribe-method-ipworksiot_stomp-class) is called, it will return a subscription Id. To unsubscribe, pass this subscription Id to the [Unsubscribe](#unsubscribe-method-ipworksiot_stomp-class) method.

After subscribing to a message destination, any messages received will cause the [MessageIn](#messagein-event-ipworksiot_stomp-class) event to fire.

**Basic Subscriptions Example**

```csharp
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](#subscribe-method-ipworksiot_stomp-class), [Unsubscribe](#unsubscribe-method-ipworksiot_stomp-class), and [MessageIn](#messagein-event-ipworksiot_stomp-class) for more information about subscriptions and receiving messages.

### Sending Messages

To send messages, use the [SendMessage](#sendmessage-method-ipworksiot_stomp-class) and [SendData](#senddata-method-ipworksiot_stomp-class) methods. [SendMessage](#sendmessage-method-ipworksiot_stomp-class) is used to send messages with string payloads, while [SendData](#senddata-method-ipworksiot_stomp-class) is used to send messages with binary payloads.

**Send String Message Example**

```csharp
stomp1.SendMessage("test/a/b", "Hello, world!");
```

**Send Binary Message Example**

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

Refer to [SendMessage](#sendmessage-method-ipworksiot_stomp-class) and [SendData](#senddata-method-ipworksiot_stomp-class) 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**

```csharp
// Open a new transaction.
stomp1.BeginTransaction("txn1");
// Set the Transaction property to make sure that messages are sent as part of the transaction.
stomp1.Transaction = "txn1";

stomp1.SendMessage("test/a/b", "Hello, world!");
stomp1.SendMessage("test/a/b", "This is a test.");
stomp1.SendMessage("test/a/b", "Another test!");

// At this point, none of the messages sent above would have been delivered to any clients
// subscribed to the "test/a/b" destination yet, because the transaction is still open.

// If we close and commit the transaction, the server will then deliver the messages to subscribers,
// queue them, or process them in another manner; the behavior is server-dependent.
stomp1.CommitTransaction("txn1");

// Or, the transaction can be aborted, in which case the server will discard the messages
// without delivering them to the subscribers.
//stomp1.AbortTransaction("txn1");

// Reset (or change) the Transaction property after committing or aborting a transaction
// so that future messages are not associated with the previous transaction.
stomp1.Transaction = "";
```

Refer to [BeginTransaction](#begintransaction-method-ipworksiot_stomp-class) for more information about using transactions.

## Property List

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

|  |  |
| --- | --- |
| [Connected](#connected-property-ipworksiot_stomp-class) | Whether the class is connected. |
| [ContentType](#contenttype-property-ipworksiot_stomp-class) | The content type of the outgoing message. |
| [FirewallAutoDetect](#firewallautodetect-property-ipworksiot_stomp-class) | Whether to automatically detect and use firewall system settings, if available. |
| [FirewallType](#firewalltype-property-ipworksiot_stomp-class) | The type of firewall to connect through. |
| [FirewallHost](#firewallhost-property-ipworksiot_stomp-class) | The name or IP address of the firewall (optional). |
| [FirewallPassword](#firewallpassword-property-ipworksiot_stomp-class) | A password if authentication is to be used when connecting through the firewall. |
| [FirewallPort](#firewallport-property-ipworksiot_stomp-class) | The Transmission Control Protocol (TCP) port for the firewall Host . |
| [FirewallUser](#firewalluser-property-ipworksiot_stomp-class) | A username if authentication is to be used when connecting through a firewall. |
| [HeaderCount](#headercount-property-ipworksiot_stomp-class) | The number of records in the Header arrays. |
| [HeaderKey](#headerkey-property-ipworksiot_stomp-class) | This header's key. |
| [HeaderValue](#headervalue-property-ipworksiot_stomp-class) | This header's value. |
| [IncomingHeartbeat](#incomingheartbeat-property-ipworksiot_stomp-class) | Specifies the server-to-class heartbeat timing. |
| [LocalHost](#localhost-property-ipworksiot_stomp-class) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| [LocalPort](#localport-property-ipworksiot_stomp-class) | The TCP port in the local host where the class binds. |
| [OutgoingHeartbeat](#outgoingheartbeat-property-ipworksiot_stomp-class) | Specifies the class-to-server heartbeat timing. |
| [ParsedHeaderCount](#parsedheadercount-property-ipworksiot_stomp-class) | The number of records in the ParsedHeader arrays. |
| [ParsedHeaderKey](#parsedheaderkey-property-ipworksiot_stomp-class) | This header's key. |
| [ParsedHeaderValue](#parsedheadervalue-property-ipworksiot_stomp-class) | This header's value. |
| [Password](#password-property-ipworksiot_stomp-class) | A password if authentication is to be used. |
| [ReadyToSend](#readytosend-property-ipworksiot_stomp-class) | Indicates whether the class is ready to send data. |
| [RemoteHost](#remotehost-property-ipworksiot_stomp-class) | The address of the remote host. Domain names are resolved to IP addresses. |
| [RemotePort](#remoteport-property-ipworksiot_stomp-class) | The port of the STOMP server (default is 61613). The default port for SSL is 61612. |
| [RequestReceipts](#requestreceipts-property-ipworksiot_stomp-class) | Whether the class should request that the server provide message receipts. |
| [SSLAcceptServerCertEffectiveDate](#sslacceptservercerteffectivedate-property-ipworksiot_stomp-class) | The date on which this certificate becomes valid. |
| [SSLAcceptServerCertExpirationDate](#sslacceptservercertexpirationdate-property-ipworksiot_stomp-class) | The date on which the certificate expires. |
| [SSLAcceptServerCertExtendedKeyUsage](#sslacceptservercertextendedkeyusage-property-ipworksiot_stomp-class) | A comma-delimited list of extended key usage identifiers. |
| [SSLAcceptServerCertFingerprint](#sslacceptservercertfingerprint-property-ipworksiot_stomp-class) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [SSLAcceptServerCertFingerprintSHA1](#sslacceptservercertfingerprintsha1-property-ipworksiot_stomp-class) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [SSLAcceptServerCertFingerprintSHA256](#sslacceptservercertfingerprintsha256-property-ipworksiot_stomp-class) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [SSLAcceptServerCertIssuer](#sslacceptservercertissuer-property-ipworksiot_stomp-class) | The issuer of the certificate. |
| [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-ipworksiot_stomp-class) | The private key of the certificate (if available). |
| [SSLAcceptServerCertPrivateKeyAvailable](#sslacceptservercertprivatekeyavailable-property-ipworksiot_stomp-class) | Whether a PrivateKey is available for the selected certificate. |
| [SSLAcceptServerCertPrivateKeyContainer](#sslacceptservercertprivatekeycontainer-property-ipworksiot_stomp-class) | The name of the PrivateKey container for the certificate (if available). |
| [SSLAcceptServerCertPublicKey](#sslacceptservercertpublickey-property-ipworksiot_stomp-class) | The public key of the certificate. |
| [SSLAcceptServerCertPublicKeyAlgorithm](#sslacceptservercertpublickeyalgorithm-property-ipworksiot_stomp-class) | The textual description of the certificate's public key algorithm. |
| [SSLAcceptServerCertPublicKeyLength](#sslacceptservercertpublickeylength-property-ipworksiot_stomp-class) | The length of the certificate's public key (in bits). |
| [SSLAcceptServerCertSerialNumber](#sslacceptservercertserialnumber-property-ipworksiot_stomp-class) | The serial number of the certificate encoded as a string. |
| [SSLAcceptServerCertSignatureAlgorithm](#sslacceptservercertsignaturealgorithm-property-ipworksiot_stomp-class) | The text description of the certificate's signature algorithm. |
| [SSLAcceptServerCertStore](#sslacceptservercertstore-property-ipworksiot_stomp-class) | The name of the certificate store for the client certificate. |
| [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-ipworksiot_stomp-class) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [SSLAcceptServerCertStoreType](#sslacceptservercertstoretype-property-ipworksiot_stomp-class) | The type of certificate store for this certificate. |
| [SSLAcceptServerCertSubjectAltNames](#sslacceptservercertsubjectaltnames-property-ipworksiot_stomp-class) | Comma-separated lists of alternative subject names for the certificate. |
| [SSLAcceptServerCertThumbprintMD5](#sslacceptservercertthumbprintmd5-property-ipworksiot_stomp-class) | The MD5 hash of the certificate. |
| [SSLAcceptServerCertThumbprintSHA1](#sslacceptservercertthumbprintsha1-property-ipworksiot_stomp-class) | The SHA-1 hash of the certificate. |
| [SSLAcceptServerCertThumbprintSHA256](#sslacceptservercertthumbprintsha256-property-ipworksiot_stomp-class) | The SHA-256 hash of the certificate. |
| [SSLAcceptServerCertUsage](#sslacceptservercertusage-property-ipworksiot_stomp-class) | The text description of UsageFlags . |
| [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-ipworksiot_stomp-class) | The flags that show intended use for the certificate. |
| [SSLAcceptServerCertVersion](#sslacceptservercertversion-property-ipworksiot_stomp-class) | The certificate's version number. |
| [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-ipworksiot_stomp-class) | The subject of the certificate used for client authentication. |
| [SSLAcceptServerCertEncoded](#sslacceptservercertencoded-property-ipworksiot_stomp-class) | The certificate (PEM/Base64 encoded). |
| [SSLCertEffectiveDate](#sslcerteffectivedate-property-ipworksiot_stomp-class) | The date on which this certificate becomes valid. |
| [SSLCertExpirationDate](#sslcertexpirationdate-property-ipworksiot_stomp-class) | The date on which the certificate expires. |
| [SSLCertExtendedKeyUsage](#sslcertextendedkeyusage-property-ipworksiot_stomp-class) | A comma-delimited list of extended key usage identifiers. |
| [SSLCertFingerprint](#sslcertfingerprint-property-ipworksiot_stomp-class) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [SSLCertFingerprintSHA1](#sslcertfingerprintsha1-property-ipworksiot_stomp-class) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [SSLCertFingerprintSHA256](#sslcertfingerprintsha256-property-ipworksiot_stomp-class) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [SSLCertIssuer](#sslcertissuer-property-ipworksiot_stomp-class) | The issuer of the certificate. |
| [SSLCertPrivateKey](#sslcertprivatekey-property-ipworksiot_stomp-class) | The private key of the certificate (if available). |
| [SSLCertPrivateKeyAvailable](#sslcertprivatekeyavailable-property-ipworksiot_stomp-class) | Whether a PrivateKey is available for the selected certificate. |
| [SSLCertPrivateKeyContainer](#sslcertprivatekeycontainer-property-ipworksiot_stomp-class) | The name of the PrivateKey container for the certificate (if available). |
| [SSLCertPublicKey](#sslcertpublickey-property-ipworksiot_stomp-class) | The public key of the certificate. |
| [SSLCertPublicKeyAlgorithm](#sslcertpublickeyalgorithm-property-ipworksiot_stomp-class) | The textual description of the certificate's public key algorithm. |
| [SSLCertPublicKeyLength](#sslcertpublickeylength-property-ipworksiot_stomp-class) | The length of the certificate's public key (in bits). |
| [SSLCertSerialNumber](#sslcertserialnumber-property-ipworksiot_stomp-class) | The serial number of the certificate encoded as a string. |
| [SSLCertSignatureAlgorithm](#sslcertsignaturealgorithm-property-ipworksiot_stomp-class) | The text description of the certificate's signature algorithm. |
| [SSLCertStore](#sslcertstore-property-ipworksiot_stomp-class) | The name of the certificate store for the client certificate. |
| [SSLCertStorePassword](#sslcertstorepassword-property-ipworksiot_stomp-class) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [SSLCertStoreType](#sslcertstoretype-property-ipworksiot_stomp-class) | The type of certificate store for this certificate. |
| [SSLCertSubjectAltNames](#sslcertsubjectaltnames-property-ipworksiot_stomp-class) | Comma-separated lists of alternative subject names for the certificate. |
| [SSLCertThumbprintMD5](#sslcertthumbprintmd5-property-ipworksiot_stomp-class) | The MD5 hash of the certificate. |
| [SSLCertThumbprintSHA1](#sslcertthumbprintsha1-property-ipworksiot_stomp-class) | The SHA-1 hash of the certificate. |
| [SSLCertThumbprintSHA256](#sslcertthumbprintsha256-property-ipworksiot_stomp-class) | The SHA-256 hash of the certificate. |
| [SSLCertUsage](#sslcertusage-property-ipworksiot_stomp-class) | The text description of UsageFlags . |
| [SSLCertUsageFlags](#sslcertusageflags-property-ipworksiot_stomp-class) | The flags that show intended use for the certificate. |
| [SSLCertVersion](#sslcertversion-property-ipworksiot_stomp-class) | The certificate's version number. |
| [SSLCertSubject](#sslcertsubject-property-ipworksiot_stomp-class) | The subject of the certificate used for client authentication. |
| [SSLCertEncoded](#sslcertencoded-property-ipworksiot_stomp-class) | The certificate (PEM/Base64 encoded). |
| [SSLEnabled](#sslenabled-property-ipworksiot_stomp-class) | This property indicates whether Transport Layer Security/Secure Sockets Layer (TLS/SSL) is enabled. |
| [SSLProvider](#sslprovider-property-ipworksiot_stomp-class) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
| [SSLServerCertEffectiveDate](#sslservercerteffectivedate-property-ipworksiot_stomp-class) | The date on which this certificate becomes valid. |
| [SSLServerCertExpirationDate](#sslservercertexpirationdate-property-ipworksiot_stomp-class) | The date on which the certificate expires. |
| [SSLServerCertExtendedKeyUsage](#sslservercertextendedkeyusage-property-ipworksiot_stomp-class) | A comma-delimited list of extended key usage identifiers. |
| [SSLServerCertFingerprint](#sslservercertfingerprint-property-ipworksiot_stomp-class) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| [SSLServerCertFingerprintSHA1](#sslservercertfingerprintsha1-property-ipworksiot_stomp-class) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| [SSLServerCertFingerprintSHA256](#sslservercertfingerprintsha256-property-ipworksiot_stomp-class) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| [SSLServerCertIssuer](#sslservercertissuer-property-ipworksiot_stomp-class) | The issuer of the certificate. |
| [SSLServerCertPrivateKey](#sslservercertprivatekey-property-ipworksiot_stomp-class) | The private key of the certificate (if available). |
| [SSLServerCertPrivateKeyAvailable](#sslservercertprivatekeyavailable-property-ipworksiot_stomp-class) | Whether a PrivateKey is available for the selected certificate. |
| [SSLServerCertPrivateKeyContainer](#sslservercertprivatekeycontainer-property-ipworksiot_stomp-class) | The name of the PrivateKey container for the certificate (if available). |
| [SSLServerCertPublicKey](#sslservercertpublickey-property-ipworksiot_stomp-class) | The public key of the certificate. |
| [SSLServerCertPublicKeyAlgorithm](#sslservercertpublickeyalgorithm-property-ipworksiot_stomp-class) | The textual description of the certificate's public key algorithm. |
| [SSLServerCertPublicKeyLength](#sslservercertpublickeylength-property-ipworksiot_stomp-class) | The length of the certificate's public key (in bits). |
| [SSLServerCertSerialNumber](#sslservercertserialnumber-property-ipworksiot_stomp-class) | The serial number of the certificate encoded as a string. |
| [SSLServerCertSignatureAlgorithm](#sslservercertsignaturealgorithm-property-ipworksiot_stomp-class) | The text description of the certificate's signature algorithm. |
| [SSLServerCertStore](#sslservercertstore-property-ipworksiot_stomp-class) | The name of the certificate store for the client certificate. |
| [SSLServerCertStorePassword](#sslservercertstorepassword-property-ipworksiot_stomp-class) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| [SSLServerCertStoreType](#sslservercertstoretype-property-ipworksiot_stomp-class) | The type of certificate store for this certificate. |
| [SSLServerCertSubjectAltNames](#sslservercertsubjectaltnames-property-ipworksiot_stomp-class) | Comma-separated lists of alternative subject names for the certificate. |
| [SSLServerCertThumbprintMD5](#sslservercertthumbprintmd5-property-ipworksiot_stomp-class) | The MD5 hash of the certificate. |
| [SSLServerCertThumbprintSHA1](#sslservercertthumbprintsha1-property-ipworksiot_stomp-class) | The SHA-1 hash of the certificate. |
| [SSLServerCertThumbprintSHA256](#sslservercertthumbprintsha256-property-ipworksiot_stomp-class) | The SHA-256 hash of the certificate. |
| [SSLServerCertUsage](#sslservercertusage-property-ipworksiot_stomp-class) | The text description of UsageFlags . |
| [SSLServerCertUsageFlags](#sslservercertusageflags-property-ipworksiot_stomp-class) | The flags that show intended use for the certificate. |
| [SSLServerCertVersion](#sslservercertversion-property-ipworksiot_stomp-class) | The certificate's version number. |
| [SSLServerCertSubject](#sslservercertsubject-property-ipworksiot_stomp-class) | The subject of the certificate used for client authentication. |
| [SSLServerCertEncoded](#sslservercertencoded-property-ipworksiot_stomp-class) | The certificate (PEM/Base64 encoded). |
| [SubscriptionCount](#subscriptioncount-property-ipworksiot_stomp-class) | The number of records in the Subscription arrays. |
| [SubscriptionDestination](#subscriptiondestination-property-ipworksiot_stomp-class) | The destination on the server that this subscription is associated with. |
| [SubscriptionId](#subscriptionid-property-ipworksiot_stomp-class) | This subscription's unique Id. |
| [Timeout](#timeout-property-ipworksiot_stomp-class) | This property includes the timeout for the class. |
| [TransactionId](#transactionid-property-ipworksiot_stomp-class) | Specifies the Id of the transaction that outgoing messages are associated with. |
| [User](#user-property-ipworksiot_stomp-class) | A username if authentication is to be used. |

## Method List

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

|  |  |
| --- | --- |
| [AbortTransaction](#aborttransaction-method-ipworksiot_stomp-class) | Aborts an existing transaction. |
| [AddHeader](#addheader-method-ipworksiot_stomp-class) | Adds a custom header to send with outgoing messages. |
| [BeginTransaction](#begintransaction-method-ipworksiot_stomp-class) | Begins a new transaction. |
| [CommitTransaction](#committransaction-method-ipworksiot_stomp-class) | Commits an existing transaction. |
| [Config](#config-method-ipworksiot_stomp-class) | Sets or retrieves a configuration setting. |
| [Connect](#connect-method-ipworksiot_stomp-class) | Connects to the remote host. |
| [ConnectTo](#connectto-method-ipworksiot_stomp-class) | Connects to the remote host. |
| [Disconnect](#disconnect-method-ipworksiot_stomp-class) | This method disconnects from the remote host. |
| [DoEvents](#doevents-method-ipworksiot_stomp-class) | This method processes events from the internal message queue. |
| [Interrupt](#interrupt-method-ipworksiot_stomp-class) | Interrupt the current action and disconnects from the remote host. |
| [Reset](#reset-method-ipworksiot_stomp-class) | This method will reset the class. |
| [ResetHeaders](#resetheaders-method-ipworksiot_stomp-class) | Clear the user-defined headers collection. |
| [SendData](#senddata-method-ipworksiot_stomp-class) | Publishes a message with a raw data payload. |
| [SendMessage](#sendmessage-method-ipworksiot_stomp-class) | Publishes a message with a string payload. |
| [Subscribe](#subscribe-method-ipworksiot_stomp-class) | Subscribes to a message destination on the server. |
| [Unsubscribe](#unsubscribe-method-ipworksiot_stomp-class) | Removes an existing subscription. |

## Event List

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

|  |  |
| --- | --- |
| [Connected](#connected-event-ipworksiot_stomp-class) | Fired immediately after a connection completes (or fails). |
| [ConnectionStatus](#connectionstatus-event-ipworksiot_stomp-class) | Fired to indicate changes in the connection state. |
| [Disconnected](#disconnected-event-ipworksiot_stomp-class) | Fired when a connection is closed. |
| [Error](#error-event-ipworksiot_stomp-class) | Fired when a class or protocol error occurs. |
| [Log](#log-event-ipworksiot_stomp-class) | Fired once for each log message. |
| [MessageIn](#messagein-event-ipworksiot_stomp-class) | Fired when a message has been received. |
| [MessageOut](#messageout-event-ipworksiot_stomp-class) | Fired after a message has been sent. |
| [ReadyToSend](#readytosend-event-ipworksiot_stomp-class) | Fired when the class is ready to send data. |
| [ReceiptIn](#receiptin-event-ipworksiot_stomp-class) | Fires when the class receives a receipt from the server. |
| [ReceiptOut](#receiptout-event-ipworksiot_stomp-class) | Fires when the class sends a STOMP frame that includes a 'receipt' header. |
| [SSLServerAuthentication](#sslserverauthentication-event-ipworksiot_stomp-class) | Fired after the server presents its certificate to the client. |
| [SSLStatus](#sslstatus-event-ipworksiot_stomp-class) | Fired when secure connection progress messages are available. |
| [Subscribed](#subscribed-event-ipworksiot_stomp-class) | Fired when the class has subscribed to a message destination on the server. |
| [Unsubscribed](#unsubscribed-event-ipworksiot_stomp-class) | Fired when the class has unsubscribed from a message destination on the server. |

## Config Settings

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

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

# Connected Property ([IPWorksIoT_STOMP](#stomp-class) Class)

Whether the class is connected.

## Object Oriented Interface

```text
public function getConnected();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 1 );
```

## Default Value

false

## Remarks

This property is used to determine whether or not the class is connected to the remote host. When connecting to a STOMP server, the class sends information from the following properties, if populated:

- [IncomingHeartbeat](#incomingheartbeat-property-ipworksiot_stomp-class)
- [OutgoingHeartbeat](#outgoingheartbeat-property-ipworksiot_stomp-class)
- [User](#user-property-ipworksiot_stomp-class)
- [Password](#password-property-ipworksiot_stomp-class)

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

- [SupportedVersions](#SupportedVersions): Controls which STOMP versions the class advertises support for.
- [VirtualHost](#VirtualHost): Controls the virtual host to connect to. If left empty (default), the value from [RemoteHost](#remotehost-property-ipworksiot_stomp-class) is used.

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

## Data Type

Boolean

# ContentType Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The content type of the outgoing message.

## Object Oriented Interface

```text
public function getContentType();
public function setContentType($value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 2 );
ipworksiot_stomp_set($res, 2, $value );
```

## Default Value

'text/plain'

## Remarks

This property is used to specify the content type (MIME type) for outgoing messages sent using [SendMessage](#sendmessage-method-ipworksiot_stomp-class). The default value is *text/plain*, which should be sufficient is most cases.

Note that this property is ignored for messages sent using [SendData](#senddata-method-ipworksiot_stomp-class), as such messages do not have a *content-type* header added to them. The absence of a *content-type* header indicates to the server that the data should be treated as a binary blob.

This property is not available at design time.

## Data Type

String

# FirewallAutoDetect Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 3 );
ipworksiot_stomp_set($res, 3, $value );
```

## Default Value

false

## Remarks

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

## Data Type

Boolean

# FirewallType Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The type of firewall to connect through.

## Object Oriented Interface

```text
public function getFirewallType();
public function setFirewallType($value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 4 );
ipworksiot_stomp_set($res, 4, $value );
```

## Possible Values

```text
STOMP_FIREWALLTYPE_NONE(0), STOMP_FIREWALLTYPE_TUNNEL(1), STOMP_FIREWALLTYPE_SOCKS4(2), STOMP_FIREWALLTYPE_SOCKS5(3), STOMP_FIREWALLTYPE_SOCKS4A(10)
```

## Default Value

0

## Remarks

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

|  |  |
| --- | --- |
| fwNone (0) | No firewall (default setting). |
| fwTunnel (1) | Connect through a tunneling proxy. [FirewallPort](#firewallport-property-ipworksiot_stomp-class) is set to 80. |
| fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [FirewallPort](#firewallport-property-ipworksiot_stomp-class) is set to 1080. |
| fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [FirewallPort](#firewallport-property-ipworksiot_stomp-class) is set to 1080. |
| fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [FirewallPort](#firewallport-property-ipworksiot_stomp-class) is set to 1080. |

## Data Type

Integer

# FirewallHost Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getFirewallHost();
public function setFirewallHost($value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 5 );
ipworksiot_stomp_set($res, 5, $value );
```

## Default Value

''

## Remarks

The name or IP address of the firewall (optional). If a [FirewallHost](#firewallhost-property-ipworksiot_stomp-class) 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 class fails with an error.

## Data Type

String

# FirewallPassword Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getFirewallPassword();
public function setFirewallPassword($value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 6 );
ipworksiot_stomp_set($res, 6, $value );
```

## Default Value

''

## Remarks

A password if authentication is to be used when connecting through the firewall. If [FirewallHost](#firewallhost-property-ipworksiot_stomp-class) is specified, the [FirewallUser](#firewalluser-property-ipworksiot_stomp-class) and [FirewallPassword](#firewallpassword-property-ipworksiot_stomp-class) properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

## Data Type

String

# FirewallPort Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getFirewallPort();
public function setFirewallPort($value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 7 );
ipworksiot_stomp_set($res, 7, $value );
```

## Default Value

0

## Remarks

The Transmission Control Protocol (TCP) port for the firewall [FirewallHost](#firewallhost-property-ipworksiot_stomp-class). See the description of the [FirewallHost](#firewallhost-property-ipworksiot_stomp-class) property for details.

NOTE: This property is set automatically when [FirewallType](#firewalltype-property-ipworksiot_stomp-class) is set to a valid value. See the description of the [FirewallType](#firewalltype-property-ipworksiot_stomp-class) property for details.

## Data Type

Integer

# FirewallUser Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getFirewallUser();
public function setFirewallUser($value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 8 );
ipworksiot_stomp_set($res, 8, $value );
```

## Default Value

''

## Remarks

A username if authentication is to be used when connecting through a firewall. If [FirewallHost](#firewallhost-property-ipworksiot_stomp-class) is specified, this property and the [FirewallPassword](#firewallpassword-property-ipworksiot_stomp-class) property are used to connect and authenticate to the given [Firewall](#Type_Firewall). If the authentication fails, the class fails with an error.

## Data Type

String

# HeaderCount Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The number of records in the Header arrays.

## Object Oriented Interface

```text
public function getHeaderCount();
public function setHeaderCount($value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 9 );
ipworksiot_stomp_set($res, 9, $value );
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [HeaderKey](#headerkey-property-ipworksiot_stomp-class)
- [HeaderValue](#headervalue-property-ipworksiot_stomp-class)

The array indices start at *0* and end at *HeaderCount - 1*.

This property is not available at design time.

## Data Type

Integer

# HeaderKey Property ([IPWorksIoT_STOMP](#stomp-class) Class)

This header's key.

## Object Oriented Interface

```text
public function getHeaderKey($headerindex);
public function setHeaderKey($headerindex, $value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 10 , $headerindex);
ipworksiot_stomp_set($res, 10, $value , $headerindex);
```

## 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](#headercount-property-ipworksiot_stomp-class) property.

This property is not available at design time.

## Data Type

String

# HeaderValue Property ([IPWorksIoT_STOMP](#stomp-class) Class)

This header's value.

## Object Oriented Interface

```text
public function getHeaderValue($headerindex);
public function setHeaderValue($headerindex, $value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 11 , $headerindex);
ipworksiot_stomp_set($res, 11, $value , $headerindex);
```

## 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](#headercount-property-ipworksiot_stomp-class) property.

This property is not available at design time.

## Data Type

String

# IncomingHeartbeat Property ([IPWorksIoT_STOMP](#stomp-class) Class)

Specifies the server-to-class heartbeat timing.

## Object Oriented Interface

```text
public function getIncomingHeartbeat();
public function setIncomingHeartbeat($value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 12 );
ipworksiot_stomp_set($res, 12, $value );
```

## Default Value

0

## Remarks

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

For information about outgoing (class-to-server) heartbeats; see the [OutgoingHeartbeat](#outgoingheartbeat-property-ipworksiot_stomp-class) property.

### Before Connecting

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

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

### After Connecting

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

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

This property is not available at design time.

## Data Type

Integer

# LocalHost Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getLocalHost();
public function setLocalHost($value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 13 );
ipworksiot_stomp_set($res, 13, $value );
```

## Default Value

''

## Remarks

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

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

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

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

## Data Type

String

# LocalPort Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getLocalPort();
public function setLocalPort($value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 14 );
ipworksiot_stomp_set($res, 14, $value );
```

## Default Value

0

## Remarks

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

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

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

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

## Data Type

Integer

# OutgoingHeartbeat Property ([IPWorksIoT_STOMP](#stomp-class) Class)

Specifies the class-to-server heartbeat timing.

## Object Oriented Interface

```text
public function getOutgoingHeartbeat();
public function setOutgoingHeartbeat($value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 15 );
ipworksiot_stomp_set($res, 15, $value );
```

## Default Value

0

## Remarks

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

For information about incoming (server-to-class) heartbeats; see the [IncomingHeartbeat](#incomingheartbeat-property-ipworksiot_stomp-class) property.

### Before Connecting

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

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

### After Connecting

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

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

This property is not available at design time.

## Data Type

Integer

# ParsedHeaderCount Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The number of records in the ParsedHeader arrays.

## Object Oriented Interface

```text
public function getParsedHeaderCount();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 16 );
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [ParsedHeaderKey](#parsedheaderkey-property-ipworksiot_stomp-class)
- [ParsedHeaderValue](#parsedheadervalue-property-ipworksiot_stomp-class)

The array indices start at *0* and end at *ParsedHeaderCount - 1*.

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

## Data Type

Integer

# ParsedHeaderKey Property ([IPWorksIoT_STOMP](#stomp-class) Class)

This header's key.

## Object Oriented Interface

```text
public function getParsedHeaderKey($parsedheaderindex);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 17 , $parsedheaderindex);
```

## 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](#parsedheadercount-property-ipworksiot_stomp-class) property.

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

## Data Type

String

# ParsedHeaderValue Property ([IPWorksIoT_STOMP](#stomp-class) Class)

This header's value.

## Object Oriented Interface

```text
public function getParsedHeaderValue($parsedheaderindex);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 18 , $parsedheaderindex);
```

## 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](#parsedheadercount-property-ipworksiot_stomp-class) property.

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

## Data Type

String

# Password Property ([IPWorksIoT_STOMP](#stomp-class) Class)

A password if authentication is to be used.

## Object Oriented Interface

```text
public function getPassword();
public function setPassword($value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 19 );
ipworksiot_stomp_set($res, 19, $value );
```

## Default Value

''

## Remarks

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

This property is not available at design time.

## Data Type

String

# ReadyToSend Property ([IPWorksIoT_STOMP](#stomp-class) Class)

Indicates whether the class is ready to send data.

## Object Oriented Interface

```text
public function getReadyToSend();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 20 );
```

## Default Value

false

## Remarks

This property indicates that the underlying TCP/IP subsystem is ready to accept data. This is *True* after connecting to the remote host, and will become *False* if a call to [SendData](#senddata-method-ipworksiot_stomp-class) or [SendMessage](#sendmessage-method-ipworksiot_stomp-class) fails due to a WOULDBLOCK condition.

Once data can be sent again, the [ReadyToSend](#readytosend-event-ipworksiot_stomp-class) event will fire and this property will be *True*.

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

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

## Data Type

Boolean

# RemoteHost Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getRemoteHost();
public function setRemoteHost($value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 21 );
ipworksiot_stomp_set($res, 21, $value );
```

## Default Value

''

## Remarks

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

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

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

By default the class will connect in plaintext. To enable SSL set [SSLEnabled](#sslenabled-property-ipworksiot_stomp-class) to True.

## Data Type

String

# RemotePort Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getRemotePort();
public function setRemotePort($value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 22 );
ipworksiot_stomp_set($res, 22, $value );
```

## Default Value

61613

## Remarks

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

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

This property is not available at design time.

## Data Type

Integer

# RequestReceipts Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getRequestReceipts();
public function setRequestReceipts($value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 23 );
ipworksiot_stomp_set($res, 23, $value );
```

## Default Value

false

## Remarks

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

When this property is set to *True*, and a message is sent, the [ReceiptOut](#receiptout-event-ipworksiot_stomp-class) event will fire immediately after the [MessageOut](#messageout-event-ipworksiot_stomp-class) event fires.

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

| To Request Receipts For... | Set The... |
| --- | --- |
| Messages | RequestReceipts property |
| Message acknowledgment frames | [RequestAckReceipts](#RequestAckReceipts) configuration setting |
| Subscribe and Unsubscribe frames | [RequestSubscriptionReceipts](#RequestSubscriptionReceipts) configuration setting |
| Begin, Commit, and Abort transaction frames | [RequestTransactionReceipts](#RequestTransactionReceipts) configuration setting |

**Received Receipt Notes**

When a receipt is received, the [ReceiptIn](#receiptin-event-ipworksiot_stomp-class) event fires.

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

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

 then the server could, at some point, send back a single receipt with a *receipt-id* header value of *SEND-5* to confirm that it has received the first three frames.

This property is not available at design time.

## Data Type

Boolean

# SSLAcceptServerCertEffectiveDate Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The date on which this certificate becomes valid.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertEffectiveDate();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 24 );
```

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

# SSLAcceptServerCertExpirationDate Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The date on which the certificate expires.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertExpirationDate();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 25 );
```

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

# SSLAcceptServerCertExtendedKeyUsage Property ([IPWorksIoT_STOMP](#stomp-class) Class)

A comma-delimited list of extended key usage identifiers.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertExtendedKeyUsage();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 26 );
```

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

# SSLAcceptServerCertFingerprint Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getSSLAcceptServerCertFingerprint();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 27 );
```

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

# SSLAcceptServerCertFingerprintSHA1 Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getSSLAcceptServerCertFingerprintSHA1();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 28 );
```

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

# SSLAcceptServerCertFingerprintSHA256 Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getSSLAcceptServerCertFingerprintSHA256();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 29 );
```

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

# SSLAcceptServerCertIssuer Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The issuer of the certificate.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertIssuer();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 30 );
```

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

# SSLAcceptServerCertPrivateKey Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The private key of the certificate (if available).

## Object Oriented Interface

```text
public function getSSLAcceptServerCertPrivateKey();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 31 );
```

## Default Value

''

## Remarks

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

NOTE: The [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-ipworksiot_stomp-class) may be available but not exportable. In this case, [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-ipworksiot_stomp-class) returns an empty string.

This property is read-only.

## Data Type

String

# SSLAcceptServerCertPrivateKeyAvailable Property ([IPWorksIoT_STOMP](#stomp-class) Class)

Whether a PrivateKey is available for the selected certificate.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertPrivateKeyAvailable();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 32 );
```

## Default Value

false

## Remarks

Whether a [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-ipworksiot_stomp-class) is available for the selected certificate. If [SSLAcceptServerCertPrivateKeyAvailable](#sslacceptservercertprivatekeyavailable-property-ipworksiot_stomp-class) is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

## Data Type

Boolean

# SSLAcceptServerCertPrivateKeyContainer Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getSSLAcceptServerCertPrivateKeyContainer();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 33 );
```

## Default Value

''

## Remarks

The name of the [SSLAcceptServerCertPrivateKey](#sslacceptservercertprivatekey-property-ipworksiot_stomp-class) container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

## Data Type

String

# SSLAcceptServerCertPublicKey Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The public key of the certificate.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertPublicKey();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 34 );
```

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

# SSLAcceptServerCertPublicKeyAlgorithm Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getSSLAcceptServerCertPublicKeyAlgorithm();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 35 );
```

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

# SSLAcceptServerCertPublicKeyLength Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getSSLAcceptServerCertPublicKeyLength();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 36 );
```

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

Integer

# SSLAcceptServerCertSerialNumber Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The serial number of the certificate encoded as a string.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertSerialNumber();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 37 );
```

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

# SSLAcceptServerCertSignatureAlgorithm Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The text description of the certificate's signature algorithm.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertSignatureAlgorithm();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 38 );
```

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

# SSLAcceptServerCertStore Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The name of the certificate store for the client certificate.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 39 );
ipworksiot_stomp_set($res, 39, $value );
```

## Default Value

'MY'

## Remarks

The name of the certificate store for the client certificate.

The [SSLAcceptServerCertStoreType](#sslacceptservercertstoretype-property-ipworksiot_stomp-class) property denotes the type of the certificate store specified by [SSLAcceptServerCertStore](#sslacceptservercertstore-property-ipworksiot_stomp-class). If the store is password-protected, specify the password in [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-ipworksiot_stomp-class).

[SSLAcceptServerCertStore](#sslacceptservercertstore-property-ipworksiot_stomp-class) is used in conjunction with the [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-ipworksiot_stomp-class) property to specify client certificates. If [SSLAcceptServerCertStore](#sslacceptservercertstore-property-ipworksiot_stomp-class) has a value, and [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-ipworksiot_stomp-class) or [SSLAcceptServerCertEncoded](#sslacceptservercertencoded-property-ipworksiot_stomp-class) is set, a search for a certificate is initiated. Please see the [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-ipworksiot_stomp-class) property for details.

 Designations of certificate stores are platform dependent.

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

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

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

Binary String

# SSLAcceptServerCertStorePassword Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 40 );
ipworksiot_stomp_set($res, 40, $value );
```

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

# SSLAcceptServerCertStoreType Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The type of certificate store for this certificate.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 41 );
ipworksiot_stomp_set($res, 41, $value );
```

## Possible Values

```text
STOMP_SSLACCEPTSERVERCERTSTORETYPE_USER(0), STOMP_SSLACCEPTSERVERCERTSTORETYPE_MACHINE(1), STOMP_SSLACCEPTSERVERCERTSTORETYPE_PFXFILE(2), STOMP_SSLACCEPTSERVERCERTSTORETYPE_PFXBLOB(3), STOMP_SSLACCEPTSERVERCERTSTORETYPE_JKSFILE(4), STOMP_SSLACCEPTSERVERCERTSTORETYPE_JKSBLOB(5), STOMP_SSLACCEPTSERVERCERTSTORETYPE_PEMKEY_FILE(6), STOMP_SSLACCEPTSERVERCERTSTORETYPE_PEMKEY_BLOB(7), STOMP_SSLACCEPTSERVERCERTSTORETYPE_PUBLIC_KEY_FILE(8), STOMP_SSLACCEPTSERVERCERTSTORETYPE_PUBLIC_KEY_BLOB(9), STOMP_SSLACCEPTSERVERCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), STOMP_SSLACCEPTSERVERCERTSTORETYPE_P7BFILE(11), STOMP_SSLACCEPTSERVERCERTSTORETYPE_P7BBLOB(12), STOMP_SSLACCEPTSERVERCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), STOMP_SSLACCEPTSERVERCERTSTORETYPE_PPKFILE(14), STOMP_SSLACCEPTSERVERCERTSTORETYPE_PPKBLOB(15), STOMP_SSLACCEPTSERVERCERTSTORETYPE_XMLFILE(16), STOMP_SSLACCEPTSERVERCERTSTORETYPE_XMLBLOB(17), STOMP_SSLACCEPTSERVERCERTSTORETYPE_JWKFILE(18), STOMP_SSLACCEPTSERVERCERTSTORETYPE_JWKBLOB(19), STOMP_SSLACCEPTSERVERCERTSTORETYPE_SECURITY_KEY(20), STOMP_SSLACCEPTSERVERCERTSTORETYPE_BCFKSFILE(21), STOMP_SSLACCEPTSERVERCERTSTORETYPE_BCFKSBLOB(22), STOMP_SSLACCEPTSERVERCERTSTORETYPE_PKCS11(23), STOMP_SSLACCEPTSERVERCERTSTORETYPE_AUTO(99)
```

## Default Value

0

## Remarks

The type of certificate store for this certificate.

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

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SSLAcceptServerCertStoreType](#sslacceptservercertstoretype-property-ipworksiot_stomp-class), the full path of the PKCS#11 DLL as the [SSLAcceptServerCertStore](#sslacceptservercertstore-property-ipworksiot_stomp-class), and the PIN as the [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-ipworksiot_stomp-class). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SSLAcceptServerCertStore](#sslacceptservercertstore-property-ipworksiot_stomp-class) and set [SSLAcceptServerCertStorePassword](#sslacceptservercertstorepassword-property-ipworksiot_stomp-class) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |

## Data Type

Integer

# SSLAcceptServerCertSubjectAltNames Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getSSLAcceptServerCertSubjectAltNames();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 42 );
```

## Default Value

''

## Remarks

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

This property is read-only.

## Data Type

String

# SSLAcceptServerCertThumbprintMD5 Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The MD5 hash of the certificate.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertThumbprintMD5();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 43 );
```

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

# SSLAcceptServerCertThumbprintSHA1 Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The SHA-1 hash of the certificate.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertThumbprintSHA1();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 44 );
```

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

# SSLAcceptServerCertThumbprintSHA256 Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The SHA-256 hash of the certificate.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertThumbprintSHA256();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 45 );
```

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

# SSLAcceptServerCertUsage Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The text description of UsageFlags .

## Object Oriented Interface

```text
public function getSSLAcceptServerCertUsage();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 46 );
```

## Default Value

''

## Remarks

The text description of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-ipworksiot_stomp-class).

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

# SSLAcceptServerCertUsageFlags Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The flags that show intended use for the certificate.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertUsageFlags();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 47 );
```

## Default Value

0

## Remarks

The flags that show intended use for the certificate. The value of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-ipworksiot_stomp-class) is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the [SSLAcceptServerCertUsage](#sslacceptservercertusage-property-ipworksiot_stomp-class) property for a text representation of [SSLAcceptServerCertUsageFlags](#sslacceptservercertusageflags-property-ipworksiot_stomp-class).

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

This property is read-only.

## Data Type

Integer

# SSLAcceptServerCertVersion Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The certificate's version number.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertVersion();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 48 );
```

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

# SSLAcceptServerCertSubject Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The subject of the certificate used for client authentication.

## Object Oriented Interface

```text
public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 49 );
ipworksiot_stomp_set($res, 49, $value );
```

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

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

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

## Data Type

String

# SSLAcceptServerCertEncoded Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The certificate (PEM/Base64 encoded).

## Object Oriented Interface

```text
public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 50 );
ipworksiot_stomp_set($res, 50, $value );
```

## Default Value

''

## Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLAcceptServerCertStore](#sslacceptservercertstore-property-ipworksiot_stomp-class) and [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-ipworksiot_stomp-class) properties also may be used to specify a certificate.

When [SSLAcceptServerCertEncoded](#sslacceptservercertencoded-property-ipworksiot_stomp-class) is set, a search is initiated in the current [SSLAcceptServerCertStore](#sslacceptservercertstore-property-ipworksiot_stomp-class) for the private key of the certificate. If the key is found, [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-ipworksiot_stomp-class) is updated to reflect the full subject of the selected certificate; otherwise, [SSLAcceptServerCertSubject](#sslacceptservercertsubject-property-ipworksiot_stomp-class) is set to an empty string.

This property is not available at design time.

## Data Type

Binary String

# SSLCertEffectiveDate Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The date on which this certificate becomes valid.

## Object Oriented Interface

```text
public function getSSLCertEffectiveDate();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 51 );
```

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

# SSLCertExpirationDate Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The date on which the certificate expires.

## Object Oriented Interface

```text
public function getSSLCertExpirationDate();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 52 );
```

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

# SSLCertExtendedKeyUsage Property ([IPWorksIoT_STOMP](#stomp-class) Class)

A comma-delimited list of extended key usage identifiers.

## Object Oriented Interface

```text
public function getSSLCertExtendedKeyUsage();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 53 );
```

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

# SSLCertFingerprint Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getSSLCertFingerprint();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 54 );
```

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

# SSLCertFingerprintSHA1 Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getSSLCertFingerprintSHA1();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 55 );
```

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

# SSLCertFingerprintSHA256 Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getSSLCertFingerprintSHA256();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 56 );
```

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

# SSLCertIssuer Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The issuer of the certificate.

## Object Oriented Interface

```text
public function getSSLCertIssuer();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 57 );
```

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

# SSLCertPrivateKey Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The private key of the certificate (if available).

## Object Oriented Interface

```text
public function getSSLCertPrivateKey();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 58 );
```

## Default Value

''

## Remarks

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

NOTE: The [SSLCertPrivateKey](#sslcertprivatekey-property-ipworksiot_stomp-class) may be available but not exportable. In this case, [SSLCertPrivateKey](#sslcertprivatekey-property-ipworksiot_stomp-class) returns an empty string.

This property is read-only.

## Data Type

String

# SSLCertPrivateKeyAvailable Property ([IPWorksIoT_STOMP](#stomp-class) Class)

Whether a PrivateKey is available for the selected certificate.

## Object Oriented Interface

```text
public function getSSLCertPrivateKeyAvailable();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 59 );
```

## Default Value

false

## Remarks

Whether a [SSLCertPrivateKey](#sslcertprivatekey-property-ipworksiot_stomp-class) is available for the selected certificate. If [SSLCertPrivateKeyAvailable](#sslcertprivatekeyavailable-property-ipworksiot_stomp-class) is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

## Data Type

Boolean

# SSLCertPrivateKeyContainer Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getSSLCertPrivateKeyContainer();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 60 );
```

## Default Value

''

## Remarks

The name of the [SSLCertPrivateKey](#sslcertprivatekey-property-ipworksiot_stomp-class) container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

## Data Type

String

# SSLCertPublicKey Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The public key of the certificate.

## Object Oriented Interface

```text
public function getSSLCertPublicKey();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 61 );
```

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

# SSLCertPublicKeyAlgorithm Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getSSLCertPublicKeyAlgorithm();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 62 );
```

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

# SSLCertPublicKeyLength Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getSSLCertPublicKeyLength();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 63 );
```

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

Integer

# SSLCertSerialNumber Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The serial number of the certificate encoded as a string.

## Object Oriented Interface

```text
public function getSSLCertSerialNumber();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 64 );
```

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

# SSLCertSignatureAlgorithm Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The text description of the certificate's signature algorithm.

## Object Oriented Interface

```text
public function getSSLCertSignatureAlgorithm();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 65 );
```

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

# SSLCertStore Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The name of the certificate store for the client certificate.

## Object Oriented Interface

```text
public function getSSLCertStore();
public function setSSLCertStore($value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 66 );
ipworksiot_stomp_set($res, 66, $value );
```

## Default Value

'MY'

## Remarks

The name of the certificate store for the client certificate.

The [SSLCertStoreType](#sslcertstoretype-property-ipworksiot_stomp-class) property denotes the type of the certificate store specified by [SSLCertStore](#sslcertstore-property-ipworksiot_stomp-class). If the store is password-protected, specify the password in [SSLCertStorePassword](#sslcertstorepassword-property-ipworksiot_stomp-class).

[SSLCertStore](#sslcertstore-property-ipworksiot_stomp-class) is used in conjunction with the [SSLCertSubject](#sslcertsubject-property-ipworksiot_stomp-class) property to specify client certificates. If [SSLCertStore](#sslcertstore-property-ipworksiot_stomp-class) has a value, and [SSLCertSubject](#sslcertsubject-property-ipworksiot_stomp-class) or [SSLCertEncoded](#sslcertencoded-property-ipworksiot_stomp-class) is set, a search for a certificate is initiated. Please see the [SSLCertSubject](#sslcertsubject-property-ipworksiot_stomp-class) property for details.

 Designations of certificate stores are platform dependent.

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

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

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

Binary String

# SSLCertStorePassword Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 67 );
ipworksiot_stomp_set($res, 67, $value );
```

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

# SSLCertStoreType Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The type of certificate store for this certificate.

## Object Oriented Interface

```text
public function getSSLCertStoreType();
public function setSSLCertStoreType($value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 68 );
ipworksiot_stomp_set($res, 68, $value );
```

## Possible Values

```text
STOMP_SSLCERTSTORETYPE_USER(0), STOMP_SSLCERTSTORETYPE_MACHINE(1), STOMP_SSLCERTSTORETYPE_PFXFILE(2), STOMP_SSLCERTSTORETYPE_PFXBLOB(3), STOMP_SSLCERTSTORETYPE_JKSFILE(4), STOMP_SSLCERTSTORETYPE_JKSBLOB(5), STOMP_SSLCERTSTORETYPE_PEMKEY_FILE(6), STOMP_SSLCERTSTORETYPE_PEMKEY_BLOB(7), STOMP_SSLCERTSTORETYPE_PUBLIC_KEY_FILE(8), STOMP_SSLCERTSTORETYPE_PUBLIC_KEY_BLOB(9), STOMP_SSLCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), STOMP_SSLCERTSTORETYPE_P7BFILE(11), STOMP_SSLCERTSTORETYPE_P7BBLOB(12), STOMP_SSLCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), STOMP_SSLCERTSTORETYPE_PPKFILE(14), STOMP_SSLCERTSTORETYPE_PPKBLOB(15), STOMP_SSLCERTSTORETYPE_XMLFILE(16), STOMP_SSLCERTSTORETYPE_XMLBLOB(17), STOMP_SSLCERTSTORETYPE_JWKFILE(18), STOMP_SSLCERTSTORETYPE_JWKBLOB(19), STOMP_SSLCERTSTORETYPE_SECURITY_KEY(20), STOMP_SSLCERTSTORETYPE_BCFKSFILE(21), STOMP_SSLCERTSTORETYPE_BCFKSBLOB(22), STOMP_SSLCERTSTORETYPE_PKCS11(23), STOMP_SSLCERTSTORETYPE_AUTO(99)
```

## Default Value

0

## Remarks

The type of certificate store for this certificate.

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

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SSLCertStoreType](#sslcertstoretype-property-ipworksiot_stomp-class), the full path of the PKCS#11 DLL as the [SSLCertStore](#sslcertstore-property-ipworksiot_stomp-class), and the PIN as the [SSLCertStorePassword](#sslcertstorepassword-property-ipworksiot_stomp-class). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SSLCertStore](#sslcertstore-property-ipworksiot_stomp-class) and set [SSLCertStorePassword](#sslcertstorepassword-property-ipworksiot_stomp-class) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |

## Data Type

Integer

# SSLCertSubjectAltNames Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getSSLCertSubjectAltNames();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 69 );
```

## Default Value

''

## Remarks

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

This property is read-only.

## Data Type

String

# SSLCertThumbprintMD5 Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The MD5 hash of the certificate.

## Object Oriented Interface

```text
public function getSSLCertThumbprintMD5();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 70 );
```

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

# SSLCertThumbprintSHA1 Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The SHA-1 hash of the certificate.

## Object Oriented Interface

```text
public function getSSLCertThumbprintSHA1();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 71 );
```

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

# SSLCertThumbprintSHA256 Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The SHA-256 hash of the certificate.

## Object Oriented Interface

```text
public function getSSLCertThumbprintSHA256();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 72 );
```

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

# SSLCertUsage Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The text description of UsageFlags .

## Object Oriented Interface

```text
public function getSSLCertUsage();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 73 );
```

## Default Value

''

## Remarks

The text description of [SSLCertUsageFlags](#sslcertusageflags-property-ipworksiot_stomp-class).

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

# SSLCertUsageFlags Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The flags that show intended use for the certificate.

## Object Oriented Interface

```text
public function getSSLCertUsageFlags();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 74 );
```

## Default Value

0

## Remarks

The flags that show intended use for the certificate. The value of [SSLCertUsageFlags](#sslcertusageflags-property-ipworksiot_stomp-class) is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the [SSLCertUsage](#sslcertusage-property-ipworksiot_stomp-class) property for a text representation of [SSLCertUsageFlags](#sslcertusageflags-property-ipworksiot_stomp-class).

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

This property is read-only.

## Data Type

Integer

# SSLCertVersion Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The certificate's version number.

## Object Oriented Interface

```text
public function getSSLCertVersion();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 75 );
```

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

# SSLCertSubject Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The subject of the certificate used for client authentication.

## Object Oriented Interface

```text
public function getSSLCertSubject();
public function setSSLCertSubject($value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 76 );
ipworksiot_stomp_set($res, 76, $value );
```

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

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

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

## Data Type

String

# SSLCertEncoded Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The certificate (PEM/Base64 encoded).

## Object Oriented Interface

```text
public function getSSLCertEncoded();
public function setSSLCertEncoded($value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 77 );
ipworksiot_stomp_set($res, 77, $value );
```

## Default Value

''

## Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLCertStore](#sslcertstore-property-ipworksiot_stomp-class) and [SSLCertSubject](#sslcertsubject-property-ipworksiot_stomp-class) properties also may be used to specify a certificate.

When [SSLCertEncoded](#sslcertencoded-property-ipworksiot_stomp-class) is set, a search is initiated in the current [SSLCertStore](#sslcertstore-property-ipworksiot_stomp-class) for the private key of the certificate. If the key is found, [SSLCertSubject](#sslcertsubject-property-ipworksiot_stomp-class) is updated to reflect the full subject of the selected certificate; otherwise, [SSLCertSubject](#sslcertsubject-property-ipworksiot_stomp-class) is set to an empty string.

This property is not available at design time.

## Data Type

Binary String

# SSLEnabled Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getSSLEnabled();
public function setSSLEnabled($value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 78 );
ipworksiot_stomp_set($res, 78, $value );
```

## Default Value

false

## Remarks

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

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

This property is not available at design time.

## Data Type

Boolean

# SSLProvider Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getSSLProvider();
public function setSSLProvider($value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 79 );
ipworksiot_stomp_set($res, 79, $value );
```

## Possible Values

```text
STOMP_SSLPROVIDER_AUTOMATIC(0), STOMP_SSLPROVIDER_PLATFORM(1), STOMP_SSLPROVIDER_INTERNAL(2)
```

## Default Value

0

## Remarks

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

Possible values are as follows:

|  |  |
| --- | --- |
| 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
| 1 (sslpPlatform) | Uses the platform/system implementation. |
| 2 (sslpInternal) | Uses the internal implementation. |

 **Additional Notes**

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

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via [SSLEnabledProtocols](#SSLEnabledProtocols), the class 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

Integer

# SSLServerCertEffectiveDate Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The date on which this certificate becomes valid.

## Object Oriented Interface

```text
public function getSSLServerCertEffectiveDate();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 80 );
```

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

# SSLServerCertExpirationDate Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The date on which the certificate expires.

## Object Oriented Interface

```text
public function getSSLServerCertExpirationDate();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 81 );
```

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

# SSLServerCertExtendedKeyUsage Property ([IPWorksIoT_STOMP](#stomp-class) Class)

A comma-delimited list of extended key usage identifiers.

## Object Oriented Interface

```text
public function getSSLServerCertExtendedKeyUsage();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 82 );
```

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

# SSLServerCertFingerprint Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getSSLServerCertFingerprint();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 83 );
```

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

# SSLServerCertFingerprintSHA1 Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getSSLServerCertFingerprintSHA1();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 84 );
```

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

# SSLServerCertFingerprintSHA256 Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getSSLServerCertFingerprintSHA256();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 85 );
```

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

# SSLServerCertIssuer Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The issuer of the certificate.

## Object Oriented Interface

```text
public function getSSLServerCertIssuer();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 86 );
```

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

# SSLServerCertPrivateKey Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The private key of the certificate (if available).

## Object Oriented Interface

```text
public function getSSLServerCertPrivateKey();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 87 );
```

## Default Value

''

## Remarks

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

NOTE: The [SSLServerCertPrivateKey](#sslservercertprivatekey-property-ipworksiot_stomp-class) may be available but not exportable. In this case, [SSLServerCertPrivateKey](#sslservercertprivatekey-property-ipworksiot_stomp-class) returns an empty string.

This property is read-only.

## Data Type

String

# SSLServerCertPrivateKeyAvailable Property ([IPWorksIoT_STOMP](#stomp-class) Class)

Whether a PrivateKey is available for the selected certificate.

## Object Oriented Interface

```text
public function getSSLServerCertPrivateKeyAvailable();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 88 );
```

## Default Value

false

## Remarks

Whether a [SSLServerCertPrivateKey](#sslservercertprivatekey-property-ipworksiot_stomp-class) is available for the selected certificate. If [SSLServerCertPrivateKeyAvailable](#sslservercertprivatekeyavailable-property-ipworksiot_stomp-class) is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

## Data Type

Boolean

# SSLServerCertPrivateKeyContainer Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getSSLServerCertPrivateKeyContainer();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 89 );
```

## Default Value

''

## Remarks

The name of the [SSLServerCertPrivateKey](#sslservercertprivatekey-property-ipworksiot_stomp-class) container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

## Data Type

String

# SSLServerCertPublicKey Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The public key of the certificate.

## Object Oriented Interface

```text
public function getSSLServerCertPublicKey();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 90 );
```

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

# SSLServerCertPublicKeyAlgorithm Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getSSLServerCertPublicKeyAlgorithm();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 91 );
```

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

# SSLServerCertPublicKeyLength Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getSSLServerCertPublicKeyLength();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 92 );
```

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

Integer

# SSLServerCertSerialNumber Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The serial number of the certificate encoded as a string.

## Object Oriented Interface

```text
public function getSSLServerCertSerialNumber();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 93 );
```

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

# SSLServerCertSignatureAlgorithm Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The text description of the certificate's signature algorithm.

## Object Oriented Interface

```text
public function getSSLServerCertSignatureAlgorithm();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 94 );
```

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

# SSLServerCertStore Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The name of the certificate store for the client certificate.

## Object Oriented Interface

```text
public function getSSLServerCertStore();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 95 );
```

## Default Value

'MY'

## Remarks

The name of the certificate store for the client certificate.

The [SSLServerCertStoreType](#sslservercertstoretype-property-ipworksiot_stomp-class) property denotes the type of the certificate store specified by [SSLServerCertStore](#sslservercertstore-property-ipworksiot_stomp-class). If the store is password-protected, specify the password in [SSLServerCertStorePassword](#sslservercertstorepassword-property-ipworksiot_stomp-class).

[SSLServerCertStore](#sslservercertstore-property-ipworksiot_stomp-class) is used in conjunction with the [SSLServerCertSubject](#sslservercertsubject-property-ipworksiot_stomp-class) property to specify client certificates. If [SSLServerCertStore](#sslservercertstore-property-ipworksiot_stomp-class) has a value, and [SSLServerCertSubject](#sslservercertsubject-property-ipworksiot_stomp-class) or [SSLServerCertEncoded](#sslservercertencoded-property-ipworksiot_stomp-class) is set, a search for a certificate is initiated. Please see the [SSLServerCertSubject](#sslservercertsubject-property-ipworksiot_stomp-class) property for details.

 Designations of certificate stores are platform dependent.

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

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

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

Binary String

# SSLServerCertStorePassword Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getSSLServerCertStorePassword();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 96 );
```

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

# SSLServerCertStoreType Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The type of certificate store for this certificate.

## Object Oriented Interface

```text
public function getSSLServerCertStoreType();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 97 );
```

## Possible Values

```text
STOMP_SSLSERVERCERTSTORETYPE_USER(0), STOMP_SSLSERVERCERTSTORETYPE_MACHINE(1), STOMP_SSLSERVERCERTSTORETYPE_PFXFILE(2), STOMP_SSLSERVERCERTSTORETYPE_PFXBLOB(3), STOMP_SSLSERVERCERTSTORETYPE_JKSFILE(4), STOMP_SSLSERVERCERTSTORETYPE_JKSBLOB(5), STOMP_SSLSERVERCERTSTORETYPE_PEMKEY_FILE(6), STOMP_SSLSERVERCERTSTORETYPE_PEMKEY_BLOB(7), STOMP_SSLSERVERCERTSTORETYPE_PUBLIC_KEY_FILE(8), STOMP_SSLSERVERCERTSTORETYPE_PUBLIC_KEY_BLOB(9), STOMP_SSLSERVERCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), STOMP_SSLSERVERCERTSTORETYPE_P7BFILE(11), STOMP_SSLSERVERCERTSTORETYPE_P7BBLOB(12), STOMP_SSLSERVERCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), STOMP_SSLSERVERCERTSTORETYPE_PPKFILE(14), STOMP_SSLSERVERCERTSTORETYPE_PPKBLOB(15), STOMP_SSLSERVERCERTSTORETYPE_XMLFILE(16), STOMP_SSLSERVERCERTSTORETYPE_XMLBLOB(17), STOMP_SSLSERVERCERTSTORETYPE_JWKFILE(18), STOMP_SSLSERVERCERTSTORETYPE_JWKBLOB(19), STOMP_SSLSERVERCERTSTORETYPE_SECURITY_KEY(20), STOMP_SSLSERVERCERTSTORETYPE_BCFKSFILE(21), STOMP_SSLSERVERCERTSTORETYPE_BCFKSBLOB(22), STOMP_SSLSERVERCERTSTORETYPE_PKCS11(23), STOMP_SSLSERVERCERTSTORETYPE_AUTO(99)
```

## Default Value

0

## Remarks

The type of certificate store for this certificate.

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

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SSLServerCertStoreType](#sslservercertstoretype-property-ipworksiot_stomp-class), the full path of the PKCS#11 DLL as the [SSLServerCertStore](#sslservercertstore-property-ipworksiot_stomp-class), and the PIN as the [SSLServerCertStorePassword](#sslservercertstorepassword-property-ipworksiot_stomp-class). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SSLServerCertStore](#sslservercertstore-property-ipworksiot_stomp-class) and set [SSLServerCertStorePassword](#sslservercertstorepassword-property-ipworksiot_stomp-class) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |

This property is read-only.

## Data Type

Integer

# SSLServerCertSubjectAltNames Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getSSLServerCertSubjectAltNames();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 98 );
```

## Default Value

''

## Remarks

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

This property is read-only.

## Data Type

String

# SSLServerCertThumbprintMD5 Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The MD5 hash of the certificate.

## Object Oriented Interface

```text
public function getSSLServerCertThumbprintMD5();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 99 );
```

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

# SSLServerCertThumbprintSHA1 Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The SHA-1 hash of the certificate.

## Object Oriented Interface

```text
public function getSSLServerCertThumbprintSHA1();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 100 );
```

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

# SSLServerCertThumbprintSHA256 Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The SHA-256 hash of the certificate.

## Object Oriented Interface

```text
public function getSSLServerCertThumbprintSHA256();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 101 );
```

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

# SSLServerCertUsage Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The text description of UsageFlags .

## Object Oriented Interface

```text
public function getSSLServerCertUsage();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 102 );
```

## Default Value

''

## Remarks

The text description of [SSLServerCertUsageFlags](#sslservercertusageflags-property-ipworksiot_stomp-class).

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

# SSLServerCertUsageFlags Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The flags that show intended use for the certificate.

## Object Oriented Interface

```text
public function getSSLServerCertUsageFlags();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 103 );
```

## Default Value

0

## Remarks

The flags that show intended use for the certificate. The value of [SSLServerCertUsageFlags](#sslservercertusageflags-property-ipworksiot_stomp-class) is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the [SSLServerCertUsage](#sslservercertusage-property-ipworksiot_stomp-class) property for a text representation of [SSLServerCertUsageFlags](#sslservercertusageflags-property-ipworksiot_stomp-class).

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

This property is read-only.

## Data Type

Integer

# SSLServerCertVersion Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The certificate's version number.

## Object Oriented Interface

```text
public function getSSLServerCertVersion();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 104 );
```

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

# SSLServerCertSubject Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The subject of the certificate used for client authentication.

## Object Oriented Interface

```text
public function getSSLServerCertSubject();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 105 );
```

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

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

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

This property is read-only.

## Data Type

String

# SSLServerCertEncoded Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The certificate (PEM/Base64 encoded).

## Object Oriented Interface

```text
public function getSSLServerCertEncoded();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 106 );
```

## Default Value

''

## Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLServerCertStore](#sslservercertstore-property-ipworksiot_stomp-class) and [SSLServerCertSubject](#sslservercertsubject-property-ipworksiot_stomp-class) properties also may be used to specify a certificate.

When [SSLServerCertEncoded](#sslservercertencoded-property-ipworksiot_stomp-class) is set, a search is initiated in the current [SSLServerCertStore](#sslservercertstore-property-ipworksiot_stomp-class) for the private key of the certificate. If the key is found, [SSLServerCertSubject](#sslservercertsubject-property-ipworksiot_stomp-class) is updated to reflect the full subject of the selected certificate; otherwise, [SSLServerCertSubject](#sslservercertsubject-property-ipworksiot_stomp-class) is set to an empty string.

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

## Data Type

Binary String

# SubscriptionCount Property ([IPWorksIoT_STOMP](#stomp-class) Class)

The number of records in the Subscription arrays.

## Object Oriented Interface

```text
public function getSubscriptionCount();
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 107 );
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [SubscriptionDestination](#subscriptiondestination-property-ipworksiot_stomp-class)
- [SubscriptionId](#subscriptionid-property-ipworksiot_stomp-class)

The array indices start at *0* and end at *SubscriptionCount - 1*.

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

## Data Type

Integer

# SubscriptionDestination Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getSubscriptionDestination($subscriptionindex);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 108 , $subscriptionindex);
```

## 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](#subscriptioncount-property-ipworksiot_stomp-class) property.

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

## Data Type

String

# SubscriptionId Property ([IPWorksIoT_STOMP](#stomp-class) Class)

This subscription's unique Id.

## Object Oriented Interface

```text
public function getSubscriptionId($subscriptionindex);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 109 , $subscriptionindex);
```

## 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](#subscriptioncount-property-ipworksiot_stomp-class) property.

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

## Data Type

String

# Timeout Property ([IPWorksIoT_STOMP](#stomp-class) Class)

This property includes the timeout for the class.

## Object Oriented Interface

```text
public function getTimeout();
public function setTimeout($value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 110 );
ipworksiot_stomp_set($res, 110, $value );
```

## Default Value

60

## Remarks

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

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

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

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

NOTE: By default, all timeouts are *inactivity timeouts*, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

## Data Type

Integer

# TransactionId Property ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function getTransactionId();
public function setTransactionId($value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 111 );
ipworksiot_stomp_set($res, 111, $value );
```

## Default Value

''

## Remarks

This property, if not empty, is used to specify which transaction outgoing messages sent using [SendMessage](#sendmessage-method-ipworksiot_stomp-class) or [SendData](#senddata-method-ipworksiot_stomp-class) are associated with.

This property must either be empty, or set to the Id of a currently open transaction. The [OpenTransactions](#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](#AckTransactionId) configuration setting during the [MessageIn](#messagein-event-ipworksiot_stomp-class) event handler.

Refer to [BeginTransaction](#begintransaction-method-ipworksiot_stomp-class) for more information about transactions.

This property is not available at design time.

## Data Type

String

# User Property ([IPWorksIoT_STOMP](#stomp-class) Class)

A username if authentication is to be used.

## Object Oriented Interface

```text
public function getUser();
public function setUser($value);
```

## Procedural Interface

```text
ipworksiot_stomp_get($res, 112 );
ipworksiot_stomp_set($res, 112, $value );
```

## Default Value

''

## Remarks

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

This property is not available at design time.

## Data Type

String

# AbortTransaction Method ([IPWorksIoT_STOMP](#stomp-class) Class)

Aborts an existing transaction.

## Object Oriented Interface

```text
public function doAbortTransaction($id);
```

## Procedural Interface

```text
ipworksiot_stomp_do_aborttransaction($res, $id);
```

## Remarks

This method aborts a transaction previously started with [BeginTransaction](#begintransaction-method-ipworksiot_stomp-class). *Id* identifies the transaction to abort.

The [OpenTransactions](#OpenTransactions) configuration setting can be queried to obtain a list of currently-open transactions.

Refer to [BeginTransaction](#begintransaction-method-ipworksiot_stomp-class) for more information about transactions.

# AddHeader Method ([IPWorksIoT_STOMP](#stomp-class) Class)

Adds a custom header to send with outgoing messages.

## Object Oriented Interface

```text
public function doAddHeader($key, $value);
```

## Procedural Interface

```text
ipworksiot_stomp_do_addheader($res, $key, $value);
```

## Remarks

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

When [SendMessage](#sendmessage-method-ipworksiot_stomp-class) or [SendData](#senddata-method-ipworksiot_stomp-class) is called, all headers in the Headers collection property are added to the outgoing message.

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

# BeginTransaction Method ([IPWorksIoT_STOMP](#stomp-class) Class)

Begins a new transaction.

## Object Oriented Interface

```text
public function doBeginTransaction($id);
```

## Procedural Interface

```text
ipworksiot_stomp_do_begintransaction($res, $id);
```

## Remarks

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

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

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

Since it is possible for multiple transactions to be open at any given time, the [TransactionId](#transactionid-property-ipworksiot_stomp-class) 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](#AckTransactionId) configuration setting during the [MessageIn](#messagein-event-ipworksiot_stomp-class) event handler.

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

**Basic Transaction Example**

```csharp
// 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 = "";
```

# CommitTransaction Method ([IPWorksIoT_STOMP](#stomp-class) Class)

Commits an existing transaction.

## Object Oriented Interface

```text
public function doCommitTransaction($id);
```

## Procedural Interface

```text
ipworksiot_stomp_do_committransaction($res, $id);
```

## Remarks

This method commits a transaction previously started with [BeginTransaction](#begintransaction-method-ipworksiot_stomp-class). *Id* identifies the transaction to commit.

The [OpenTransactions](#OpenTransactions) configuration setting can be queried to obtain a list of currently-open transactions.

Refer to [BeginTransaction](#begintransaction-method-ipworksiot_stomp-class) for more information about transactions.

# Config Method ([IPWorksIoT_STOMP](#stomp-class) Class)

Sets or retrieves a configuration setting.

## Object Oriented Interface

```text
public function doConfig($configurationstring);
```

## Procedural Interface

```text
ipworksiot_stomp_do_config($res, $configurationstring);
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-stomp-class) for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the Config method.

To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a [configuration setting](#config-settings-stomp-class), you must call *Config("PROPERTY")*. The value will be returned as a string.

# Connect Method ([IPWorksIoT_STOMP](#stomp-class) Class)

Connects to the remote host.

## Object Oriented Interface

```text
public function doConnect();
```

## Procedural Interface

```text
ipworksiot_stomp_do_connect($res);
```

## Remarks

This method connects to the remote host, specified by [RemoteHost](#remotehost-property-ipworksiot_stomp-class) and [RemotePort](#remoteport-property-ipworksiot_stomp-class).

By default the class will connect in plaintext. To enable SSL set [SSLEnabled](#sslenabled-property-ipworksiot_stomp-class) to *True*.

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

- [IncomingHeartbeat](#incomingheartbeat-property-ipworksiot_stomp-class)
- [OutgoingHeartbeat](#outgoingheartbeat-property-ipworksiot_stomp-class)
- [User](#user-property-ipworksiot_stomp-class)
- [Password](#password-property-ipworksiot_stomp-class)

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

- [SupportedVersions](#SupportedVersions): Controls which STOMP versions the class advertises support for.
- [VirtualHost](#VirtualHost): Controls the virtual host to connect to. If left empty (default), the value from [RemoteHost](#remotehost-property-ipworksiot_stomp-class) is used.

# ConnectTo Method ([IPWorksIoT_STOMP](#stomp-class) Class)

Connects to the remote host.

## Object Oriented Interface

```text
public function doConnectTo($host, $port);
```

## Procedural Interface

```text
ipworksiot_stomp_do_connectto($res, $host, $port);
```

## Remarks

This method connects to the remote host specified by the *Host* and *Port* parameters. Calling this method is equivalent to setting the [RemoteHost](#remotehost-property-ipworksiot_stomp-class) property to *Host* and setting [RemotePort](#remoteport-property-ipworksiot_stomp-class) to *Port*.

By default the class will connect in plaintext. To enable SSL set [SSLEnabled](#sslenabled-property-ipworksiot_stomp-class) to *True*.

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

- [IncomingHeartbeat](#incomingheartbeat-property-ipworksiot_stomp-class)
- [OutgoingHeartbeat](#outgoingheartbeat-property-ipworksiot_stomp-class)
- [User](#user-property-ipworksiot_stomp-class)
- [Password](#password-property-ipworksiot_stomp-class)

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

- [SupportedVersions](#SupportedVersions): Controls which STOMP versions the class advertises support for.
- [VirtualHost](#VirtualHost): Controls the virtual host to connect to. If left empty (default), the value from [RemoteHost](#remotehost-property-ipworksiot_stomp-class) is used.

# Disconnect Method ([IPWorksIoT_STOMP](#stomp-class) Class)

This method disconnects from the remote host.

## Object Oriented Interface

```text
public function doDisconnect();
```

## Procedural Interface

```text
ipworksiot_stomp_do_disconnect($res);
```

## Remarks

This method disconnects from the remote host.

# DoEvents Method ([IPWorksIoT_STOMP](#stomp-class) Class)

This method processes events from the internal message queue.

## Object Oriented Interface

```text
public function doEvents();
```

## Procedural Interface

```text
ipworksiot_stomp_do_doevents($res);
```

## Remarks

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

# Interrupt Method ([IPWorksIoT_STOMP](#stomp-class) Class)

Interrupt the current action and disconnects from the remote host.

## Object Oriented Interface

```text
public function doInterrupt();
```

## Procedural Interface

```text
ipworksiot_stomp_do_interrupt($res);
```

## Remarks

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

# Reset Method ([IPWorksIoT_STOMP](#stomp-class) Class)

This method will reset the class.

## Object Oriented Interface

```text
public function doReset();
```

## Procedural Interface

```text
ipworksiot_stomp_do_reset($res);
```

## Remarks

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

# ResetHeaders Method ([IPWorksIoT_STOMP](#stomp-class) Class)

Clear the user-defined headers collection.

## Object Oriented Interface

```text
public function doResetHeaders();
```

## Procedural Interface

```text
ipworksiot_stomp_do_resetheaders($res);
```

## Remarks

This method clears the Headers collection property.

# SendData Method ([IPWorksIoT_STOMP](#stomp-class) Class)

Publishes a message with a raw data payload.

## Object Oriented Interface

```text
public function doSendData($destination, $data);
```

## Procedural Interface

```text
ipworksiot_stomp_do_senddata($res, $destination, $data);
```

## Remarks

This method publishes a STOMP message with a raw data payload to the specified *Destination*. The [MessageOut](#messageout-event-ipworksiot_stomp-class) event will fire after the message has been sent.

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

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

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

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

If [RequestReceipts](#requestreceipts-property-ipworksiot_stomp-class) is enabled when this method is called, the class will request that the server send back a receipt to confirm it has received the message. Refer to [RequestReceipts](#requestreceipts-property-ipworksiot_stomp-class) for more information.

Note that no content type is defined for raw data payload messages; so the [ContentType](#contenttype-property-ipworksiot_stomp-class) property is ignored by this method.

**Send String Message Example**

```csharp
stomp1.SendMessage("test/a/b", "Hello, world!");
```

**Send Binary Message Example**

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

# SendMessage Method ([IPWorksIoT_STOMP](#stomp-class) Class)

Publishes a message with a string payload.

## Object Oriented Interface

```text
public function doSendMessage($destination, $message);
```

## Procedural Interface

```text
ipworksiot_stomp_do_sendmessage($res, $destination, $message);
```

## Remarks

This method publishes a STOMP message with a string payload to the specified *Destination*. The [MessageOut](#messageout-event-ipworksiot_stomp-class) event will fire after the message has been sent.

The [ContentType](#contenttype-property-ipworksiot_stomp-class) property can be used to specify the content type of the payload. By default, [ContentType](#contenttype-property-ipworksiot_stomp-class) is set to *text/plain*.

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

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

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

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

If [RequestReceipts](#requestreceipts-property-ipworksiot_stomp-class) is enabled when this method is called, the class will request that the server send back a receipt to confirm it has received the message. Refer to [RequestReceipts](#requestreceipts-property-ipworksiot_stomp-class) for more information.

**Send String Message Example**

```csharp
stomp1.SendMessage("test/a/b", "Hello, world!");
```

**Send Binary Message Example**

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

# Subscribe Method ([IPWorksIoT_STOMP](#stomp-class) Class)

Subscribes to a message destination on the server.

## Object Oriented Interface

```text
public function doSubscribe($destination, $requireacks);
```

## Procedural Interface

```text
ipworksiot_stomp_do_subscribe($res, $destination, $requireacks);
```

## Remarks

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

Once subscribed, the [Subscribed](#subscribed-event-ipworksiot_stomp-class) event will fire and an item will be added to the Subscriptions collection property. The [MessageIn](#messagein-event-ipworksiot_stomp-class) event will fire anytime a message is received for any subscription.

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

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

**Basic Subscriptions Example**

```csharp
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 ([IPWorksIoT_STOMP](#stomp-class) Class)

Removes an existing subscription.

## Object Oriented Interface

```text
public function doUnsubscribe($id);
```

## Procedural Interface

```text
ipworksiot_stomp_do_unsubscribe($res, $id);
```

## Remarks

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

Once unsubscribed, the relevant item will be removed from the Subscriptions collection property and the [Unsubscribed](#unsubscribed-event-ipworksiot_stomp-class) event will fire.

**Basic Subscriptions Example**

```csharp
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);
```

# Connected Event ([IPWorksIoT_STOMP](#stomp-class) Class)

Fired immediately after a connection completes (or fails).

## Object Oriented Interface

```text
public function fireConnected($param);
```

## Procedural Interface

```text
ipworksiot_stomp_register_callback($res, 1, array($this, 'fireConnected'));
```

## Parameter List

```text
 'statuscode' 'description'
```

## Remarks

If the connection is made normally, *StatusCode* is 0 and *Description* is "OK".

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

Please refer to the [Error Codes](#trappable-errors-stomp-class) section for more information.

# ConnectionStatus Event ([IPWorksIoT_STOMP](#stomp-class) Class)

Fired to indicate changes in the connection state.

## Object Oriented Interface

```text
public function fireConnectionStatus($param);
```

## Procedural Interface

```text
ipworksiot_stomp_register_callback($res, 2, array($this, 'fireConnectionStatus'));
```

## Parameter List

```text
 'connectionevent' 'statuscode' 'description'
```

## Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The *ConnectionEvent* parameter indicates the type of connection event. Values may include the following:

|  |  |
| --- | --- |
|  | Firewall connection complete. |
|  | Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable). |
|  | Remote host connection complete. |
|  | Remote host disconnected. |
|  | SSL or S/Shell connection broken. |
|  | Firewall host disconnected. |

 *StatusCode* has the error code returned by the Transmission Control Protocol (TCP)/IP stack. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the error.

# Disconnected Event ([IPWorksIoT_STOMP](#stomp-class) Class)

Fired when a connection is closed.

## Object Oriented Interface

```text
public function fireDisconnected($param);
```

## Procedural Interface

```text
ipworksiot_stomp_register_callback($res, 3, array($this, 'fireDisconnected'));
```

## Parameter List

```text
 'statuscode' 'description'
```

## Remarks

If the connection is broken normally, *StatusCode* is 0 and *Description* is "OK".

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

Please refer to the [Error Codes](#trappable-errors-stomp-class) section for more information.

# Error Event ([IPWorksIoT_STOMP](#stomp-class) Class)

Fired when a class or protocol error occurs.

## Object Oriented Interface

```text
public function fireError($param);
```

## Procedural Interface

```text
ipworksiot_stomp_register_callback($res, 4, array($this, 'fireError'));
```

## Parameter List

```text
 'errorcode' 'description' 'data'
```

## Remarks

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

*ErrorCode* contains an error code and *Description* contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-stomp-class) section.

### STOMP Protocol Errors

 The class will fire the Error event anytime the server reports a STOMP protocol error (i.e., the class receives an ERROR frame).

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](#ErrorHeaders) configuration setting will also be populated with the raw headers from the ERROR frame for the duration of the Error event handler.

# Log Event ([IPWorksIoT_STOMP](#stomp-class) Class)

Fired once for each log message.

## Object Oriented Interface

```text
public function fireLog($param);
```

## Procedural Interface

```text
ipworksiot_stomp_register_callback($res, 5, array($this, 'fireLog'));
```

## Parameter List

```text
 'loglevel' 'message' 'logtype'
```

## Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the [LogLevel](#LogLevel) setting.

*LogLevel* indicates the level of the *Message*. Possible values are:

|  |  |
| --- | --- |
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data is logged. |
| 3 (Debug) | Debug data is logged. |

*LogType* identifies the type of log entry. Possible values are:

- Info: General information about the class.
- Acknowledgment: Information about outgoing message acknowledgments.
- Frame: Frame content logging.

# MessageIn Event ([IPWorksIoT_STOMP](#stomp-class) Class)

Fired when a message has been received.

## Object Oriented Interface

```text
public function fireMessageIn($param);
```

## Procedural Interface

```text
ipworksiot_stomp_register_callback($res, 6, array($this, 'fireMessageIn'));
```

## Parameter List

```text
 'messageid' 'subscriptionid' 'destination' 'data' 'contenttype' 'ack'
```

## Remarks

This events fires whenever the class has received a message.

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

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

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

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

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

# MessageOut Event ([IPWorksIoT_STOMP](#stomp-class) Class)

Fired after a message has been sent.

## Object Oriented Interface

```text
public function fireMessageOut($param);
```

## Procedural Interface

```text
ipworksiot_stomp_register_callback($res, 7, array($this, 'fireMessageOut'));
```

## Parameter List

```text
 'destination' 'data' 'contenttype'
```

## Remarks

This event fires after a message has been sent using either [SendMessage](#sendmessage-method-ipworksiot_stomp-class) or [SendData](#senddata-method-ipworksiot_stomp-class). The following parameters are available within this event:

- *Destination*: The destination the message was sent to.
- *Data*: The message's payload.
- *ContentType*: The content type of the message (always empty for messages sent with [SendData](#senddata-method-ipworksiot_stomp-class)).

# ReadyToSend Event ([IPWorksIoT_STOMP](#stomp-class) Class)

Fired when the class is ready to send data.

## Object Oriented Interface

```text
public function fireReadyToSend($param);
```

## Procedural Interface

```text
ipworksiot_stomp_register_callback($res, 8, array($this, 'fireReadyToSend'));
```

## Parameter List

```text

```

## Remarks

The ReadyToSend event indicates that the underlying TCP/IP subsystem is ready to accept data after a call to [SendData](#senddata-method-ipworksiot_stomp-class) or [SendMessage](#sendmessage-method-ipworksiot_stomp-class) fails due to a WOULDBLOCK condition. The event is also fired immediately after a connection to the remote host is established.

# ReceiptIn Event ([IPWorksIoT_STOMP](#stomp-class) Class)

Fires when the class receives a receipt from the server.

## Object Oriented Interface

```text
public function fireReceiptIn($param);
```

## Procedural Interface

```text
ipworksiot_stomp_register_callback($res, 9, array($this, 'fireReceiptIn'));
```

## Parameter List

```text
 'receiptid'
```

## Remarks

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

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

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

 then the server could, at some point, send back a single receipt with a *receipt-id* header value of *SEND-5* to confirm that it has received the first three frames.

Refer to [RequestReceipts](#requestreceipts-property-ipworksiot_stomp-class) for more information about receipts.

# ReceiptOut Event ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function fireReceiptOut($param);
```

## Procedural Interface

```text
ipworksiot_stomp_register_callback($res, 10, array($this, 'fireReceiptOut'));
```

## Parameter List

```text
 'receiptid'
```

## Remarks

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

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

Refer to [RequestReceipts](#requestreceipts-property-ipworksiot_stomp-class) for more information about receipts.

# SSLServerAuthentication Event ([IPWorksIoT_STOMP](#stomp-class) Class)

Fired after the server presents its certificate to the client.

## Object Oriented Interface

```text
public function fireSSLServerAuthentication($param);
```

## Procedural Interface

```text
ipworksiot_stomp_register_callback($res, 11, array($this, 'fireSSLServerAuthentication'));
```

## Parameter List

```text
 'certencoded' 'certsubject' 'certissuer' 'status' 'accept'
```

## Remarks

During this event, the client can decide whether or not to continue with the connection process. The *Accept* parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

 When *Accept* is False, *Status* shows why the verification failed (otherwise, *Status* contains the string *OK*). If it is decided to continue, you can override and accept the certificate by setting the *Accept* parameter to True.

# SSLStatus Event ([IPWorksIoT_STOMP](#stomp-class) Class)

Fired when secure connection progress messages are available.

## Object Oriented Interface

```text
public function fireSSLStatus($param);
```

## Procedural Interface

```text
ipworksiot_stomp_register_callback($res, 12, array($this, 'fireSSLStatus'));
```

## Parameter List

```text
 'message'
```

## Remarks

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

# Subscribed Event ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function fireSubscribed($param);
```

## Procedural Interface

```text
ipworksiot_stomp_register_callback($res, 13, array($this, 'fireSubscribed'));
```

## Parameter List

```text
 'id' 'destination' 'requireacks'
```

## Remarks

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

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

# Unsubscribed Event ([IPWorksIoT_STOMP](#stomp-class) Class)

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

## Object Oriented Interface

```text
public function fireUnsubscribed($param);
```

## Procedural Interface

```text
ipworksiot_stomp_register_callback($res, 14, array($this, 'fireUnsubscribed'));
```

## Parameter List

```text
 'id' 'destination'
```

## Remarks

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

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

# Config Settings ([STOMP](#stomp-class) Class)

 The class accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the [Config](#config-method-ipworksiot_stomp-class) method.

### STOMP Config Settings

**AckTransactionId**: The transaction Id to include when sending a message acknowledgment.This configuration setting can be set during the [MessageIn](#messagein-event-ipworksiot_stomp-class) event handler to have the class use its value to add a *transaction* header to the outgoing message acknowledgment.

Note that the class won't send a message acknowledgment for messages which don't require one, and in such cases any value set to this configuration setting will be ignored.

This configuration setting can only be set while inside the [MessageIn](#messagein-event-ipworksiot_stomp-class) event handler, and is reset when the event handler ends.

**CollapseHeaders**: Whether the class should collapse headers on incoming messages.The configuration setting controls whether the class will collapse headers on incoming messages, keeping only the first instance of any headers with duplicate keys. The default is *True*.

Keep in mind that, even if this setting is disabled, STOMP servers are not required to pass through duplicate headers when delivering messages (i.e., some server may choose to discard duplicate headers before delivering a message).

Note that changing this setting will only affect messages received in the future.

**ErrorHeaders**: Raw headers from a STOMP 'ERROR' frame.If the [Error](#error-event-ipworksiot_stomp-class) event fires due to a STOMP protocol error (e.g., the *ErrorCode* event argument is *600*), this configuration setting will contain a plain-text list of headers from the ERROR frame, with one header per line, separated by CRLF (*"\r\n"*) .

**LogLevel**: The level of detail that is logged.This setting controls the level of detail that is logged through the [Log](#log-event-ipworksiot_stomp-class) event. Possible values are:

|  |  |
| --- | --- |
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data is logged. |
| 3 (Debug) | Debug data is logged. |

**OpenTransactions**: A comma-separated list of currently open transactions.This configuration setting can be queried to obtain a comma-separated list of Ids for all currently open transactions.

**ProtocolVersion**: The agreed-upon STOMP protocol version that the class is using.After connecting to a STOMP server, this configuration setting can be queried to determine which STOMP protocol version the class and server agreed to use. Return value will be a string like, e.g., *"1.2"*.

Note that this setting is read-only; to control which STOMP protocol versions the class advertises support for, set the [SupportedVersions](#SupportedVersions) configuration setting before connecting.

**RequestAckReceipts**: Whether the class should request receipts for any message acknowledgments that are sent.This configuration setting controls whether the class will request receipts from the server for any message acknowledgments that are sent. The default is *False*.

Refer to [RequestReceipts](#requestreceipts-property-ipworksiot_stomp-class) for general information about receipts, and refer to [Subscribe](#subscribe-method-ipworksiot_stomp-class) and [MessageIn](#messagein-event-ipworksiot_stomp-class) for more information about message acknowledgments.

**RequestSubscriptionReceipts**: Whether the class should request receipts when sending subscribe and unsubscribe requests.This configuration setting controls whether the class will request receipts from the server when subscription requests are sent using the [Subscribe](#subscribe-method-ipworksiot_stomp-class) and [Unsubscribe](#unsubscribe-method-ipworksiot_stomp-class) methods. The default is *False*.

Refer to [RequestReceipts](#requestreceipts-property-ipworksiot_stomp-class) for general information about receipts.

**RequestTransactionReceipts**: Whether the class should request receipts when sending begin, commit, and abort transaction requests.This configuration setting controls whether the class will request receipts from the server when transaction requests are sent using the [BeginTransaction](#begintransaction-method-ipworksiot_stomp-class), [CommitTransaction](#committransaction-method-ipworksiot_stomp-class), and [AbortTransaction](#aborttransaction-method-ipworksiot_stomp-class) methods. The default is *False*.

Refer to [RequestReceipts](#requestreceipts-property-ipworksiot_stomp-class) for general information about receipts.

**SendCustomFrame**: Sends a frame constructed using the supplied hex byte string.Setting this setting to a string with hex bytes will cause the class to construct and send a custom frame. This should not be necessary except for debugging purposes.

**ServerInfo**: Information about the currently connected server.This configuration setting can be queried after connecting to a STOMP server to obtain information about the server itself (similar to an HTTP user-agent).

Note that some STOMP servers may choose not to communicate server information, in which case this setting will not be populated.

**SessionId**: The server-assigned session Id.This configuration setting can be queried after connecting to a STOMP server to obtain the session Id value which the server assigned to this connection.

Note that some STOMP servers may choose not to assign a session Id, in which case this setting will not be populated.

**SupportedVersions**: Which STOMP protocol versions the class should advertise support for when connecting.This configuration setting is used to specify which versions of the STOMP protocol the class should advertise support for when connecting to the server. Valid values for this setting are:

- *"1.1,1.2"* (default)
- *"1.1"*
- *"1.2"*

The highest STOMP protocol version supported by both the class and server will be the one chosen. After connecting, the [ProtocolVersion](#ProtocolVersion) configuration setting can be queried to determine which protocol version was chosen.

Note: This setting can only be changed before connecting.

**VirtualHost**: The virtual host to connect to.This configuration setting can be set before connecting in order to explicitly specify a value to use for the *host* header in the CONNECT frame.

Note that, in most cases, this setting can be left empty, in which case the class will automatically set the *host* header in the CONNECT frame to match the value set to [RemoteHost](#remotehost-property-ipworksiot_stomp-class).

### TCPClient Config Settings

**ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use [Timeout](#timeout-property-ipworksiot_stomp-class) for establishing a connection and transmitting/receiving data.

**EnableFallback**: Whether to try the other addresses the remote host resolves to when a connection attempt fails.When set to True and [RemoteHost](#remotehost-property-ipworksiot_stomp-class) resolves to more than one address, the class will try the remaining addresses in turn if the connection to the first one fails, and only fails with an error once every address has been tried. The error reported is the one from the last attempt. Use [FallbackTimeout](#FallbackTimeout) to limit the total time spent.

NOTE: Only addresses of the same IP version as the first one are tried, this setting does not fall back from IPv6 to IPv4. Selecting between IPv6 and IPv4 is done by [UseIPv6](#UseIPv6) when the host is resolved.

This setting must be set before the connection is established. The default value for this setting is False.

**FallbackTimeout**: The maximum time in milliseconds to spend on connection attempts when EnableFallback is enabled.This setting limits the total time that the class will spend on all of the connection attempts made when [EnableFallback](#EnableFallback) is enabled. The default value is 0, in which case each attempt uses the operating system's own connection timeout.

NOTE: This setting only applies when [EnableFallback](#EnableFallback) is True. It is unrelated to [ConnectionTimeout](#ConnectionTimeout), which is specified in seconds and applies to the [Connected](#connected-property-ipworksiot_stomp-class) operation as a whole.

**FirewallAutoDetect**: Tells the class whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by classes that do not directly expose Firewall properties.

**FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting.

If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned.

NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.

**FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting.

**FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.

**FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value.

NOTE: This configuration setting is provided for use by classes that do not directly expose Firewall properties.

**FirewallType**: Determines the type of firewall to connect through.Possible values are as follows:

|  |  |
| --- | --- |
| 0 | No firewall (default setting). |
| 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. |
| 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. |
| 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. |
| 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. |

NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.

**FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.

NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.

**KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

NOTE: This value is not applicable in macOS.

**KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

**Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

**LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

**LocalHost**: The name of the local host through which connections are initiated or accepted. The [LocalHost](#localhost-property-ipworksiot_stomp-class) setting 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 value of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface.

If the class is connected, the [LocalHost](#localhost-property-ipworksiot_stomp-class) setting 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).

**LocalPort**: The port in the local host where the class binds. This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by [LocalPort](#localport-property-ipworksiot_stomp-class) after the connection is established.

[LocalPort](#localport-property-ipworksiot_stomp-class) cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

**MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the DataIn event is fired with the *EOL* parameter set to True, and the buffer is reset.

If no EOL is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the DataIn event is fired with the *EOL* parameter set to False, and the buffer is reset.

The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes.

**MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

**ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

*www.google.com;www.example.com*

**TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets.

NOTE: This value is not applicable in Java.

**TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

**UseIPv6**: Whether to use IPv6.When set to *0* (default), the class will use IPv4 exclusively. When set to *1*, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows:

|  |  |
| --- | --- |
| 0 | IPv4 only |
| 1 | IPv6 only |
| 2 | IPv6 with IPv4 fallback |

**UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1.

### SSL Config Settings

**LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [SSLProvider](#sslprovider-property-ipworksiot_stomp-class) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes.

When enabled, SSL packet logs are output using the [SSLStatus](#sslstatus-event-ipworksiot_stomp-class) event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if [SSLProvider](#sslprovider-property-ipworksiot_stomp-class) is set to *Platform*.

**OpenSSLCADir**: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

**OpenSSLCAFile**: Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:

 -----BEGIN CERTIFICATE-----

 ... (CA certificate in base64 encoding) ...

 -----END CERTIFICATE-----

 Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

**OpenSSLCipherList**: A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

**OpenSSLPrngSeedData**: The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL.

By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

**ReuseSSLSession**: Determines if the SSL session is reused.

If set to True, the class will reuse the context if and only if the following criteria are met:

- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the class is the same.

**SSLCACertFilePaths**: The paths to CA certificate files on Unix/Linux.This configuration setting specifies the paths on disk to CA certificate files on Unix/Linux.

The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.

The default value is as follows:

*/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem*

**SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [SSLProvider](#sslprovider-property-ipworksiot_stomp-class) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the SSLCert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

**SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the class will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error.

When set to 0 (default), the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

**SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the class fails with an error.

When set to 0 (default), the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.

This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.

**SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [SSLStatus](#sslstatus-event-ipworksiot_stomp-class) event.

Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting.

**SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

**SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when [SSLProvider](#sslprovider-property-ipworksiot_stomp-class) is set to *Platform* include the following:

```text
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
```

 Possible values when [SSLProvider](#sslprovider-property-ipworksiot_stomp-class) is set to *Platform* include the following:

- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF

 Example values when [SSLProvider](#sslprovider-property-ipworksiot_stomp-class) is set to *Internal*include the following:

```text
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
```

 Possible values when [SSLProvider](#sslprovider-property-ipworksiot_stomp-class) is set to *Internal* include the following:

- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see [SSLEnabledProtocols](#SSLEnabledProtocols)), only the following cipher suites are supported:

- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256

[SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength).

**SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols.

Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values:

|  |  |
| --- | --- |
| TLS1.3 | 12288 (Hex 3000) |
| TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
| TLS1.1 | 768 (Hex 300) (Default - Client) |
| TLS1 | 192 (Hex C0) (Default - Client) |
| SSL3 | 48 (Hex 30) |
| SSL2 | 12 (Hex 0C) |

Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.

**SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:**

By default when TLS 1.3 is enabled, the class will first try to use the platform TLS 1.3 implementation when the [SSLProvider](#sslprovider-property-ipworksiot_stomp-class) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

In editions that are designed to run on Windows, [SSLProvider](#sslprovider-property-ipworksiot_stomp-class) can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to *1* (Platform provider), please be aware of the following notes:

- The platform provider is available only on Windows 11/Windows Server 2022 and up.
- [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported.
- If [SSLEnabledProtocols](#SSLEnabledProtocols) includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

**SSLEnabledProtocols: SSL2 and SSL3 Notes: **

SSL 2.0 and 3.0 are not supported by the class when the [SSLProvider](#sslprovider-property-ipworksiot_stomp-class) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [SSLProvider](#sslprovider-property-ipworksiot_stomp-class) needs to be set to platform.

**SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *false* by default, but it can be set to *true* to enable the extension.

This configuration setting is applicable only when [SSLProvider](#sslprovider-property-ipworksiot_stomp-class) is set to *Internal*.

**SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-ipworksiot_stomp-class) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-ipworksiot_stomp-class) event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the [SSLServerAuthentication](#sslserverauthentication-event-ipworksiot_stomp-class) event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

**SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.

NOTE: This configuration setting is applicable only when [SSLProvider](#sslprovider-property-ipworksiot_stomp-class) is set to *Internal*.

**SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipher[connId]");
```

**SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipherStrength[connId]");
```

**SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipherSuite[connId]");
```

**SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedKeyExchange[connId]");
```

**SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
```

**SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedVersion[connId]");
```

**SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:

|  |  |
| --- | --- |
| 0x00000001 | Ignore time validity status of certificate. |
| 0x00000002 | Ignore time validity status of CTL. |
| 0x00000004 | Ignore non-nested certificate times. |
| 0x00000010 | Allow unknown certificate authority. |
| 0x00000020 | Ignore wrong certificate usage. |
| 0x00000100 | Ignore unknown certificate revocation status. |
| 0x00000200 | Ignore unknown CTL signer revocation status. |
| 0x00000400 | Ignore unknown certificate authority revocation status. |
| 0x00000800 | Ignore unknown root revocation status. |
| 0x00008000 | Allow test root certificate. |
| 0x00004000 | Trust test root certificate. |
| 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). |

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

**SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

**TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [SSLProvider](#sslprovider-property-ipworksiot_stomp-class) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2.

When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class fails with an error.

The format of this value is a comma-separated list of hash-signature combinations. For instance:

```csharp
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
```

 The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*.

To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

**TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC.

The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*.

When using TLS 1.2 and [SSLProvider](#sslprovider-property-ipworksiot_stomp-class) is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported:

- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)

**TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting.

NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.

In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so.

The default value is *ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072*

The values are ordered from most preferred to least preferred. The following values are supported:

- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"

**TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:

- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)

 The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3.

**TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so.

The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*

The values are ordered from most preferred to least preferred. The following values are supported:

- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
- "mlkem_512" (default)
- "mlkem_768" (default)
- "mlkem_1024" (default)
- "x25519_mlkem_768" (default)
- "secp256r1_mlkem_768" (default)

Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported:

-  Windows Server 2025
-  Windows 11 24H2
-  Windows 11 25H2

### Socket Config Settings

**AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [Timeout](#timeout-property-ipworksiot_stomp-class) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout.

NOTE: This option is not valid for User Datagram Protocol (UDP) ports.

**FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).

**InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

**OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

### Base Config Settings

**BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build.

**CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

|  |  |
| --- | --- |
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |

 The following is a list of valid code page identifiers for Mac OS only:

|  |  |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**ProcessIdleEvents**: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

**SelectWaitMillis**: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when [DoEvents](#doevents-method-ipworksiot_stomp-class) is called, the class will wait for the amount of time specified here before returning. The default value is 20.

**UseFIPSCompliantAPI**: Tells the class whether or not to use FIPS certified APIs.When set to *true*, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries.

FIPS mode can be enabled by setting the *UseFIPSCompliantAPI* configuration setting to *true*. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details, please see the [FIPS 140-2 Compliance](https://www.nsoftware.com/kb/articles/fips.rst) article.

NOTE: This setting is applicable only on Windows.

NOTE: Enabling FIPS compliance requires a special license; please contact [sales@nsoftware.com](mailto:sales@nsoftware.com) for details.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries.

 On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default.

 To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section.

# Trappable Errors ([STOMP](#stomp-class) Class)

### STOMP Errors

|  |  |
| --- | --- |
| 600 | STOMP protocol error. Refer to the error message for more information. |
| 601 | Malformed STOMP frame received. Refer to error message for more information. |
| 602 | Invalid value provided for the [SupportedVersions](#SupportedVersions) configuration setting. |
| 603 | Invalid subscription Id provided. Refer to error message for more information. |
| 604 | Invalid transaction Id provided. Refer to error message for more information. |

### TCPClient Errors

|  |  |
| --- | --- |
| 100 | You cannot change the [RemotePort](#remoteport-property-ipworksiot_stomp-class) at this time. A connection is in progress. |
| 101 | You cannot change the [RemoteHost](#remotehost-property-ipworksiot_stomp-class) (Server) at this time. A connection is in progress. |
| 102 | The [RemoteHost](#remotehost-property-ipworksiot_stomp-class) address is invalid (0.0.0.0). |
| 104 | Already connected. If you want to reconnect, close the current connection first. |
| 106 | You cannot change the [LocalPort](#localport-property-ipworksiot_stomp-class) at this time. A connection is in progress. |
| 107 | You cannot change the [LocalHost](#localhost-property-ipworksiot_stomp-class) at this time. A connection is in progress. |
| 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. |
| 116 | [RemotePort](#remoteport-property-ipworksiot_stomp-class) cannot be zero. Please specify a valid service port number. |
| 117 | You cannot change the UseConnection option while the class is active. |
| 135 | Operation would block. |
| 201 | Timeout. |
| 211 | Action impossible in control's present state. |
| 212 | Action impossible while not connected. |
| 213 | Action impossible while listening. |
| 301 | Timeout. |
| 302 | Could not open file. |
| 434 | Unable to convert string to selected CodePage. |
| 1105 | Already connecting. If you want to reconnect, close the current connection first. |
| 1117 | You need to connect first. |
| 1119 | You cannot change the LocalHost at this time. A connection is in progress. |
| 1120 | Connection dropped by remote host. |

### SSL Errors

|  |  |
| --- | --- |
| 270 | Cannot load specified security library. |
| 271 | Cannot open certificate store. |
| 272 | Cannot find specified certificate. |
| 273 | Cannot acquire security credentials. |
| 274 | Cannot find certificate chain. |
| 275 | Cannot verify certificate chain. |
| 276 | Error during handshake. |
| 280 | Error verifying certificate. |
| 281 | Could not find client certificate. |
| 282 | Could not find server certificate. |
| 283 | Error encrypting data. |
| 284 | Error decrypting data. |

### TCP/IP Errors

|  |  |
| --- | --- |
| 10004 | [10004] Interrupted system call. |
| 10009 | [10009] Bad file number. |
| 10013 | [10013] Access denied. |
| 10014 | [10014] Bad address. |
| 10022 | [10022] Invalid argument. |
| 10024 | [10024] Too many open files. |
| 10035 | [10035] Operation would block. |
| 10036 | [10036] Operation now in progress. |
| 10037 | [10037] Operation already in progress. |
| 10038 | [10038] Socket operation on nonsocket. |
| 10039 | [10039] Destination address required. |
| 10040 | [10040] Message is too long. |
| 10041 | [10041] Protocol wrong type for socket. |
| 10042 | [10042] Bad protocol option. |
| 10043 | [10043] Protocol is not supported. |
| 10044 | [10044] Socket type is not supported. |
| 10045 | [10045] Operation is not supported on socket. |
| 10046 | [10046] Protocol family is not supported. |
| 10047 | [10047] Address family is not supported by protocol family. |
| 10048 | [10048] Address already in use. |
| 10049 | [10049] Cannot assign requested address. |
| 10050 | [10050] Network is down. |
| 10051 | [10051] Network is unreachable. |
| 10052 | [10052] Net dropped connection or reset. |
| 10053 | [10053] Software caused connection abort. |
| 10054 | [10054] Connection reset by peer. |
| 10055 | [10055] No buffer space available. |
| 10056 | [10056] Socket is already connected. |
| 10057 | [10057] Socket is not connected. |
| 10058 | [10058] Cannot send after socket shutdown. |
| 10059 | [10059] Too many references, cannot splice. |
| 10060 | [10060] Connection timed out. |
| 10061 | [10061] Connection refused. |
| 10062 | [10062] Too many levels of symbolic links. |
| 10063 | [10063] File name is too long. |
| 10064 | [10064] Host is down. |
| 10065 | [10065] No route to host. |
| 10066 | [10066] Directory is not empty |
| 10067 | [10067] Too many processes. |
| 10068 | [10068] Too many users. |
| 10069 | [10069] Disc Quota Exceeded. |
| 10070 | [10070] Stale NFS file handle. |
| 10071 | [10071] Too many levels of remote in path. |
| 10091 | [10091] Network subsystem is unavailable. |
| 10092 | [10092] WINSOCK DLL Version out of range. |
| 10093 | [10093] Winsock is not loaded yet. |
| 11001 | [11001] Host not found. |
| 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
| 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
| 11004 | [11004] Valid name, no data record (check DNS setup). |