diff --git a/man/mosquitto.8.xml b/man/mosquitto.8.xml index 2a443224..bd90678c 100644 --- a/man/mosquitto.8.xml +++ b/man/mosquitto.8.xml @@ -39,12 +39,12 @@ - + Load configuration from a file. If not given, then the broker will listen on port 1883 bound to the loopback interface, - and the default values as described in + and the default values as described in mosquitto.conf5 - are used. - + are used. + See the option for a description of changes in behaviour from 1.6.x to 2.0. @@ -91,6 +91,231 @@ + + MQTT Support + Mosquitto supports MQTT v5.0, v3.1.1, and v3.1. + + + MQTT v5.0 + + Mosquitto provides full MQTT v5.0 support, but some features + are not used directly. The following sections describe the new + features and explain where Mosquitto does not make use of a feature. + + + + Features + + + + + Basic MQTT authentication uses username/password + checks. Enhanced authentication allows different + authentication schemes to be integrated into MQTT, + and even those schemes with multiple step processes. + Clients request a particular type of authentication + and if the broker is configured for that scheme the + authentication continues. Mosquitto supports + enhanced authentication through plugins. + + + + + + Most MQTT packets now have the concept of a + + which indicates success or failure, and what the failure + was. Mosquitto provides full support for reason codes, + but does not make use of the + + feature which can be used to provide a human readable + error string to explain the reason code. + + + + + + The number of "in flight" messages for QoS 1 and QoS + 2 can be controlled by both the client and the + broker. + + + + + + MQTT v5.0 adds a request/response pattern that + allows a client to publish a message and instruct + the subscribers of that message where to publish a + response. + + + + + + Server redirection is the concept of telling a + client to connect to a different MQTT broker, either + on CONNECT or with a broker initiated DISCONNECT. + Mosquitto does not currently make use of this + feature. + + + + + + When multiple clients subscribe to the same shared + subscription, only one client out of the group will + receive each message which allows for distributing + work loads. + + + + + + + Packet properties + + MQTT v5.0 allows properties to be added to packets to + control certain behaviour. Unless noted, Mosquitto + support the properties listed below. + + + + + + + + Authentication data + Authentication method + Maximum packet size + Receive maximum + Request problem information - supported but not used + Request response information - supported but not used + Session expiry interval + Topic alias maximum + User property + + + + + + + + Content type + Correlation data + Message expiry interval + Payload format indicator + Response topic + User property + Will delay interval + + + + + + + + Assigned client identifier + Authentication data + Authentication method + Maximum packet size + Maximum qos + Reason string - supported but not used + Receive maximum + Response information - supported but not used + Retain available + Server keep alive + Server reference - supported but not used + Session expiry interval + Shared subscription available + Subscription identifiers available + Topic alias maximum + User property + Wildcard subscription available + + + + + + + + Content type + Correlation data + Message expiry interval + Payload format indicator + Response topic + Subscription identifier + Topic alias + User property + + + + + + + + Reason string - supported but not used + User property + + + + + + + + Subscription identifier + User property + + + + + + + + Reason string - supported but not used + Server reference - supported but not used + Session expiry interval + User property + + + + + + + + Authentication method + Authentication data + Reason string - supported but not used + User property + + + + + + + + + MQTT v3.1.1 + Mosquitto provides full MQTT v3.1.1 support. + + + + MQTT v3.1 + Mosquitto provides full MQTT v3.1 support. + + + + MQTT v3 + + MQTT v3 is an obsolete version of the protocol that does not + support username/password authentication and used the + flag in the CONNECT packet which + applied only to the start of a session. An MQTT v3 client + will be able to successfully connect to a Mosquitto instance + that does not require authentication. + + + + Broker Status Clients can find information about the broker by subscribing to @@ -331,21 +556,21 @@ The total number of retained messages active on the broker. - - - (deprecated) + + + (deprecated) The number of messages currently held in the message store. This includes retained messages and messages queued for durable clients. - - + + The number of bytes currently held by message payloads - in the message store. This includes retained messages - and messages queued for durable clients. + in the message store. This includes retained messages + and messages queued for durable clients.