diff --git a/samples/mqtt5_shared_subscription.md b/samples/mqtt5_shared_subscription.md index a76e8a37..91a9799e 100644 --- a/samples/mqtt5_shared_subscription.md +++ b/samples/mqtt5_shared_subscription.md @@ -4,20 +4,20 @@ This sample uses the [Message Broker](https://docs.aws.amazon.com/iot/latest/developerguide/iot-message-broker.html) -for AWS IoT to send and receive messages through an MQTT connection using MQTT5 using a Shared Subscription. +for AWS IoT to send and receive messages over a MQTT5 connection using a shared subscription. MQTT5 introduces additional features and enhancements that improve the development experience with MQTT. You can read more about MQTT5 in the Python V2 SDK by checking out the [MQTT5 user guide](../documents/MQTT5_Userguide.md). Note: MQTT5 support is currently in **developer preview**. We encourage feedback at all times, but feedback during the preview window is especially valuable in shaping the final product. During the preview period we may make backwards-incompatible changes to the public API, but in general, this is something we will try our best to avoid. -Shared Subscriptions allow IoT devices to connect to a group where messages sent to a topic are then relayed to the group in a round-robin-like fashion. This is useful for distributing message load across multiple subscribing MQTT5 clients automatically. This is helpful for load balancing when you have many messages that need to processed. +[Shared Subscriptions](https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901250) allow IoT devices to connect to a group where messages sent to a topic are then relayed to the group in a round-robin-like fashion. This is useful for distributing message load across multiple subscribing MQTT5 clients automatically. This is helpful for load balancing when you have many messages that need to be processed. -Shared Subscriptions rely on what is called a group identifier, which tells the MQTT5 broker/server which IoT devices are in what group. This is done when subscribing by formatting the subscription topic like the following: `$share//`. +Shared Subscriptions rely on a group identifier, which tells the MQTT5 broker/server which IoT devices to treat as a group for message distribution. This is done when subscribing by formatting the subscription topic like the following: `$share//`. * `$share`: Tells the MQTT5 broker/server that the device is subscribing to a Shared Subscription. -* ``: Tells the MQTT5 broker/server which group to add this Shared Subscription to. THis is the group of MQTT5 clients that will be worked through as part of the round-robin when a message comes in. For example: `my-iot-group`. +* ``: Tells the MQTT5 broker/server which group to add this Shared Subscription to. Messages published to a matching topic will be distributed round-robin amongst the group. * ``: The topic that the Shared Subscription is for. Messages published to this topic will be processed in a round-robin fashion. For example, `test/topic`. -As mentioned, Shared Subscriptions use a round-robbin like method of distributing messages. For example, say you have three MQTT5 clients all subscribed to the same Shared Subscription group and topic. If five messages are sent to the Shared Subscription topic, the messages will likely be delivered in the following order: +Shared Subscriptions use a round-robbin like method of distributing messages. For example, say you have three MQTT5 clients all subscribed to the same Shared Subscription group and topic. If five messages are sent to the Shared Subscription topic, the messages will likely be delivered in the following order: * Message 1 -> Client one * Message 2 -> Client two * Message 3 -> Client three diff --git a/samples/mqtt5_shared_subscription.py b/samples/mqtt5_shared_subscription.py index b291e0b2..2befcb83 100644 --- a/samples/mqtt5_shared_subscription.py +++ b/samples/mqtt5_shared_subscription.py @@ -8,10 +8,6 @@ from concurrent.futures import Future import time -# MQTT5 support is currently in developer preview. We encourage feedback at all times, but feedback during the -# preview window is especially valuable in shaping the final product. During the preview period we may make -# backwards-incompatible changes to the public API, but in general, this is something we will try our best to avoid. - # For the purposes of this sample, we need to associate certain variables with a particular MQTT5 client # and to do so we use this class to hold all the data for a particular client used in the sample. class sample_mqtt5_client: