Packages

package streaming

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Package Members

  1. package impl
  2. package javadsl
  3. package scaladsl

Type Members

  1. final case class Command[A](command: ControlPacket, completed: Option[Promise[Done]], carry: Option[A]) extends Product with Serializable

    Send a command to an MQTT session with optional data to carry through into any related event.

    Send a command to an MQTT session with optional data to carry through into any related event.

    A

    The type of data to carry through

    command

    The command to send

    completed

    A promise that is completed by the session when the command has been processed - useful for synchronizing when activities should occur in relation to a command The only commands that support this presently are SubAck, UnsubAck, PubAck, PubRec and PubComp. These completions can be used to signal when processing should continue.

    carry

    The data to carry though

  2. final case class ConnAck(connectAckFlags: ConnAckFlags, returnCode: ConnAckReturnCode) extends ControlPacket with Product with Serializable

    3.2 CONNACK – Acknowledge connection request http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html

  3. final case class ConnAckFlags extends AnyVal with Product with Serializable

    3.2.2.1 Connect Acknowledge Flags http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html

  4. final case class ConnAckReturnCode extends AnyVal with Product with Serializable

    3.2.2.3 Connect Return code http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html

  5. final case class Connect(protocolName: ProtocolName, protocolLevel: ProtocolLevel, clientId: String, connectFlags: ConnectFlags, keepAlive: FiniteDuration, willTopic: Option[String], willMessage: Option[String], username: Option[String], password: Option[String]) extends ControlPacket with Product with Serializable

    3.1 CONNECT – Client requests a connection to a Server http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html

  6. final case class ConnectFlags extends AnyVal with Product with Serializable

    3.1.2.3 Connect Flags http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html

  7. sealed abstract class ControlPacket extends AnyRef

    2 MQTT Control Packet format http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html

  8. final case class ControlPacketFlags(underlying: Int) extends AnyVal with Product with Serializable
    Annotations
    @InternalApi()
  9. final case class ControlPacketType(underlying: Int) extends AnyVal with Product with Serializable
    Annotations
    @InternalApi()
  10. final case class DecodeErrorOrEvent[A](v: Either[DecodeError, Event[A]]) extends Product with Serializable

    JAVA API

  11. final case class Event[A](event: ControlPacket, carry: Option[A]) extends Product with Serializable

    Receive an event from a MQTT session with optional data to carry through infrom ay related event.

    Receive an event from a MQTT session with optional data to carry through infrom ay related event.

    A

    The type of data to carry through

    event

    The event to receive

    carry

    The data to carry though

  12. final class MqttSessionSettings extends AnyRef

    Configuration settings for client and server usage.

  13. final case class PacketId(underlying: Int) extends AnyVal with Product with Serializable

    2.3.1 Packet Identifier http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html

    2.3.1 Packet Identifier http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html

    Annotations
    @InternalApi()
  14. final case class PubAck(packetId: PacketId) extends ControlPacket with Product with Serializable

    3.4 PUBACK – Publish acknowledgement http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html

  15. final case class PubComp(packetId: PacketId) extends ControlPacket with Product with Serializable

    3.7 PUBCOMP – Publish complete (QoS 2 publish received, part 3) http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html

  16. final case class PubRec(packetId: PacketId) extends ControlPacket with Product with Serializable

    3.5 PUBREC – Publish received (QoS 2 publish received, part 1) http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html

  17. final case class PubRel(packetId: PacketId) extends ControlPacket with Product with Serializable

    3.6 PUBREL – Publish release (QoS 2 publish received, part 2) http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html

  18. final case class Publish(flags: ControlPacketFlags, topicName: String, packetId: Option[PacketId], payload: ByteString) extends ControlPacket with Product with Serializable

    3.3 PUBLISH – Publish message http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html

    3.3 PUBLISH – Publish message http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html

    Annotations
    @InternalApi()
  19. final case class SubAck(packetId: PacketId, returnCodes: Seq[ControlPacketFlags]) extends ControlPacket with Product with Serializable

    3.9 SUBACK – Subscribe acknowledgement http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html

  20. final case class Subscribe extends ControlPacket with Product with Serializable

    3.8 SUBSCRIBE - Subscribe to topics http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html

  21. final case class UnsubAck(packetId: PacketId) extends ControlPacket with Product with Serializable

    3.11 UNSUBACK – Unsubscribe acknowledgement http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html

  22. final case class Unsubscribe extends ControlPacket with Product with Serializable

    3.10 UNSUBSCRIBE – Unsubscribe from topics http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html

Value Members

  1. object Command extends Serializable
  2. object ConnAckFlags extends Serializable
  3. object ConnAckReturnCode extends Serializable
  4. object Connect extends Serializable
  5. object ConnectFlags extends Serializable
  6. object ControlPacketFlags extends Serializable

    2.2.2 Flags http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html

  7. object ControlPacketType extends Serializable

    2.2.1 MQTT Control Packet type http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html

  8. object DecodeErrorOrEvent extends Serializable
  9. case object Disconnect extends ControlPacket with Product with Serializable

    3.14 DISCONNECT – Disconnect notification http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html

  10. object Event extends Serializable
  11. object MqttCodec

    Provides functions to decode bytes to various MQTT types and vice-versa.

    Provides functions to decode bytes to various MQTT types and vice-versa. Performed in accordance with http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html with section numbers referenced accordingly.

  12. object MqttSessionSettings
  13. case object PingReq extends ControlPacket with Product with Serializable

    3.12 PINGREQ – PING request http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html

  14. case object PingResp extends ControlPacket with Product with Serializable

    3.13 PINGRESP – PING response http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html

  15. object Publish extends Serializable
  16. case object Reserved1 extends ControlPacket with Product with Serializable
  17. case object Reserved2 extends ControlPacket with Product with Serializable
  18. object Subscribe extends Serializable
  19. object Unsubscribe extends Serializable

Ungrouped