Provider - MQTT
Search form
Description - The MQTT Client provider configures the transport layer to a MQTT server. Both security and messaging handling options are supported.
Runtime Class - com.iwaysoftware.eclipse.template.MQTTClientProviderType
Parameter Groups
| Parameter | Type | Description | |
|---|---|---|---|
| * | URI: | string | The address of the MQTT server to connect to in the format scheme://host[:port] where the scheme is one of tcp, ssl, ws or wss with default port 1883, 8883, 80 and 443 respectively. |
| Protocol: | string | The version of the MQTT protocol
|
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| * | Client ID: | string | A client identifier that is unique on the server being connected to |
| User Name: | string | The user name to authenticate with the MQTT server | |
| Password: | string | The password to authenticate with the MQTT server | |
| Connection Timeout: | integer | Maximum time in seconds to wait for the connection to the server to be established. 0 turns off timeout processing meaning wait until the connection is established or fails. |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| TLS/SSL Configuration: | string | iWay Security Provider for the SSL Context when using ssl or wss scheme to connect to the MQTT server. Click below for a definition: |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| Clean Session | boolean | When true the server creates a new session, when false the server preserves the session which maintains state across restarts of the client, the server or the connection. | |
| Maximum Inflight | integer | Maximum number of messages that can be sent or received with pending acknowledgments | |
| Keep Alive Interval | integer | Interval in seconds before sending a keep alive ping message if no other messages are transmitted. The value 0 disables the keep alive processing. | |
| Persistence Store | string | The persistence store keeps messages until they are acknowledged for "At Least Once" and "Exactly Once" quality of service. The file store is preserved when the provider is recreated (for example at server restart) but the memory store is lost.
|
* - denotes required