mcxiaoke/mqtt
Mqtt
This project provides a technical specification and reference manual for the MQTT 3.1.1 standard, serving as a translated Chinese guide for implementing this lightweight IoT messaging protocol in resource-constrained device networks.
The documentation covers the fundamental mechanisms of the publish-subscribe model, including topic-based routing with wildcard filtering, retained message storage, and the configuration of last will and testament messages. It details the protocol's approach to reliability through various quality of service levels, ranging from single-level acknowledgments to exactly-once delivery confirmations.
The reference material further describes session management for persisting client state across reconnections, connection lifecycle handling with heartbeat monitoring, and security measures such as client authentication, data encryption, and anomaly detection. It also specifies data encoding standards, including big-endian byte ordering and UTF-8 string validation, as well as transport options like binary WebSocket wrapping.
Features
- Quality of Service Implementations - Distributes application messages using multiple quality-of-service levels to balance reliability and network overhead.
- Topic-Based Pub/Sub - Implements a core publish-subscribe architecture using topic strings and wildcard filtering for message routing.
- Publishers - Provides detailed specifications for publishing payloads to MQTT topics with configurable quality-of-service levels.
- Lightweight Messaging Protocols - Provides a technical specification for a lightweight publish-subscribe messaging protocol optimized for IoT environments.
- Control Packet Exchanges - Defines the structured control packets used to manage communication and state between MQTT clients and servers.
- MQTT Message Acknowledgements - Ships a detailed specification for MQTT-specific acknowledgments with reason codes to confirm high-reliability message reception.
- MQTT Protocol Versions - Provides a detailed reference manual covering packet formats, QoS levels, and connection handshakes for MQTT.
- Message Delivery Guarantees - Tracks transmissions using identifiers and duplicate flags to guarantee delivery at different reliability levels.
- Exactly-Once Delivery Guarantees - Implements high-reliability delivery confirmation using a four-way handshake to ensure exactly-once delivery.
- QoS Retransmission Engines - Details the multi-level quality of service handshaking and acknowledgment sequences to guarantee message delivery reliability.
- Protocol Acknowledgements - Defines the use of confirmation packets and message identifiers to signal the completion of single-level delivery.
- Protocol Specifications - Serves as a comprehensive translated Chinese reference of the MQTT 3.1.1 standard.
- Session State Management - Maintains session data between clients and servers to guarantee service quality across network reconnections.
- Session Restoration - Restores communication state using unique client identifiers to maintain connectivity after network interruptions.
- Topic-Based Messaging - Implements a system for exchanging messages categorized by topics to allow filtered delivery based on matching criteria.
- Topic Subscription Management - Specifies how clients register topic filters and manage memberships to receive matching application messages.
- MQTT Credential Validators - Validates client IDs, usernames, and passwords during the connection handshake to ensure only authorized users connect.
- Client Access Authorizations - Restricts access to topics and resources based on client identifiers, IP addresses, and authentication results.
- Messaging Session Persistence - Provides mechanisms to persist client subscriptions and unacknowledged messages across reconnections using unique identifiers.
- Packet Framing Protocols - Defines structured packet framing with length prefixes and headers to delineate discrete messages in a byte stream.
- Packet Identifiers - Assigns unique identifiers to packets to guarantee reliable delivery and acknowledgement across service levels.
- Length-Delimited Encodings - Uses length-delimited encoding with a continuation-bit scheme to represent packet sizes up to 256MB.
- Variable-Width Integer Encodings - Utilizes a continuation-bit scheme for variable-length integer encoding to optimize packet header size.
- Node Availability Verification - Confirms server activity through responses to heartbeat requests to maintain the active network link.
- Topic Subscribers - Provides support for matching published messages to subscribers using wildcard characters in topic filters.
- Retained Messages - Defines the mechanism for storing and delivering the most recent state to new subscribers via retained messages.
- Connection Establishment Protocols - Defines the request and acknowledgment packet sequence used to initiate and confirm communication sessions.
- Graceful Connection Shutdowns - Provides a specific disconnect packet to ensure the graceful termination of the client-server session.
- Subscription Acknowledgments - Provides a mechanism for the server to confirm the processing of subscription requests and granted QoS levels.
- Topic Unsubscriptions - Defines the protocol exchange for removing topic filters from a client session.
- Message Ordering Guarantees - Ensures that messages and acknowledgments are sent and received in their original sequence for ordered topics.
- Last Will and Testament Messages - Implements the last will and testament mechanism to notify other clients of unexpected device disconnections.
- Application-Level Connection Acceptance - Implements protocol-level validation to accept or reject connections based on version, identity, and authorization.
- WebSocket Transports - Enables communication over web-compatible connections by wrapping protocol packets in binary WebSocket frames.
- Client Authentications - The MQTT protocol verifies client identities using credentials, certificates, or external systems to ensure secure access.
- Cryptographic Identity Verification - Confirms server identity using certificates or secure tunnels to ensure clients connect to the intended endpoint.
- Data Encryption - Secures communication and static data through cryptographic encryption to prevent unauthorized access.
- Anomaly Detection - Monitors network traffic for anomalies like topic scanning or connection flooding to proactively disconnect malicious clients.
- Connection Heartbeats - Implements keep-alive intervals with ping and pong packets to monitor and maintain network connection liveness.
