Module packet
Expand description
Control packet types — zero-copy decode, borrowed from the input buffer.
Modules§
- ack 🔒
- auth 🔒
- connack 🔒
- connect 🔒
- disconnect 🔒
- publish 🔒
- reason_
code 🔒 - suback 🔒
- subscribe 🔒
- unsuback 🔒
- unsubscribe 🔒
Structs§
- Ack
- Acknowledgement packet (PUBACK, PUBREC, PUBREL, PUBCOMP).
- Auth
- AUTH packet for enhanced authentication.
- Connack
- CONNACK packet sent by the server in response to CONNECT.
- Connect
- CONNECT packet sent by the client to initiate a session.
- Connect
Flags - Connect flags byte.
- Disconnect
- DISCONNECT packet signaling connection termination.
- Publish
- PUBLISH packet carrying an application message.
- Suback
- SUBACK packet acknowledging a SUBSCRIBE.
- Subscribe
- SUBSCRIBE packet requesting topic filter subscriptions.
- Subscription
- A single subscription entry (topic filter + options).
- Subscription
Iter - Iterator over subscription entries.
- Subscription
Options - Subscription options byte in a SUBSCRIBE payload entry.
- Topic
Filter Iter - Iterator over topic filter strings in UNSUBSCRIBE payload.
- Unsuback
- UNSUBACK packet acknowledging an UNSUBSCRIBE.
- Unsubscribe
- UNSUBSCRIBE packet requesting removal of topic filter subscriptions.
- Will
- Will message included in a CONNECT packet.
Enums§
- Packet
- A decoded MQTT v5 packet. All borrowed data refers to the input buffer.
- Reason
Code - All MQTT v5 reason codes.
- Retain
Handling - Retain handling option for SUBSCRIBE.
Functions§
- subscription_
encoded_ len - Number of bytes needed to encode a single subscription entry.
- topic_
filter_ encoded_ len - Number of bytes needed to encode a single topic filter (for UNSUBSCRIBE).