Commit 5454f1c4110dcea2b03e217d78fcc73c36f8266a
1 parent
63266779
chore(interface): document that unsubscribe removes all subscriptions on that exact topic
It wasn't all that clear that this was the case.
Showing
1 changed file
with
2 additions
and
0 deletions
include/TrueMQTT.h
| @@ -250,6 +250,8 @@ namespace TrueMQTT | @@ -250,6 +250,8 @@ namespace TrueMQTT | ||
| 250 | * @param topic The topic to unsubscribe from. | 250 | * @param topic The topic to unsubscribe from. |
| 251 | * | 251 | * |
| 252 | * @note If you unsubscribe from a topic you were not subscribed too, nothing happens. | 252 | * @note If you unsubscribe from a topic you were not subscribed too, nothing happens. |
| 253 | + * @note This unsubscribes all subscriptions on this exact topic. It is not possible | ||
| 254 | + * to only unsubscribe from a single subscription on the same exact topic. | ||
| 253 | * @note You cannot unsubscribe from a topic if you are disconnected from the broker. | 255 | * @note You cannot unsubscribe from a topic if you are disconnected from the broker. |
| 254 | * Call \ref connect (and \ref subscribe) first. | 256 | * Call \ref connect (and \ref subscribe) first. |
| 255 | * @note This function can stall for a short moment if you publish just at the | 257 | * @note This function can stall for a short moment if you publish just at the |