MqttClientOptions

Represents options used by the MQTT client

Name

Type

Description

autoGeneratedClientId

Boolean

Set if the MQTT client must generate clientId automatically (default is true)

autoKeepAlive

Boolean

Set if the MQTT client must handle PINGREQ automatically (default is true)

cleanSession

Boolean

-

clientId

String

-

connectTimeout

Number (int)

-

crlPaths

Array of String

-

crlValues

Array of Buffer

-

enabledCipherSuites

Array of String

-

enabledSecureTransportProtocols

Array of String

-

host

String

-

hostnameVerificationAlgorithm

String

-

idleTimeout

Number (int)

-

jdkSslEngineOptions

JdkSSLEngineOptions

-

keepAliveTimeSeconds

Number (int)

-

keyStoreOptions

JksOptions

-

localAddress

String

-

logActivity

Boolean

-

maxMessageSize

Number (int)

Set max MQTT message size

metricsName

String

-

openSslEngineOptions

OpenSSLEngineOptions

-

password

String

-

pemKeyCertOptions

PemKeyCertOptions

-

pemTrustOptions

PemTrustOptions

-

pfxKeyCertOptions

PfxOptions

-

pfxTrustOptions

PfxOptions

-

port

Number (int)

-

proxyOptions

ProxyOptions

-

receiveBufferSize

Number (int)

-

reconnectAttempts

Number (int)

-

reconnectInterval

Number (long)

-

reuseAddress

Boolean

-

sendBufferSize

Number (int)

-

soLinger

Number (int)

-

ssl

Boolean

-

tcpKeepAlive

Boolean

-

tcpNoDelay

Boolean

-

trafficClass

Number (int)

-

trustAll

Boolean

-

trustStoreOptions

JksOptions

-

useAlpn

Boolean

-

usePooledBuffers

Boolean

-

username

String

-

willFlag

Boolean

-

willMessage

String

-

willQoS

Number (int)

-

willRetain

Boolean

-

willTopic

String

-

MqttServerOptions

Represents options used by the MQTT server

Name

Type

Description

acceptBacklog

Number (int)

-

autoClientId

Boolean

Set if clientid should be auto-generated when it's "zero-bytes"

clientAuth

ClientAuth

-

clientAuthRequired

Boolean

-

crlPaths

Array of String

-

crlValues

Array of Buffer

-

enabledCipherSuites

Array of String

-

enabledSecureTransportProtocols

Array of String

-

host

String

-

idleTimeout

Number (int)

-

jdkSslEngineOptions

JdkSSLEngineOptions

-

keyStoreOptions

JksOptions

-

logActivity

Boolean

-

maxMessageSize

Number (int)

Set max MQTT message size

openSslEngineOptions

OpenSSLEngineOptions

-

pemKeyCertOptions

PemKeyCertOptions

-

pemTrustOptions

PemTrustOptions

-

pfxKeyCertOptions

PfxOptions

-

pfxTrustOptions

PfxOptions

-

port

Number (int)

-

receiveBufferSize

Number (int)

-

reuseAddress

Boolean

-

sendBufferSize

Number (int)

-

sni

Boolean

-

soLinger

Number (int)

-

ssl

Boolean

-

tcpKeepAlive

Boolean

-

tcpNoDelay

Boolean

-

timeoutOnConnect

Number (int)

Set the timeout on CONNECT packet

trafficClass

Number (int)

-

trustStoreOptions

JksOptions

-

useAlpn

Boolean

-

usePooledBuffers

Boolean

-