Packages

final class MqttSessionSettings extends AnyRef

Configuration settings for client and server usage.

Source
MqttSessionSettings.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MqttSessionSettings
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. val clientSendBufferSize: Int
  2. val clientTerminationWatcherBufferSize: Int
  3. val commandParallelism: Int
  4. val consumerPubAckRecTimeout: FiniteDuration
  5. val consumerPubCompTimeout: FiniteDuration
  6. val consumerPubRelTimeout: FiniteDuration
  7. val eventParallelism: Int
  8. val maxPacketSize: Int
  9. val producerPubAckRecTimeout: FiniteDuration
  10. val producerPubCompTimeout: FiniteDuration
  11. val receiveConnAckTimeout: FiniteDuration
  12. val receiveConnectTimeout: FiniteDuration
  13. val receiveSubAckTimeout: FiniteDuration
  14. val receiveUnsubAckTimeout: FiniteDuration
  15. val serverSendBufferSize: Int
  16. def toString(): String
    Definition Classes
    MqttSessionSettings → AnyRef → Any
  17. def withClientSendBufferSize(clientSendBufferSize: Int): MqttSessionSettings

    Just for clients - the number of commands that can be buffered while connected to a server.

    Just for clients - the number of commands that can be buffered while connected to a server. Defaults to 10. Any commands received beyond this will apply backpressure.

  18. 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.

  19. 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.

  20. 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.

  21. 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.

  22. 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.

  23. 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.

  24. 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.

  25. 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.

  26. 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.

  27. 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.

  28. 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.

  29. 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.

  30. 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.

  31. 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.

  32. 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.

  33. 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.

  34. 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.

  35. 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.

  36. 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.

  37. 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.

  38. 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.

  39. 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.

  40. 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 apply backpressure.