Packages

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
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  5. def addCrlValue(value: Buffer): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  6. def addEnabledCipherSuite(value: String): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  7. def addEnabledSecureTransportProtocol(value: String): MqttClientOptions
    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
    @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
    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 getJdkSslEngineOptions: JdkSSLEngineOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  24. def getKeepAliveTimeSeconds: Int
  25. def getKeyStoreOptions: JksOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  26. def getLocalAddress: String
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase
  27. def getLogActivity: Boolean
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  28. def getMaxInflightQueue: Int
  29. def getMaxMessageSize: Int
  30. def getMetricsName: String
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase
  31. def getOpenSslEngineOptions: OpenSSLEngineOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  32. def getPassword: String
  33. def getPemKeyCertOptions: PemKeyCertOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  34. def getPemTrustOptions: PemTrustOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  35. def getPfxKeyCertOptions: PfxOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  36. def getPfxTrustOptions: PfxOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  37. def getProxyOptions: ProxyOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase
  38. def getReceiveBufferSize: Int
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  39. def getReconnectAttempts: Int
    Definition Classes
    MqttClientOptions → NetClientOptions
  40. def getReconnectInterval: Long
    Definition Classes
    MqttClientOptions → NetClientOptions
  41. def getSendBufferSize: Int
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  42. def getSoLinger: Int
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  43. def getTrafficClass: Int
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  44. def getTrustStoreOptions: JksOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  45. def getUsername: String
  46. def getWillMessage: String
  47. def getWillQoS: Int
  48. def getWillTopic: String
  49. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  50. def isAutoGeneratedClientId: Boolean
  51. def isAutoKeepAlive: Boolean
  52. def isCleanSession: Boolean
  53. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  54. def isReuseAddress: Boolean
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  55. def isReusePort: Boolean
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  56. def isSsl: Boolean
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  57. def isTcpCork: Boolean
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  58. def isTcpFastOpen: Boolean
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  59. def isTcpKeepAlive: Boolean
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  60. def isTcpNoDelay: Boolean
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  61. def isTcpQuickAck: Boolean
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  62. def isTrustAll: Boolean
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase
  63. def isUseAlpn: Boolean
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  64. def isUsePooledBuffers: Boolean
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  65. def isWillFlag: Boolean
  66. def isWillRetain: Boolean
  67. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  68. final def notify(): Unit
    Definition Classes
    AnyRef
  69. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  70. def setAutoGeneratedClientId(value: Boolean): MqttClientOptions

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

  71. def setAutoKeepAlive(value: Boolean): MqttClientOptions

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

  72. def setCleanSession(value: Boolean): MqttClientOptions

    Set to start with a clean session (or not)

  73. def setClientId(value: String): MqttClientOptions

    Set the client identifier

  74. def setConnectTimeout(value: Int): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase
  75. def setHostnameVerificationAlgorithm(value: String): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions
  76. def setIdleTimeout(value: Int): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  77. def setJdkSslEngineOptions(value: JdkSSLEngineOptions): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  78. def setKeepAliveTimeSeconds(value: Int): MqttClientOptions

    Set the keep alive timeout in seconds

  79. def setKeyStoreOptions(value: JksOptions): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  80. def setLocalAddress(value: String): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase
  81. def setLogActivity(value: Boolean): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  82. def setMaxInflightQueue(value: Int): MqttClientOptions

    Set max count of unacknowledged messages

  83. def setMaxMessageSize(value: Int): MqttClientOptions

    Set max MQTT message size

  84. def setMetricsName(value: String): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase
  85. def setOpenSslEngineOptions(value: OpenSSLEngineOptions): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  86. def setPassword(value: String): MqttClientOptions

    Set the password

  87. def setPemKeyCertOptions(value: PemKeyCertOptions): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  88. def setPemTrustOptions(value: PemTrustOptions): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  89. def setPfxKeyCertOptions(value: PfxOptions): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  90. def setPfxTrustOptions(value: PfxOptions): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  91. def setProxyOptions(value: ProxyOptions): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase
  92. def setReceiveBufferSize(value: Int): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  93. def setReconnectAttempts(value: Int): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions
  94. def setReconnectInterval(value: Long): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions
  95. def setReuseAddress(value: Boolean): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  96. def setReusePort(value: Boolean): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  97. def setSendBufferSize(value: Int): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  98. def setSoLinger(value: Int): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  99. def setSsl(value: Boolean): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  100. def setTcpCork(value: Boolean): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  101. def setTcpFastOpen(value: Boolean): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  102. def setTcpKeepAlive(value: Boolean): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  103. def setTcpNoDelay(value: Boolean): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  104. def setTcpQuickAck(value: Boolean): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  105. def setTrafficClass(value: Int): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
  106. def setTrustAll(value: Boolean): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase
  107. def setTrustStoreOptions(value: JksOptions): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  108. def setUseAlpn(value: Boolean): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  109. def setUsePooledBuffers(value: Boolean): MqttClientOptions
    Definition Classes
    MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
  110. def setUsername(value: String): MqttClientOptions

    Set the username

  111. def setWillFlag(value: Boolean): MqttClientOptions

    Set if will information are provided on connection

  112. def setWillMessage(value: String): MqttClientOptions

    Set the content of the will message

  113. def setWillQoS(value: Int): MqttClientOptions

    Set the QoS level for the will message

  114. def setWillRetain(value: Boolean): MqttClientOptions

    Set if the will message must be retained

  115. def setWillTopic(value: String): MqttClientOptions

    Set the topic on which the will message will be published

  116. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  117. def toString(): String
    Definition Classes
    AnyRef → Any
  118. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  119. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  120. 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