Static
newCreate a new MQTT5 client builder that will create MQTT5 clients that connect to AWS IoT Core via websockets, using AWS Sigv4 signing to establish authenticate.
AWS IoT endpoint to connect to
additional sigv4-oriented options to use
Static
newCreate a new MQTT5 client builder that will create MQTT5 clients that connect to AWS IoT Core via websockets, authenticating via a custom authenticator.
AWS IoT endpoint to connect to
AWS IoT custom auth configuration
Overrides the port to connect to on the IoT endpoint
The port to connect to on the IoT endpoint. Usually 8883 for MQTT, or 443 for websockets
Overrides all configurable options with respect to the CONNECT packet sent by the client, including the will. These connect properties will be used for every connection attempt made by the client. Custom authentication configuration will override the username and password values in this configuration.
all configurable options with respect to the CONNECT packet sent by the client
Overrides how the MQTT5 client should behave with respect to MQTT sessions.
how the MQTT5 client should behave with respect to MQTT sessions.
Overrides how the reconnect delay is modified in order to smooth out the distribution of reconnection attempt timepoints for a large set of reconnecting clients.
controls how the reconnect delay is modified in order to smooth out the distribution of econnection attempt timepoints for a large set of reconnecting clients.
Overrides the minimum amount of time to wait to reconnect after a disconnect. Exponential backoff is performed with controllable jitter after each connection failure.
minimum amount of time to wait to reconnect after a disconnect.
Overrides the maximum amount of time to wait to reconnect after a disconnect. Exponential backoff is performed with controllable jitter after each connection failure.
maximum amount of time to wait to reconnect after a disconnect.
Overrides the amount of time that must elapse with an established connection before the reconnect delay is reset to the minimum. This helps alleviate bandwidth-waste in fast reconnect cycles due to permission failures on operations.
the amount of time that must elapse with an established connection before the reconnect delay is reset to the minimum
Overrides the overall time interval to wait to establish an MQTT connection. If a complete MQTT connection (from socket establishment all the way up to CONNACK receipt) has not been established before this timeout expires, the connection attempt will be considered a failure.
overall time interval to wait to establish an MQTT connection
Sets the opaque options set passed through to the underlying websocket implementation regardless of url factory. Use this to control proxy settings amongst other things.
websocket transport options
Constructs an MQTT5 Client configuration object for creating mqtt5 clients.
Generated using TypeDoc
Builder pattern class to create an Mqtt5ClientConfig which can then be used to create an Mqtt5Client, configured for use with AWS IoT.
MQTT5 Client User Guide