vertx-lang-scala-docs_2.12 3.6.0 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package mqtt
  Definition Classes
    scala
-  package messages
  Definition Classes
    mqtt
- MqttAuth
- MqttClient
- MqttClientOptions
- MqttEndpoint
- MqttServer
- MqttServerOptions
- MqttTopicSubscription
- MqttWill

c

io.vertx.scala.mqtt

# MqttClientOptions 

###
Companion object MqttClientOptions

#### class MqttClientOptions extends NetClientOptions

Represents options used by the MQTT client.

Linear Supertypes
NetClientOptions, ClientOptionsBase, TCPSSLOptions, NetworkOptions, AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. MqttClientOptions
2. NetClientOptions
3. ClientOptionsBase
4. TCPSSLOptions
5. NetworkOptions
6. AnyRef
7. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new MqttClientOptions(_asJava: mqtt.MqttClientOptions)

### Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##(): Int
   Definition Classes
     AnyRef → Any
3.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
4.  def addCrlPath(value: String): MqttClientOptions

   Add a CRL path

   Add a CRL path

   Definition Classes
     MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
5.  def addCrlValue(value: Buffer): MqttClientOptions

   Add a CRL value

   Add a CRL value

   Definition Classes
     MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
6.  def addEnabledCipherSuite(value: String): MqttClientOptions

   Add an enabled cipher suite, appended to the ordered suites.

   Add an enabled cipher suite, appended to the ordered suites.

   Definition Classes
     MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
7.  def addEnabledSecureTransportProtocol(value: String): MqttClientOptions

   Sets the list of enabled SSL/TLS protocols.

   Sets the list of enabled SSL/TLS protocols.

   Definition Classes
     MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
8.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
9.  def asJava: mqtt.MqttClientOptions
   Definition Classes
     MqttClientOptions → NetClientOptions
10.  def clone(): AnyRef
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )
11.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
12.  def equals(arg0: Any): Boolean
    Definition Classes
      AnyRef → Any
13.  def finalize(): Unit
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
14.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
15.  def getClientId: String
16.  def getConnectTimeout: Int
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase
17.  def getCrlPaths: Buffer[String]
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
18.  def getCrlValues: Buffer[Buffer]
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
19.  def getEnabledCipherSuites: Set[String]
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
20.  def getEnabledSecureTransportProtocols: Set[String]
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
21.  def getHostnameVerificationAlgorithm: String
    Definition Classes
      MqttClientOptions → NetClientOptions
22.  def getIdleTimeout: Int
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
23.  def getIdleTimeoutUnit: TimeUnit
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
24.  def getJdkSslEngineOptions: JdkSSLEngineOptions
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
25.  def getKeepAliveTimeSeconds: Int
26.  def getKeyStoreOptions: JksOptions
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
27.  def getLocalAddress: String
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase
28.  def getLogActivity: Boolean
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
29.  def getMaxInflightQueue: Int
30.  def getMaxMessageSize: Int
31.  def getMetricsName: String
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase
32.  def getOpenSslEngineOptions: OpenSSLEngineOptions
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
33.  def getPassword: String
34.  def getPemKeyCertOptions: PemKeyCertOptions
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
35.  def getPemTrustOptions: PemTrustOptions
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
36.  def getPfxKeyCertOptions: PfxOptions
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
37.  def getPfxTrustOptions: PfxOptions
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
38.  def getProxyOptions: ProxyOptions
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase
39.  def getReceiveBufferSize: Int
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
40.  def getReconnectAttempts: Int
    Definition Classes
      MqttClientOptions → NetClientOptions
41.  def getReconnectInterval: Long
    Definition Classes
      MqttClientOptions → NetClientOptions
42.  def getSendBufferSize: Int
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
43.  def getSoLinger: Int
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
44.  def getTrafficClass: Int
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
45.  def getTrustStoreOptions: JksOptions
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
46.  def getUsername: String
47.  def getWillMessage: String
48.  def getWillQoS: Int
49.  def getWillTopic: String
50.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
51.  def isAutoGeneratedClientId: Boolean
52.  def isAutoKeepAlive: Boolean
53.  def isCleanSession: Boolean
54.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
55.  def isReuseAddress: Boolean
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
56.  def isReusePort: Boolean
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
57.  def isSsl: Boolean
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
58.  def isTcpCork: Boolean
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
59.  def isTcpFastOpen: Boolean
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
60.  def isTcpKeepAlive: Boolean
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
61.  def isTcpNoDelay: Boolean
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
62.  def isTcpQuickAck: Boolean
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
63.  def isTrustAll: Boolean
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase
64.  def isUseAlpn: Boolean
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
65.  def isUsePooledBuffers: Boolean
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
66.  def isWillFlag: Boolean
67.  def isWillRetain: Boolean
68.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
69.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
70.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
71.  def setAutoGeneratedClientId(value: Boolean): MqttClientOptions

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

72.  def setAutoKeepAlive(value: Boolean): MqttClientOptions

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

73.  def setCleanSession(value: Boolean): MqttClientOptions

    Set to start with a clean session (or not)

74.  def setClientId(value: String): MqttClientOptions

    Set the client identifier

75.  def setConnectTimeout(value: Int): MqttClientOptions

    Set the connect timeout

    Set the connect timeout

    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase
76.  def setEnabledSecureTransportProtocols(value: Set[String]): MqttClientOptions
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
77.  def setHostnameVerificationAlgorithm(value: String): MqttClientOptions

    Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty String

    Set the hostname verification algorithm interval To disable hostname verification, set hostnameVerificationAlgorithm to an empty String

    Definition Classes
      MqttClientOptions → NetClientOptions
78.  def setIdleTimeout(value: Int): MqttClientOptions

    Do the same thing as MqttClientOptions.

    Do the same thing as MqttClientOptions. Use it instead.

    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
79.  def setIdleTimeoutUnit(value: TimeUnit): MqttClientOptions

    Set the idle timeout unit.

    Set the idle timeout unit. If not specified, default is seconds.

    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
80.  def setJdkSslEngineOptions(value: JdkSSLEngineOptions): MqttClientOptions
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
81.  def setKeepAliveTimeSeconds(value: Int): MqttClientOptions

    Set the keep alive timeout in seconds

82.  def setKeyStoreOptions(value: JksOptions): MqttClientOptions

    Set the key/cert options in jks format, aka Java keystore.

    Set the key/cert options in jks format, aka Java keystore.

    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
83.  def setLocalAddress(value: String): MqttClientOptions

    Set the local interface to bind for network connections.

    Set the local interface to bind for network connections. When the local address is null, it will pick any local address, the default local address is null.

    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase
84.  def setLogActivity(value: Boolean): MqttClientOptions

    Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

    Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
85.  def setMaxInflightQueue(value: Int): MqttClientOptions

    Set max count of unacknowledged messages

86.  def setMaxMessageSize(value: Int): MqttClientOptions

    Set max MQTT message size

87.  def setMetricsName(value: String): MqttClientOptions

    Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name.

    Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name.

    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase
88.  def setOpenSslEngineOptions(value: OpenSSLEngineOptions): MqttClientOptions
    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
89.  def setPassword(value: String): MqttClientOptions

    Set the password

90.  def setPemKeyCertOptions(value: PemKeyCertOptions): MqttClientOptions

    Set the key/cert store options in pem format.

    Set the key/cert store options in pem format.

    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
91.  def setPemTrustOptions(value: PemTrustOptions): MqttClientOptions

    Set the trust options in pem format

    Set the trust options in pem format

    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
92.  def setPfxKeyCertOptions(value: PfxOptions): MqttClientOptions

    Set the key/cert options in pfx format.

    Set the key/cert options in pfx format.

    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
93.  def setPfxTrustOptions(value: PfxOptions): MqttClientOptions

    Set the trust options in pfx format

    Set the trust options in pfx format

    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
94.  def setProxyOptions(value: ProxyOptions): MqttClientOptions

    Set proxy options for connections via CONNECT proxy (e.g.

    Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy.

    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase
95.  def setReceiveBufferSize(value: Int): MqttClientOptions

    Set the TCP receive buffer size

    Set the TCP receive buffer size

    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
96.  def setReconnectAttempts(value: Int): MqttClientOptions

    Set the value of reconnect attempts

    Set the value of reconnect attempts

    Definition Classes
      MqttClientOptions → NetClientOptions
97.  def setReconnectInterval(value: Long): MqttClientOptions

    Set the reconnect interval

    Set the reconnect interval

    Definition Classes
      MqttClientOptions → NetClientOptions
98.  def setReuseAddress(value: Boolean): MqttClientOptions

    Set the value of reuse address

    Set the value of reuse address

    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
99.  def setReusePort(value: Boolean): MqttClientOptions

    Set the value of reuse port.

    Set the value of reuse port.

    This is only supported by native transports.

    Definition Classes
      MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
100.  def setSendBufferSize(value: Int): MqttClientOptions

     Set the TCP send buffer size

     Set the TCP send buffer size

     Definition Classes
       MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
101.  def setSoLinger(value: Int): MqttClientOptions

     Set whether SO_linger keep alive is enabled

     Set whether SO_linger keep alive is enabled

     Definition Classes
       MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
102.  def setSsl(value: Boolean): MqttClientOptions

     Set whether SSL/TLS is enabled

     Set whether SSL/TLS is enabled

     Definition Classes
       MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
103.  def setTcpCork(value: Boolean): MqttClientOptions

     Enable the `TCP_CORK` option - only with linux native transport.

     Enable the `TCP_CORK` option - only with linux native transport.

     Definition Classes
       MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
104.  def setTcpFastOpen(value: Boolean): MqttClientOptions

     Enable the `TCP_FASTOPEN` option - only with linux native transport.

     Enable the `TCP_FASTOPEN` option - only with linux native transport.

     Definition Classes
       MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
105.  def setTcpKeepAlive(value: Boolean): MqttClientOptions

     Set whether TCP keep alive is enabled

     Set whether TCP keep alive is enabled

     Definition Classes
       MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
106.  def setTcpNoDelay(value: Boolean): MqttClientOptions

     Set whether TCP no delay is enabled

     Set whether TCP no delay is enabled

     Definition Classes
       MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
107.  def setTcpQuickAck(value: Boolean): MqttClientOptions

     Enable the `TCP_QUICKACK` option - only with linux native transport.

     Enable the `TCP_QUICKACK` option - only with linux native transport.

     Definition Classes
       MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
108.  def setTrafficClass(value: Int): MqttClientOptions

     Set the value of traffic class

     Set the value of traffic class

     Definition Classes
       MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
109.  def setTrustAll(value: Boolean): MqttClientOptions

     Set whether all server certificates should be trusted

     Set whether all server certificates should be trusted

     Definition Classes
       MqttClientOptions → NetClientOptions → ClientOptionsBase
110.  def setTrustStoreOptions(value: JksOptions): MqttClientOptions

     Set the trust options in jks format, aka Java truststore

     Set the trust options in jks format, aka Java truststore

     Definition Classes
       MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
111.  def setUseAlpn(value: Boolean): MqttClientOptions

     Set the ALPN usage.

     Set the ALPN usage.

     Definition Classes
       MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
112.  def setUsePooledBuffers(value: Boolean): MqttClientOptions

     Set whether Netty pooled buffers are enabled

     Set whether Netty pooled buffers are enabled

     Definition Classes
       MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
113.  def setUsername(value: String): MqttClientOptions

     Set the username

114.  def setWillFlag(value: Boolean): MqttClientOptions

     Set if will information are provided on connection

115.  def setWillMessage(value: String): MqttClientOptions

     Set the content of the will message

116.  def setWillQoS(value: Int): MqttClientOptions

     Set the QoS level for the will message

117.  def setWillRetain(value: Boolean): MqttClientOptions

     Set if the will message must be retained

118.  def setWillTopic(value: String): MqttClientOptions

     Set the topic on which the will message will be published

119.  final def synchronized[T0](arg0: ⇒ T0): T0
     Definition Classes
       AnyRef
120.  def toString(): String
     Definition Classes
       AnyRef → Any
121.  final def wait(): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws( ... )
122.  final def wait(arg0: Long, arg1: Int): Unit
     Definition Classes
       AnyRef
     Annotations
       @throws( ... )
123.  final def wait(arg0: Long): Unit
     Definition Classes
       AnyRef
     Annotations
       @native() @throws( ... )

### Inherited from NetClientOptions

### Inherited from ClientOptionsBase

### Inherited from TCPSSLOptions

### Inherited from NetworkOptions

### Inherited from AnyRef

### Inherited from Any

### Ungrouped