# Struct ipworksiot::MQTTBroker

A lightweight, fully-featured MQTT broker implementation.

## Syntax

```text
ipworksiot::MQTTBroker
```

## Remarks

The MQTTBroker struct provides a lightweight, fully-featured MQTT broker implementation with support for version 3.1.1. The struct supports plaintext and TLS-enabled connections over both standard TCP and WebSockets.

### Configuring Listeners

 The [add_broker_listener](#add_broker_listener-method-mqttbroker-struct) method adds a new listener to the listeners collection. Any listeners must be configured before starting the broker. Multiple protocols can be supported by adding different listeners.

The struct supports the following protocols:

|  |  |
| --- | --- |
| 0 (mbpTCP) | Plaintext TCP |
| 1 (mbpTLS) | SSL/TLS over TCP |
| 2 (mbpWS) | Plaintext WebSocket |
| 3 (mbpWSS) | SSL/TLS over WebSocket |

Multiple protocols can be enabled (each on a different port):

```csharp
// Plaintext TCP
mqttbroker.AddBrokerListener("127.0.0.1", PLAIN_PORT, (int)MQTTBrokerProtocols.mbpTCP, 0, null, null, null);
// TCP with TLS
mqttbroker.AddBrokerListener("127.0.0.1", SSL_PORT, (int)MQTTBrokerProtocols.mbpTLS, (int)CertStoreTypes.cstPFXFile, "test1.pfx", "test", "*");
// Plaintext WebSocket
mqttbroker.AddBrokerListener("127.0.0.1", WS_PORT, (int)MQTTBrokerProtocols.mbpWS, 0, null, null, null);
// WebSocket with TLS
mqttbroker.AddBrokerListener("127.0.0.1", WSS_PORT, (int)MQTTBrokerProtocols.mbpWSS, (int)CertStoreTypes.cstPFXFile, "test2.pfx", "test", "*");
```

 Once all listeners have been added, the broker can be started via the [start_listening](#start_listening-method-mqttbroker-struct) method.

### Handling Sessions

 When an MQTT client requests a session, the [on_session_request](#on_session_request-event-mqttbroker-struct) event will fire with session details. The *UserName* and *Password* parameters can be checked before setting *Accept* to True to accept the session request. *Accept* can be set to False to reject the session request.

```csharp
broker.OnSessionRequest += (s,e) => {
  // Check e.UserName and e.Password if needed
  // Set Accept to true to accept the session request
  e.Accept = true;
};
```

### Handling Subscriptions

 When an MQTT client requests to subscribe to a topic, the [on_subscribe](#on_subscribe-event-mqttbroker-struct) event will fire.

The *ClientId* is used to identify this client in subsequent actions.

The *TopicFilter* is the requested topic the client wishes to subscribe to.

The *RequestedQoS* is the client's preferred QoS level.

*ReturnCode* is used to confirm the maximum QoS level granted for this subscription or indicate a failure. This can be less than the client's *RequestedQoS*.

|  |  |
| --- | --- |
| 0x00 | Success - Maximum QoS 0 |
| 0x01 | Success - Maximum QoS 1 |
| 0x02 | Success - Maximum QoS 2 |
| 0x80 | Failure |

 When a client requests to unsubscribe from a topic, the [on_unsubscribe](#on_unsubscribe-event-mqttbroker-struct) event will fire, specifying which *TopicFilter* the client is unsubscribing from.

### Incoming Messages

 The MQTTBroker struct will automatically forward received messages to any subscribed clients. Events can be used to record the state of any incoming messages.

The [on_message_receiving](#on_message_receiving-event-mqttbroker-struct) event fires when a message is initially received and contains message metadata.

The [on_incoming_message_status](#on_incoming_message_status-event-mqttbroker-struct) event fires each time an incoming message's state is updated.

- MessageId: A unique identifier for this message.
- DUP: Whether or not the server has indicated that this message is a duplicate of another message received previously.
- QoS: The message's QoS level.
- Retain: Whether or not this message was received as a result of subscribing to a topic.
- PacketId: The message packet Id. This will always be -1 if QoS is 0.
- State: Information about the incoming message's state.

  - 6 - For an incoming QoS 1 message, which has been received from the client, but prior to sending the PUBACK for it. When the PUBACK is sent, the state will change to 10.
  - 7 - For an incoming QoS 2 message, which has been received from a client, but prior to sending the PUBREC for it,
  - 8 - For an incoming QoS 2 message, which has sent the PUBREC, but waiting to receive the PUBREL for it.
  - 9 - For an incoming QoS 2 message, which has received the PUBREL, but prior to sending the PUBCOMP for it. When the PUBCOMP is sent, the state will change to 10.
  - 10 - Message successfully received.

 The [on_message_received](#on_message_received-event-mqttbroker-struct) event fires when the message has completed the acknowledgment process with the client, depending on the QoS level.

### Outgoing Messages

 The MQTTBroker struct will automatically forward received messages to any subscribed clients. Events can be used to record the state of any incoming messages.

The [on_message_sending](#on_message_sending-event-mqttbroker-struct) event fires when a message is initially sent to a client and contains message metadata.

The [on_outgoing_message_status](#on_outgoing_message_status-event-mqttbroker-struct) event fires each time an outgoing message's state is updated.

- MessageId: A unique identifier for this message.
- DUP: Whether or not the server has indicated that this message is a duplicate of another message sent previously.
- QoS: The message's QoS level.
- Retain: Whether or not this message is a retained message.
- PacketId: The message packet Id. This will always be -1 if QoS is 0.
- State: Information about the outgoing message's state.

  - 1 - Outgoing message is waiting to be sent
  - 2 - For an outgoing QoS 1 message, which has been sent to the client and waiting for the PUBACK. When the PUBACK is received, the state will change to 10.
  - 3 - For an outgoing QoS 2 message, which has been sent to the client and waiting for the PUBREC.
  - 4 - For an outgoing QoS 2 message, which has received the PUBREC, prior to sending the PUBREL for it.
  - 5 - For an outgoing QoS 2 message, which has sent the PUBREL. When the PUBCOMP is received, the state will change to 10.
  - 10 - Message successfully sent.

### Saving and Loading Sessions

 The [save_session](#save_session-method-mqttbroker-struct) method saves the current state of a client session, including message queues and subscription data, for later retrieval.

[save_session](#save_session-method-mqttbroker-struct) returns a JSON string representing the client's subscriptions and messages. This can later be loaded via [load_session](#load_session-method-mqttbroker-struct) to restore the client's state.

The format should be a JSON string with the following parameters:

```csharp
string sessiondata = broker.SaveSession("Client1");
// sessiondata may contain a JSON string with information like this:
{
  "ClientId":"Client1",
  "Subscriptions":[{      // A collection of the client's subscribed topics
    "Topic":"topic name",
    "QoS":2,
  }],
  "IncomingMessages": [{  // A collection of incoming messages
    "MessageId":1,        // The incoming message's ID
    "Topic":"A",          // The incoming message's topic
    "Payload":"54657374", // hexadecimal message payload
    "QoS":2,              // The incoming message's QoS level
    "DUP":false,          // Whether this message is a duplicate
    "Retain":false,       // Whether this is a retained message
    "PacketId":1,         // This message's packet ID
    "State":3             // See IncomingMessageStatus event for State details
    }],
  "OutgoingMessages":[{   // A collection of outgoing messages
    "MessageId":2,
    "Topic":"A",
    "Payload":"54657374",
    "QoS":2,
    "DUP":false,
    "Retain":false,
    "PacketId":2,
    "State":3             // See OutgoingMessageStatus event for State details
    }]
}
// Later, the LoadSession method can be used to load the session data
broker.LoadSession(sessiondata);
```

### Object Lifetime

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

## Property List

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

|  |  |
| --- | --- |
| [connection_count](#connection_count-property-mqttbroker-struct) | The number of records in the Connection arrays. |
| [connection_client_id](#connection_client_id-property-mqttbroker-struct) | A unique identifier for the client. |
| [connection_id](#connection_id-property-mqttbroker-struct) | This property contains an identifier generated by the struct to identify each connection. |
| [connection_keep_alive](#connection_keep_alive-property-mqttbroker-struct) | When set to 1, KEEPALIVE packets are enabled (for long connections). |
| [connection_local_host](#connection_local_host-property-mqttbroker-struct) | This property shows the IP address of the interface through which the connection is passing. |
| [connection_local_port](#connection_local_port-property-mqttbroker-struct) | This property shows the Transmission Control Protocol (TCP) port on the local host through which the connection is passing. |
| [connection_protocol](#connection_protocol-property-mqttbroker-struct) | The protocol of the connected client. |
| [connection_remote_host](#connection_remote_host-property-mqttbroker-struct) | This property shows the IP address of the remote host through which the connection is coming. |
| [connection_remote_port](#connection_remote_port-property-mqttbroker-struct) | This property shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming. |
| [connection_user_name](#connection_user_name-property-mqttbroker-struct) | The username for this connected client. |
| [default_idle_timeout](#default_idle_timeout-property-mqttbroker-struct) | This property includes the default idle timeout for inactive clients. |
| [listener_count](#listener_count-property-mqttbroker-struct) | The number of records in the Listener arrays. |
| [listener_local_host](#listener_local_host-property-mqttbroker-struct) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| [listener_local_port](#listener_local_port-property-mqttbroker-struct) | This property includes the port in the local host for this listener. |
| [listener_protocol](#listener_protocol-property-mqttbroker-struct) | The struct supports the following protocols: 0 (mbpTCP) Plaintext TCP 1 (mbpTLS) SSL/TLS over TCP 2 (mbpWS) Plaintext WebSocket 3 (mbpWSS) SSL/TLS over WebSocket . |
| [listener_ssl_authenticate_clients](#listener_ssl_authenticate_clients-property-mqttbroker-struct) | If set to True, the server asks the client(s) for a certificate. |
| [listener_ssl_cert_store](#listener_ssl_cert_store-property-mqttbroker-struct) | The name of the certificate store for the listener's certificate. |
| [listener_ssl_cert_store_password](#listener_ssl_cert_store_password-property-mqttbroker-struct) | This is the password of the SSL certificate. |
| [listener_ssl_cert_store_type](#listener_ssl_cert_store_type-property-mqttbroker-struct) | This is the type of certificate store for this certificate. |
| [listener_ssl_cert_subject](#listener_ssl_cert_subject-property-mqttbroker-struct) | The subject of the SSL certificate. |
| [listening](#listening-property-mqttbroker-struct) | This property indicates whether the struct is listening for incoming connections on LocalPort. |
| [message_count](#message_count-property-mqttbroker-struct) | The number of records in the Message arrays. |
| [message_id](#message_id-property-mqttbroker-struct) | Message identifier used to associate the message state. |
| [message_payload](#message_payload-property-mqttbroker-struct) | This message's raw data payload. |
| [message_topic](#message_topic-property-mqttbroker-struct) | This message's topic. |
| [session_count](#session_count-property-mqttbroker-struct) | The number of records in the Session arrays. |
| [session_client_id](#session_client_id-property-mqttbroker-struct) | A unique identifier for the client. |
| [session_incoming_messages](#session_incoming_messages-property-mqttbroker-struct) | A collection of incoming messages. |
| [session_outgoing_messages](#session_outgoing_messages-property-mqttbroker-struct) | A collection of outgoing messages. |
| [session_sub_granted_qo_s](#session_sub_granted_qo_s-property-mqttbroker-struct) | The subscription's granted QoS level for the client. |
| [session_sub_topic_filters](#session_sub_topic_filters-property-mqttbroker-struct) | The subscription topic filters for this client session. |
| [ssl_provider](#ssl_provider-property-mqttbroker-struct) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |

## Method List

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

|  |  |
| --- | --- |
| [add_broker_listener](#add_broker_listener-method-mqttbroker-struct) | Creates a new listener for the broker service. |
| [config](#config-method-mqttbroker-struct) | Sets or retrieves a configuration setting. |
| [disconnect](#disconnect-method-mqttbroker-struct) | This method disconnects the specified client. |
| [do_events](#do_events-method-mqttbroker-struct) | This method processes events from the internal message queue. |
| [interrupt](#interrupt-method-mqttbroker-struct) | This method interrupts a synchronous send to the remote host. |
| [load_session](#load_session-method-mqttbroker-struct) | Restores session data for a specified client, enabling resumption of pending operations or message delivery. |
| [reset](#reset-method-mqttbroker-struct) | This method will reset the struct. |
| [save_session](#save_session-method-mqttbroker-struct) | Saves the current state of a client session, including message queues and subscription data, for later retrieval. |
| [shutdown](#shutdown-method-mqttbroker-struct) | This method shuts down the server. |
| [start_listening](#start_listening-method-mqttbroker-struct) | This method starts listening for incoming connections. |
| [stop_listening](#stop_listening-method-mqttbroker-struct) | This method stops listening for new connections. |

## Event List

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

|  |  |
| --- | --- |
| [on_connected](#on_connected-event-mqttbroker-struct) | This event is fired immediately after a connection completes (or fails). |
| [on_connection_request](#on_connection_request-event-mqttbroker-struct) | This event is fired when a request for connection comes from a remote host. |
| [on_disconnected](#on_disconnected-event-mqttbroker-struct) | This event is fired when a connection is closed. |
| [on_error](#on_error-event-mqttbroker-struct) | This event fires information about errors during data delivery. |
| [on_incoming_message_status](#on_incoming_message_status-event-mqttbroker-struct) | Fires when an incoming message's state is updated. |
| [on_log](#on_log-event-mqttbroker-struct) | Fires once for each log message. |
| [on_message_received](#on_message_received-event-mqttbroker-struct) | Fires when a new message is received from a client. |
| [on_message_receiving](#on_message_receiving-event-mqttbroker-struct) | Fires when a message is initially received from a client. |
| [on_message_sending](#on_message_sending-event-mqttbroker-struct) | Fires when a message is initially sent to a client. |
| [on_message_sent](#on_message_sent-event-mqttbroker-struct) | Fires after a message is successfully delivered to a client, confirming transmission. |
| [on_outgoing_message_status](#on_outgoing_message_status-event-mqttbroker-struct) | Fired to provide the current delivery status of an outgoing message. Includes success or failure metadata. |
| [on_session_removed](#on_session_removed-event-mqttbroker-struct) | Fired when a client session is removed, indicating all resources associated with the session are cleaned up. |
| [on_session_request](#on_session_request-event-mqttbroker-struct) | Fires when a new session is requested. |
| [on_ssl_client_authentication](#on_ssl_client_authentication-event-mqttbroker-struct) | This event is fired when the client presents its credentials to the server. |
| [on_ssl_status](#on_ssl_status-event-mqttbroker-struct) | This event is fired to show the progress of the secure connection. |
| [on_subscribe](#on_subscribe-event-mqttbroker-struct) | Fires when a client requests to subscribe to a topic. |
| [on_unsubscribe](#on_unsubscribe-event-mqttbroker-struct) | Fires when a client unsubscribes from a topic, removing its subscription data. |

## Config Settings

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

|  |  |
| --- | --- |
| [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. |
| [FirewallAutoDetect](#FirewallAutoDetect) | Tells the struct 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 struct 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. |
| [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. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# connection_count property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

The number of records in the Connection arrays.

## Syntax

*Rust Syntax*

```text
fn connection_count(&self ) -> Result<i32, IPWorksIoTError>
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [connection_client_id](#connection_client_id-property-mqttbroker-struct)
- [connection_id](#connection_id-property-mqttbroker-struct)
- [connection_keep_alive](#connection_keep_alive-property-mqttbroker-struct)
- [connection_local_host](#connection_local_host-property-mqttbroker-struct)
- [connection_local_port](#connection_local_port-property-mqttbroker-struct)
- [connection_protocol](#connection_protocol-property-mqttbroker-struct)
- [connection_remote_host](#connection_remote_host-property-mqttbroker-struct)
- [connection_remote_port](#connection_remote_port-property-mqttbroker-struct)
- [connection_user_name](#connection_user_name-property-mqttbroker-struct)

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

This property is read-only.

## Data Type

i32

# connection_client_id property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

A unique identifier for the client.

## Syntax

*Rust Syntax*

```text
fn connection_client_id(&self , ConnectionId : i32) -> Result<String, IPWorksIoTError>
```

## Default Value

""

## Remarks

A unique identifier for the client.

The *ConnectionId* parameter specifies the index of the item in the array. The size of the array is controlled by the [ConnectionCount](#connection_count-property-mqttbroker-struct) property.

This property is read-only.

## Data Type

String

# connection_id property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

This property contains an identifier generated by the struct to identify each connection.

## Syntax

*Rust Syntax*

```text
fn connection_id(&self , ConnectionId : i32) -> Result<i32, IPWorksIoTError>
```

## Default Value

0

## Remarks

This field contains an identifier generated by the component to identify each connection. This identifier is unique to this connection.

The *ConnectionId* parameter specifies the index of the item in the array. The size of the array is controlled by the [ConnectionCount](#connection_count-property-mqttbroker-struct) property.

This property is read-only.

## Data Type

i32

# connection_keep_alive property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

When set to 1, KEEPALIVE packets are enabled (for long connections).

## Syntax

*Rust Syntax*

```text
fn connection_keep_alive(&self , ConnectionId : i32) -> Result<i32, IPWorksIoTError>
```

## Default Value

0

## Remarks

When set to 1, KEEPALIVE packets are enabled (for long connections).

This property enables the SO_KEEPALIVE option on the incoming connections. This option prevents long connections from timing out in case of inactivity.

NOTE: System Transmission Control Protocol (TCP)/IP stack implementations are not required to support SO_KEEPALIVE.

This property is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified.

The *ConnectionId* parameter specifies the index of the item in the array. The size of the array is controlled by the [ConnectionCount](#connection_count-property-mqttbroker-struct) property.

This property is read-only.

## Data Type

i32

# connection_local_host property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

This property shows the IP address of the interface through which the connection is passing.

## Syntax

*Rust Syntax*

```text
fn connection_local_host(&self , ConnectionId : i32) -> Result<String, IPWorksIoTError>
```

## Default Value

""

## Remarks

This field shows the IP address of the interface through which the connection is passing.

LocalAddress is important for multihomed hosts so that it can be used to find the particular network interface through which an individual connection is going.

The *ConnectionId* parameter specifies the index of the item in the array. The size of the array is controlled by the [ConnectionCount](#connection_count-property-mqttbroker-struct) property.

This property is read-only.

## Data Type

String

# connection_local_port property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

This property shows the Transmission Control Protocol (TCP) port on the local host through which the connection is passing.

## Syntax

*Rust Syntax*

```text
fn connection_local_port(&self , ConnectionId : i32) -> Result<i32, IPWorksIoTError>
```

## Default Value

0

## Remarks

This field shows the Transmission Control Protocol (TCP) port on the local host through which the connection is passing.

The *ConnectionId* parameter specifies the index of the item in the array. The size of the array is controlled by the [ConnectionCount](#connection_count-property-mqttbroker-struct) property.

This property is read-only.

## Data Type

i32

# connection_protocol property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

The protocol of the connected client.

## Syntax

*Rust Syntax*

```text
fn connection_protocol(&self , ConnectionId : i32) -> Result<i32, IPWorksIoTError>
```

## Possible Values

```text
0   // TCP1   // TLS2   // WS3   // WSS
```

## Default Value

0

## Remarks

The protocol of the connected client.

The struct supports the following protocols:

|  |  |
| --- | --- |
| 0 (mbpTCP) | Plaintext TCP |
| 1 (mbpTLS) | SSL/TLS over TCP |
| 2 (mbpWS) | Plaintext WebSocket |
| 3 (mbpWSS) | SSL/TLS over WebSocket |

The *ConnectionId* parameter specifies the index of the item in the array. The size of the array is controlled by the [ConnectionCount](#connection_count-property-mqttbroker-struct) property.

This property is read-only.

## Data Type

i32

# connection_remote_host property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

This property shows the IP address of the remote host through which the connection is coming.

## Syntax

*Rust Syntax*

```text
fn connection_remote_host(&self , ConnectionId : i32) -> Result<String, IPWorksIoTError>
```

## Default Value

""

## Remarks

This field shows the IP address of the remote host through which the connection is coming.

The connection must be valid or an error will be fired.

If the component 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.

The *ConnectionId* parameter specifies the index of the item in the array. The size of the array is controlled by the [ConnectionCount](#connection_count-property-mqttbroker-struct) property.

This property is read-only.

## Data Type

String

# connection_remote_port property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

This property shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming.

## Syntax

*Rust Syntax*

```text
fn connection_remote_port(&self , ConnectionId : i32) -> Result<i32, IPWorksIoTError>
```

## Default Value

0

## Remarks

This field shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming.

The connection must be valid or an error will be fired.

The *ConnectionId* parameter specifies the index of the item in the array. The size of the array is controlled by the [ConnectionCount](#connection_count-property-mqttbroker-struct) property.

This property is read-only.

## Data Type

i32

# connection_user_name property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

The username for this connected client.

## Syntax

*Rust Syntax*

```text
fn connection_user_name(&self , ConnectionId : i32) -> Result<String, IPWorksIoTError>
```

## Default Value

""

## Remarks

The username for this connected client.

The *ConnectionId* parameter specifies the index of the item in the array. The size of the array is controlled by the [ConnectionCount](#connection_count-property-mqttbroker-struct) property.

This property is read-only.

## Data Type

String

# default_idle_timeout property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

This property includes the default idle timeout for inactive clients.

## Syntax

*Rust Syntax*

```text
fn default_idle_timeout(&self ) -> Result<i32, IPWorksIoTError> fn set_default_idle_timeout(&self, value : i32) ->  Option<IPWorksIoTError>
```

## Default Value

0

## Remarks

This property specifies the idle timeout (in seconds) for clients. When set to a positive value, the struct will disconnect idle clients after the specified timeout.

This applies only to clients that have not sent or received data within default_idle_timeout seconds.

If set to 0 (default), no idle timeout is applied.

NOTE: [do_events](#do_events-method-mqttbroker-struct) must be called for the struct to check existing connections.

## Data Type

i32

# listener_count property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

The number of records in the Listener arrays.

## Syntax

*Rust Syntax*

```text
fn listener_count(&self ) -> Result<i32, IPWorksIoTError>
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [listener_local_host](#listener_local_host-property-mqttbroker-struct)
- [listener_local_port](#listener_local_port-property-mqttbroker-struct)
- [listener_protocol](#listener_protocol-property-mqttbroker-struct)
- [listener_ssl_authenticate_clients](#listener_ssl_authenticate_clients-property-mqttbroker-struct)
- [listener_ssl_cert_store](#listener_ssl_cert_store-property-mqttbroker-struct)
- [listener_ssl_cert_store_password](#listener_ssl_cert_store_password-property-mqttbroker-struct)
- [listener_ssl_cert_store_type](#listener_ssl_cert_store_type-property-mqttbroker-struct)
- [listener_ssl_cert_subject](#listener_ssl_cert_subject-property-mqttbroker-struct)

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

This property is read-only.

## Data Type

i32

# listener_local_host property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

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

## Syntax

*Rust Syntax*

```text
fn listener_local_host(&self , ListenerIndex : i32) -> Result<String, IPWorksIoTError>
```

## Default Value

""

## Remarks

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

The *ListenerIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ListenerCount](#listener_count-property-mqttbroker-struct) property.

This property is read-only.

## Data Type

String

# listener_local_port property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

This property includes the port in the local host for this listener.

## Syntax

*Rust Syntax*

```text
fn listener_local_port(&self , ListenerIndex : i32) -> Result<i32, IPWorksIoTError>
```

## Default Value

0

## Remarks

This field includes the port in the local host for this listener.

The *ListenerIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ListenerCount](#listener_count-property-mqttbroker-struct) property.

This property is read-only.

## Data Type

i32

# listener_protocol property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

The struct supports the following protocols: 0 (mbpTCP) Plaintext TCP 1 (mbpTLS) SSL/TLS over TCP 2 (mbpWS) Plaintext WebSocket 3 (mbpWSS) SSL/TLS over WebSocket .

## Syntax

*Rust Syntax*

```text
fn listener_protocol(&self , ListenerIndex : i32) -> Result<i32, IPWorksIoTError>
```

## Possible Values

```text
0   // TCP1   // TLS2   // WS3   // WSS
```

## Default Value

0

## Remarks

The struct supports the following protocols:

|  |  |
| --- | --- |
| 0 (mbpTCP) | Plaintext TCP |
| 1 (mbpTLS) | SSL/TLS over TCP |
| 2 (mbpWS) | Plaintext WebSocket |
| 3 (mbpWSS) | SSL/TLS over WebSocket |

The *ListenerIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ListenerCount](#listener_count-property-mqttbroker-struct) property.

This property is read-only.

## Data Type

i32

# listener_ssl_authenticate_clients property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

If set to True, the server asks the client(s) for a certificate.

## Syntax

*Rust Syntax*

```text
fn listener_ssl_authenticate_clients(&self , ListenerIndex : i32) -> Result<bool, IPWorksIoTError>
```

## Default Value

false

## Remarks

If set to True, the server asks the client(s) for a certificate.

This is used in conjunction with the on_ssl_client_authentication event. Please refer to the documentation of the on_ssl_client_authentication event for details.

The *ListenerIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ListenerCount](#listener_count-property-mqttbroker-struct) property.

This property is read-only.

## Data Type

bool

# listener_ssl_cert_store property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

The name of the certificate store for the listener's certificate.

## Syntax

*Rust Syntax*

```text
fn listener_ssl_cert_store(&self , ListenerIndex : i32) -> Result<Vec<u8>, IPWorksIoTError>
```

## Default Value

"MY"

## Remarks

The name of the certificate store for the listener's certificate.

The [listener_store_type](#MQTTBroker_p_ListenerStoreType) property denotes the type of the certificate store specified by [listener_store](#MQTTBroker_p_ListenerStore). If the store is password-protected, specify the password in [listener_store_password](#MQTTBroker_p_ListenerStorePassword).

[listener_store](#MQTTBroker_p_ListenerStore) is used in conjunction with the [listener_subject](#MQTTBroker_p_ListenerSubject) property to specify client certificates. If [listener_store](#MQTTBroker_p_ListenerStore) has a value, and [listener_subject](#MQTTBroker_p_ListenerSubject) or [listener_encoded](#MQTTBroker_p_ListenerEncoded) is set, a search for a certificate is initiated. Please see the [listener_subject](#MQTTBroker_p_ListenerSubject) 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).

The *ListenerIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ListenerCount](#listener_count-property-mqttbroker-struct) property.

This property is read-only.

## Data Type

Vec

# listener_ssl_cert_store_password property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

This is the password of the SSL certificate.

## Syntax

*Rust Syntax*

```text
fn listener_ssl_cert_store_password(&self , ListenerIndex : i32) -> Result<String, IPWorksIoTError>
```

## Default Value

""

## Remarks

This is the password of the SSL certificate.

The *ListenerIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ListenerCount](#listener_count-property-mqttbroker-struct) property.

This property is read-only.

## Data Type

String

# listener_ssl_cert_store_type property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

This is the type of certificate store for this certificate.

## Syntax

*Rust Syntax*

```text
fn listener_ssl_cert_store_type(&self , ListenerIndex : i32) -> Result<i32, IPWorksIoTError>
```

## Possible Values

```text
0   // User1   // Machine2   // PFXFile3   // PFXBlob4   // JKSFile5   // JKSBlob6   // PEMKeyFile7   // PEMKeyBlob8   // PublicKeyFile9   // PublicKeyBlob10   // SSHPublicKeyBlob11   // P7BFile12   // P7BBlob13   // SSHPublicKeyFile14   // PPKFile15   // PPKBlob16   // XMLFile17   // XMLBlob18   // JWKFile19   // JWKBlob20   // SecurityKey21   // BCFKSFile22   // BCFKSBlob23   // PKCS1199   // Auto
```

## Default Value

0

## Remarks

This is the type of certificate store for this certificate.

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

The *ListenerIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ListenerCount](#listener_count-property-mqttbroker-struct) property.

This property is read-only.

## Data Type

i32

# listener_ssl_cert_subject property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

The subject of the SSL certificate.

## Syntax

*Rust Syntax*

```text
fn listener_ssl_cert_subject(&self , ListenerIndex : i32) -> Result<String, IPWorksIoTError>
```

## Default Value

""

## Remarks

The subject of the SSL certificate.

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.

The *ListenerIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ListenerCount](#listener_count-property-mqttbroker-struct) property.

This property is read-only.

## Data Type

String

# listening property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

This property indicates whether the struct is listening for incoming connections on LocalPort.

## Syntax

*Rust Syntax*

```text
fn listening(&self ) -> Result<bool, IPWorksIoTError>
```

## Default Value

false

## Remarks

This property indicates whether the struct is listening for connections on the port specified by the local_port property. Use the [start_listening](#start_listening-method-mqttbroker-struct) and [stop_listening](#stop_listening-method-mqttbroker-struct) methods to control whether the struct is listening.

This property is read-only.

## Data Type

bool

# message_count property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

The number of records in the Message arrays.

## Syntax

*Rust Syntax*

```text
fn message_count(&self ) -> Result<i32, IPWorksIoTError>
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [message_id](#message_id-property-mqttbroker-struct)
- [message_payload](#message_payload-property-mqttbroker-struct)
- [message_topic](#message_topic-property-mqttbroker-struct)

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

This property is read-only.

## Data Type

i32

# message_id property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

Message identifier used to associate the message state.

## Syntax

*Rust Syntax*

```text
fn message_id(&self , MessageIndex : i32) -> Result<i64, IPWorksIoTError>
```

## Default Value

0

## Remarks

Message identifier used to associate the message state.

The *MessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [MessageCount](#message_count-property-mqttbroker-struct) property.

This property is read-only.

## Data Type

i64

# message_payload property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

This message's raw data payload.

## Syntax

*Rust Syntax*

```text
fn message_payload(&self , MessageIndex : i32) -> Result<Vec<u8>, IPWorksIoTError>
```

## Default Value

""

## Remarks

This message's raw data payload.

The *MessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [MessageCount](#message_count-property-mqttbroker-struct) property.

This property is read-only.

## Data Type

Vec

# message_topic property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

This message's topic.

## Syntax

*Rust Syntax*

```text
fn message_topic(&self , MessageIndex : i32) -> Result<String, IPWorksIoTError>
```

## Default Value

""

## Remarks

This message's topic.

The *MessageIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [MessageCount](#message_count-property-mqttbroker-struct) property.

This property is read-only.

## Data Type

String

# session_count property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

The number of records in the Session arrays.

## Syntax

*Rust Syntax*

```text
fn session_count(&self ) -> Result<i32, IPWorksIoTError>
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [session_client_id](#session_client_id-property-mqttbroker-struct)
- [session_incoming_messages](#session_incoming_messages-property-mqttbroker-struct)
- [session_outgoing_messages](#session_outgoing_messages-property-mqttbroker-struct)
- [session_sub_granted_qo_s](#session_sub_granted_qo_s-property-mqttbroker-struct)
- [session_sub_topic_filters](#session_sub_topic_filters-property-mqttbroker-struct)

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

This property is read-only.

## Data Type

i32

# session_client_id property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

A unique identifier for the client.

## Syntax

*Rust Syntax*

```text
fn session_client_id(&self , SessionIndex : i32) -> Result<String, IPWorksIoTError>
```

## Default Value

""

## Remarks

A unique identifier for the client.

The *SessionIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SessionCount](#session_count-property-mqttbroker-struct) property.

This property is read-only.

## Data Type

String

# session_incoming_messages property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

A collection of incoming messages.

## Syntax

*Rust Syntax*

```text
fn session_incoming_messages(&self , SessionIndex : i32) -> Result<String, IPWorksIoTError>
```

## Default Value

""

## Remarks

A collection of incoming messages.

The *SessionIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SessionCount](#session_count-property-mqttbroker-struct) property.

This property is read-only.

## Data Type

String

# session_outgoing_messages property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

A collection of outgoing messages.

## Syntax

*Rust Syntax*

```text
fn session_outgoing_messages(&self , SessionIndex : i32) -> Result<String, IPWorksIoTError>
```

## Default Value

""

## Remarks

A collection of outgoing messages.

The *SessionIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SessionCount](#session_count-property-mqttbroker-struct) property.

This property is read-only.

## Data Type

String

# session_sub_granted_qo_s property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

The subscription's granted QoS level for the client.

## Syntax

*Rust Syntax*

```text
fn session_sub_granted_qo_s(&self , SessionIndex : i32) -> Result<String, IPWorksIoTError>
```

## Default Value

""

## Remarks

The subscription's granted QoS level for the client.

The *SessionIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SessionCount](#session_count-property-mqttbroker-struct) property.

This property is read-only.

## Data Type

String

# session_sub_topic_filters property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

The subscription topic filters for this client session.

## Syntax

*Rust Syntax*

```text
fn session_sub_topic_filters(&self , SessionIndex : i32) -> Result<String, IPWorksIoTError>
```

## Default Value

""

## Remarks

The subscription topic filters for this client session.

The *SessionIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SessionCount](#session_count-property-mqttbroker-struct) property.

This property is read-only.

## Data Type

String

# ssl_provider property ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

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

## Syntax

*Rust Syntax*

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

## Possible Values

```text
0   // Automatic1   // Platform2   // Internal
```

## Default Value

0

## Remarks

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

Possible values are as follows:

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

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

## Data Type

i32

# add_broker_listener method ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

Creates a new listener for the broker service.

## Syntax

*Rust Syntax*

```text
fn add_broker_listener(&self, local_host : &str, local_port : i32, protocol : i32, ssl_cert_store_type : i32, ssl_cert_store : &[u8], ssl_cert_store_password : &str, ssl_cert_subject : &str) -> Result<(), IPWorksIoTError>
```

## Remarks

*AddBrokerListener* adds a new listener to the listeners collection. Any listeners must be configured before starting the broker. Multiple protocols can be supported by adding different listeners.

The struct supports the following protocols:

|  |  |
| --- | --- |
| 0 (mbpTCP) | Plaintext TCP |
| 1 (mbpTLS) | SSL/TLS over TCP |
| 2 (mbpWS) | Plaintext WebSocket |
| 3 (mbpWSS) | SSL/TLS over WebSocket |

Certificate details can be provided via the following parameters:

|  |  |
| --- | --- |
| SSLCertStoreType | The type of certificate store for this certificate. |
| SSLCertStore | The name of the certificate store for the client certificate. This can be null for plaintext. |
| SSLCertStorePassword | If the type of certificate store requires a password, this field is used to specify the password needed to open the certificate store. |
| SSLCertSubject | The subject of the certificate used for client authentication. |

 Multiple protocols can be enabled (each on a different port):

```csharp
// Plaintext TCP
mqttbroker.AddBrokerListener("127.0.0.1", PLAIN_PORT, (int)MQTTBrokerProtocols.mbpTCP, 0, null, null, null);
// TCP with TLS
mqttbroker.AddBrokerListener("127.0.0.1", SSL_PORT, (int)MQTTBrokerProtocols.mbpTLS, (int)CertStoreTypes.cstPFXFile, "test1.pfx", "test", "*");
// Plaintext WebSocket
mqttbroker.AddBrokerListener("127.0.0.1", WS_PORT, (int)MQTTBrokerProtocols.mbpWS, 0, null, null, null);
// WebSocket with TLS
mqttbroker.AddBrokerListener("127.0.0.1", WSS_PORT, (int)MQTTBrokerProtocols.mbpWSS, (int)CertStoreTypes.cstPFXFile, "test2.pfx", "test", "*");
```

# config method ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

Sets or retrieves a configuration setting.

## Syntax

*Rust Syntax*

```text
fn config(&self, configuration_string : &str) ->  Result<String, IPWorksIoTError>
```

## Remarks

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

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

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

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

# disconnect method ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

This method disconnects the specified client.

## Syntax

*Rust Syntax*

```text
fn disconnect(&self, connection_id : i32) -> Result<(), IPWorksIoTError>
```

## Remarks

Calling this method will disconnect the client specified by the *connection_id* parameter.

# do_events method ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

This method processes events from the internal message queue.

## Syntax

*Rust Syntax*

```text
fn do_events(&self) -> Result<(), IPWorksIoTError>
```

## Remarks

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

# interrupt method ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

This method interrupts a synchronous send to the remote host.

## Syntax

*Rust Syntax*

```text
fn interrupt(&self, connection_id : i32) -> Result<(), IPWorksIoTError>
```

## Remarks

This property is called using the Connection Id if you wish to interrupt a connection and stop a file from uploading without disconnecting the client connected to the struct. If you use send_file to upload a file, the struct will run synchronously on that Connection Id until it is completed.

# load_session method ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

Restores session data for a specified client, enabling resumption of pending operations or message delivery.

## Syntax

*Rust Syntax*

```text
fn load_session(&self, session_info : &str) -> Result<(), IPWorksIoTError>
```

## Remarks

The load_session method is used to load prior client session information if required. This can be used after shutting down a broker to preserve session data and ensure messages can be redelivered once the broker is restarted.

The [save_session](#save_session-method-mqttbroker-struct) method can be used to save session data, and the resulting string can be provided to the load_session method.

The format should be a JSON string with the following parameters:

```csharp
{
  "ClientId":"Client1",
  "Subscriptions":[{      // A collection of the client's subscribed topics
    "Topic":"topic name",
    "QoS":2,
  }],
  "IncomingMessages": [{  // A collection of incoming messages
    "MessageId":1,        // The incoming message's ID
    "Topic":"A",          // The incoming message's topic
    "Payload":"54657374", // hexadecimal message payload
    "QoS":2,              // The incoming message's QoS level
    "DUP":false,          // Whether this message is a duplicate
    "Retain":false,       // Whether this is a retained message
    "PacketId":1,         // This message's packet ID
    "State":3             // See IncomingMessageStatus event for State details
    }],
  "OutgoingMessages":[{   // A collection of outgoing messages
    "MessageId":2,
    "Topic":"A",
    "Payload":"54657374",
    "QoS":2,
    "DUP":false,
    "Retain":false,
    "PacketId":2,
    "State":3             // See OutgoingMessageStatus event for State details
    }]
}
```

 **Session data can be saved with [save_session](#save_session-method-mqttbroker-struct), then later loaded with load_session**

```csharp
string sessiondata = broker.SaveSession("Client1");
// sessiondata contains session information for Client1
...
broker.LoadSession(sessiondata);
```

# reset method ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

This method will reset the struct.

## Syntax

*Rust Syntax*

```text
fn reset(&self) -> Result<(), IPWorksIoTError>
```

## Remarks

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

# save_session method ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

Saves the current state of a client session, including message queues and subscription data, for later retrieval.

## Syntax

*Rust Syntax*

```text
fn save_session(&self, client_id : &str) ->  Result<String, IPWorksIoTError>
```

## Remarks

Returns a JSON string representing the client's subscriptions and messages. This can later be loaded via [load_session](#load_session-method-mqttbroker-struct) to restore the client's state.

The format should be a JSON string with the following parameters:

```csharp
string sessiondata = broker.SaveSession("Client1");
// sessiondata may contain a JSON string with information like this:
{
  "ClientId":"Client1",
  "Subscriptions":[{      // A collection of the client's subscribed topics
    "Topic":"topic name",
    "QoS":2,
  }],
  "IncomingMessages": [{  // A collection of incoming messages
    "MessageId":1,        // The incoming message's ID
    "Topic":"A",          // The incoming message's topic
    "Payload":"54657374", // hexadecimal message payload
    "QoS":2,              // The incoming message's QoS level
    "DUP":false,          // Whether this message is a duplicate
    "Retain":false,       // Whether this is a retained message
    "PacketId":1,         // This message's packet ID
    "State":3             // See IncomingMessageStatus event for State details
    }],
  "OutgoingMessages":[{   // A collection of outgoing messages
    "MessageId":2,
    "Topic":"A",
    "Payload":"54657374",
    "QoS":2,
    "DUP":false,
    "Retain":false,
    "PacketId":2,
    "State":3             // See OutgoingMessageStatus event for State details
    }]
}
```

# shutdown method ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

This method shuts down the server.

## Syntax

*Rust Syntax*

```text
fn shutdown(&self) -> Result<(), IPWorksIoTError>
```

## Remarks

This method shuts down the server. Calling this method is equivalent to calling [stop_listening](#stop_listening-method-mqttbroker-struct) and then breaking every client connection by calling [disconnect](#disconnect-method-mqttbroker-struct).

# start_listening method ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

This method starts listening for incoming connections.

## Syntax

*Rust Syntax*

```text
fn start_listening(&self) -> Result<(), IPWorksIoTError>
```

## Remarks

This method begins listening for incoming connections on the port specified by local_port. Once listening, events will fire as new clients connect and data are transferred.

To stop listening for new connections, call [stop_listening](#stop_listening-method-mqttbroker-struct). To stop listening for new connections and to disconnect all existing clients, call [shutdown](#shutdown-method-mqttbroker-struct).

# stop_listening method ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

This method stops listening for new connections.

## Syntax

*Rust Syntax*

```text
fn stop_listening(&self) -> Result<(), IPWorksIoTError>
```

## Remarks

This method stops listening for new connections. After being called, any new connection attempts will be rejected. Calling this method does not disconnect existing connections.

To stop listening and to disconnect all existing clients, call [shutdown](#shutdown-method-mqttbroker-struct) instead.

# on_connected event ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

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

## Syntax

*Rust Syntax*

```text
// MQTTBrokerConnectedEventArgs carries the MQTTBroker Connected event's parameters.
pub struct MQTTBrokerConnectedEventArgs {
  fn connection_id(&self) -> i32
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

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

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

## Remarks

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

If the connection fails, *status_code* has the error code returned by the system. *description* contains a description of this code. The value of *status_code* is equal to the value of the system error.

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

# on_connection_request event ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

This event is fired when a request for connection comes from a remote host.

## Syntax

*Rust Syntax*

```text
// MQTTBrokerConnectionRequestEventArgs carries the MQTTBroker ConnectionRequest event's parameters.
pub struct MQTTBrokerConnectionRequestEventArgs {
  fn address(&self) -> &String
  fn port(&self) -> i32
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// MQTTBrokerConnectionRequestEvent defines the signature of the MQTTBroker ConnectionRequest event's handler function.
pub trait MQTTBrokerConnectionRequestEvent {
  fn on_connection_request(&self, sender : MQTTBroker, e : &mut MQTTBrokerConnectionRequestEventArgs);
}

impl <'a> MQTTBroker<'a> {
  pub fn on_connection_request(&self) -> &'a dyn MQTTBrokerConnectionRequestEvent;
  pub fn set_on_connection_request(&mut self, value : &'a dyn MQTTBrokerConnectionRequestEvent);
  ...
}
```

## Remarks

This event indicates an incoming connection. The connection is accepted by default. *address* and *port* will contain information about the remote host requesting the inbound connection. If you want to refuse it, you can set the *accept* parameter to False.

# on_disconnected event ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

This event is fired when a connection is closed.

## Syntax

*Rust Syntax*

```text
// MQTTBrokerDisconnectedEventArgs carries the MQTTBroker Disconnected event's parameters.
pub struct MQTTBrokerDisconnectedEventArgs {
  fn connection_id(&self) -> i32
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

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

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

## Remarks

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

If the connection is broken for any other reason, *status_code* has the error code returned by the system. *description* contains a description of this code. The value of *status_code* is equal to the value of the system error.

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

# on_error event ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

This event fires information about errors during data delivery.

## Syntax

*Rust Syntax*

```text
// MQTTBrokerErrorEventArgs carries the MQTTBroker Error event's parameters.
pub struct MQTTBrokerErrorEventArgs {
  fn connection_id(&self) -> i32
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

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

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

## Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally, the struct fails with an error.

*error_code* 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-mqttbroker-struct) section.

*connection_id* indicates the connection for which the error is applicable.

# on_incoming_message_status event ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

Fires when an incoming message's state is updated.

## Syntax

*Rust Syntax*

```text
// MQTTBrokerIncomingMessageStatusEventArgs carries the MQTTBroker IncomingMessageStatus event's parameters.
pub struct MQTTBrokerIncomingMessageStatusEventArgs {
  fn connection_id(&self) -> i32
  fn client_id(&self) -> &String
  fn message_id(&self) -> i64
  fn dup(&self) -> bool
  fn qo_s(&self) -> i32
  fn retain(&self) -> bool
  fn packet_id(&self) -> i32
  fn state(&self) -> i32
}

// MQTTBrokerIncomingMessageStatusEvent defines the signature of the MQTTBroker IncomingMessageStatus event's handler function.
pub trait MQTTBrokerIncomingMessageStatusEvent {
  fn on_incoming_message_status(&self, sender : MQTTBroker, e : &mut MQTTBrokerIncomingMessageStatusEventArgs);
}

impl <'a> MQTTBroker<'a> {
  pub fn on_incoming_message_status(&self) -> &'a dyn MQTTBrokerIncomingMessageStatusEvent;
  pub fn set_on_incoming_message_status(&mut self, value : &'a dyn MQTTBrokerIncomingMessageStatusEvent);
  ...
}
```

## Remarks

The *IncomingMessageStatus* event fires each time an incoming message's state is updated.

- MessageId: A unique identifier for this message.
- DUP: Whether or not the server has indicated that this message is a duplicate of another message received previously.
- QoS: The message's QoS level.
- Retain: Whether or not this message was received as a result of subscribing to a topic.
- PacketId: The message packet Id. This will always be -1 if QoS is 0.
- State: Information about the incoming message's state.

  - 6 - For an incoming QoS 1 message, which has been received from the client, but prior to sending the PUBACK for it. When the PUBACK is sent, the state will change to 10.
  - 7 - For an incoming QoS 2 message, which has been received from a client, but prior to sending the PUBREC for it,
  - 8 - For an incoming QoS 2 message, which has sent the PUBREC, but waiting to receive the PUBREL for it.
  - 9 - For an incoming QoS 2 message, which has received the PUBREL, but prior to sending the PUBCOMP for it. When the PUBCOMP is sent, the state will change to 10.
  - 10 - Message successfully received.

# on_log event ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

Fires once for each log message.

## Syntax

*Rust Syntax*

```text
// MQTTBrokerLogEventArgs carries the MQTTBroker Log event's parameters.
pub struct MQTTBrokerLogEventArgs {
  fn connection_id(&self) -> i32
  fn log_level(&self) -> i32
  fn message(&self) -> &String
  fn log_type(&self) -> &String
}

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

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

## Remarks

This event fires once for each log message generated by the struct. 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 struct.
- Session: Session status messages.
- Frame: Frame status messages.

# on_message_received event ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

Fires when a new message is received from a client.

## Syntax

*Rust Syntax*

```text
// MQTTBrokerMessageReceivedEventArgs carries the MQTTBroker MessageReceived event's parameters.
pub struct MQTTBrokerMessageReceivedEventArgs {
  fn connection_id(&self) -> i32
  fn client_id(&self) -> &String
  fn message_id(&self) -> i64
}

// MQTTBrokerMessageReceivedEvent defines the signature of the MQTTBroker MessageReceived event's handler function.
pub trait MQTTBrokerMessageReceivedEvent {
  fn on_message_received(&self, sender : MQTTBroker, e : &mut MQTTBrokerMessageReceivedEventArgs);
}

impl <'a> MQTTBroker<'a> {
  pub fn on_message_received(&self) -> &'a dyn MQTTBrokerMessageReceivedEvent;
  pub fn set_on_message_received(&mut self, value : &'a dyn MQTTBrokerMessageReceivedEvent);
  ...
}
```

## Remarks

This event fires each time a message is received from a client.

# on_message_receiving event ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

Fires when a message is initially received from a client.

## Syntax

*Rust Syntax*

```text
// MQTTBrokerMessageReceivingEventArgs carries the MQTTBroker MessageReceiving event's parameters.
pub struct MQTTBrokerMessageReceivingEventArgs {
  fn connection_id(&self) -> i32
  fn client_id(&self) -> &String
  fn message_id(&self) -> i64
  fn dup(&self) -> bool
  fn qo_s(&self) -> i32
  fn retain(&self) -> bool
  fn packet_id(&self) -> i32
}

// MQTTBrokerMessageReceivingEvent defines the signature of the MQTTBroker MessageReceiving event's handler function.
pub trait MQTTBrokerMessageReceivingEvent {
  fn on_message_receiving(&self, sender : MQTTBroker, e : &mut MQTTBrokerMessageReceivingEventArgs);
}

impl <'a> MQTTBroker<'a> {
  pub fn on_message_receiving(&self) -> &'a dyn MQTTBrokerMessageReceivingEvent;
  pub fn set_on_message_receiving(&mut self, value : &'a dyn MQTTBrokerMessageReceivingEvent);
  ...
}
```

## Remarks

The MessageReceiving event fires once for each incoming message immediately after it is received from a client.

- MessageId: A unique identifier for this message.
- DUP: Whether or not the server has indicated that this message is a duplicate of another message sent previously.
- QoS: The message's QoS level.
- Retain: Whether or not this message was received as a result of subscribing to a topic.
- PacketId: The message packet Id. This will always be -1 if QoS is 0.

# on_message_sending event ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

Fires when a message is initially sent to a client.

## Syntax

*Rust Syntax*

```text
// MQTTBrokerMessageSendingEventArgs carries the MQTTBroker MessageSending event's parameters.
pub struct MQTTBrokerMessageSendingEventArgs {
  fn connection_id(&self) -> i32
  fn client_id(&self) -> &String
  fn message_id(&self) -> i64
  fn dup(&self) -> bool
  fn qo_s(&self) -> i32
  fn retain(&self) -> bool
  fn packet_id(&self) -> i32
}

// MQTTBrokerMessageSendingEvent defines the signature of the MQTTBroker MessageSending event's handler function.
pub trait MQTTBrokerMessageSendingEvent {
  fn on_message_sending(&self, sender : MQTTBroker, e : &mut MQTTBrokerMessageSendingEventArgs);
}

impl <'a> MQTTBroker<'a> {
  pub fn on_message_sending(&self) -> &'a dyn MQTTBrokerMessageSendingEvent;
  pub fn set_on_message_sending(&mut self, value : &'a dyn MQTTBrokerMessageSendingEvent);
  ...
}
```

## Remarks

The MessageSending fires once for each outgoing message immediately after it is sent to a client.

- MessageId: A unique identifier for this message.
- DUP: Whether or not the server has indicated that this message is a duplicate of another message sent previously.
- QoS: The message's QoS level.
- Retain: Whether or not this message was received as a result of subscribing to a topic.
- PacketId: The message packet Id. This will always be -1 if QoS is 0.

# on_message_sent event ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

Fires after a message is successfully delivered to a client, confirming transmission.

## Syntax

*Rust Syntax*

```text
// MQTTBrokerMessageSentEventArgs carries the MQTTBroker MessageSent event's parameters.
pub struct MQTTBrokerMessageSentEventArgs {
  fn connection_id(&self) -> i32
  fn client_id(&self) -> &String
  fn message_id(&self) -> i64
}

// MQTTBrokerMessageSentEvent defines the signature of the MQTTBroker MessageSent event's handler function.
pub trait MQTTBrokerMessageSentEvent {
  fn on_message_sent(&self, sender : MQTTBroker, e : &mut MQTTBrokerMessageSentEventArgs);
}

impl <'a> MQTTBroker<'a> {
  pub fn on_message_sent(&self) -> &'a dyn MQTTBrokerMessageSentEvent;
  pub fn set_on_message_sent(&mut self, value : &'a dyn MQTTBrokerMessageSentEvent);
  ...
}
```

## Remarks

This event fires each time a message is delivered to a client.

# on_outgoing_message_status event ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

Fired to provide the current delivery status of an outgoing message. Includes success or failure metadata.

## Syntax

*Rust Syntax*

```text
// MQTTBrokerOutgoingMessageStatusEventArgs carries the MQTTBroker OutgoingMessageStatus event's parameters.
pub struct MQTTBrokerOutgoingMessageStatusEventArgs {
  fn connection_id(&self) -> i32
  fn client_id(&self) -> &String
  fn message_id(&self) -> i64
  fn dup(&self) -> bool
  fn qo_s(&self) -> i32
  fn retain(&self) -> bool
  fn packet_id(&self) -> i32
  fn state(&self) -> i32
}

// MQTTBrokerOutgoingMessageStatusEvent defines the signature of the MQTTBroker OutgoingMessageStatus event's handler function.
pub trait MQTTBrokerOutgoingMessageStatusEvent {
  fn on_outgoing_message_status(&self, sender : MQTTBroker, e : &mut MQTTBrokerOutgoingMessageStatusEventArgs);
}

impl <'a> MQTTBroker<'a> {
  pub fn on_outgoing_message_status(&self) -> &'a dyn MQTTBrokerOutgoingMessageStatusEvent;
  pub fn set_on_outgoing_message_status(&mut self, value : &'a dyn MQTTBrokerOutgoingMessageStatusEvent);
  ...
}
```

## Remarks

The *OutgoingMessageStatus* event fires each time an outgoing message's state is updated.

- MessageId: A unique identifier for this message.
- DUP: Whether or not the server has indicated that this message is a duplicate of another message sent previously.
- QoS: The message's QoS level.
- Retain: Whether or not this message is a retained message.
- PacketId: The message packet Id. This will always be -1 if QoS is 0.
- State: Information about the outgoing message's state.

  - 1 - Outgoing message is waiting to be sent
  - 2 - For an outgoing QoS 1 message, which has been sent to the client and waiting for the PUBACK. When the PUBACK is received, the state will change to 10.
  - 3 - For an outgoing QoS 2 message, which has been sent to the client and waiting for the PUBREC.
  - 4 - For an outgoing QoS 2 message, which has received the PUBREC, prior to sending the PUBREL for it.
  - 5 - For an outgoing QoS 2 message, which has sent the PUBREL. When the PUBCOMP is received, the state will change to 10.
  - 10 - Message successfully sent.

# on_session_removed event ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

Fired when a client session is removed, indicating all resources associated with the session are cleaned up.

## Syntax

*Rust Syntax*

```text
// MQTTBrokerSessionRemovedEventArgs carries the MQTTBroker SessionRemoved event's parameters.
pub struct MQTTBrokerSessionRemovedEventArgs {
  fn client_id(&self) -> &String
}

// MQTTBrokerSessionRemovedEvent defines the signature of the MQTTBroker SessionRemoved event's handler function.
pub trait MQTTBrokerSessionRemovedEvent {
  fn on_session_removed(&self, sender : MQTTBroker, e : &mut MQTTBrokerSessionRemovedEventArgs);
}

impl <'a> MQTTBroker<'a> {
  pub fn on_session_removed(&self) -> &'a dyn MQTTBrokerSessionRemovedEvent;
  pub fn set_on_session_removed(&mut self, value : &'a dyn MQTTBrokerSessionRemovedEvent);
  ...
}
```

## Remarks

The client with the associated *ClientId* will also be removed from the sessions collection when this event returns.

# on_session_request event ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

Fires when a new session is requested.

## Syntax

*Rust Syntax*

```text
// MQTTBrokerSessionRequestEventArgs carries the MQTTBroker SessionRequest event's parameters.
pub struct MQTTBrokerSessionRequestEventArgs {
  fn connection_id(&self) -> i32
  fn client_id(&self) -> &String
  fn user_name(&self) -> &String
  fn password(&self) -> &String
  fn is_new(&self) -> bool
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// MQTTBrokerSessionRequestEvent defines the signature of the MQTTBroker SessionRequest event's handler function.
pub trait MQTTBrokerSessionRequestEvent {
  fn on_session_request(&self, sender : MQTTBroker, e : &mut MQTTBrokerSessionRequestEventArgs);
}

impl <'a> MQTTBroker<'a> {
  pub fn on_session_request(&self) -> &'a dyn MQTTBrokerSessionRequestEvent;
  pub fn set_on_session_request(&mut self, value : &'a dyn MQTTBrokerSessionRequestEvent);
  ...
}
```

## Remarks

*UserName* and *Password* contain authentication credentials which can be verified in this event.

*IsNew* denotes whether this is a clean session from the client.

*Accept* can be set to false to reject the client. Set *Accept* to true to accept this client.

**Example:**

```csharp
broker.OnSessionRequest += (s,e) => {
  // Check e.UserName and e.Password if needed
  // Set Accept to true to accept the session request
  e.Accept = true;
};
```

# on_ssl_client_authentication event ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

This event is fired when the client presents its credentials to the server.

## Syntax

*Rust Syntax*

```text
// MQTTBrokerSSLClientAuthenticationEventArgs carries the MQTTBroker SSLClientAuthentication event's parameters.
pub struct MQTTBrokerSSLClientAuthenticationEventArgs {
  fn connection_id(&self) -> i32
  fn cert_encoded(&self) -> &[u8]
  fn cert_subject(&self) -> &String
  fn cert_issuer(&self) -> &String
  fn status(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// MQTTBrokerSSLClientAuthenticationEvent defines the signature of the MQTTBroker SSLClientAuthentication event's handler function.
pub trait MQTTBrokerSSLClientAuthenticationEvent {
  fn on_ssl_client_authentication(&self, sender : MQTTBroker, e : &mut MQTTBrokerSSLClientAuthenticationEventArgs);
}

impl <'a> MQTTBroker<'a> {
  pub fn on_ssl_client_authentication(&self) -> &'a dyn MQTTBrokerSSLClientAuthenticationEvent;
  pub fn set_on_ssl_client_authentication(&mut self, value : &'a dyn MQTTBrokerSSLClientAuthenticationEvent);
  ...
}
```

## Remarks

This event enables the server to decide whether or not to continue. The *accept* parameter is a recommendation on whether to continue or to 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").

# on_ssl_status event ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

This event is fired to show the progress of the secure connection.

## Syntax

*Rust Syntax*

```text
// MQTTBrokerSSLStatusEventArgs carries the MQTTBroker SSLStatus event's parameters.
pub struct MQTTBrokerSSLStatusEventArgs {
  fn connection_id(&self) -> i32
  fn message(&self) -> &String
}

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

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

## Remarks

The event is fired for informational and logging purposes only. It is used to track the progress of the connection.

# on_subscribe event ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

Fires when a client requests to subscribe to a topic.

## Syntax

*Rust Syntax*

```text
// MQTTBrokerSubscribeEventArgs carries the MQTTBroker Subscribe event's parameters.
pub struct MQTTBrokerSubscribeEventArgs {
  fn connection_id(&self) -> i32
  fn client_id(&self) -> &String
  fn topic_filter(&self) -> &String
  fn requested_qo_s(&self) -> i32
  fn return_code(&self) -> i32
  fn set_return_code(&self, value : i32)
}

// MQTTBrokerSubscribeEvent defines the signature of the MQTTBroker Subscribe event's handler function.
pub trait MQTTBrokerSubscribeEvent {
  fn on_subscribe(&self, sender : MQTTBroker, e : &mut MQTTBrokerSubscribeEventArgs);
}

impl <'a> MQTTBroker<'a> {
  pub fn on_subscribe(&self) -> &'a dyn MQTTBrokerSubscribeEvent;
  pub fn set_on_subscribe(&mut self, value : &'a dyn MQTTBrokerSubscribeEvent);
  ...
}
```

## Remarks

The *ClientId* is used to identify this client in subsequent actions.

The *TopicFilter* is the requested topic the client wishes to subscribe to.

The *RequestedQoS* is the client's preferred QoS level.

*ReturnCode* is used to confirm the maximum QoS level granted for this subscription or indicate a failure. This can be less than the client's *RequestedQoS*.

|  |  |
| --- | --- |
| 0x00 | Success - Maximum QoS 0 |
| 0x01 | Success - Maximum QoS 1 |
| 0x02 | Success - Maximum QoS 2 |
| 0x80 | Failure |

# on_unsubscribe event ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

Fires when a client unsubscribes from a topic, removing its subscription data.

## Syntax

*Rust Syntax*

```text
// MQTTBrokerUnsubscribeEventArgs carries the MQTTBroker Unsubscribe event's parameters.
pub struct MQTTBrokerUnsubscribeEventArgs {
  fn connection_id(&self) -> i32
  fn client_id(&self) -> &String
  fn topic_filter(&self) -> &String
}

// MQTTBrokerUnsubscribeEvent defines the signature of the MQTTBroker Unsubscribe event's handler function.
pub trait MQTTBrokerUnsubscribeEvent {
  fn on_unsubscribe(&self, sender : MQTTBroker, e : &mut MQTTBrokerUnsubscribeEventArgs);
}

impl <'a> MQTTBroker<'a> {
  pub fn on_unsubscribe(&self) -> &'a dyn MQTTBrokerUnsubscribeEvent;
  pub fn set_on_unsubscribe(&mut self, value : &'a dyn MQTTBrokerUnsubscribeEvent);
  ...
}
```

## Remarks

The *TopicFilter* shows the topic this client is unsubscribing from.

# Config Settings ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

 The struct 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 struct, access to these *internal properties* is provided through the [config](#config-method-mqttbroker-struct) method.

### 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 struct will use timeout for establishing a connection and transmitting/receiving data.

**FirewallAutoDetect**: Tells the struct whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by structs 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 structs 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 struct fails with an error.

NOTE: This setting is provided for use by structs 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 structs 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 structs 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 struct fails with an error.

NOTE: This setting is provided for use by structs 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 struct 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 local_host 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 struct initiate connections (or accept in the case of server structs) only through that interface.

If the struct is connected, the local_host 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 struct binds. This configuration setting must be set before a connection is attempted. It instructs the struct to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by local_port after the connection is established.

local_port 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 on_data_in 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 on_data_in 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 struct will use IPv4 exclusively. When set to *1*, the struct will use IPv6 exclusively. To instruct the struct 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 [ssl_provider](#ssl_provider-property-mqttbroker-struct) 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 [on_ssl_status](#on_ssl_status-event-mqttbroker-struct) event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if [ssl_provider](#ssl_provider-property-mqttbroker-struct) 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 struct 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 struct is the same.

**SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [ssl_provider](#ssl_provider-property-mqttbroker-struct) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the ssl_cert 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 struct will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the struct will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The struct 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 struct fails with an error.

When set to 0 (default), the CRL check will not be performed by the struct. 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 struct will use OCSP to check the validity of the server certificate. If set to 1 or 2, the struct will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The struct 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 struct fails with an error.

When set to 0 (default), the struct 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 [on_ssl_status](#on_ssl_status-event-mqttbroker-struct) 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 ssl_authenticate_clients 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 struct 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 [ssl_provider](#ssl_provider-property-mqttbroker-struct) 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 [ssl_provider](#ssl_provider-property-mqttbroker-struct) 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 [ssl_provider](#ssl_provider-property-mqttbroker-struct) 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 [ssl_provider](#ssl_provider-property-mqttbroker-struct) 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 struct will first try to use the platform TLS 1.3 implementation when the [ssl_provider](#ssl_provider-property-mqttbroker-struct) 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, [ssl_provider](#ssl_provider-property-mqttbroker-struct) 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 struct when the [ssl_provider](#ssl_provider-property-mqttbroker-struct) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [ssl_provider](#ssl_provider-property-mqttbroker-struct) 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 [ssl_provider](#ssl_provider-property-mqttbroker-struct) 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 on_ssl_server_authentication 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 on_ssl_server_authentication event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the on_ssl_server_authentication 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 struct 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 struct will only append, it will not overwrite previous values.

NOTE: This configuration setting is applicable only when [ssl_provider](#ssl_provider-property-mqttbroker-struct) 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 [ssl_provider](#ssl_provider-property-mqttbroker-struct) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2.

When specified the struct 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 struct 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 [ssl_provider](#ssl_provider-property-mqttbroker-struct) 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 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 struct 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 struct 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 struct 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*.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the struct will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the struct 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 ([MQTTBroker](#struct-ipworksiotmqttbroker) Struct)

### MQTTBroker Errors

|  |  |
| --- | --- |
| 600 | MQTT protocol error. Refer to the error message for more information. |
| 601 | Invalid topic name. Refer to the error message for more information. |

### TCPClient Errors

|  |  |
| --- | --- |
| 100 | You cannot change the remote_port at this time. A connection is in progress. |
| 101 | You cannot change the remote_host (Server) at this time. A connection is in progress. |
| 102 | The remote_host 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 local_port at this time. A connection is in progress. |
| 107 | You cannot change the local_host at this time. A connection is in progress. |
| 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. |
| 116 | remote_port cannot be zero. Please specify a valid service port number. |
| 117 | You cannot change the UseConnection option while the struct 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). |