= Cheatsheets

[[MqttAuth]]
== MqttAuth

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

[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|===

[[MqttClientOptions]]
== MqttClientOptions

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

[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[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. Use it instead.
+++
|[[jdkSslEngineOptions]]`jdkSslEngineOptions`|`link:dataobjects.html#JdkSSLEngineOptions[JdkSSLEngineOptions]`|-
|[[keepAliveTimeSeconds]]`keepAliveTimeSeconds`|`Number (int)`|
+++
Set the keep alive timeout in seconds
+++
|[[keyStoreOptions]]`keyStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|-
|[[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`|-
|[[openSslEngineOptions]]`openSslEngineOptions`|`link:dataobjects.html#OpenSSLEngineOptions[OpenSSLEngineOptions]`|-
|[[password]]`password`|`String`|
+++
Set the password
+++
|[[pemKeyCertOptions]]`pemKeyCertOptions`|`link:dataobjects.html#PemKeyCertOptions[PemKeyCertOptions]`|-
|[[pemTrustOptions]]`pemTrustOptions`|`link:dataobjects.html#PemTrustOptions[PemTrustOptions]`|-
|[[pfxKeyCertOptions]]`pfxKeyCertOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|-
|[[pfxTrustOptions]]`pfxTrustOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|-
|[[proxyOptions]]`proxyOptions`|`link:dataobjects.html#ProxyOptions[ProxyOptions]`|-
|[[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`|-
|[[tcpCork]]`tcpCork`|`Boolean`|-
|[[tcpFastOpen]]`tcpFastOpen`|`Boolean`|-
|[[tcpKeepAlive]]`tcpKeepAlive`|`Boolean`|-
|[[tcpNoDelay]]`tcpNoDelay`|`Boolean`|-
|[[tcpQuickAck]]`tcpQuickAck`|`Boolean`|-
|[[trafficClass]]`trafficClass`|`Number (int)`|-
|[[trustAll]]`trustAll`|`Boolean`|-
|[[trustStoreOptions]]`trustStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|-
|[[useAlpn]]`useAlpn`|`Boolean`|-
|[[usePooledBuffers]]`usePooledBuffers`|`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]`|-
|[[clientAuthRequired]]`clientAuthRequired`|`Boolean`|-
|[[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)`|-
|[[jdkSslEngineOptions]]`jdkSslEngineOptions`|`link:dataobjects.html#JdkSSLEngineOptions[JdkSSLEngineOptions]`|-
|[[keyStoreOptions]]`keyStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|-
|[[logActivity]]`logActivity`|`Boolean`|-
|[[maxMessageSize]]`maxMessageSize`|`Number (int)`|
+++
Set max MQTT message size
+++
|[[openSslEngineOptions]]`openSslEngineOptions`|`link:dataobjects.html#OpenSSLEngineOptions[OpenSSLEngineOptions]`|-
|[[pemKeyCertOptions]]`pemKeyCertOptions`|`link:dataobjects.html#PemKeyCertOptions[PemKeyCertOptions]`|-
|[[pemTrustOptions]]`pemTrustOptions`|`link:dataobjects.html#PemTrustOptions[PemTrustOptions]`|-
|[[pfxKeyCertOptions]]`pfxKeyCertOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|-
|[[pfxTrustOptions]]`pfxTrustOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|-
|[[port]]`port`|`Number (int)`|-
|[[receiveBufferSize]]`receiveBufferSize`|`Number (int)`|-
|[[reuseAddress]]`reuseAddress`|`Boolean`|-
|[[reusePort]]`reusePort`|`Boolean`|-
|[[sendBufferSize]]`sendBufferSize`|`Number (int)`|-
|[[sni]]`sni`|`Boolean`|-
|[[soLinger]]`soLinger`|`Number (int)`|-
|[[ssl]]`ssl`|`Boolean`|-
|[[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)`|-
|[[trustStoreOptions]]`trustStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|-
|[[useAlpn]]`useAlpn`|`Boolean`|-
|[[usePooledBuffers]]`usePooledBuffers`|`Boolean`|-
|===

[[MqttWill]]
== MqttWill

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

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

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

+++
|===

