MQTTBroker Class

Properties   Methods   Events   Config Settings   Errors  

A lightweight, fully-featured MQTT broker implementation.

Syntax

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 method adds a new listener to the Listeners collection. Any listeners must be configured before starting the broker. Multiple protocols can be supported by adding different listeners.

The 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): // 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 method.

Handling Sessions

When an MQTT client requests a session, the SessionRequest 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.

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 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 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 event fires when a message is initially received and contains message metadata.

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.
The MessageReceived 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 event fires when a message is initially sent to a client and contains message metadata.

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.

Saving and Loading Sessions

The SaveSession method saves the current state of a client session, including message queues and subscription data, for later retrieval.

SaveSession returns a JSON string representing the client's subscriptions and messages. This can later be loaded via LoadSession to restore the client's state.

The format should be a JSON string with the following parameters: 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.

ConnectionsA collection of currently connected clients.
DefaultIdleTimeoutThis property includes the default idle timeout for inactive clients.
ListenersDefines the set of network endpoints where the MQTT Broker listens for client connections.
ListeningThis property indicates whether the class is listening for incoming connections on LocalPort.
MessagesProvides a collection of retained messages available to newly subscribed clients.
SessionsContains session information for clients.
SSLProviderThe 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.

AddBrokerListenerCreates a new listener for the broker service.
ConfigSets or retrieves a configuration setting.
DisconnectThis method disconnects the specified client.
DoEventsThis method processes events from the internal message queue.
InterruptThis method interrupts a synchronous send to the remote host.
LoadSessionRestores session data for a specified client, enabling resumption of pending operations or message delivery.
ResetThis method will reset the class.
SaveSessionSaves the current state of a client session, including message queues and subscription data, for later retrieval.
ShutdownThis method shuts down the server.
StartListeningThis method starts listening for incoming connections.
StopListeningThis 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.

ConnectedThis event is fired immediately after a connection completes (or fails).
ConnectionRequestThis event is fired when a request for connection comes from a remote host.
DisconnectedThis event is fired when a connection is closed.
ErrorThis event fires information about errors during data delivery.
IncomingMessageStatusFires when an incoming message's state is updated.
LogFires once for each log message.
MessageReceivedFires when a new message is received from a client.
MessageReceivingFires when a message is initially received from a client.
MessageSendingFires when a message is initially sent to a client.
MessageSentFires after a message is successfully delivered to a client, confirming transmission.
OutgoingMessageStatusFired to provide the current delivery status of an outgoing message. Includes success or failure metadata.
SessionRemovedFired when a client session is removed, indicating all resources associated with the session are cleaned up.
SessionRequestFires when a new session is requested.
SSLClientAuthenticationThis event is fired when the client presents its credentials to the server.
SSLStatusThis event is fired to show the progress of the secure connection.
SubscribeFires when a client requests to subscribe to a topic.
UnsubscribeFires 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.

ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveRetryCountThe number of keep-alive packets to be sent before the remotehost is considered disconnected.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificates to be included when performing an SSL handshake.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLClientCACertsA newline separated list of CA certificates to use during SSL client certificate validation.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated cipher suite.
SSLNegotiatedCipherStrengthReturns the negotiated cipher suite strength.
SSLNegotiatedCipherSuiteReturns the negotiated cipher suite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificates to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveDataWhether sensitive data is masked in log messages.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseFIPSCompliantAPITells the class whether or not to use FIPS certified APIs.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

Connections Property (MQTTBroker Class)

A collection of currently connected clients.

Syntax

int ipworksiot_mqttbroker_getconnectioncount(void* lpObj);
char* ipworksiot_mqttbroker_getconnectionclientid(void* lpObj, int connectionid);
int ipworksiot_mqttbroker_getconnectionconnectionid(void* lpObj, int connectionid);
int ipworksiot_mqttbroker_getconnectionkeepalive(void* lpObj, int connectionid);
char* ipworksiot_mqttbroker_getconnectionlocalhost(void* lpObj, int connectionid);
int ipworksiot_mqttbroker_getconnectionlocalport(void* lpObj, int connectionid);
int ipworksiot_mqttbroker_getconnectionprotocol(void* lpObj, int connectionid);
char* ipworksiot_mqttbroker_getconnectionremotehost(void* lpObj, int connectionid);
int ipworksiot_mqttbroker_getconnectionremoteport(void* lpObj, int connectionid);
char* ipworksiot_mqttbroker_getconnectionusername(void* lpObj, int connectionid);
int GetConnectionCount();

QString GetConnectionClientId(int iConnectionId);

int GetConnectionConnectionId(int iConnectionId);

int GetConnectionKeepAlive(int iConnectionId);

QString GetConnectionLocalHost(int iConnectionId);

int GetConnectionLocalPort(int iConnectionId);

int GetConnectionProtocol(int iConnectionId);

QString GetConnectionRemoteHost(int iConnectionId);

int GetConnectionRemotePort(int iConnectionId);

QString GetConnectionUserName(int iConnectionId);

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.

Data Type

IPWorksIoTMQTTBrokerConnection

DefaultIdleTimeout Property (MQTTBroker Class)

This property includes the default idle timeout for inactive clients.

Syntax

ANSI (Cross Platform)
int GetDefaultIdleTimeout();
int SetDefaultIdleTimeout(int iDefaultIdleTimeout); Unicode (Windows) INT GetDefaultIdleTimeout();
INT SetDefaultIdleTimeout(INT iDefaultIdleTimeout);
int ipworksiot_mqttbroker_getdefaultidletimeout(void* lpObj);
int ipworksiot_mqttbroker_setdefaultidletimeout(void* lpObj, int iDefaultIdleTimeout);
int GetDefaultIdleTimeout();
int SetDefaultIdleTimeout(int iDefaultIdleTimeout);

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 must be called for the class to check existing connections.

Data Type

Integer

Listeners Property (MQTTBroker Class)

Defines the set of network endpoints where the MQTT Broker listens for client connections.

Syntax

int ipworksiot_mqttbroker_getlistenercount(void* lpObj);
char* ipworksiot_mqttbroker_getlistenerlocalhost(void* lpObj, int listenerindex);
int ipworksiot_mqttbroker_getlistenerlocalport(void* lpObj, int listenerindex);
int ipworksiot_mqttbroker_getlistenerprotocol(void* lpObj, int listenerindex);
int ipworksiot_mqttbroker_getlistenersslauthenticateclients(void* lpObj, int listenerindex);
int ipworksiot_mqttbroker_getlistenersslcertstore(void* lpObj, int listenerindex, char** lpListenerSSLCertStore, int* lenListenerSSLCertStore);
char* ipworksiot_mqttbroker_getlistenersslcertstorepassword(void* lpObj, int listenerindex);
int ipworksiot_mqttbroker_getlistenersslcertstoretype(void* lpObj, int listenerindex);
char* ipworksiot_mqttbroker_getlistenersslcertsubject(void* lpObj, int listenerindex);
int GetListenerCount();

QString GetListenerLocalHost(int iListenerIndex);

int GetListenerLocalPort(int iListenerIndex);

int GetListenerProtocol(int iListenerIndex);

bool GetListenerSSLAuthenticateClients(int iListenerIndex);

QByteArray GetListenerSSLCertStore(int iListenerIndex);

QString GetListenerSSLCertStorePassword(int iListenerIndex);

int GetListenerSSLCertStoreType(int iListenerIndex);

QString GetListenerSSLCertSubject(int iListenerIndex);

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.

Data Type

IPWorksIoTMQTTBrokerListener

Listening Property (MQTTBroker Class)

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

Syntax

ANSI (Cross Platform)
int GetListening();

Unicode (Windows)
BOOL GetListening();
int ipworksiot_mqttbroker_getlistening(void* lpObj);
bool GetListening();

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 and StopListening methods to control whether the class is listening.

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

Data Type

Boolean

Messages Property (MQTTBroker Class)

Provides a collection of retained messages available to newly subscribed clients.

Syntax

int ipworksiot_mqttbroker_getmessagecount(void* lpObj);
int64 ipworksiot_mqttbroker_getmessagemessageid(void* lpObj, int messageindex);
int ipworksiot_mqttbroker_getmessagepayload(void* lpObj, int messageindex, char** lpMessagePayload, int* lenMessagePayload);
char* ipworksiot_mqttbroker_getmessagetopic(void* lpObj, int messageindex);
int GetMessageCount();

qint64 GetMessageMessageId(int iMessageIndex);

QByteArray GetMessagePayload(int iMessageIndex);

QString GetMessageTopic(int iMessageIndex);

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.

Data Type

IPWorksIoTMQTTBrokerMessage

Sessions Property (MQTTBroker Class)

Contains session information for clients.

Syntax

int ipworksiot_mqttbroker_getsessioncount(void* lpObj);
char* ipworksiot_mqttbroker_getsessionclientid(void* lpObj, int sessionindex);
char* ipworksiot_mqttbroker_getsessionincomingmessages(void* lpObj, int sessionindex);
char* ipworksiot_mqttbroker_getsessionoutgoingmessages(void* lpObj, int sessionindex);
char* ipworksiot_mqttbroker_getsessionsubgrantedqos(void* lpObj, int sessionindex);
char* ipworksiot_mqttbroker_getsessionsubtopicfilters(void* lpObj, int sessionindex);
int GetSessionCount();

QString GetSessionClientId(int iSessionIndex);

QString GetSessionIncomingMessages(int iSessionIndex);

QString GetSessionOutgoingMessages(int iSessionIndex);

QString GetSessionSubGrantedQoS(int iSessionIndex);

QString GetSessionSubTopicFilters(int iSessionIndex);

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.

Data Type

IPWorksIoTMQTTBrokerSession

SSLProvider Property (MQTTBroker Class)

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

Syntax

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider); Unicode (Windows) INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

Possible Values

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1),
SSLP_INTERNAL(2)
int ipworksiot_mqttbroker_getsslprovider(void* lpObj);
int ipworksiot_mqttbroker_setsslprovider(void* lpObj, int iSSLProvider);
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

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

Possible values are as follows:

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

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

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

AddBrokerListener Method (MQTTBroker Class)

Creates a new listener for the broker service.

Syntax

ANSI (Cross Platform)
int AddBrokerListener(const char* lpszLocalHost, int iLocalPort, int iProtocol, int iSSLCertStoreType, const char* lpSSLCertStore, int lenSSLCertStore, const char* lpszSSLCertStorePassword, const char* lpszSSLCertSubject);

Unicode (Windows)
INT AddBrokerListener(LPCWSTR lpszLocalHost, INT iLocalPort, INT iProtocol, INT iSSLCertStoreType, LPCSTR lpSSLCertStore, INT lenSSLCertStore, LPCWSTR lpszSSLCertStorePassword, LPCWSTR lpszSSLCertSubject);
int ipworksiot_mqttbroker_addbrokerlistener(void* lpObj, const char* lpszLocalHost, int iLocalPort, int iProtocol, int iSSLCertStoreType, const char* lpSSLCertStore, int lenSSLCertStore, const char* lpszSSLCertStorePassword, const char* lpszSSLCertSubject);
int AddBrokerListener(const QString& qsLocalHost, int iLocalPort, int iProtocol, int iSSLCertStoreType, QByteArray qbaSSLCertStore, const QString& qsSSLCertStorePassword, const QString& qsSSLCertSubject);

Remarks

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

The 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): // 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", "*");

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (MQTTBroker Class)

Sets or retrieves a configuration setting.

Syntax

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
char* ipworksiot_mqttbroker_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings 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, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Disconnect Method (MQTTBroker Class)

This method disconnects the specified client.

Syntax

ANSI (Cross Platform)
int Disconnect(int iConnectionId);

Unicode (Windows)
INT Disconnect(INT iConnectionId);
int ipworksiot_mqttbroker_disconnect(void* lpObj, int iConnectionId);
int Disconnect(int iConnectionId);

Remarks

Calling this method will disconnect the client specified by the ConnectionId parameter.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DoEvents Method (MQTTBroker Class)

This method processes events from the internal message queue.

Syntax

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();
int ipworksiot_mqttbroker_doevents(void* lpObj);
int 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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Interrupt Method (MQTTBroker Class)

This method interrupts a synchronous send to the remote host.

Syntax

ANSI (Cross Platform)
int Interrupt(int iConnectionId);

Unicode (Windows)
INT Interrupt(INT iConnectionId);
int ipworksiot_mqttbroker_interrupt(void* lpObj, int iConnectionId);
int Interrupt(int iConnectionId);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

LoadSession Method (MQTTBroker Class)

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

Syntax

ANSI (Cross Platform)
int LoadSession(const char* lpszsessionInfo);

Unicode (Windows)
INT LoadSession(LPCWSTR lpszsessionInfo);
int ipworksiot_mqttbroker_loadsession(void* lpObj, const char* lpszsessionInfo);
int LoadSession(const QString& qssessionInfo);

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 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: { "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, then later loaded with LoadSession string sessiondata = broker.SaveSession("Client1"); // sessiondata contains session information for Client1 ... broker.LoadSession(sessiondata);

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (MQTTBroker Class)

This method will reset the class.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();
int ipworksiot_mqttbroker_reset(void* lpObj);
int Reset();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SaveSession Method (MQTTBroker Class)

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

Syntax

ANSI (Cross Platform)
char* SaveSession(const char* lpszclientId);

Unicode (Windows)
LPWSTR SaveSession(LPCWSTR lpszclientId);
char* ipworksiot_mqttbroker_savesession(void* lpObj, const char* lpszclientId);
QString SaveSession(const QString& qsclientId);

Remarks

Returns a JSON string representing the client's subscriptions and messages. This can later be loaded via LoadSession to restore the client's state.

The format should be a JSON string with the following parameters: 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 }] }

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Shutdown Method (MQTTBroker Class)

This method shuts down the server.

Syntax

ANSI (Cross Platform)
int Shutdown();

Unicode (Windows)
INT Shutdown();
int ipworksiot_mqttbroker_shutdown(void* lpObj);
int Shutdown();

Remarks

This method shuts down the server. Calling this method is equivalent to calling StopListening and then breaking every client connection by calling Disconnect.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

StartListening Method (MQTTBroker Class)

This method starts listening for incoming connections.

Syntax

ANSI (Cross Platform)
int StartListening();

Unicode (Windows)
INT StartListening();
int ipworksiot_mqttbroker_startlistening(void* lpObj);
int 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. To stop listening for new connections and to disconnect all existing clients, call Shutdown.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

StopListening Method (MQTTBroker Class)

This method stops listening for new connections.

Syntax

ANSI (Cross Platform)
int StopListening();

Unicode (Windows)
INT StopListening();
int ipworksiot_mqttbroker_stoplistening(void* lpObj);
int 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 instead.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Connected Event (MQTTBroker Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireConnected(MQTTBrokerConnectedEventParams *e);
typedef struct {
int ConnectionId;
int StatusCode;
const char *Description; int reserved; } MQTTBrokerConnectedEventParams;
Unicode (Windows) virtual INT FireConnected(MQTTBrokerConnectedEventParams *e);
typedef struct {
INT ConnectionId;
INT StatusCode;
LPCWSTR Description; INT reserved; } MQTTBrokerConnectedEventParams;
#define EID_MQTTBROKER_CONNECTED 1

virtual INT IPWORKSIOT_CALL FireConnected(INT &iConnectionId, INT &iStatusCode, LPSTR &lpszDescription);
class MQTTBrokerConnectedEventParams {
public:
  int ConnectionId();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Connected(MQTTBrokerConnectedEventParams *e);
// Or, subclass MQTTBroker and override this emitter function. virtual int FireConnected(MQTTBrokerConnectedEventParams *e) {...}

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 section for more information.

ConnectionRequest Event (MQTTBroker Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireConnectionRequest(MQTTBrokerConnectionRequestEventParams *e);
typedef struct {
const char *Address;
int Port;
int Accept; int reserved; } MQTTBrokerConnectionRequestEventParams;
Unicode (Windows) virtual INT FireConnectionRequest(MQTTBrokerConnectionRequestEventParams *e);
typedef struct {
LPCWSTR Address;
INT Port;
BOOL Accept; INT reserved; } MQTTBrokerConnectionRequestEventParams;
#define EID_MQTTBROKER_CONNECTIONREQUEST 2

virtual INT IPWORKSIOT_CALL FireConnectionRequest(LPSTR &lpszAddress, INT &iPort, BOOL &bAccept);
class MQTTBrokerConnectionRequestEventParams {
public:
  const QString &Address();

  int Port();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void ConnectionRequest(MQTTBrokerConnectionRequestEventParams *e);
// Or, subclass MQTTBroker and override this emitter function. virtual int FireConnectionRequest(MQTTBrokerConnectionRequestEventParams *e) {...}

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

This event is fired when a connection is closed.

Syntax

ANSI (Cross Platform)
virtual int FireDisconnected(MQTTBrokerDisconnectedEventParams *e);
typedef struct {
int ConnectionId;
int StatusCode;
const char *Description; int reserved; } MQTTBrokerDisconnectedEventParams;
Unicode (Windows) virtual INT FireDisconnected(MQTTBrokerDisconnectedEventParams *e);
typedef struct {
INT ConnectionId;
INT StatusCode;
LPCWSTR Description; INT reserved; } MQTTBrokerDisconnectedEventParams;
#define EID_MQTTBROKER_DISCONNECTED 3

virtual INT IPWORKSIOT_CALL FireDisconnected(INT &iConnectionId, INT &iStatusCode, LPSTR &lpszDescription);
class MQTTBrokerDisconnectedEventParams {
public:
  int ConnectionId();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Disconnected(MQTTBrokerDisconnectedEventParams *e);
// Or, subclass MQTTBroker and override this emitter function. virtual int FireDisconnected(MQTTBrokerDisconnectedEventParams *e) {...}

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 section for more information.

Error Event (MQTTBroker Class)

This event fires information about errors during data delivery.

Syntax

ANSI (Cross Platform)
virtual int FireError(MQTTBrokerErrorEventParams *e);
typedef struct {
int ConnectionId;
int ErrorCode;
const char *Description; int reserved; } MQTTBrokerErrorEventParams;
Unicode (Windows) virtual INT FireError(MQTTBrokerErrorEventParams *e);
typedef struct {
INT ConnectionId;
INT ErrorCode;
LPCWSTR Description; INT reserved; } MQTTBrokerErrorEventParams;
#define EID_MQTTBROKER_ERROR 4

virtual INT IPWORKSIOT_CALL FireError(INT &iConnectionId, INT &iErrorCode, LPSTR &lpszDescription);
class MQTTBrokerErrorEventParams {
public:
  int ConnectionId();

  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Error(MQTTBrokerErrorEventParams *e);
// Or, subclass MQTTBroker and override this emitter function. virtual int FireError(MQTTBrokerErrorEventParams *e) {...}

Remarks

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

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

ConnectionId indicates the connection for which the error is applicable.

IncomingMessageStatus Event (MQTTBroker Class)

Fires when an incoming message's state is updated.

Syntax

ANSI (Cross Platform)
virtual int FireIncomingMessageStatus(MQTTBrokerIncomingMessageStatusEventParams *e);
typedef struct {
int ConnectionId;
const char *ClientId;
int64 MessageId;
int DUP;
int QoS;
int Retain;
int PacketId;
int State; int reserved; } MQTTBrokerIncomingMessageStatusEventParams;
Unicode (Windows) virtual INT FireIncomingMessageStatus(MQTTBrokerIncomingMessageStatusEventParams *e);
typedef struct {
INT ConnectionId;
LPCWSTR ClientId;
LONG64 MessageId;
BOOL DUP;
INT QoS;
BOOL Retain;
INT PacketId;
INT State; INT reserved; } MQTTBrokerIncomingMessageStatusEventParams;
#define EID_MQTTBROKER_INCOMINGMESSAGESTATUS 5

virtual INT IPWORKSIOT_CALL FireIncomingMessageStatus(INT &iConnectionId, LPSTR &lpszClientId, LONG64 &lMessageId, BOOL &bDUP, INT &iQoS, BOOL &bRetain, INT &iPacketId, INT &iState);
class MQTTBrokerIncomingMessageStatusEventParams {
public:
  int ConnectionId();

  const QString &ClientId();

  qint64 MessageId();

  bool DUP();

  int QoS();

  bool Retain();

  int PacketId();

  int State();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void IncomingMessageStatus(MQTTBrokerIncomingMessageStatusEventParams *e);
// Or, subclass MQTTBroker and override this emitter function. virtual int FireIncomingMessageStatus(MQTTBrokerIncomingMessageStatusEventParams *e) {...}

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

Fires once for each log message.

Syntax

ANSI (Cross Platform)
virtual int FireLog(MQTTBrokerLogEventParams *e);
typedef struct {
int ConnectionId;
int LogLevel;
const char *Message;
const char *LogType; int reserved; } MQTTBrokerLogEventParams;
Unicode (Windows) virtual INT FireLog(MQTTBrokerLogEventParams *e);
typedef struct {
INT ConnectionId;
INT LogLevel;
LPCWSTR Message;
LPCWSTR LogType; INT reserved; } MQTTBrokerLogEventParams;
#define EID_MQTTBROKER_LOG 6

virtual INT IPWORKSIOT_CALL FireLog(INT &iConnectionId, INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);
class MQTTBrokerLogEventParams {
public:
  int ConnectionId();

  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Log(MQTTBrokerLogEventParams *e);
// Or, subclass MQTTBroker and override this emitter function. virtual int FireLog(MQTTBrokerLogEventParams *e) {...}

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the 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 Class)

Fires when a new message is received from a client.

Syntax

ANSI (Cross Platform)
virtual int FireMessageReceived(MQTTBrokerMessageReceivedEventParams *e);
typedef struct {
int ConnectionId;
const char *ClientId;
int64 MessageId; int reserved; } MQTTBrokerMessageReceivedEventParams;
Unicode (Windows) virtual INT FireMessageReceived(MQTTBrokerMessageReceivedEventParams *e);
typedef struct {
INT ConnectionId;
LPCWSTR ClientId;
LONG64 MessageId; INT reserved; } MQTTBrokerMessageReceivedEventParams;
#define EID_MQTTBROKER_MESSAGERECEIVED 7

virtual INT IPWORKSIOT_CALL FireMessageReceived(INT &iConnectionId, LPSTR &lpszClientId, LONG64 &lMessageId);
class MQTTBrokerMessageReceivedEventParams {
public:
  int ConnectionId();

  const QString &ClientId();

  qint64 MessageId();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void MessageReceived(MQTTBrokerMessageReceivedEventParams *e);
// Or, subclass MQTTBroker and override this emitter function. virtual int FireMessageReceived(MQTTBrokerMessageReceivedEventParams *e) {...}

Remarks

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

MessageReceiving Event (MQTTBroker Class)

Fires when a message is initially received from a client.

Syntax

ANSI (Cross Platform)
virtual int FireMessageReceiving(MQTTBrokerMessageReceivingEventParams *e);
typedef struct {
int ConnectionId;
const char *ClientId;
int64 MessageId;
int DUP;
int QoS;
int Retain;
int PacketId; int reserved; } MQTTBrokerMessageReceivingEventParams;
Unicode (Windows) virtual INT FireMessageReceiving(MQTTBrokerMessageReceivingEventParams *e);
typedef struct {
INT ConnectionId;
LPCWSTR ClientId;
LONG64 MessageId;
BOOL DUP;
INT QoS;
BOOL Retain;
INT PacketId; INT reserved; } MQTTBrokerMessageReceivingEventParams;
#define EID_MQTTBROKER_MESSAGERECEIVING 8

virtual INT IPWORKSIOT_CALL FireMessageReceiving(INT &iConnectionId, LPSTR &lpszClientId, LONG64 &lMessageId, BOOL &bDUP, INT &iQoS, BOOL &bRetain, INT &iPacketId);
class MQTTBrokerMessageReceivingEventParams {
public:
  int ConnectionId();

  const QString &ClientId();

  qint64 MessageId();

  bool DUP();

  int QoS();

  bool Retain();

  int PacketId();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void MessageReceiving(MQTTBrokerMessageReceivingEventParams *e);
// Or, subclass MQTTBroker and override this emitter function. virtual int FireMessageReceiving(MQTTBrokerMessageReceivingEventParams *e) {...}

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

Fires when a message is initially sent to a client.

Syntax

ANSI (Cross Platform)
virtual int FireMessageSending(MQTTBrokerMessageSendingEventParams *e);
typedef struct {
int ConnectionId;
const char *ClientId;
int64 MessageId;
int DUP;
int QoS;
int Retain;
int PacketId; int reserved; } MQTTBrokerMessageSendingEventParams;
Unicode (Windows) virtual INT FireMessageSending(MQTTBrokerMessageSendingEventParams *e);
typedef struct {
INT ConnectionId;
LPCWSTR ClientId;
LONG64 MessageId;
BOOL DUP;
INT QoS;
BOOL Retain;
INT PacketId; INT reserved; } MQTTBrokerMessageSendingEventParams;
#define EID_MQTTBROKER_MESSAGESENDING 9

virtual INT IPWORKSIOT_CALL FireMessageSending(INT &iConnectionId, LPSTR &lpszClientId, LONG64 &lMessageId, BOOL &bDUP, INT &iQoS, BOOL &bRetain, INT &iPacketId);
class MQTTBrokerMessageSendingEventParams {
public:
  int ConnectionId();

  const QString &ClientId();

  qint64 MessageId();

  bool DUP();

  int QoS();

  bool Retain();

  int PacketId();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void MessageSending(MQTTBrokerMessageSendingEventParams *e);
// Or, subclass MQTTBroker and override this emitter function. virtual int FireMessageSending(MQTTBrokerMessageSendingEventParams *e) {...}

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

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

Syntax

ANSI (Cross Platform)
virtual int FireMessageSent(MQTTBrokerMessageSentEventParams *e);
typedef struct {
int ConnectionId;
const char *ClientId;
int64 MessageId; int reserved; } MQTTBrokerMessageSentEventParams;
Unicode (Windows) virtual INT FireMessageSent(MQTTBrokerMessageSentEventParams *e);
typedef struct {
INT ConnectionId;
LPCWSTR ClientId;
LONG64 MessageId; INT reserved; } MQTTBrokerMessageSentEventParams;
#define EID_MQTTBROKER_MESSAGESENT 10

virtual INT IPWORKSIOT_CALL FireMessageSent(INT &iConnectionId, LPSTR &lpszClientId, LONG64 &lMessageId);
class MQTTBrokerMessageSentEventParams {
public:
  int ConnectionId();

  const QString &ClientId();

  qint64 MessageId();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void MessageSent(MQTTBrokerMessageSentEventParams *e);
// Or, subclass MQTTBroker and override this emitter function. virtual int FireMessageSent(MQTTBrokerMessageSentEventParams *e) {...}

Remarks

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

OutgoingMessageStatus Event (MQTTBroker Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireOutgoingMessageStatus(MQTTBrokerOutgoingMessageStatusEventParams *e);
typedef struct {
int ConnectionId;
const char *ClientId;
int64 MessageId;
int DUP;
int QoS;
int Retain;
int PacketId;
int State; int reserved; } MQTTBrokerOutgoingMessageStatusEventParams;
Unicode (Windows) virtual INT FireOutgoingMessageStatus(MQTTBrokerOutgoingMessageStatusEventParams *e);
typedef struct {
INT ConnectionId;
LPCWSTR ClientId;
LONG64 MessageId;
BOOL DUP;
INT QoS;
BOOL Retain;
INT PacketId;
INT State; INT reserved; } MQTTBrokerOutgoingMessageStatusEventParams;
#define EID_MQTTBROKER_OUTGOINGMESSAGESTATUS 11

virtual INT IPWORKSIOT_CALL FireOutgoingMessageStatus(INT &iConnectionId, LPSTR &lpszClientId, LONG64 &lMessageId, BOOL &bDUP, INT &iQoS, BOOL &bRetain, INT &iPacketId, INT &iState);
class MQTTBrokerOutgoingMessageStatusEventParams {
public:
  int ConnectionId();

  const QString &ClientId();

  qint64 MessageId();

  bool DUP();

  int QoS();

  bool Retain();

  int PacketId();

  int State();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void OutgoingMessageStatus(MQTTBrokerOutgoingMessageStatusEventParams *e);
// Or, subclass MQTTBroker and override this emitter function. virtual int FireOutgoingMessageStatus(MQTTBrokerOutgoingMessageStatusEventParams *e) {...}

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

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

Syntax

ANSI (Cross Platform)
virtual int FireSessionRemoved(MQTTBrokerSessionRemovedEventParams *e);
typedef struct {
const char *ClientId; int reserved; } MQTTBrokerSessionRemovedEventParams;
Unicode (Windows) virtual INT FireSessionRemoved(MQTTBrokerSessionRemovedEventParams *e);
typedef struct {
LPCWSTR ClientId; INT reserved; } MQTTBrokerSessionRemovedEventParams;
#define EID_MQTTBROKER_SESSIONREMOVED 12

virtual INT IPWORKSIOT_CALL FireSessionRemoved(LPSTR &lpszClientId);
class MQTTBrokerSessionRemovedEventParams {
public:
  const QString &ClientId();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SessionRemoved(MQTTBrokerSessionRemovedEventParams *e);
// Or, subclass MQTTBroker and override this emitter function. virtual int FireSessionRemoved(MQTTBrokerSessionRemovedEventParams *e) {...}

Remarks

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

SessionRequest Event (MQTTBroker Class)

Fires when a new session is requested.

Syntax

ANSI (Cross Platform)
virtual int FireSessionRequest(MQTTBrokerSessionRequestEventParams *e);
typedef struct {
int ConnectionId;
const char *ClientId;
const char *UserName;
const char *Password;
int IsNew;
int Accept; int reserved; } MQTTBrokerSessionRequestEventParams;
Unicode (Windows) virtual INT FireSessionRequest(MQTTBrokerSessionRequestEventParams *e);
typedef struct {
INT ConnectionId;
LPCWSTR ClientId;
LPCWSTR UserName;
LPCWSTR Password;
BOOL IsNew;
BOOL Accept; INT reserved; } MQTTBrokerSessionRequestEventParams;
#define EID_MQTTBROKER_SESSIONREQUEST 13

virtual INT IPWORKSIOT_CALL FireSessionRequest(INT &iConnectionId, LPSTR &lpszClientId, LPSTR &lpszUserName, LPSTR &lpszPassword, BOOL &bIsNew, BOOL &bAccept);
class MQTTBrokerSessionRequestEventParams {
public:
  int ConnectionId();

  const QString &ClientId();

  const QString &UserName();

  const QString &Password();

  bool IsNew();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SessionRequest(MQTTBrokerSessionRequestEventParams *e);
// Or, subclass MQTTBroker and override this emitter function. virtual int FireSessionRequest(MQTTBrokerSessionRequestEventParams *e) {...}

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: 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 Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireSSLClientAuthentication(MQTTBrokerSSLClientAuthenticationEventParams *e);
typedef struct {
int ConnectionId;
const char *CertEncoded; int lenCertEncoded;
const char *CertSubject;
const char *CertIssuer;
const char *Status;
int Accept; int reserved; } MQTTBrokerSSLClientAuthenticationEventParams;
Unicode (Windows) virtual INT FireSSLClientAuthentication(MQTTBrokerSSLClientAuthenticationEventParams *e);
typedef struct {
INT ConnectionId;
LPCSTR CertEncoded; INT lenCertEncoded;
LPCWSTR CertSubject;
LPCWSTR CertIssuer;
LPCWSTR Status;
BOOL Accept; INT reserved; } MQTTBrokerSSLClientAuthenticationEventParams;
#define EID_MQTTBROKER_SSLCLIENTAUTHENTICATION 14

virtual INT IPWORKSIOT_CALL FireSSLClientAuthentication(INT &iConnectionId, LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);
class MQTTBrokerSSLClientAuthenticationEventParams {
public:
  int ConnectionId();

  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SSLClientAuthentication(MQTTBrokerSSLClientAuthenticationEventParams *e);
// Or, subclass MQTTBroker and override this emitter function. virtual int FireSSLClientAuthentication(MQTTBrokerSSLClientAuthenticationEventParams *e) {...}

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

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

Syntax

ANSI (Cross Platform)
virtual int FireSSLStatus(MQTTBrokerSSLStatusEventParams *e);
typedef struct {
int ConnectionId;
const char *Message; int reserved; } MQTTBrokerSSLStatusEventParams;
Unicode (Windows) virtual INT FireSSLStatus(MQTTBrokerSSLStatusEventParams *e);
typedef struct {
INT ConnectionId;
LPCWSTR Message; INT reserved; } MQTTBrokerSSLStatusEventParams;
#define EID_MQTTBROKER_SSLSTATUS 15

virtual INT IPWORKSIOT_CALL FireSSLStatus(INT &iConnectionId, LPSTR &lpszMessage);
class MQTTBrokerSSLStatusEventParams {
public:
  int ConnectionId();

  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SSLStatus(MQTTBrokerSSLStatusEventParams *e);
// Or, subclass MQTTBroker and override this emitter function. virtual int FireSSLStatus(MQTTBrokerSSLStatusEventParams *e) {...}

Remarks

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

Subscribe Event (MQTTBroker Class)

Fires when a client requests to subscribe to a topic.

Syntax

ANSI (Cross Platform)
virtual int FireSubscribe(MQTTBrokerSubscribeEventParams *e);
typedef struct {
int ConnectionId;
const char *ClientId;
const char *TopicFilter;
int RequestedQoS;
int ReturnCode; int reserved; } MQTTBrokerSubscribeEventParams;
Unicode (Windows) virtual INT FireSubscribe(MQTTBrokerSubscribeEventParams *e);
typedef struct {
INT ConnectionId;
LPCWSTR ClientId;
LPCWSTR TopicFilter;
INT RequestedQoS;
INT ReturnCode; INT reserved; } MQTTBrokerSubscribeEventParams;
#define EID_MQTTBROKER_SUBSCRIBE 16

virtual INT IPWORKSIOT_CALL FireSubscribe(INT &iConnectionId, LPSTR &lpszClientId, LPSTR &lpszTopicFilter, INT &iRequestedQoS, INT &iReturnCode);
class MQTTBrokerSubscribeEventParams {
public:
  int ConnectionId();

  const QString &ClientId();

  const QString &TopicFilter();

  int RequestedQoS();

  int ReturnCode();
  void SetReturnCode(int iReturnCode);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Subscribe(MQTTBrokerSubscribeEventParams *e);
// Or, subclass MQTTBroker and override this emitter function. virtual int FireSubscribe(MQTTBrokerSubscribeEventParams *e) {...}

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

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

Syntax

ANSI (Cross Platform)
virtual int FireUnsubscribe(MQTTBrokerUnsubscribeEventParams *e);
typedef struct {
int ConnectionId;
const char *ClientId;
const char *TopicFilter; int reserved; } MQTTBrokerUnsubscribeEventParams;
Unicode (Windows) virtual INT FireUnsubscribe(MQTTBrokerUnsubscribeEventParams *e);
typedef struct {
INT ConnectionId;
LPCWSTR ClientId;
LPCWSTR TopicFilter; INT reserved; } MQTTBrokerUnsubscribeEventParams;
#define EID_MQTTBROKER_UNSUBSCRIBE 17

virtual INT IPWORKSIOT_CALL FireUnsubscribe(INT &iConnectionId, LPSTR &lpszClientId, LPSTR &lpszTopicFilter);
class MQTTBrokerUnsubscribeEventParams {
public:
  int ConnectionId();

  const QString &ClientId();

  const QString &TopicFilter();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Unsubscribe(MQTTBrokerUnsubscribeEventParams *e);
// Or, subclass MQTTBroker and override this emitter function. virtual int FireUnsubscribe(MQTTBrokerUnsubscribeEventParams *e) {...}

Remarks

The TopicFilter shows the topic this client is unsubscribing from.

MQTTBrokerConnection Type

This is a currently connected client.

Syntax

IPWorksIoTMQTTBrokerConnection (declared in ipworksiot.h)

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:

Fields

ClientId
char* (read-only)

Default Value: ""

A unique identifier for the client.

ConnectionId
int (read-only)

Default Value: 0

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
char* (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
char* (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
char* (read-only)

Default Value: ""

The username for this connected client.

Constructors

MQTTBrokerConnection()

MQTTBrokerListener Type

This represents a broker listener.

Syntax

IPWorksIoTMQTTBrokerListener (declared in ipworksiot.h)

Remarks

Multiple listeners can be configured to listen on different ports and protocols..

The following fields are available:

Fields

LocalHost
char* (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
int (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
char* (read-only)

Default Value: "MY"

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

The StoreType field denotes the type of the certificate store specified by Store. If the store is password-protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the 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:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

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

SSLCertStorePassword
char* (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:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

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

SSLCertSubject
char* (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=support@nsoftware.com". Common fields and their meanings are as follows:

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

Constructors

MQTTBrokerListener()

MQTTBrokerMessage Type

An MQTT message.

Syntax

IPWorksIoTMQTTBrokerMessage (declared in ipworksiot.h)

Remarks

This type represents an MQTT message.

The following fields are available:

Fields

MessageId
int64 (read-only)

Default Value: 0

Message identifier used to associate the message state.

Payload
char* (read-only)

Default Value: ""

This message's raw data payload.

Topic
char* (read-only)

Default Value: ""

This message's topic.

Constructors

MQTTBrokerMessage()

MQTTBrokerSession Type

Information for the client session.

Syntax

IPWorksIoTMQTTBrokerSession (declared in ipworksiot.h)

Remarks

This contains session information for a client.

The following fields are available:

Fields

ClientId
char* (read-only)

Default Value: ""

A unique identifier for the client.

IncomingMessages
char* (read-only)

Default Value: ""

A collection of incoming messages.

OutgoingMessages
char* (read-only)

Default Value: ""

A collection of outgoing messages.

SubGrantedQoS
char* (read-only)

Default Value: ""

The subscription's granted QoS level for the client.

SubTopicFilters
char* (read-only)

Default Value: ""

The subscription topic filters for this client session.

Constructors

MQTTBrokerSession()

IPWorksIoTList Type

Syntax

IPWorksIoTList<T> (declared in ipworksiot.h)

Remarks

IPWorksIoTList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the MQTTBroker class.

Methods

GetCount This method returns the current size of the collection.

int GetCount() {}

SetCount This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection.

int SetCount(int count) {}

Get This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified.

T* Get(int index) {}

Set This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class.

T* Set(int index, T* value) {}

Config Settings (MQTTBroker 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 method.

TCPClient Config Settings

ConnectionTimeout:   Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data.

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 classs that do not directly expose Firewall properties.

FirewallHost:   Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the 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 classs that do not directly expose Firewall properties.

FirewallPassword:   Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort:   The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType:   Determines the type of firewall to connect through.

Possible values are as follows:

0No firewall (default setting).
1Connect through a tunneling proxy. FirewallPort is set to 80.
2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallUser:   A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs 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 will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by 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.

KeepAliveRetryCount:   The number of keep-alive packets to be sent before the remotehost is considered disconnected.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the number of times that the keep-alive packets will be sent before the remote host is considered disconnected. The system default if this value is not specified here is 9.

Note: This configuration setting is only available in the Unix platform. It is not supported in masOS or FreeBSD.

KeepAliveTime:   The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, 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 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 is a positive value, the system will attempt to send pending data until the specified 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 classs) 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 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 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 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 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.nsoftware.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 and 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

SSL Config Settings

LogSSLPackets:   Controls whether SSL packets are logged when using the internal security API.

When SSLProvider 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 event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if SSLProvider is set to Platform.

OpenSSLCADir:   The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile:   Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:

-----BEGIN CERTIFICATE-----

... (CA certificate in base64 encoding) ...

-----END CERTIFICATE-----

Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList:   A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData:   The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession:   Determines if the SSL session is reused.

If set to True, the class will reuse the context if and only if the following criteria are met:

  • The target host name is the same.
  • The system cache entry has not expired (default timeout is 10 hours).
  • The application process that calls the function is the same.
  • The logon session is the same.
  • The instance of the class is the same.

SSLCACertFilePaths:   The paths to CA certificate files on Unix/Linux.

This configuration setting specifies the paths on disk to CA certificate files on Unix/Linux.

The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found, the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.

The default value is as follows:

/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem

SSLCACerts:   A newline separated list of CA certificates to be included when performing an SSL handshake.

When SSLProvider 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:

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

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 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 is currently not supported. This functionality is instead made available through the 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 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:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

SSLEnabledCipherSuites:   The cipher suite to be used in an SSL negotiation.

This configuration setting enables the cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when SSLProvider is set to Platform include the following: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider is set to Platform include the following:

  • CALG_3DES
  • CALG_3DES_112
  • CALG_AES
  • CALG_AES_128
  • CALG_AES_192
  • CALG_AES_256
  • CALG_AGREEDKEY_ANY
  • CALG_CYLINK_MEK
  • CALG_DES
  • CALG_DESX
  • CALG_DH_EPHEM
  • CALG_DH_SF
  • CALG_DSS_SIGN
  • CALG_ECDH
  • CALG_ECDH_EPHEM
  • CALG_ECDSA
  • CALG_ECMQV
  • CALG_HASH_REPLACE_OWF
  • CALG_HUGHES_MD5
  • CALG_HMAC
  • CALG_KEA_KEYX
  • CALG_MAC
  • CALG_MD2
  • CALG_MD4
  • CALG_MD5
  • CALG_NO_SIGN
  • CALG_OID_INFO_CNG_ONLY
  • CALG_OID_INFO_PARAMETERS
  • CALG_PCT1_MASTER
  • CALG_RC2
  • CALG_RC4
  • CALG_RC5
  • CALG_RSA_KEYX
  • CALG_RSA_SIGN
  • CALG_SCHANNEL_ENC_KEY
  • CALG_SCHANNEL_MAC_KEY
  • CALG_SCHANNEL_MASTER_HASH
  • CALG_SEAL
  • CALG_SHA
  • CALG_SHA1
  • CALG_SHA_256
  • CALG_SHA_384
  • CALG_SHA_512
  • CALG_SKIPJACK
  • CALG_SSL2_MASTER
  • CALG_SSL3_MASTER
  • CALG_SSL3_SHAMD5
  • CALG_TEK
  • CALG_TLS1_MASTER
  • CALG_TLS1PRF
Example values when SSLProvider is set to Internalinclude the following: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA"); Possible values when SSLProvider 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), only the following cipher suites are supported:

  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with 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.312288 (Hex 3000)
TLS1.23072 (Hex C00) (Default - Client and Server)
TLS1.1768 (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 use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.

In editions that are designed to run on Windows, SSLProvider 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 and other similar SSL configuration settings are not supported.
  • If 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 is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider 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 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.

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 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: 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: 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: 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: 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: 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: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags:   Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:

0x00000001Ignore time validity status of certificate.
0x00000002Ignore time validity status of CTL.
0x00000004Ignore non-nested certificate times.
0x00000010Allow unknown certificate authority.
0x00000020Ignore wrong certificate usage.
0x00000100Ignore unknown certificate revocation status.
0x00000200Ignore unknown CTL signer revocation status.
0x00000400Ignore unknown certificate authority revocation status.
0x00000800Ignore unknown root revocation status.
0x00008000Allow test root certificate.
0x00004000Trust test root certificate.
0x80000000Ignore non-matching CN (certificate CN non-matching server name).

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

SSLServerCACerts:   A newline separated list of CA certificates to use during SSL server certificate validation.

This configuration setting is only used by client components (e.g., TCPClient) see SSLClientCACerts 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:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This configuration setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class fails with an error.

The format of this value is a comma-separated list of hash-signature combinations. For instance: 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 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 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

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)

Socket Config Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

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

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

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.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseFIPSCompliantAPI:   Tells the class whether or not to use FIPS certified APIs.

When set to true, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries.

On Linux, the C++ edition requires installation of the FIPS-enabled OpenSSL library. The OpenSSL FIPS provider version must be at least 3.0.0. For additional information and instructions regarding the installation and activation of the FIPS-enabled OpenSSL library, please refer to the following link: https://github.com/openssl/openssl/blob/master/README-FIPS.md

To ensure the class utilizes the FIPS-enabled OpenSSL library, the obfuscated source code should first be compiled with OpenSSL enabled, as described in the Supported Platforms section. Additionally, the FIPS module should be enabled and active. If the obfuscated source code is not compiled as mentioned, or the FIPS module is inactive, the class will throw an appropriate error assuming FIPS mode is enabled.

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

Note: This setting is applicable only on Windows.

Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

Trappable Errors (MQTTBroker Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

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 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.
302   Could not open file.
434   Unable to convert string to selected CodePage.
1105   Already connecting. If you want to reconnect, close the current connection first.
1117   You need to connect first.
1119   You cannot change the LocalHost at this time. A connection is in progress.
1120   Connection dropped by remote host.

SSL Errors

270   Cannot load specified security library.
271   Cannot open certificate store.
272   Cannot find specified certificate.
273   Cannot acquire security credentials.
274   Cannot find certificate chain.
275   Cannot verify certificate chain.
276   Error during handshake.
280   Error verifying certificate.
281   Could not find client certificate.
282   Could not find server certificate.
283   Error encrypting data.
284   Error decrypting data.

TCP/IP Errors

10004   [10004] Interrupted system call.
10009   [10009] Bad file number.
10013   [10013] Access denied.
10014   [10014] Bad address.
10022   [10022] Invalid argument.
10024   [10024] Too many open files.
10035   [10035] Operation would block.
10036   [10036] Operation now in progress.
10037   [10037] Operation already in progress.
10038   [10038] Socket operation on nonsocket.
10039   [10039] Destination address required.
10040   [10040] Message is too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol is not supported.
10044   [10044] Socket type is not supported.
10045   [10045] Operation is not supported on socket.
10046   [10046] Protocol family is not supported.
10047   [10047] Address family is not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Cannot assign requested address.
10050   [10050] Network is down.
10051   [10051] Network is unreachable.
10052   [10052] Net dropped connection or reset.
10053   [10053] Software caused connection abort.
10054   [10054] Connection reset by peer.
10055   [10055] No buffer space available.
10056   [10056] Socket is already connected.
10057   [10057] Socket is not connected.
10058   [10058] Cannot send after socket shutdown.
10059   [10059] Too many references, cannot splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name is too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory is not empty
10067   [10067] Too many processes.
10068   [10068] Too many users.
10069   [10069] Disc Quota Exceeded.
10070   [10070] Stale NFS file handle.
10071   [10071] Too many levels of remote in path.
10091   [10091] Network subsystem is unavailable.
10092   [10092] WINSOCK DLL Version out of range.
10093   [10093] Winsock is not loaded yet.
11001   [11001] Host not found.
11002   [11002] Nonauthoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).