diff options
| author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2018-08-17 10:12:17 +0200 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2018-08-17 12:30:34 +0000 |
| commit | 8651b99d882841d5c5554a8c40da75de2c558e01 (patch) | |
| tree | 01f05f31bbd0bbc8f71dbf3a72df74a72b149b2d | |
| parent | cda830081d7e349eced80551b201ebb5152e8023 (diff) | |
Add documentation for shared subscriptions
Change-Id: I7b54142a10643bcf9a114eb83fcdf4e1cdb9f4f9
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Maurice Kalinowski <maurice.kalinowski@qt.io>
| -rw-r--r-- | src/mqtt/doc/src/overview.qdoc | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/src/mqtt/doc/src/overview.qdoc b/src/mqtt/doc/src/overview.qdoc index cefe33e..5ba73c1 100644 --- a/src/mqtt/doc/src/overview.qdoc +++ b/src/mqtt/doc/src/overview.qdoc @@ -90,6 +90,31 @@ receive messages on the temperature of all rooms in all apartments in a house. + \section1 Shared Subscriptions + + \e {Shared subscriptions} describe a pool of subscribers to one topic + filter. Instead of all subscribers receiving a message, only one subscriber + receives it. This enables load balancing on multiple clients. + The format of a shared subscription is: + + \badcode + $share/{sharename}/{topicfilter} + \endcode + + For example, if \e {Client 1} and \e {Client 2} should share a subscription + to the topic \e {sensors/house/temperature}, the topic filter to subscribe + to is: + + \badcode + $share/poolAB/sensors/house/temperature + \endcode + + It is not defined in which order messages are distributed by the server. + This is a server specific option. + + To identify whether a server supports shared subscriptions, see also + QMqttServerConnectionProperties::sharedSubscriptionSupported(). + \section1 Topic Aliases Structuring topics in a tree helps to separate data channels and provide a |