Peter M. Groen / TrueMQTT-cpp

Commit 63266779af6704390088207acace36e02da403c4

Authored by Patric Stout
1 parent ace91efd

chore(interface): remove documentation suggesting unsubscribe can fail 

Protocol specification of MQTT 3.1.1 doesn't allow unsubscribes
to fail.
Inline Side-by-side
Showing 1 changed file with 0 additions and 11 deletions
include/TrueMQTT.h
  View file @6326677
... ... @@ -46,15 +46,6 @@ namespace TrueMQTT
46 46 * @note This error is non-fatal.
47 47 */
48 48 SUBSCRIBE_FAILED,
49   -
50   - /**
51   - * @brief The unsubscription failed.
52   - *
53   - * The topic that failed to unsubscribe is passed as the second argument.
54   - *
55   - * @note This error is non-fatal.
56   - */
57   - UNSUBSCRIBE_FAILED,
58 49 };
59 50  
60 51 /**
... ... @@ -256,8 +247,6 @@ namespace TrueMQTT
256 247 /**
257 248 * @brief Unsubscribe from a topic.
258 249 *
259   - * If the broker refuses the unsubscribe request, the error-callback is called.
260   - *
261 250 * @param topic The topic to unsubscribe from.
262 251 *
263 252 * @note If you unsubscribe from a topic you were not subscribed too, nothing happens.
... ...