class MqttClientOptions extends NetClientOptions
Represents options used by the MQTT client
- Alphabetic
- By Inheritance
- MqttClientOptions
- NetClientOptions
- ClientOptionsBase
- TCPSSLOptions
- NetworkOptions
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new MqttClientOptions(_asJava: mqtt.MqttClientOptions)
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
addCrlPath(value: String): MqttClientOptions
Add a CRL path
Add a CRL path
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
addCrlValue(value: Buffer): MqttClientOptions
Add a CRL value
Add a CRL value
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
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
-
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
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
asJava: mqtt.MqttClientOptions
- Definition Classes
- MqttClientOptions → NetClientOptions
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- def getClientId: String
-
def
getConnectTimeout: Int
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase
-
def
getCrlPaths: Buffer[String]
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
getCrlValues: Buffer[Buffer]
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
getEnabledCipherSuites: Set[String]
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
getEnabledSecureTransportProtocols: Set[String]
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
- def getHost: String
-
def
getHostnameVerificationAlgorithm: String
- Definition Classes
- MqttClientOptions → NetClientOptions
-
def
getIdleTimeout: Int
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
getJdkSslEngineOptions: JdkSSLEngineOptions
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
- def getKeepAliveTimeSeconds: Int
-
def
getKeyStoreOptions: JksOptions
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
getLocalAddress: String
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase
-
def
getLogActivity: Boolean
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
- def getMaxMessageSize: Int
-
def
getMetricsName: String
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase
-
def
getOpenSslEngineOptions: OpenSSLEngineOptions
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
- def getPassword: String
-
def
getPemKeyCertOptions: PemKeyCertOptions
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
getPemTrustOptions: PemTrustOptions
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
getPfxKeyCertOptions: PfxOptions
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
getPfxTrustOptions: PfxOptions
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
- def getPort: Int
-
def
getProxyOptions: ProxyOptions
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase
-
def
getReceiveBufferSize: Int
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
-
def
getReconnectAttempts: Int
- Definition Classes
- MqttClientOptions → NetClientOptions
-
def
getReconnectInterval: Long
- Definition Classes
- MqttClientOptions → NetClientOptions
-
def
getSendBufferSize: Int
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
-
def
getSoLinger: Int
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
getTrafficClass: Int
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
-
def
getTrustStoreOptions: JksOptions
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
- def getUsername: String
- def getWillMessage: String
- def getWillQoS: Int
- def getWillTopic: String
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- def isAutoGeneratedClientId: Boolean
- def isAutoKeepAlive: Boolean
- def isCleanSession: Boolean
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isReuseAddress: Boolean
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
-
def
isSsl: Boolean
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
isTcpKeepAlive: Boolean
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
isTcpNoDelay: Boolean
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
isTrustAll: Boolean
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase
-
def
isUseAlpn: Boolean
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
isUsePooledBuffers: Boolean
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
- def isWillFlag: Boolean
- def isWillRetain: Boolean
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
def
setAutoGeneratedClientId(value: Boolean): MqttClientOptions
Set if the MQTT client must generate clientId automatically (default is true)
-
def
setAutoKeepAlive(value: Boolean): MqttClientOptions
Set if the MQTT client must handle PINGREQ automatically (default is true)
- def setCleanSession(value: Boolean): MqttClientOptions
- def setClientId(value: String): MqttClientOptions
-
def
setConnectTimeout(value: Int): MqttClientOptions
Set the connect timeout
Set the connect timeout
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase
- def setHost(value: String): MqttClientOptions
-
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
-
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
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
def
setJdkSslEngineOptions(value: JdkSSLEngineOptions): MqttClientOptions
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
- def setKeepAliveTimeSeconds(value: Int): MqttClientOptions
-
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
-
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
-
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
-
def
setMaxMessageSize(value: Int): MqttClientOptions
Set max MQTT message size
-
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
-
def
setOpenSslEngineOptions(value: OpenSSLEngineOptions): MqttClientOptions
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
- def setPassword(value: String): MqttClientOptions
-
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
-
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
-
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
-
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
- def setPort(value: Int): MqttClientOptions
-
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
-
def
setReceiveBufferSize(value: Int): MqttClientOptions
Set the TCP receive buffer size
Set the TCP receive buffer size
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
-
def
setReconnectAttempts(value: Int): MqttClientOptions
Set the value of reconnect attempts
Set the value of reconnect attempts
- Definition Classes
- MqttClientOptions → NetClientOptions
-
def
setReconnectInterval(value: Long): MqttClientOptions
Set the reconnect interval
Set the reconnect interval
- Definition Classes
- MqttClientOptions → NetClientOptions
-
def
setReuseAddress(value: Boolean): MqttClientOptions
Set the value of reuse address
Set the value of reuse address
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
-
def
setSendBufferSize(value: Int): MqttClientOptions
Set the TCP send buffer size
Set the TCP send buffer size
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
-
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
-
def
setSsl(value: Boolean): MqttClientOptions
Set whether SSL/TLS is enabled
Set whether SSL/TLS is enabled
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
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
-
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
-
def
setTrafficClass(value: Int): MqttClientOptions
Set the value of traffic class
Set the value of traffic class
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions → NetworkOptions
-
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
-
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
-
def
setUseAlpn(value: Boolean): MqttClientOptions
Set the ALPN usage.
Set the ALPN usage.
- Definition Classes
- MqttClientOptions → NetClientOptions → ClientOptionsBase → TCPSSLOptions
-
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
- def setUsername(value: String): MqttClientOptions
- def setWillFlag(value: Boolean): MqttClientOptions
- def setWillMessage(value: String): MqttClientOptions
- def setWillQoS(value: Int): MqttClientOptions
- def setWillRetain(value: Boolean): MqttClientOptions
- def setWillTopic(value: String): MqttClientOptions
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )