final class MqttSessionSettings extends AnyRef
Configuration settings for client and server usage.
- Alphabetic
- By Inheritance
- MqttSessionSettings
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
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
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val clientTerminationWatcherBufferSize: Int
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
- val commandParallelism: Int
- val consumerPubAckRecTimeout: FiniteDuration
- val consumerPubCompTimeout: FiniteDuration
- val consumerPubRelTimeout: FiniteDuration
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val eventParallelism: Int
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val maxPacketSize: Int
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val producerPubAckRecTimeout: FiniteDuration
- val producerPubCompTimeout: FiniteDuration
- val receiveConnAckTimeout: FiniteDuration
- val receiveConnectTimeout: FiniteDuration
- val receiveSubAckTimeout: FiniteDuration
- val receiveUnsubAckTimeout: FiniteDuration
- val serverSendBufferSize: Int
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- MqttSessionSettings → 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
- @native() @throws( ... )
-
def
withClientTerminationWatcherBufferSize(clientTerminationWatcherBufferSize: Int): MqttSessionSettings
The maximum number of client termination event observers permitted.
The maximum number of client termination event observers permitted. Defaults to 100 which should be more than adequate for most situations.
-
def
withCommandParallelism(commandParallelism: Int): MqttSessionSettings
The number of commands that can be processed at a time, with a default of 50.
The number of commands that can be processed at a time, with a default of 50. For client usage, note that each CONNECT will reduced the availability of remaining command channels for other commands by 1. For server usage, each CONNACK received will reduce the availability of remaining command channels for other commands by 1.
-
def
withConsumerPubAckRecTimeout(consumerPubAckRecTimeout: Duration): MqttSessionSettings
JAVA API
JAVA API
For consumers of PUBLISH, the amount of time to wait before receiving an ack/receive command locally in reply to a QoS 1/2 publish event before failing. Defaults to 30 seconds.
-
def
withConsumerPubAckRecTimeout(consumerPubAckRecTimeout: FiniteDuration): MqttSessionSettings
For consumers of PUBLISH, the amount of time to wait before receiving an ack/receive command locally in reply to a QoS 1/2 publish event before failing.
For consumers of PUBLISH, the amount of time to wait before receiving an ack/receive command locally in reply to a QoS 1/2 publish event before failing. Defaults to 30 seconds.
-
def
withConsumerPubCompTimeout(consumerPubCompTimeout: Duration): MqttSessionSettings
JAVA API
JAVA API
For consumers of PUBLISH, the amount of time to wait before receiving a complete command locally in reply to a QoS 2 publish event before failing. Defaults to 30 seconds.
-
def
withConsumerPubCompTimeout(consumerPubCompTimeout: FiniteDuration): MqttSessionSettings
For consumers of PUBLISH, the amount of time to wait before receiving a complete command locally in reply to a QoS 2 publish event before failing.
For consumers of PUBLISH, the amount of time to wait before receiving a complete command locally in reply to a QoS 2 publish event before failing. Defaults to 30 seconds.
-
def
withConsumerPubRelTimeout(consumerPubRelTimeout: Duration): MqttSessionSettings
JAVA API
JAVA API
For consumers of PUBLISH, the amount of time to wait for a server to release a QoS 2 publish before failing. Defaults to 30 seconds.
-
def
withConsumerPubRelTimeout(consumerPubRelTimeout: FiniteDuration): MqttSessionSettings
For consumers of PUBLISH, the amount of time to wait for a server to release a QoS 2 publish before failing.
For consumers of PUBLISH, the amount of time to wait for a server to release a QoS 2 publish before failing. Defaults to 30 seconds.
-
def
withEventParallelism(eventParallelism: Int): MqttSessionSettings
This is the number of events that can be received in parallel at any one time, with a default of 10.
-
def
withMaxPacketSize(maxPacketSize: Int): MqttSessionSettings
The maximum size of a packet that is allowed to be decoded.
The maximum size of a packet that is allowed to be decoded. Defaults to 4k.
-
def
withProducerPubAckRecTimeout(producerPubAckRecTimeout: Duration): MqttSessionSettings
JAVA API
JAVA API
For producers of PUBLISH, the amount of time to wait to ack/receive a QoS 1/2 publish before retrying with the DUP flag set. Defaults to 0 seconds, which means republishing only occurs on reconnect.
-
def
withProducerPubAckRecTimeout(producerPubAckRecTimeout: FiniteDuration): MqttSessionSettings
For producers of PUBLISH, the amount of time to wait to ack/receive a QoS 1/2 publish before retrying with the DUP flag set.
For producers of PUBLISH, the amount of time to wait to ack/receive a QoS 1/2 publish before retrying with the DUP flag set. Defaults to 0 seconds, which means republishing only occurs on reconnect.
-
def
withProducerPubCompTimeout(producerPubCompTimeout: Duration): MqttSessionSettings
JAVA API
JAVA API
For producers of PUBLISH, the amount of time to wait for a server to complete a QoS 2 publish before retrying with another PUBREL. Defaults to 0 seconds, which means republishing only occurs on reconnect.
-
def
withProducerPubCompTimeout(producerPubCompTimeout: FiniteDuration): MqttSessionSettings
For producers of PUBLISH, the amount of time to wait for a server to complete a QoS 2 publish before retrying with another PUBREL.
For producers of PUBLISH, the amount of time to wait for a server to complete a QoS 2 publish before retrying with another PUBREL. Defaults to 0 seconds, which means republishing only occurs on reconnect.
-
def
withReceiveConnAckTimeout(receiveConnAckTimeout: Duration): MqttSessionSettings
JAVA API
JAVA API
For clients, the amount of time to wait for a server to ack a connection. For servers, the amount of time to wait before receiving an ack command locally in reply to a connect event. Defaults to 30 seconds.
-
def
withReceiveConnAckTimeout(receiveConnAckTimeout: FiniteDuration): MqttSessionSettings
For clients, the amount of time to wait for a server to ack a connection.
For clients, the amount of time to wait for a server to ack a connection. For servers, the amount of time to wait before receiving an ack command locally in reply to a connect event. Defaults to 30 seconds.
-
def
withReceiveConnectTimeout(receiveConnectTimeout: Duration): MqttSessionSettings
JAVA API
JAVA API
For servers, the amount of time a session can be disconnected before being re-connected. Defaults to 5 minutes.
-
def
withReceiveConnectTimeout(receiveConnectTimeout: FiniteDuration): MqttSessionSettings
For servers, the amount of time a session can be disconnected before being re-connected.
For servers, the amount of time a session can be disconnected before being re-connected. Defaults to 5 minutes.
-
def
withReceiveSubAckTimeout(receiveSubAckTimeout: Duration): MqttSessionSettings
JAVA API
JAVA API
For clients, the amount of time to wait for a server to ack a subscribe. For servers, the amount of time to wait before receiving an ack command locally in reply to a subscribe event. Defaults to 30 seconds.
-
def
withReceiveSubAckTimeout(receiveSubAckTimeout: FiniteDuration): MqttSessionSettings
For clients, the amount of time to wait for a server to ack a subscribe.
For clients, the amount of time to wait for a server to ack a subscribe. For servers, the amount of time to wait before receiving an ack command locally in reply to a subscribe event. Defaults to 30 seconds.
-
def
withReceiveUnsubAckTimeout(receiveUnsubAckTimeout: Duration): MqttSessionSettings
JAVA API
JAVA API
For clients, the amount of time to wait for a server to ack a unsubscribe. For servers, the amount of time to wait before receiving an ack command locally in reply to a unsubscribe event. Defaults to 30 seconds.
-
def
withReceiveUnsubAckTimeout(receiveUnsubAckTimeout: FiniteDuration): MqttSessionSettings
For clients, the amount of time to wait for a server to ack a unsubscribe.
For clients, the amount of time to wait for a server to ack a unsubscribe. For servers, the amount of time to wait before receiving an ack command locally in reply to a unsubscribe event. Defaults to 30 seconds.
-
def
withServerSendBufferSize(serverSendBufferSize: Int): MqttSessionSettings
Just for servers - the number of commands that can be buffered while connected to a client.
Just for servers - the number of commands that can be buffered while connected to a client. Defaults to 100. Any commands received beyond this will be dropped.