scala-mqtt-wrapper
API
Generated with
scala-mqtt-wrapper/pl.waw.ibspan.scala_mqtt_wrapper

pl.waw.ibspan.scala_mqtt_wrapper

package pl.waw.ibspan.scala_mqtt_wrapper

Members list

Type members

Classlikes

class MqttClient(val mqttSettings: MqttSettings, val mqttSessionSettings: MqttSessionSettings, val loggingSettings: Option[MqttLoggingSettings])(implicit system: ActorSystem[_])

MQTT client

MQTT client

Value parameters

loggingSettings

optional logging settings

mqttSessionSettings

MQTT session settings

mqttSettings

MQTT client settings

system

actor system

Attributes

Constructor

create a new MQTT client

Supertypes
class Object
trait Matchable
class Any
final case class MqttLoggingSettings(name: String, attributes: Attributes)

MQTT logging settings

MQTT logging settings

Value parameters

attributes

attributes with log levels

name

name used in log messages

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class MqttPublishMessage(payload: ByteString, topic: String, flags: ControlPacketFlags)

MQTT data to be published

MQTT data to be published

Value parameters

flags

MQTT flags

payload

payload to be published

topic

topic to which the payload will be published

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class MqttReceivedMessage(payload: ByteString, topic: String, flags: ControlPacketFlags, packetId: Option[PacketId])

data received from the MQTT broker

data received from the MQTT broker

Value parameters

flags

MQTT flags

packetId

MQTT packet id

payload

received payload

topic

topic from which the payload was received

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class MqttSettings(host: String, port: Int, username: String, password: String, subscriptions: Seq[MqttTopic], clientId: String, sessionId: ByteString, connectFlags: ConnectFlags, restartMinBackoff: FiniteDuration, restartMaxBackoff: FiniteDuration, restartRandomFactor: Double, maxRestarts: Int, restartLogLevel: LogLevel, commandMergeSinkPerProducerBufferSize: Int, commandBroadcastSourceBufferSize: Int, eventBroadcastSourceBufferSize: Int, withEventBroadcastSourceBackpressure: Boolean, publishMergeSinkPerProducerBufferSize: Int, commandQueueBufferSize: Int)

MQTT client settings

MQTT client settings

Value parameters

clientId

MQTT client ID

commandBroadcastSourceBufferSize

MQTT commands broadcast buffer size, must be a power of 2

commandMergeSinkPerProducerBufferSize

buffer space used per producer for command sink merge hub

commandQueueBufferSize

MQTT command queue buffer size

connectFlags

MQTT connect flags

eventBroadcastSourceBufferSize

MQTT events broadcast buffer size, must be a power of 2

host

MQTT host

maxRestarts

MQTT maximum restarts, set to -1 for infinite restarts

password

MQTT password

port

MQTT port

publishMergeSinkPerProducerBufferSize

buffer space used per producer for publish merge sink

restartLogLevel

MQTT restart log level

restartMaxBackoff

MQTT restart maximum backoff

restartMinBackoff

MQTT restart minimum backoff

restartRandomFactor

MQTT restart random factor, random delay is added based on this factor

sessionId

MQTT session ID

subscriptions

MQTT topics to subscribe to

username

MQTT username

withEventBroadcastSourceBackpressure

if true, the event broadcast will store events in a buffer until there is demand and eventually apply backpressure on the MQTT session flow; if false, the events will be always consumed even if there is no external demand

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object MqttSink

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
MqttSink.type
object MqttSource

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
MqttSource.type
final case class MqttTopic(name: String, flags: ControlPacketFlags)

MQTT topic

MQTT topic

Value parameters

flags

MQTT flags

name

topic name

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object PublishQoSFlags

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object SubscribeQoSFlags

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Generated with