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

    Add a CRL value

    Add a CRL value

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

    Add an enabled SSL/TLS protocols, appended to the ordered protocols.

    Add an enabled SSL/TLS protocols, appended to the ordered protocols.

    Definition Classes
    MqttClientOptionsNetClientOptionsClientOptionsBaseTCPSSLOptions
  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
    @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
  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 getHost: String
  22. def getHostnameVerificationAlgorithm: String
    Definition Classes
    MqttClientOptionsNetClientOptions
  23. def getIdleTimeout: Int
  24. def getJdkSslEngineOptions: JdkSSLEngineOptions
  25. def getKeepAliveTimeSeconds: Int
  26. def getKeyStoreOptions: JksOptions
  27. def getLocalAddress: String
  28. def getLogActivity: Boolean
  29. def getMaxMessageSize: Int
  30. def getMetricsName: String
  31. def getOpenSslEngineOptions: OpenSSLEngineOptions
  32. def getPassword: String
  33. def getPemKeyCertOptions: PemKeyCertOptions
  34. def getPemTrustOptions: PemTrustOptions
  35. def getPfxKeyCertOptions: PfxOptions
  36. def getPfxTrustOptions: PfxOptions
  37. def getPort: Int
  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 getTrafficClass: Int
  45. def getTrustStoreOptions: JksOptions
  46. def getUsername: String
  47. def getWillMessage: String
  48. def getWillQoS: Int
  49. def getWillTopic: String
  50. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  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
  56. def isSsl: Boolean
  57. def isTcpKeepAlive: Boolean
  58. def isTcpNoDelay: Boolean
  59. def isTrustAll: Boolean
  60. def isUseAlpn: Boolean
  61. def isUsePooledBuffers: Boolean
  62. def isWillFlag: Boolean
  63. def isWillRetain: Boolean
  64. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  65. final def notify(): Unit
    Definition Classes
    AnyRef
  66. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  67. def setAutoGeneratedClientId(value: Boolean): MqttClientOptions

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

  68. def setAutoKeepAlive(value: Boolean): MqttClientOptions

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

  69. def setCleanSession(value: Boolean): MqttClientOptions
  70. def setClientId(value: String): MqttClientOptions
  71. def setConnectTimeout(value: Int): MqttClientOptions

    Set the connect timeout

    Set the connect timeout

    Definition Classes
    MqttClientOptionsNetClientOptionsClientOptionsBase
  72. def setHost(value: String): MqttClientOptions
  73. 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
  74. def setIdleTimeout(value: Int): MqttClientOptions

    Set the idle timeout, in seconds.

    Set the idle timeout, in seconds. zero means don't timeout. This determines if a connection will timeout and be closed if no data is received within the timeout.

    Definition Classes
    MqttClientOptionsNetClientOptionsClientOptionsBaseTCPSSLOptions
  75. def setJdkSslEngineOptions(value: JdkSSLEngineOptions): MqttClientOptions
  76. def setKeepAliveTimeSeconds(value: Int): MqttClientOptions
  77. 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
    MqttClientOptionsNetClientOptionsClientOptionsBaseTCPSSLOptions
  78. 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
  79. 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
    MqttClientOptionsNetClientOptionsClientOptionsBaseTCPSSLOptionsNetworkOptions
  80. def setMaxMessageSize(value: Int): MqttClientOptions

    Set max MQTT message size

  81. 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
  82. def setOpenSslEngineOptions(value: OpenSSLEngineOptions): MqttClientOptions
  83. def setPassword(value: String): MqttClientOptions
  84. 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
    MqttClientOptionsNetClientOptionsClientOptionsBaseTCPSSLOptions
  85. def setPemTrustOptions(value: PemTrustOptions): MqttClientOptions

    Set the trust options in pem format

    Set the trust options in pem format

    Definition Classes
    MqttClientOptionsNetClientOptionsClientOptionsBaseTCPSSLOptions
  86. def setPfxKeyCertOptions(value: PfxOptions): MqttClientOptions

    Set the key/cert options in pfx format.

    Set the key/cert options in pfx format.

    Definition Classes
    MqttClientOptionsNetClientOptionsClientOptionsBaseTCPSSLOptions
  87. def setPfxTrustOptions(value: PfxOptions): MqttClientOptions

    Set the trust options in pfx format

    Set the trust options in pfx format

    Definition Classes
    MqttClientOptionsNetClientOptionsClientOptionsBaseTCPSSLOptions
  88. def setPort(value: Int): MqttClientOptions
  89. 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
  90. def setReceiveBufferSize(value: Int): MqttClientOptions

    Set the TCP receive buffer size

    Set the TCP receive buffer size

    Definition Classes
    MqttClientOptionsNetClientOptionsClientOptionsBaseTCPSSLOptionsNetworkOptions
  91. def setReconnectAttempts(value: Int): MqttClientOptions

    Set the value of reconnect attempts

    Set the value of reconnect attempts

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

    Set the reconnect interval

    Set the reconnect interval

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

    Set the value of reuse address

    Set the value of reuse address

    Definition Classes
    MqttClientOptionsNetClientOptionsClientOptionsBaseTCPSSLOptionsNetworkOptions
  94. def setSendBufferSize(value: Int): MqttClientOptions

    Set the TCP send buffer size

    Set the TCP send buffer size

    Definition Classes
    MqttClientOptionsNetClientOptionsClientOptionsBaseTCPSSLOptionsNetworkOptions
  95. def setSoLinger(value: Int): MqttClientOptions

    Set whether SO_linger keep alive is enabled

    Set whether SO_linger keep alive is enabled

    Definition Classes
    MqttClientOptionsNetClientOptionsClientOptionsBaseTCPSSLOptions
  96. def setSsl(value: Boolean): MqttClientOptions

    Set whether SSL/TLS is enabled

    Set whether SSL/TLS is enabled

    Definition Classes
    MqttClientOptionsNetClientOptionsClientOptionsBaseTCPSSLOptions
  97. def setTcpKeepAlive(value: Boolean): MqttClientOptions

    Set whether TCP keep alive is enabled

    Set whether TCP keep alive is enabled

    Definition Classes
    MqttClientOptionsNetClientOptionsClientOptionsBaseTCPSSLOptions
  98. def setTcpNoDelay(value: Boolean): MqttClientOptions

    Set whether TCP no delay is enabled

    Set whether TCP no delay is enabled

    Definition Classes
    MqttClientOptionsNetClientOptionsClientOptionsBaseTCPSSLOptions
  99. def setTrafficClass(value: Int): MqttClientOptions

    Set the value of traffic class

    Set the value of traffic class

    Definition Classes
    MqttClientOptionsNetClientOptionsClientOptionsBaseTCPSSLOptionsNetworkOptions
  100. def setTrustAll(value: Boolean): MqttClientOptions

    Set whether all server certificates should be trusted

    Set whether all server certificates should be trusted

    Definition Classes
    MqttClientOptionsNetClientOptionsClientOptionsBase
  101. 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
    MqttClientOptionsNetClientOptionsClientOptionsBaseTCPSSLOptions
  102. def setUseAlpn(value: Boolean): MqttClientOptions

    Set the ALPN usage.

    Set the ALPN usage.

    Definition Classes
    MqttClientOptionsNetClientOptionsClientOptionsBaseTCPSSLOptions
  103. def setUsePooledBuffers(value: Boolean): MqttClientOptions

    Set whether Netty pooled buffers are enabled

    Set whether Netty pooled buffers are enabled

    Definition Classes
    MqttClientOptionsNetClientOptionsClientOptionsBaseTCPSSLOptions
  104. def setUsername(value: String): MqttClientOptions
  105. def setWillFlag(value: Boolean): MqttClientOptions
  106. def setWillMessage(value: String): MqttClientOptions
  107. def setWillQoS(value: Int): MqttClientOptions
  108. def setWillRetain(value: Boolean): MqttClientOptions
  109. def setWillTopic(value: String): MqttClientOptions
  110. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  111. def toString(): String
    Definition Classes
    AnyRef → Any
  112. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  113. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  114. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from NetClientOptions

Inherited from ClientOptionsBase

Inherited from TCPSSLOptions

Inherited from NetworkOptions

Inherited from AnyRef

Inherited from Any

Ungrouped