= Cheatsheets

[[MqttAuth]]
== MqttAuth

++++
MQTT authentication information
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[password]]`@password`|`String`|+++

+++
|[[username]]`@username`|`String`|+++

+++
|===

[[MqttClientOptions]]
== MqttClientOptions

++++
Represents options used by the MQTT client.
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[ackTimeout]]`@ackTimeout`|`Number (int)`|+++
Sets the time in seconds after which the client will stop waiting for a PUBACK, PUBREC
or PUBCOMP packet from the server in response to a packet it has sent.
<p>
The default value of this property is -1 which indicates that the client should wait
an unlimited time for the server's acknowledgement.
+++
|[[autoGeneratedClientId]]`@autoGeneratedClientId`|`Boolean`|+++
Set if the MQTT client must generate clientId automatically
(default is true)
+++
|[[autoKeepAlive]]`@autoKeepAlive`|`Boolean`|+++
Set if the MQTT client must handle PINGREQ automatically
(default is true)
+++
|[[cleanSession]]`@cleanSession`|`Boolean`|+++
Set to start with a clean session (or not)
+++
|[[clientId]]`@clientId`|`String`|+++
Set the client identifier
+++
|[[connectTimeout]]`@connectTimeout`|`Number (int)`|-
|[[crlPaths]]`@crlPaths`|`Array of String`|-
|[[crlValues]]`@crlValues`|`Array of Buffer`|-
|[[enabledCipherSuites]]`@enabledCipherSuites`|`Array of String`|-
|[[enabledSecureTransportProtocols]]`@enabledSecureTransportProtocols`|`Array of String`|-
|[[hostnameVerificationAlgorithm]]`@hostnameVerificationAlgorithm`|`String`|-
|[[idleTimeout]]`@idleTimeout`|`Number (int)`|+++
Do the same thing as link (int)}. Use it instead.
+++
|[[idleTimeoutUnit]]`@idleTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|-
|[[keepAliveInterval]]`@keepAliveInterval`|`Number (int)`|+++
Set the keep alive interval in seconds
+++
|[[localAddress]]`@localAddress`|`String`|-
|[[logActivity]]`@logActivity`|`Boolean`|-
|[[maxInflightQueue]]`@maxInflightQueue`|`Number (int)`|+++
Set max count of unacknowledged messages
+++
|[[maxMessageSize]]`@maxMessageSize`|`Number (int)`|+++
Set max MQTT message size
+++
|[[metricsName]]`@metricsName`|`String`|-
|[[password]]`@password`|`String`|+++
Set the password
+++
|[[receiveBufferSize]]`@receiveBufferSize`|`Number (int)`|-
|[[reconnectAttempts]]`@reconnectAttempts`|`Number (int)`|-
|[[reconnectInterval]]`@reconnectInterval`|`Number (long)`|-
|[[reuseAddress]]`@reuseAddress`|`Boolean`|-
|[[reusePort]]`@reusePort`|`Boolean`|-
|[[sendBufferSize]]`@sendBufferSize`|`Number (int)`|-
|[[soLinger]]`@soLinger`|`Number (int)`|-
|[[ssl]]`@ssl`|`Boolean`|-
|[[sslHandshakeTimeout]]`@sslHandshakeTimeout`|`Number (long)`|-
|[[sslHandshakeTimeoutUnit]]`@sslHandshakeTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|-
|[[tcpCork]]`@tcpCork`|`Boolean`|-
|[[tcpFastOpen]]`@tcpFastOpen`|`Boolean`|-
|[[tcpKeepAlive]]`@tcpKeepAlive`|`Boolean`|-
|[[tcpNoDelay]]`@tcpNoDelay`|`Boolean`|-
|[[tcpQuickAck]]`@tcpQuickAck`|`Boolean`|-
|[[trafficClass]]`@trafficClass`|`Number (int)`|-
|[[trustAll]]`@trustAll`|`Boolean`|-
|[[useAlpn]]`@useAlpn`|`Boolean`|-
|[[username]]`@username`|`String`|+++
Set the username
+++
|[[willFlag]]`@willFlag`|`Boolean`|+++
Set if will information are provided on connection
+++
|[[willMessage]]`@willMessage`|`String`|+++
Set the content of the will message
+++
|[[willQoS]]`@willQoS`|`Number (int)`|+++
Set the QoS level for the will message
+++
|[[willRetain]]`@willRetain`|`Boolean`|+++
Set if the will message must be retained
+++
|[[willTopic]]`@willTopic`|`String`|+++
Set the topic on which the will message will be published
+++
|===

[[MqttServerOptions]]
== MqttServerOptions

++++
Represents options used by the MQTT server
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[acceptBacklog]]`@acceptBacklog`|`Number (int)`|-
|[[autoClientId]]`@autoClientId`|`Boolean`|+++
Set if clientid should be auto-generated when it's "zero-bytes"
+++
|[[clientAuth]]`@clientAuth`|`link:enums.html#ClientAuth[ClientAuth]`|-
|[[crlPaths]]`@crlPaths`|`Array of String`|-
|[[crlValues]]`@crlValues`|`Array of Buffer`|-
|[[enabledCipherSuites]]`@enabledCipherSuites`|`Array of String`|-
|[[enabledSecureTransportProtocols]]`@enabledSecureTransportProtocols`|`Array of String`|-
|[[host]]`@host`|`String`|-
|[[idleTimeout]]`@idleTimeout`|`Number (int)`|-
|[[idleTimeoutUnit]]`@idleTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|-
|[[logActivity]]`@logActivity`|`Boolean`|-
|[[maxMessageSize]]`@maxMessageSize`|`Number (int)`|+++
Set max MQTT message size
+++
|[[port]]`@port`|`Number (int)`|-
|[[proxyProtocolTimeout]]`@proxyProtocolTimeout`|`Number (long)`|-
|[[proxyProtocolTimeoutUnit]]`@proxyProtocolTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|-
|[[receiveBufferSize]]`@receiveBufferSize`|`Number (int)`|-
|[[reuseAddress]]`@reuseAddress`|`Boolean`|-
|[[reusePort]]`@reusePort`|`Boolean`|-
|[[sendBufferSize]]`@sendBufferSize`|`Number (int)`|-
|[[sni]]`@sni`|`Boolean`|-
|[[soLinger]]`@soLinger`|`Number (int)`|-
|[[ssl]]`@ssl`|`Boolean`|-
|[[sslHandshakeTimeout]]`@sslHandshakeTimeout`|`Number (long)`|-
|[[sslHandshakeTimeoutUnit]]`@sslHandshakeTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|-
|[[tcpCork]]`@tcpCork`|`Boolean`|-
|[[tcpFastOpen]]`@tcpFastOpen`|`Boolean`|-
|[[tcpKeepAlive]]`@tcpKeepAlive`|`Boolean`|-
|[[tcpNoDelay]]`@tcpNoDelay`|`Boolean`|-
|[[tcpQuickAck]]`@tcpQuickAck`|`Boolean`|-
|[[timeoutOnConnect]]`@timeoutOnConnect`|`Number (int)`|+++
Set the timeout on CONNECT packet
+++
|[[trafficClass]]`@trafficClass`|`Number (int)`|-
|[[useAlpn]]`@useAlpn`|`Boolean`|-
|[[useProxyProtocol]]`@useProxyProtocol`|`Boolean`|-
|[[useWebSocket]]`@useWebSocket`|`Boolean`|+++
enable mqtt over websocket
+++
|===

[[MqttWill]]
== MqttWill

++++
Will information from the remote MQTT client
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[willFlag]]`@willFlag`|`Boolean`|+++

+++
|[[willMessage]]`@willMessage`|`Buffer`|+++

+++
|[[willQos]]`@willQos`|`Number (int)`|+++

+++
|[[willRetain]]`@willRetain`|`Boolean`|+++

+++
|[[willTopic]]`@willTopic`|`String`|+++

+++
|===