vertx / io.vertx.kotlin.mqtt / MqttClientOptions

# MqttClientOptions

`fun MqttClientOptions(autoGeneratedClientId: Boolean? = null, autoKeepAlive: Boolean? = null, cleanSession: Boolean? = null, clientId: String? = null, connectTimeout: Int? = null, crlPaths: Iterable<String>? = null, crlValues: Iterable<Buffer>? = null, enabledCipherSuites: Iterable<String>? = null, enabledSecureTransportProtocols: Iterable<String>? = null, hostnameVerificationAlgorithm: String? = null, idleTimeout: Int? = null, jdkSslEngineOptions: JdkSSLEngineOptions? = null, keepAliveTimeSeconds: Int? = null, keyStoreOptions: JksOptions? = null, localAddress: String? = null, logActivity: Boolean? = null, maxInflightQueue: Int? = null, maxMessageSize: Int? = null, metricsName: String? = null, openSslEngineOptions: OpenSSLEngineOptions? = null, password: String? = null, pemKeyCertOptions: PemKeyCertOptions? = null, pemTrustOptions: PemTrustOptions? = null, pfxKeyCertOptions: PfxOptions? = null, pfxTrustOptions: PfxOptions? = null, proxyOptions: ProxyOptions? = null, receiveBufferSize: Int? = null, reconnectAttempts: Int? = null, reconnectInterval: Long? = null, reuseAddress: Boolean? = null, reusePort: Boolean? = null, sendBufferSize: Int? = null, soLinger: Int? = null, ssl: Boolean? = null, tcpCork: Boolean? = null, tcpFastOpen: Boolean? = null, tcpKeepAlive: Boolean? = null, tcpNoDelay: Boolean? = null, tcpQuickAck: Boolean? = null, trafficClass: Int? = null, trustAll: Boolean? = null, trustStoreOptions: JksOptions? = null, useAlpn: Boolean? = null, usePooledBuffers: Boolean? = null, username: String? = null, willFlag: Boolean? = null, willMessage: String? = null, willQoS: Int? = null, willRetain: Boolean? = null, willTopic: String? = null): MqttClientOptions`

A function providing a DSL for building io.vertx.mqtt.MqttClientOptions objects.

Represents options used by the MQTT client.

### Parameters

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

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

`cleanSession` - Set to start with a clean session (or not)

`clientId` - Set the client identifier

`connectTimeout` -

`crlPaths` -

`crlValues` -

`enabledCipherSuites` -

`enabledSecureTransportProtocols` -

`hostnameVerificationAlgorithm` -

`idleTimeout` - Do the same thing as io.vertx.mqtt.MqttClientOptions. Use it instead.

`jdkSslEngineOptions` -

`keepAliveTimeSeconds` - Set the keep alive timeout in seconds

`keyStoreOptions` -

`localAddress` -

`logActivity` -

`maxInflightQueue` - Set max count of unacknowledged messages

`maxMessageSize` - Set max MQTT message size

`metricsName` -

`openSslEngineOptions` -

`password` - Set the password

`pemKeyCertOptions` -

`pemTrustOptions` -

`pfxKeyCertOptions` -

`pfxTrustOptions` -

`proxyOptions` -

`receiveBufferSize` -

`reconnectAttempts` -

`reconnectInterval` -

`reuseAddress` -

`reusePort` -

`sendBufferSize` -

`soLinger` -

`ssl` -

`tcpCork` -

`tcpFastOpen` -

`tcpKeepAlive` -

`tcpNoDelay` -

`tcpQuickAck` -

`trafficClass` -

`trustAll` -

`trustStoreOptions` -

`useAlpn` -

`usePooledBuffers` -

`username` - Set the username

`willFlag` - Set if will information are provided on connection

`willMessage` - Set the content of the will message

`willQoS` - Set the QoS level for the will message

`willRetain` - Set if the will message must be retained

`willTopic` - Set the topic on which the will message will be published