Packages

class MqttClientOptions extends NetClientOptions

Represents options used by the MQTT client.

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
    MqttClientOptionsNetClientOptionsTCPSSLOptions
  5. def addCrlValue(value: Buffer): MqttClientOptions

    Add a CRL value

    Add a CRL value

    Definition Classes
    MqttClientOptionsNetClientOptionsTCPSSLOptions
  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
    MqttClientOptionsNetClientOptionsTCPSSLOptions
  7. def addEnabledSecureTransportProtocol(value: String): MqttClientOptions

    Sets the list of enabled SSL/TLS protocols.

    Sets the list of enabled SSL/TLS protocols.

    Definition Classes
    MqttClientOptionsNetClientOptionsTCPSSLOptions
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def asJava: mqtt.MqttClientOptions
    Definition Classes
    MqttClientOptionsNetClientOptions
  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
  17. def getCrlPaths: Buffer[String]
  18. def getCrlValues: Buffer[Buffer]
  19. def getEnabledCipherSuites: Set[String]
  20. def getEnabledSecureTransportProtocols: Set[String]
  21. def getHostnameVerificationAlgorithm: String
    Definition Classes
    MqttClientOptionsNetClientOptions
  22. def getIdleTimeout: Int
  23. def getIdleTimeoutUnit: TimeUnit
  24. def getJdkSslEngineOptions: JdkSSLEngineOptions
  25. def getKeepAliveTimeSeconds: Int
  26. def getKeyStoreOptions: JksOptions
  27. def getLocalAddress: String
  28. def getLogActivity: Boolean
  29. def getMaxInflightQueue: Int
  30. def getMaxMessageSize: Int
  31. def getMetricsName: String
  32. def getOpenSslEngineOptions: OpenSSLEngineOptions
  33. def getPassword: String
  34. def getPemKeyCertOptions: PemKeyCertOptions
  35. def getPemTrustOptions: PemTrustOptions
  36. def getPfxKeyCertOptions: PfxOptions
  37. def getPfxTrustOptions: PfxOptions
  38. def getProxyOptions: ProxyOptions
  39. def getReceiveBufferSize: Int
  40. def getReconnectAttempts: Int
    Definition Classes
    MqttClientOptionsNetClientOptions
  41. def getReconnectInterval: Long
    Definition Classes
    MqttClientOptionsNetClientOptions
  42. def getSendBufferSize: Int
  43. def getSoLinger: Int
  44. def getSslHandshakeTimeout: Long
  45. def getSslHandshakeTimeoutUnit: TimeUnit
  46. def getTrafficClass: Int
  47. def getTrustStoreOptions: JksOptions
  48. def getUsername: String
  49. def getWillMessage: String
  50. def getWillQoS: Int
  51. def getWillTopic: String
  52. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  53. def isAutoGeneratedClientId: Boolean
  54. def isAutoKeepAlive: Boolean
  55. def isCleanSession: Boolean
  56. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  57. def isReuseAddress: Boolean
  58. def isReusePort: Boolean
  59. def isSsl: Boolean
  60. def isTcpCork: Boolean
  61. def isTcpFastOpen: Boolean
  62. def isTcpKeepAlive: Boolean
  63. def isTcpNoDelay: Boolean
  64. def isTcpQuickAck: Boolean
  65. def isTrustAll: Boolean
  66. def isUseAlpn: Boolean
  67. def isUsePooledBuffers: Boolean
  68. def isWillFlag: Boolean
  69. def isWillRetain: Boolean
  70. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  71. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  72. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  73. def setAutoGeneratedClientId(value: Boolean): MqttClientOptions

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

  74. def setAutoKeepAlive(value: Boolean): MqttClientOptions

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

  75. def setCleanSession(value: Boolean): MqttClientOptions

    Set to start with a clean session (or not)

  76. def setClientId(value: String): MqttClientOptions

    Set the client identifier

  77. def setConnectTimeout(value: Int): MqttClientOptions

    Set the connect timeout

    Set the connect timeout

    Definition Classes
    MqttClientOptionsNetClientOptionsClientOptionsBase
  78. def setEnabledSecureTransportProtocols(value: Set[String]): MqttClientOptions
  79. 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
    MqttClientOptionsNetClientOptions
  80. def setIdleTimeout(value: Int): MqttClientOptions

    Do the same thing as MqttClientOptions.

    Do the same thing as MqttClientOptions. Use it instead.

    Definition Classes
    MqttClientOptionsNetClientOptionsTCPSSLOptions
  81. def setIdleTimeoutUnit(value: TimeUnit): MqttClientOptions

    Set the idle timeout unit.

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

    Definition Classes
    MqttClientOptionsNetClientOptionsTCPSSLOptions
  82. def setJdkSslEngineOptions(value: JdkSSLEngineOptions): MqttClientOptions
  83. def setKeepAliveTimeSeconds(value: Int): MqttClientOptions

    Set the keep alive timeout in seconds

  84. 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
    MqttClientOptionsNetClientOptionsTCPSSLOptions
  85. 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
    MqttClientOptionsNetClientOptionsClientOptionsBase
  86. 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
    MqttClientOptionsNetClientOptionsNetworkOptions
  87. def setMaxInflightQueue(value: Int): MqttClientOptions

    Set max count of unacknowledged messages

  88. def setMaxMessageSize(value: Int): MqttClientOptions

    Set max MQTT message size

  89. 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
    MqttClientOptionsNetClientOptionsClientOptionsBase
  90. def setOpenSslEngineOptions(value: OpenSSLEngineOptions): MqttClientOptions
  91. def setPassword(value: String): MqttClientOptions

    Set the password

  92. 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
    MqttClientOptionsNetClientOptionsTCPSSLOptions
  93. def setPemTrustOptions(value: PemTrustOptions): MqttClientOptions

    Set the trust options in pem format

    Set the trust options in pem format

    Definition Classes
    MqttClientOptionsNetClientOptionsTCPSSLOptions
  94. def setPfxKeyCertOptions(value: PfxOptions): MqttClientOptions

    Set the key/cert options in pfx format.

    Set the key/cert options in pfx format.

    Definition Classes
    MqttClientOptionsNetClientOptionsTCPSSLOptions
  95. def setPfxTrustOptions(value: PfxOptions): MqttClientOptions

    Set the trust options in pfx format

    Set the trust options in pfx format

    Definition Classes
    MqttClientOptionsNetClientOptionsTCPSSLOptions
  96. 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
    MqttClientOptionsNetClientOptionsClientOptionsBase
  97. def setReceiveBufferSize(value: Int): MqttClientOptions

    Set the TCP receive buffer size

    Set the TCP receive buffer size

    Definition Classes
    MqttClientOptionsNetClientOptionsNetworkOptions
  98. def setReconnectAttempts(value: Int): MqttClientOptions

    Set the value of reconnect attempts

    Set the value of reconnect attempts

    Definition Classes
    MqttClientOptionsNetClientOptions
  99. def setReconnectInterval(value: Long): MqttClientOptions

    Set the reconnect interval

    Set the reconnect interval

    Definition Classes
    MqttClientOptionsNetClientOptions
  100. def setReuseAddress(value: Boolean): MqttClientOptions

    Set the value of reuse address

    Set the value of reuse address

    Definition Classes
    MqttClientOptionsNetClientOptionsNetworkOptions
  101. 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
    MqttClientOptionsNetClientOptionsNetworkOptions
  102. def setSendBufferSize(value: Int): MqttClientOptions

    Set the TCP send buffer size

    Set the TCP send buffer size

    Definition Classes
    MqttClientOptionsNetClientOptionsNetworkOptions
  103. def setSoLinger(value: Int): MqttClientOptions

    Set whether SO_linger keep alive is enabled

    Set whether SO_linger keep alive is enabled

    Definition Classes
    MqttClientOptionsNetClientOptionsTCPSSLOptions
  104. def setSsl(value: Boolean): MqttClientOptions

    Set whether SSL/TLS is enabled

    Set whether SSL/TLS is enabled

    Definition Classes
    MqttClientOptionsNetClientOptionsTCPSSLOptions
  105. def setSslHandshakeTimeout(value: Long): MqttClientOptions

    Set the SSL handshake timeout, default time unit is seconds.

    Set the SSL handshake timeout, default time unit is seconds.

    Definition Classes
    MqttClientOptionsNetClientOptionsTCPSSLOptions
  106. def setSslHandshakeTimeoutUnit(value: TimeUnit): MqttClientOptions

    Set the SSL handshake timeout unit.

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

    Definition Classes
    MqttClientOptionsNetClientOptionsTCPSSLOptions
  107. 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
    MqttClientOptionsNetClientOptionsTCPSSLOptions
  108. 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
    MqttClientOptionsNetClientOptionsTCPSSLOptions
  109. def setTcpKeepAlive(value: Boolean): MqttClientOptions

    Set whether TCP keep alive is enabled

    Set whether TCP keep alive is enabled

    Definition Classes
    MqttClientOptionsNetClientOptionsTCPSSLOptions
  110. def setTcpNoDelay(value: Boolean): MqttClientOptions

    Set whether TCP no delay is enabled

    Set whether TCP no delay is enabled

    Definition Classes
    MqttClientOptionsNetClientOptionsTCPSSLOptions
  111. 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
    MqttClientOptionsNetClientOptionsTCPSSLOptions
  112. def setTrafficClass(value: Int): MqttClientOptions

    Set the value of traffic class

    Set the value of traffic class

    Definition Classes
    MqttClientOptionsNetClientOptionsNetworkOptions
  113. def setTrustAll(value: Boolean): MqttClientOptions

    Set whether all server certificates should be trusted

    Set whether all server certificates should be trusted

    Definition Classes
    MqttClientOptionsNetClientOptionsClientOptionsBase
  114. 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
    MqttClientOptionsNetClientOptionsTCPSSLOptions
  115. def setUseAlpn(value: Boolean): MqttClientOptions

    Set the ALPN usage.

    Set the ALPN usage.

    Definition Classes
    MqttClientOptionsNetClientOptionsTCPSSLOptions
  116. def setUsePooledBuffers(value: Boolean): MqttClientOptions

    Set whether Netty pooled buffers are enabled

    Set whether Netty pooled buffers are enabled

    Definition Classes
    MqttClientOptionsNetClientOptionsTCPSSLOptions
  117. def setUsername(value: String): MqttClientOptions

    Set the username

  118. def setWillFlag(value: Boolean): MqttClientOptions

    Set if will information are provided on connection

  119. def setWillMessage(value: String): MqttClientOptions

    Set the content of the will message

  120. def setWillQoS(value: Int): MqttClientOptions

    Set the QoS level for the will message

  121. def setWillRetain(value: Boolean): MqttClientOptions

    Set if the will message must be retained

  122. def setWillTopic(value: String): MqttClientOptions

    Set the topic on which the will message will be published

  123. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  124. def toString(): String
    Definition Classes
    AnyRef → Any
  125. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  126. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  127. 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