# MQTTBroker Class A lightweight, fully-featured MQTT broker implementation. ## Syntax ```text ipworksiot.MQTTBroker ``` ## Remarks The MQTTBroker class provides a lightweight, fully-featured MQTT broker implementation with support for version 3.1.1. The class supports plaintext and TLS-enabled connections over both standard TCP and WebSockets. ### Configuring Listeners The [AddBrokerListener](#addbrokerlistener-method-mqttbroker-class) method adds a new listener to the [Listeners](#listeners-property-mqttbroker-class) collection. Any listeners must be configured before starting the broker. Multiple protocols can be supported by adding different listeners. The class 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 [StartListening](#startlistening-method-mqttbroker-class) method. ### Handling Sessions When an MQTT client requests a session, the [SessionRequest](#sessionrequest-event-mqttbroker-class) 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 [Subscribe](#subscribe-event-mqttbroker-class) 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 [Unsubscribe](#unsubscribe-event-mqttbroker-class) event will fire, specifying which *TopicFilter* the client is unsubscribing from. ### Incoming Messages The MQTTBroker class will automatically forward received messages to any subscribed clients. Events can be used to record the state of any incoming messages. The [MessageReceiving](#messagereceiving-event-mqttbroker-class) event fires when a message is initially received and contains message metadata. The [IncomingMessageStatus](#incomingmessagestatus-event-mqttbroker-class) 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 [MessageReceived](#messagereceived-event-mqttbroker-class) event fires when the message has completed the acknowledgment process with the client, depending on the QoS level. ### Outgoing Messages The MQTTBroker class will automatically forward received messages to any subscribed clients. Events can be used to record the state of any incoming messages. The [MessageSending](#messagesending-event-mqttbroker-class) event fires when a message is initially sent to a client and contains message metadata. The [OutgoingMessageStatus](#outgoingmessagestatus-event-mqttbroker-class) 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 [SaveSession](#savesession-method-mqttbroker-class) method saves the current state of a client session, including message queues and subscription data, for later retrieval. [SaveSession](#savesession-method-mqttbroker-class) returns a JSON string representing the client's subscriptions and messages. This can later be loaded via [LoadSession](#loadsession-method-mqttbroker-class) 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); ``` ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Connections](#connections-property-mqttbroker-class) | A collection of currently connected clients. | | [DefaultIdleTimeout](#defaultidletimeout-property-mqttbroker-class) | This property includes the default idle timeout for inactive clients. | | [Listeners](#listeners-property-mqttbroker-class) | Defines the set of network endpoints where the MQTT Broker listens for client connections. | | [Listening](#listening-property-mqttbroker-class) | This property indicates whether the class is listening for incoming connections on LocalPort. | | [Messages](#messages-property-mqttbroker-class) | Provides a collection of retained messages available to newly subscribed clients. | | [Sessions](#sessions-property-mqttbroker-class) | Contains session information for clients. | | [SSLProvider](#sslprovider-property-mqttbroker-class) | 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 class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AddBrokerListener](#addbrokerlistener-method-mqttbroker-class) | Creates a new listener for the broker service. | | [Config](#config-method-mqttbroker-class) | Sets or retrieves a configuration setting. | | [Disconnect](#disconnect-method-mqttbroker-class) | This method disconnects the specified client. | | [DoEvents](#doevents-method-mqttbroker-class) | This method processes events from the internal message queue. | | [Interrupt](#interrupt-method-mqttbroker-class) | This method interrupts a synchronous send to the remote host. | | [LoadSession](#loadsession-method-mqttbroker-class) | Restores session data for a specified client, enabling resumption of pending operations or message delivery. | | [Reset](#reset-method-mqttbroker-class) | This method will reset the class. | | [SaveSession](#savesession-method-mqttbroker-class) | Saves the current state of a client session, including message queues and subscription data, for later retrieval. | | [Shutdown](#shutdown-method-mqttbroker-class) | This method shuts down the server. | | [StartListening](#startlistening-method-mqttbroker-class) | This method starts listening for incoming connections. | | [StopListening](#stoplistening-method-mqttbroker-class) | This method stops listening for new connections. | ## Event List *The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Connected](#connected-event-mqttbroker-class) | This event is fired immediately after a connection completes (or fails). | | [ConnectionRequest](#connectionrequest-event-mqttbroker-class) | This event is fired when a request for connection comes from a remote host. | | [Disconnected](#disconnected-event-mqttbroker-class) | This event is fired when a connection is closed. | | [Error](#error-event-mqttbroker-class) | This event fires information about errors during data delivery. | | [IncomingMessageStatus](#incomingmessagestatus-event-mqttbroker-class) | Fires when an incoming message's state is updated. | | [Log](#log-event-mqttbroker-class) | Fires once for each log message. | | [MessageReceived](#messagereceived-event-mqttbroker-class) | Fires when a new message is received from a client. | | [MessageReceiving](#messagereceiving-event-mqttbroker-class) | Fires when a message is initially received from a client. | | [MessageSending](#messagesending-event-mqttbroker-class) | Fires when a message is initially sent to a client. | | [MessageSent](#messagesent-event-mqttbroker-class) | Fires after a message is successfully delivered to a client, confirming transmission. | | [OutgoingMessageStatus](#outgoingmessagestatus-event-mqttbroker-class) | Fired to provide the current delivery status of an outgoing message. Includes success or failure metadata. | | [SessionRemoved](#sessionremoved-event-mqttbroker-class) | Fired when a client session is removed, indicating all resources associated with the session are cleaned up. | | [SessionRequest](#sessionrequest-event-mqttbroker-class) | Fires when a new session is requested. | | [SSLClientAuthentication](#sslclientauthentication-event-mqttbroker-class) | This event is fired when the client presents its credentials to the server. | | [SSLStatus](#sslstatus-event-mqttbroker-class) | This event is fired to show the progress of the secure connection. | | [Subscribe](#subscribe-event-mqttbroker-class) | Fires when a client requests to subscribe to a topic. | | [Unsubscribe](#unsubscribe-event-mqttbroker-class) | Fires when a client unsubscribes from a topic, removing its subscription data. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [CloseStreamAfterTransfer](#CloseStreamAfterTransfer) | If true, the class will close the upload or download stream after the transfer. | | [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. | | [EnableFallback](#EnableFallback) | Whether to try the other addresses the remote host resolves to when a connection attempt fails. | | [FallbackTimeout](#FallbackTimeout) | The maximum time in milliseconds to spend on connection attempts when EnableFallback is enabled. | | [FirewallAutoDetect](#FirewallAutoDetect) | Tells the class whether or not to automatically detect and use firewall system settings, if available. | | [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). | | [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. | | [FirewallListener](#FirewallListener) | If true, the class binds to a SOCKS firewall as a server (TCPClient only). | | [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. | | [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. | | [FirewallType](#FirewallType) | Determines the type of firewall to connect through. | | [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. | | [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. | | [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. | | [Linger](#Linger) | When set to True, connections are terminated gracefully. | | [LingerTime](#LingerTime) | Time in seconds to have the connection linger. | | [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. | | [LocalPort](#LocalPort) | The port in the local host where the class binds. | | [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. | | [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. | | [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. | | [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. | | [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. | | [UseIPv6](#UseIPv6) | Whether to use IPv6. | | [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. | | [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. | | [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. | | [SSLContextProtocol](#SSLContextProtocol) | The protocol used when getting an SSLContext instance. | | [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. | | [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. | | [SSLTrustManagerFactoryAlgorithm](#SSLTrustManagerFactoryAlgorithm) | The algorithm to be used to create a TrustManager through TrustManagerFactory. | | [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. | | [GUIAvailable](#GUIAvailable) | Whether or not a message loop is available for processing events. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseDaemonThreads](#UseDaemonThreads) | Whether threads created by the class are daemon threads. | | [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the class whether or not to use FIPS certified APIs. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | | [UseVirtualThreads](#UseVirtualThreads) | Whether threads created by the class use virtual threads instead of platform threads. | # Connections Property ([MQTTBroker](#mqttbroker-class) Class) A collection of currently connected clients. ## Syntax ```text public MQTTBrokerConnectionMap getConnections(); ``` ## Remarks This property contains a collection of currently connected clients. All of the connections may be managed using this property. Each connection is described by the different fields of the Connection type. This collection is a hash-table type of collection, in which the Connection Id string is used as the key to the desired connection. You may acquire the key for a given connection through the Connected event. This property is read-only and not available at design time. Please refer to the [MQTTBrokerConnection](#mqttbrokerconnection-type) type for a complete list of fields. # DefaultIdleTimeout Property ([MQTTBroker](#mqttbroker-class) Class) This property includes the default idle timeout for inactive clients. ## Syntax ```text public int getDefaultIdleTimeout(); public void setDefaultIdleTimeout(int defaultIdleTimeout); ``` ## Default Value 0 ## Remarks This property specifies the idle timeout (in seconds) for clients. When set to a positive value, the class will disconnect idle clients after the specified timeout. This applies only to clients that have not sent or received data within DefaultIdleTimeout seconds. If set to 0 (default), no idle timeout is applied. NOTE: [DoEvents](#doevents-method-mqttbroker-class) must be called for the class to check existing connections. # Listeners Property ([MQTTBroker](#mqttbroker-class) Class) Defines the set of network endpoints where the MQTT Broker listens for client connections. ## Syntax ```text public MQTTBrokerListenerList getListeners(); ``` ## Remarks Each listener is represented by an endpoint structure, including IP address and port. This allows fine-grained control over accessibility and security, enabling the broker to serve clients on different networks or with different protocols. This property is read-only and not available at design time. Please refer to the [MQTTBrokerListener](#mqttbrokerlistener-type) type for a complete list of fields. # Listening Property ([MQTTBroker](#mqttbroker-class) Class) This property indicates whether the class is listening for incoming connections on LocalPort. ## Syntax ```text public boolean isListening(); ``` ## Default Value False ## Remarks This property indicates whether the class is listening for connections on the port specified by the LocalPort property. Use the [StartListening](#startlistening-method-mqttbroker-class) and [StopListening](#stoplistening-method-mqttbroker-class) methods to control whether the class is listening. This property is read-only and not available at design time. # Messages Property ([MQTTBroker](#mqttbroker-class) Class) Provides a collection of retained messages available to newly subscribed clients. ## Syntax ```text public MQTTBrokerMessageList getMessages(); ``` ## Remarks Retained messages are stored and delivered to clients subscribing to their respective topics. This property allows inspection and management of retained messages, including adding, modifying, or removing messages for specific topics. This property is read-only and not available at design time. Please refer to the [MQTTBrokerMessage](#mqttbrokermessage-type) type for a complete list of fields. # Sessions Property ([MQTTBroker](#mqttbroker-class) Class) Contains session information for clients. ## Syntax ```text public MQTTBrokerSessionList getSessions(); ``` ## Remarks Session data includes stored messages, subscription topics, and QoS levels. This ensures that messages are delivered even if a client reconnects after a disconnection. This property is read-only and not available at design time. Please refer to the [MQTTBrokerSession](#mqttbrokersession-type) type for a complete list of fields. # SSLProvider Property ([MQTTBroker](#mqttbroker-class) Class) The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. ## Syntax ```text public int getSSLProvider(); public void setSSLProvider(int SSLProvider); Enumerated values: public final static int sslpAutomatic = 0; public final static int sslpPlatform = 1; public final static int sslpInternal = 2; ``` ## Default Value 0 ## Remarks This property specifies the SSL/TLS implementation to use. In most cases the default value of *0* (Automatic) is recommended and should not be changed. When set to *0* (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used. Possible values are as follows: | | | | --- | --- | | 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. | | 1 (sslpPlatform) | Uses the platform/system implementation. | | 2 (sslpInternal) | Uses the internal implementation. | **Additional Notes** In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform. When Automatic is selected, the platform implementation is used by default. When TLS 1.3 is enabled via [SSLEnabledProtocols](#SSLEnabledProtocols), the class will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. # AddBrokerListener Method ([MQTTBroker](#mqttbroker-class) Class) Creates a new listener for the broker service. ## Syntax ```text public void addBrokerListener(String localHost, int localPort, int protocol, int SSLCertStoreType, byte[] SSLCertStore, String SSLCertStorePassword, String SSLCertSubject); ``` ## Remarks *AddBrokerListener* adds a new listener to the [Listeners](#listeners-property-mqttbroker-class) collection. Any listeners must be configured before starting the broker. Multiple protocols can be supported by adding different listeners. The class 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](#mqttbroker-class) Class) Sets or retrieves a configuration setting. ## Syntax ```text public String config(String configurationString); ``` ## Remarks Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-mqttbroker-class) for the class. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the Config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-mqttbroker-class), you must call *Config("PROPERTY")*. The value will be returned as a string. # Disconnect Method ([MQTTBroker](#mqttbroker-class) Class) This method disconnects the specified client. ## Syntax ```text public void disconnect(String connectionId); ``` ## Remarks Calling this method will disconnect the client specified by the *ConnectionId* parameter. # DoEvents Method ([MQTTBroker](#mqttbroker-class) Class) This method processes events from the internal message queue. ## Syntax ```text public void doEvents(); ``` ## Remarks When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns. # Interrupt Method ([MQTTBroker](#mqttbroker-class) Class) This method interrupts a synchronous send to the remote host. ## Syntax ```text public void interrupt(String connectionId); ``` ## 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 class. If you use SendFile to upload a file, the class will run synchronously on that Connection Id until it is completed. # LoadSession Method ([MQTTBroker](#mqttbroker-class) Class) Restores session data for a specified client, enabling resumption of pending operations or message delivery. ## Syntax ```text public void loadSession(String sessionInfo); ``` ## Remarks The LoadSession 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 [SaveSession](#savesession-method-mqttbroker-class) method can be used to save session data, and the resulting string can be provided to the LoadSession 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 [SaveSession](#savesession-method-mqttbroker-class), then later loaded with LoadSession** ```csharp string sessiondata = broker.SaveSession("Client1"); // sessiondata contains session information for Client1 ... broker.LoadSession(sessiondata); ``` # Reset Method ([MQTTBroker](#mqttbroker-class) Class) This method will reset the class. ## Syntax ```text public void reset(); ``` ## Remarks This method will reset the class's properties to their default values. # SaveSession Method ([MQTTBroker](#mqttbroker-class) Class) Saves the current state of a client session, including message queues and subscription data, for later retrieval. ## Syntax ```text public String saveSession(String clientId); ``` ## Remarks Returns a JSON string representing the client's subscriptions and messages. This can later be loaded via [LoadSession](#loadsession-method-mqttbroker-class) 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](#mqttbroker-class) Class) This method shuts down the server. ## Syntax ```text public void shutdown(); ``` ## Remarks This method shuts down the server. Calling this method is equivalent to calling [StopListening](#stoplistening-method-mqttbroker-class) and then breaking every client connection by calling [Disconnect](#disconnect-method-mqttbroker-class). # StartListening Method ([MQTTBroker](#mqttbroker-class) Class) This method starts listening for incoming connections. ## Syntax ```text public void startListening(); ``` ## Remarks This method begins listening for incoming connections on the port specified by LocalPort. Once listening, events will fire as new clients connect and data are transferred. To stop listening for new connections, call [StopListening](#stoplistening-method-mqttbroker-class). To stop listening for new connections and to disconnect all existing clients, call [Shutdown](#shutdown-method-mqttbroker-class). # StopListening Method ([MQTTBroker](#mqttbroker-class) Class) This method stops listening for new connections. ## Syntax ```text public void stopListening(); ``` ## 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-class) instead. # Connected Event ([MQTTBroker](#mqttbroker-class) Class) This event is fired immediately after a connection completes (or fails). ## Syntax ```text public class DefaultMQTTBrokerEventListener implements MQTTBrokerEventListener { ... public void connected(MQTTBrokerConnectedEvent e) {} ... } public class MQTTBrokerConnectedEvent { public String connectionId; public int statusCode; public String description; } ``` ## Remarks If the connection is made normally, *StatusCode* is 0, and *Description* is "OK". If the connection fails, *StatusCode* has the error code returned by the system. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the system error. Please refer to the [Error Codes](#trappable-errors-mqttbroker-class) section for more information. # ConnectionRequest Event ([MQTTBroker](#mqttbroker-class) Class) This event is fired when a request for connection comes from a remote host. ## Syntax ```text public class DefaultMQTTBrokerEventListener implements MQTTBrokerEventListener { ... public void connectionRequest(MQTTBrokerConnectionRequestEvent e) {} ... } public class MQTTBrokerConnectionRequestEvent { public String address; public int port; public boolean accept; //read-write } ``` ## 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. # Disconnected Event ([MQTTBroker](#mqttbroker-class) Class) This event is fired when a connection is closed. ## Syntax ```text public class DefaultMQTTBrokerEventListener implements MQTTBrokerEventListener { ... public void disconnected(MQTTBrokerDisconnectedEvent e) {} ... } public class MQTTBrokerDisconnectedEvent { public String connectionId; public int statusCode; public String description; } ``` ## Remarks If the connection is broken normally, *StatusCode* is 0, and *Description* is "OK". If the connection is broken for any other reason, *StatusCode* has the error code returned by the system. *Description* contains a description of this code. The value of *StatusCode* is equal to the value of the system error. Please refer to the [Error Codes](#trappable-errors-mqttbroker-class) section for more information. # Error Event ([MQTTBroker](#mqttbroker-class) Class) This event fires information about errors during data delivery. ## Syntax ```text public class DefaultMQTTBrokerEventListener implements MQTTBrokerEventListener { ... public void error(MQTTBrokerErrorEvent e) {} ... } public class MQTTBrokerErrorEvent { public String connectionId; public int errorCode; public String description; } ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally, the class throws an exception. *ErrorCode* contains an error code and *Description* contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-mqttbroker-class) section. *ConnectionId* indicates the connection for which the error is applicable. # IncomingMessageStatus Event ([MQTTBroker](#mqttbroker-class) Class) Fires when an incoming message's state is updated. ## Syntax ```text public class DefaultMQTTBrokerEventListener implements MQTTBrokerEventListener { ... public void incomingMessageStatus(MQTTBrokerIncomingMessageStatusEvent e) {} ... } public class MQTTBrokerIncomingMessageStatusEvent { public String connectionId; public String clientId; public long messageId; public boolean DUP; public int qoS; public boolean retain; public int packetId; public int state; } ``` ## 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. # Log Event ([MQTTBroker](#mqttbroker-class) Class) Fires once for each log message. ## Syntax ```text public class DefaultMQTTBrokerEventListener implements MQTTBrokerEventListener { ... public void log(MQTTBrokerLogEvent e) {} ... } public class MQTTBrokerLogEvent { public String connectionId; public int logLevel; public String message; public String logType; } ``` ## Remarks This event fires once for each log message generated by the class. The verbosity is controlled by the [LogLevel](#LogLevel) setting. *LogLevel* indicates the level of the *Message*. Possible values are: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data is logged. | | 3 (Debug) | Debug data is logged. | *LogType* identifies the type of log entry. Possible values are: - Info: General information about the class. - Session: Session status messages. - Frame: Frame status messages. # MessageReceived Event ([MQTTBroker](#mqttbroker-class) Class) Fires when a new message is received from a client. ## Syntax ```text public class DefaultMQTTBrokerEventListener implements MQTTBrokerEventListener { ... public void messageReceived(MQTTBrokerMessageReceivedEvent e) {} ... } public class MQTTBrokerMessageReceivedEvent { public String connectionId; public String clientId; public long messageId; } ``` ## Remarks This event fires each time a message is received from a client. # MessageReceiving Event ([MQTTBroker](#mqttbroker-class) Class) Fires when a message is initially received from a client. ## Syntax ```text public class DefaultMQTTBrokerEventListener implements MQTTBrokerEventListener { ... public void messageReceiving(MQTTBrokerMessageReceivingEvent e) {} ... } public class MQTTBrokerMessageReceivingEvent { public String connectionId; public String clientId; public long messageId; public boolean DUP; public int qoS; public boolean retain; public int packetId; } ``` ## 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. # MessageSending Event ([MQTTBroker](#mqttbroker-class) Class) Fires when a message is initially sent to a client. ## Syntax ```text public class DefaultMQTTBrokerEventListener implements MQTTBrokerEventListener { ... public void messageSending(MQTTBrokerMessageSendingEvent e) {} ... } public class MQTTBrokerMessageSendingEvent { public String connectionId; public String clientId; public long messageId; public boolean DUP; public int qoS; public boolean retain; public int packetId; } ``` ## 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. # MessageSent Event ([MQTTBroker](#mqttbroker-class) Class) Fires after a message is successfully delivered to a client, confirming transmission. ## Syntax ```text public class DefaultMQTTBrokerEventListener implements MQTTBrokerEventListener { ... public void messageSent(MQTTBrokerMessageSentEvent e) {} ... } public class MQTTBrokerMessageSentEvent { public String connectionId; public String clientId; public long messageId; } ``` ## Remarks This event fires each time a message is delivered to a client. # OutgoingMessageStatus Event ([MQTTBroker](#mqttbroker-class) Class) Fired to provide the current delivery status of an outgoing message. Includes success or failure metadata. ## Syntax ```text public class DefaultMQTTBrokerEventListener implements MQTTBrokerEventListener { ... public void outgoingMessageStatus(MQTTBrokerOutgoingMessageStatusEvent e) {} ... } public class MQTTBrokerOutgoingMessageStatusEvent { public String connectionId; public String clientId; public long messageId; public boolean DUP; public int qoS; public boolean retain; public int packetId; public int state; } ``` ## 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. # SessionRemoved Event ([MQTTBroker](#mqttbroker-class) Class) Fired when a client session is removed, indicating all resources associated with the session are cleaned up. ## Syntax ```text public class DefaultMQTTBrokerEventListener implements MQTTBrokerEventListener { ... public void sessionRemoved(MQTTBrokerSessionRemovedEvent e) {} ... } public class MQTTBrokerSessionRemovedEvent { public String clientId; } ``` ## Remarks The client with the associated *ClientId* will also be removed from the [Sessions](#sessions-property-mqttbroker-class) collection when this event returns. # SessionRequest Event ([MQTTBroker](#mqttbroker-class) Class) Fires when a new session is requested. ## Syntax ```text public class DefaultMQTTBrokerEventListener implements MQTTBrokerEventListener { ... public void sessionRequest(MQTTBrokerSessionRequestEvent e) {} ... } public class MQTTBrokerSessionRequestEvent { public String connectionId; public String clientId; public String userName; public String password; public boolean isNew; public boolean accept; //read-write } ``` ## 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; }; ``` # SSLClientAuthentication Event ([MQTTBroker](#mqttbroker-class) Class) This event is fired when the client presents its credentials to the server. ## Syntax ```text public class DefaultMQTTBrokerEventListener implements MQTTBrokerEventListener { ... public void SSLClientAuthentication(MQTTBrokerSSLClientAuthenticationEvent e) {} ... } public class MQTTBrokerSSLClientAuthenticationEvent { public String connectionId; public byte[] certEncoded; public String certSubject; public String certIssuer; public String status; public boolean accept; //read-write } ``` ## 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"). # SSLStatus Event ([MQTTBroker](#mqttbroker-class) Class) This event is fired to show the progress of the secure connection. ## Syntax ```text public class DefaultMQTTBrokerEventListener implements MQTTBrokerEventListener { ... public void SSLStatus(MQTTBrokerSSLStatusEvent e) {} ... } public class MQTTBrokerSSLStatusEvent { public String connectionId; public String message; } ``` ## Remarks The event is fired for informational and logging purposes only. It is used to track the progress of the connection. # Subscribe Event ([MQTTBroker](#mqttbroker-class) Class) Fires when a client requests to subscribe to a topic. ## Syntax ```text public class DefaultMQTTBrokerEventListener implements MQTTBrokerEventListener { ... public void subscribe(MQTTBrokerSubscribeEvent e) {} ... } public class MQTTBrokerSubscribeEvent { public String connectionId; public String clientId; public String topicFilter; public int requestedQoS; public int returnCode; //read-write } ``` ## 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 | # Unsubscribe Event ([MQTTBroker](#mqttbroker-class) Class) Fires when a client unsubscribes from a topic, removing its subscription data. ## Syntax ```text public class DefaultMQTTBrokerEventListener implements MQTTBrokerEventListener { ... public void unsubscribe(MQTTBrokerUnsubscribeEvent e) {} ... } public class MQTTBrokerUnsubscribeEvent { public String connectionId; public String clientId; public String topicFilter; } ``` ## Remarks The *TopicFilter* shows the topic this client is unsubscribing from. # MQTTBrokerConnection Type This is a currently connected client. ## Remarks This type describes the connection of a client that is currently connected to the component. You may use the different fields of this type to manage the connection. The following fields are available: - [ClientId](#MQTTBrokerConnection_f_ClientId) - [ConnectionId](#MQTTBrokerConnection_f_ConnectionId) - [KeepAlive](#MQTTBrokerConnection_f_KeepAlive) - [LocalHost](#MQTTBrokerConnection_f_LocalHost) - [LocalPort](#MQTTBrokerConnection_f_LocalPort) - [Protocol](#MQTTBrokerConnection_f_Protocol) - [RemoteHost](#MQTTBrokerConnection_f_RemoteHost) - [RemotePort](#MQTTBrokerConnection_f_RemotePort) - [UserName](#MQTTBrokerConnection_f_UserName) ## Fields **ClientId** *String (read-only)* *Default Value: ""* A unique identifier for the client. **ConnectionId** *String (read-only)* *Default Value: ""* This field contains an identifier generated by the component to identify each connection. This identifier is unique to this connection. **KeepAlive** *int (read-only)* *Default Value: 0* 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. **LocalHost** *String (read-only)* *Default Value: ""* 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. **LocalPort** *int (read-only)* *Default Value: 0* This field shows the Transmission Control Protocol (TCP) port on the local host through which the connection is passing. **Protocol** *int (read-only)* *Default Value: 0* The protocol of the connected client. The class supports the following protocols: | | | | --- | --- | | 0 (mbpTCP) | Plaintext TCP | | 1 (mbpTLS) | SSL/TLS over TCP | | 2 (mbpWS) | Plaintext WebSocket | | 3 (mbpWSS) | SSL/TLS over WebSocket | **RemoteHost** *String (read-only)* *Default Value: ""* 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. **RemotePort** *int (read-only)* *Default Value: 0* 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. **UserName** *String (read-only)* *Default Value: ""* The username for this connected client. ## Constructors ```text public MQTTBrokerConnection(); ``` # MQTTBrokerListener Type This represents a broker listener. ## Remarks Multiple listeners can be configured to listen on different ports and protocols.. The following fields are available: - [LocalHost](#MQTTBrokerListener_f_LocalHost) - [LocalPort](#MQTTBrokerListener_f_LocalPort) - [Protocol](#MQTTBrokerListener_f_Protocol) - [SSLAuthenticateClients](#MQTTBrokerListener_f_SSLAuthenticateClients) - [SSLCertStore](#MQTTBrokerListener_f_SSLCertStore) - [SSLCertStorePassword](#MQTTBrokerListener_f_SSLCertStorePassword) - [SSLCertStoreType](#MQTTBrokerListener_f_SSLCertStoreType) - [SSLCertSubject](#MQTTBrokerListener_f_SSLCertSubject) ## Fields **LocalHost** *String (read-only)* *Default Value: ""* The name of the local host or user-assigned IP interface through which connections are initiated or accepted. **LocalPort** *int (read-only)* *Default Value: 0* This field includes the port in the local host for this listener. **Protocol** *int (read-only)* *Default Value: 0* The class supports the following protocols: | | | | --- | --- | | 0 (mbpTCP) | Plaintext TCP | | 1 (mbpTLS) | SSL/TLS over TCP | | 2 (mbpWS) | Plaintext WebSocket | | 3 (mbpWSS) | SSL/TLS over WebSocket | **SSLAuthenticateClients** *boolean (read-only)* *Default Value: False* If set to True, the server asks the client(s) for a certificate. This is used in conjunction with the SSLClientAuthentication event. Please refer to the documentation of the SSLClientAuthentication event for details. **SSLCertStore** *String (read-only)* *Default Value: "MY"* The name of the certificate store for the listener's certificate. The [StoreType](#MQTTBrokerListener_f_StoreType) field denotes the type of the certificate store specified by [Store](#MQTTBrokerListener_f_Store). If the store is password-protected, specify the password in [StorePassword](#MQTTBrokerListener_f_StorePassword). [Store](#MQTTBrokerListener_f_Store) is used in conjunction with the [Subject](#MQTTBrokerListener_f_Subject) field to specify client certificates. If [Store](#MQTTBrokerListener_f_Store) has a value, and [Subject](#MQTTBrokerListener_f_Subject) or [Encoded](#MQTTBrokerListener_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#MQTTBrokerListener_f_Subject) field 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. | In Java, the certificate store normally is a file containing certificates and optional private keys. 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). **SSLCertStoreB** *byte[] (read-only)* *Default Value: "MY"* The name of the certificate store for the listener's certificate. The [StoreType](#MQTTBrokerListener_f_StoreType) field denotes the type of the certificate store specified by [Store](#MQTTBrokerListener_f_Store). If the store is password-protected, specify the password in [StorePassword](#MQTTBrokerListener_f_StorePassword). [Store](#MQTTBrokerListener_f_Store) is used in conjunction with the [Subject](#MQTTBrokerListener_f_Subject) field to specify client certificates. If [Store](#MQTTBrokerListener_f_Store) has a value, and [Subject](#MQTTBrokerListener_f_Subject) or [Encoded](#MQTTBrokerListener_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#MQTTBrokerListener_f_Subject) field 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. | In Java, the certificate store normally is a file containing certificates and optional private keys. 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). **SSLCertStorePassword** *String (read-only)* *Default Value: ""* This is the password of the SSL certificate. **SSLCertStoreType** *int (read-only)* *Default Value: 0* 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. | In Java, the certificate store normally is a file containing certificates and optional private keys. 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). **SSLCertSubject** *String (read-only)* *Default Value: ""* 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. ## Constructors ```text public MQTTBrokerListener(); ``` # MQTTBrokerMessage Type An MQTT message. ## Remarks This type represents an MQTT message. The following fields are available: - [MessageId](#MQTTBrokerMessage_f_MessageId) - [Payload](#MQTTBrokerMessage_f_Payload) - [Topic](#MQTTBrokerMessage_f_Topic) ## Fields **MessageId** *long (read-only)* *Default Value: 0* Message identifier used to associate the message state. **Payload** *String (read-only)* *Default Value: ""* This message's raw data payload. **PayloadB** *byte[] (read-only)* *Default Value: ""* This message's raw data payload. **Topic** *String (read-only)* *Default Value: ""* This message's topic. ## Constructors ```text public MQTTBrokerMessage(); ``` # MQTTBrokerSession Type Information for the client session. ## Remarks This contains session information for a client. The following fields are available: - [ClientId](#MQTTBrokerSession_f_ClientId) - [IncomingMessages](#MQTTBrokerSession_f_IncomingMessages) - [OutgoingMessages](#MQTTBrokerSession_f_OutgoingMessages) - [SubGrantedQoS](#MQTTBrokerSession_f_SubGrantedQoS) - [SubTopicFilters](#MQTTBrokerSession_f_SubTopicFilters) ## Fields **ClientId** *String (read-only)* *Default Value: ""* A unique identifier for the client. **IncomingMessages** *String (read-only)* *Default Value: ""* A collection of incoming messages. **OutgoingMessages** *String (read-only)* *Default Value: ""* A collection of outgoing messages. **SubGrantedQoS** *String (read-only)* *Default Value: ""* The subscription's granted QoS level for the client. **SubTopicFilters** *String (read-only)* *Default Value: ""* The subscription topic filters for this client session. ## Constructors ```text public MQTTBrokerSession(); ``` # Config Settings ([MQTTBroker](#mqttbroker-class) Class) The class accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the [Config](#config-method-mqttbroker-class) method. ### TCPClient Config Settings **CloseStreamAfterTransfer**: If true, the component will close the upload or download stream after the transfer.This configuration setting determines whether the input or output stream is closed after the transfer completes. When set to True (default), all streams will be closed after a transfer is completed. To keep streams open after the transfer of data, set this to False. The default value is True. **ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data. **EnableFallback**: Whether to try the other addresses the remote host resolves to when a connection attempt fails.When set to True and RemoteHost resolves to more than one address, the class will try the remaining addresses in turn if the connection to the first one fails, and only throws an exception once every address has been tried. The error reported is the one from the last attempt. Use [FallbackTimeout](#FallbackTimeout) to limit the total time spent. NOTE: Only addresses of the same IP version as the first one are tried, this setting does not fall back from IPv6 to IPv4. Selecting between IPv6 and IPv4 is done by [UseIPv6](#UseIPv6) when the host is resolved. This setting must be set before the connection is established. The default value for this setting is False. **FallbackTimeout**: The maximum time in milliseconds to spend on connection attempts when EnableFallback is enabled.This setting limits the total time that the class will spend on all of the connection attempts made when [EnableFallback](#EnableFallback) is enabled. The default value is 0, in which case each attempt uses the operating system's own connection timeout. NOTE: This setting only applies when [EnableFallback](#EnableFallback) is True. It is unrelated to [ConnectionTimeout](#ConnectionTimeout), which is specified in seconds and applies to the Connected operation as a whole. **FirewallAutoDetect**: Tells the class whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by classes that do not directly expose Firewall properties. **FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting. If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned. NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting. **FirewallListener**: If true, the component binds to a SOCKS firewall as a server (TCPClient only).This entry is for TCPClient only and does not work for other components that descend from TCPClient. If this entry is set, the class acts as a server. RemoteHost and RemotePort are used to tell the SOCKS firewall in which address and port to listen to. The firewall rules may ignore RemoteHost, and it is recommended that RemoteHost be set to empty string in this case. RemotePort is the port in which the firewall will listen to. If set to 0, the firewall will select a random port. The binding (address and port) is provided through the ConnectionStatus event. The connection to the firewall is made by calling the Connect method. **FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the class throws an exception. NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value. NOTE: This configuration setting is provided for use by classes that do not directly expose Firewall properties. **FirewallType**: Determines the type of firewall to connect through.Possible values are as follows: | | | | --- | --- | | 0 | No firewall (default setting). | | 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. | | 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. | NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the class throws an exception. NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second. NOTE: This value is not applicable in macOS. **KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. **Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True. In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection. The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes). Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action. **LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout. **LocalHost**: The name of the local host through which connections are initiated or accepted. The LocalHost setting contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface. If the class is connected, the LocalHost setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). **LocalPort**: The port in the local host where the class binds. This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established. LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems. **MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an EOL string. If an EOL string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the DataIn event is fired with the *EOL* parameter set to True, and the buffer is reset. If no EOL is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the DataIn event is fired with the *EOL* parameter set to False, and the buffer is reset. The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes. **MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit. **ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance: *www.google.com;www.example.com* **TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets. NOTE: This value is not applicable in Java. **TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm. By default, this configuration setting is set to False. **UseIPv6**: Whether to use IPv6.When set to *0* (default), the class will use IPv4 exclusively. When set to *1*, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows: | | | | --- | --- | | 0 | IPv4 only | | 1 | IPv6 only | | 2 | IPv6 with IPv4 fallback | **UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1. ### SSL Config Settings **LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [SSLProvider](#sslprovider-property-mqttbroker-class) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes. When enabled, SSL packet logs are output using the [SSLStatus](#sslstatus-event-mqttbroker-class) event, which will fire each time an SSL packet is sent or received. Enabling this configuration setting has no effect if [SSLProvider](#sslprovider-property-mqttbroker-class) is set to *Platform*. **ReuseSSLSession**: Determines if the SSL session is reused. If set to True, the class will reuse the context if and only if the following criteria are met: - The target host name is the same. - The system cache entry has not expired (default timeout is 10 hours). - The application process that calls the function is the same. - The logon session is the same. - The instance of the class is the same. **SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [SSLProvider](#sslprovider-property-mqttbroker-class) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the SSLCert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the class will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class throws an exception. When set to 0 (default), the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the class throws an exception. When set to 0 (default), the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated. NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [SSLStatus](#sslstatus-event-mqttbroker-class) event. Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting. **SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLContextProtocol**: The protocol used when getting an SSLContext instance.Possible values are SSL, SSLv2, SSLv3, TLS, and TLSv1. Use this configuration setting only in case your security provider does not support TLS. This is the parameter "protocol" inside the SSLContext.getInstance(protocol) call. **SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation. By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the class will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. NOTE: This value must be set after [SSLProvider](#sslprovider-property-mqttbroker-class) is set. Example values: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA"); obj.config("SSLEnabledCipherSuites=SSL_RSA_WITH_RC4_128_SHA; SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA"); ``` Possible values when [SSLProvider](#sslprovider-property-mqttbroker-class) is set to *Platform* include the following: - SSL_DHE_RSA_EXPORT_WITH_DES40_CBC_SHA - SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA - SSL_RSA_WITH_RC4_128_SHA - SSL_RSA_WITH_DES_CBC_SHA - SSL_RSA_EXPORT_WITH_DES40_CBC_SHA - SSL_DH_anon_WITH_DES_CBC_SHA - SSL_RSA_EXPORT_WITH_RC4_40_MD5 - SSL_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA - SSL_DH_anon_EXPORT_WITH_RC4_40_MD5 - SSL_DHE_DSS_WITH_DES_CBC_SHA - SSL_RSA_WITH_NULL_MD5 - SSL_DH_anon_WITH_3DES_EDE_CBC_SHA - SSL_DHE_RSA_WITH_DES_CBC_SHA - SSL_DH_anon_EXPORT_WITH_DES40_CBC_SHA - SSL_RSA_WITH_NULL_SHA - SSL_DH_anon_WITH_RC4_128_MD5 - SSL_RSA_WITH_RC4_128_MD5 - SSL_DHE_DSS_WITH_3DES_EDE_CBC_SHA - SSL_RSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_ECDSA_WITH_NULL_SHA - TLS_DH_anon_WITH_AES_128_CBC_SHA256 (Not Recommended) - TLS_ECDH_anon_WITH_RC4_128_SHA - TLS_DH_anon_WITH_AES_128_CBC_SHA (Not Recommended) - TLS_DHE_RSA_WITH_AES_128_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA - TLS_KRB5_WITH_3DES_EDE_CBC_SHA - TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_KRB5_EXPORT_WITH_RC4_40_SHA - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_RC4_128_SHA - TLS_ECDH_ECDSA_WITH_RC4_128_SHA - TLS_ECDH_anon_WITH_NULL_SHA - TLS_ECDHE_ECDSA_WITH_RC4_128_SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA - TLS_RSA_WITH_NULL_SHA256 - TLS_ECDH_anon_WITH_3DES_EDE_CBC_SHA - TLS_KRB5_WITH_RC4_128_MD5 - TLS_ECDHE_ECDSA_WITH_NULL_SHA - TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_RSA_WITH_RC4_128_SHA - TLS_EMPTY_RENEGOTIATION_INFO_SCSV - TLS_KRB5_WITH_3DES_EDE_CBC_MD5 - TLS_KRB5_WITH_RC4_128_SHA - TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_RSA_WITH_NULL_SHA - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA - TLS_KRB5_WITH_DES_CBC_MD5 - TLS_KRB5_EXPORT_WITH_RC4_40_MD5 - TLS_KRB5_EXPORT_WITH_DES_CBC_40_MD5 - TLS_ECDH_anon_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_KRB5_WITH_DES_CBC_SHA - TLS_RSA_WITH_AES_128_CBC_SHA - TLS_KRB5_EXPORT_WITH_DES_CBC_40_SHA - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_NULL_SHA - TLS_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_DSS_WITH_AES_128_CBC_SHA Possible values when [SSLProvider](#sslprovider-property-mqttbroker-class) is set to *Internal* include the following: - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_256_GCM_SHA384 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_DSS_WITH_AES_256_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 - TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 - TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA - TLS_DHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA - TLS_DHE_DSS_WITH_AES_256_CBC_SHA - TLS_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_DSS_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_DES_CBC_SHA - TLS_DHE_RSA_WITH_DES_CBC_SHA - TLS_DHE_DSS_WITH_DES_CBC_SHA - TLS_RSA_WITH_RC4_128_MD5 - TLS_RSA_WITH_RC4_128_SHA When TLS 1.3 is negotiated (see [SSLEnabledProtocols](#SSLEnabledProtocols)), only the following cipher suites are supported: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength). **SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols. Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values: | | | | --- | --- | | TLS1.3 | 12288 (Hex 3000) | | TLS1.2 | 3072 (Hex C00) (Default - Client and Server) | | TLS1.1 | 768 (Hex 300) (Default - Client) | | TLS1 | 192 (Hex C0) (Default - Client) | | SSL3 | 48 (Hex 30) | | SSL2 | 12 (Hex 0C) | Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases. **SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:** By default when TLS 1.3 is enabled, the class will first try to use the platform TLS 1.3 implementation when the [SSLProvider](#sslprovider-property-mqttbroker-class) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. In editions that are designed to run on Windows, [SSLProvider](#sslprovider-property-mqttbroker-class) can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version. If set to *1* (Platform provider), please be aware of the following notes: - The platform provider is available only on Windows 11/Windows Server 2022 and up. - [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported. - If [SSLEnabledProtocols](#SSLEnabledProtocols) includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions. **SSLEnabledProtocols: SSL2 and SSL3 Notes: ** SSL 2.0 and 3.0 are not supported by the class when the [SSLProvider](#sslprovider-property-mqttbroker-class) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [SSLProvider](#sslprovider-property-mqttbroker-class) needs to be set to platform. **SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *false* by default, but it can be set to *true* to enable the extension. This configuration setting is applicable only when [SSLProvider](#sslprovider-property-mqttbroker-class) is set to *Internal*. **SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event. If set to True, all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate. Note: When [SSLProvider](#sslprovider-property-mqttbroker-class) is set to *Internal* this value is automatically set to *true*. This is needed for proper validation when using the internal provider. **SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes. When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values. NOTE: This configuration setting is applicable only when [SSLProvider](#sslprovider-property-mqttbroker-class) is set to *Internal*. **SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipher[connId]"); ``` **SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherStrength[connId]"); ``` **SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherSuite[connId]"); ``` **SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchange[connId]"); ``` **SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchangeStrength[connId]"); ``` **SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedVersion[connId]"); ``` **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----- ``` **SSLTrustManagerFactoryAlgorithm**: The algorithm to be used to create a TrustManager through TrustManagerFactory.Possible values include SunX509. This is the parameter "algorithm" inside the TrustManagerFactory.getInstance(algorithm) call. **TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [SSLProvider](#sslprovider-property-mqttbroker-class) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2. When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class throws an exception. The format of this value is a comma-separated list of hash-signature combinations. For instance: ```csharp component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); ``` The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*. To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. **TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC. The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*. When using TLS 1.2 and [SSLProvider](#sslprovider-property-mqttbroker-class) is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported: - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) **TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server. The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting. NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group. In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" - "ffdhe_6144" - "ffdhe_8192" **TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following: - "ed25519" (default) - "ed448" (default) - "ecdsa_secp256r1_sha256" (default) - "ecdsa_secp384r1_sha384" (default) - "ecdsa_secp521r1_sha512" (default) - "rsa_pkcs1_sha256" (default) - "rsa_pkcs1_sha384" (default) - "rsa_pkcs1_sha512" (default) - "rsa_pss_sha256" (default) - "rsa_pss_sha384" (default) - "rsa_pss_sha512" (default) The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3. **TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" (default) - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" (default) - "ffdhe_6144" (default) - "ffdhe_8192" (default) - "mlkem_512" (default) - "mlkem_768" (default) - "mlkem_1024" (default) - "x25519_mlkem_768" (default) - "secp256r1_mlkem_768" (default) Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported: - Windows Server 2025 - Windows 11 24H2 - Windows 11 25H2 ### Socket Config Settings **AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within Timeout seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout. NOTE: This option is not valid for User Datagram Protocol (UDP) ports. **FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes). **InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. **OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **GUIAvailable**: Whether or not a message loop is available for processing events.In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The class will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation. In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting [GUIAvailable](#GUIAvailable) to *false* will ensure that the class does not attempt to process external events. **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*. **UseDaemonThreads**: Whether threads created by the class are daemon threads.If set to True (default), when the class creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the class will not set the Daemon property on the created thread. The default value is True. **UseFIPSCompliantAPI**: Tells the class whether or not to use FIPS certified APIs.When set to *true*, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries. The Java edition requires installation of the FIPS-certified Bouncy Castle library regardless of the target operating system. This can be downloaded from [https://www.bouncycastle.org/fips-java/](https://www.bouncycastle.org/fips-java/). Only the "Provider" library is needed. The jar file should then be installed in a JRE search path. The following classes must be imported in the application in which the component will be used: ```text import java.security.Security; import org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider; ``` The Bouncy Castle provider must be added as a valid provider and must also be configured to operate in FIPS mode: ```text System.setProperty("org.bouncycastle.fips.approved_only","true"); Security.addProvider(new BouncyCastleFipsProvider()); ``` When [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) is *true*, Secure Sockets Layer (SSL)-enabled classes can optionally be configured to use the Transport Layer Security (TLS) Bouncy Castle library. When [SSLProvider](#sslprovider-property-mqttbroker-class) is set to *sslpAutomatic* (default) or *sslpInternal*, an internal TLS implementation is used, but all cryptographic operations are offloaded to the Bouncy Castle FIPS provider to achieve FIPS-compliant operation. If [SSLProvider](#sslprovider-property-mqttbroker-class) is set to *sslpPlatform*, the Bouncy Castle JSSE will be used in place of the internal TLS implementation. To enable the use of the Bouncy Castle JSSE take the following steps in addition to the steps above. Both the Bouncy Castle FIPS provider and the Bouncy Castle JSSE must be configured to use the Bouncy Castle TLS library in FIPS mode. Obtain the Bouncy Castle TLS library from [https://www.bouncycastle.org/fips-java/](https://www.bouncycastle.org/fips-java/). The jar file should then be installed in a JRE search path. The following classes must be imported in the application in which the component will be used: ```text import java.security.Security; import org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider; //required to use BCJSSE when SSLProvider is set to sslpPlatform import org.bouncycastle.jsse.provider.BouncyCastleJsseProvider; ``` The Bouncy Castle provider must be added as a valid provider and also must be configured to operate in FIPS mode: ```text System.setProperty("org.bouncycastle.fips.approved_only","true"); Security.addProvider(new BouncyCastleFipsProvider()); //required to use BCJSSE when SSLProvider is set to sslpPlatform Security.addProvider(new BouncyCastleJsseProvider("fips:BCFIPS")); //optional - configure logging level of BCJSSE Logger.getLogger("org.bouncycastle.jsse").setLevel(java.util.logging.Level.OFF); //configure the class to use BCJSSE component.setSSLProvider(1); //platform component.config("UseFIPSCompliantAPI=true"); ``` NOTE: TLS 1.3 support requires the Bouncy Castle TLS library version 1.0.14 or later. FIPS mode can be enabled by setting the *UseFIPSCompliantAPI* configuration setting to *true*. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior. For more details, please see the [FIPS 140-2 Compliance](https://www.nsoftware.com/kb/articles/fips.rst) article. NOTE: Enabling FIPS compliance requires a special license; please contact [sales@nsoftware.com](mailto:sales@nsoftware.com) for details. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries. This setting is set to *false* by default on all platforms. **UseVirtualThreads**: Whether threads created by the class use virtual threads instead of platform threads.If set to *true*, when the class creates a thread, it will be created as a virtual thread instead of a platform thread. Virtual threads are lightweight threads managed by the JVM that are multiplexed onto a small pool of carrier threads, significantly reducing memory usage and platform thread count under high-concurrency workloads. Requires Java 24 or later. The default value is *false*. # Trappable Errors ([MQTTBroker](#mqttbroker-class) Class) ### 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 RemotePort at this time. A connection is in progress. | | 101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. | | 102 | The RemoteHost address is invalid (0.0.0.0). | | 104 | Already connected. If you want to reconnect, close the current connection first. | | 106 | You cannot change the LocalPort at this time. A connection is in progress. | | 107 | You cannot change the LocalHost at this time. A connection is in progress. | | 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. | | 116 | RemotePort cannot be zero. Please specify a valid service port number. | | 117 | You cannot change the UseConnection option while the class is active. | | 135 | Operation would block. | | 201 | Timeout. | | 211 | Action impossible in control's present state. | | 212 | Action impossible while not connected. | | 213 | Action impossible while listening. | | 301 | Timeout. | | 303 | 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). |