package streaming
- Alphabetic
- Public
- Protected
Type Members
- 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
- 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
- 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
- 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
- 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
- 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
- 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
- final case class ControlPacketFlags(underlying: Int) extends AnyVal with Product with Serializable
- Annotations
- @InternalApi()
- final case class ControlPacketType(underlying: Int) extends AnyVal with Product with Serializable
- Annotations
- @InternalApi()
- final case class DecodeErrorOrEvent[A](v: Either[DecodeError, Event[A]]) extends Product with Serializable
JAVA API
- 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
- final class MqttSessionSettings extends AnyRef
Configuration settings for client and server usage.
- 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()
- 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
- 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
- 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
- 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
- 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()
- 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
- 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
- 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
- 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
- object Command extends Serializable
- object ConnAckFlags extends Serializable
- object ConnAckReturnCode extends Serializable
- object Connect extends Serializable
- object ConnectFlags extends Serializable
- 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
- 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
- object DecodeErrorOrEvent extends Serializable
- 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
- object Event extends Serializable
- 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.
- object MqttSessionSettings
- 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
- 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
- object Publish extends Serializable
- case object Reserved1 extends ControlPacket with Product with Serializable
- case object Reserved2 extends ControlPacket with Product with Serializable
- object Subscribe extends Serializable
- object Unsubscribe extends Serializable