comments

Author: adam-fowler

Sources/MQTTNIO/AsyncAwaitSupport/MQTTClient+async.swift

@@ -88,6 +88,21 @@ extension MQTTClient {
     }
 
     /// Create a publish listener AsyncSequence that yields a result whenever a PUBLISH message is received from the server
+    ///
+    /// To create listener and process results
+    /// ```
+    /// Task {
+    ///     let listener = client.createPublishListener()
+    ///     for result in listener {
+    ///         switch result {
+    ///         case .success(let packet):
+    ///             ...
+    ///         case .failure:
+    ///             break
+    ///         }
+    ///     }
+    /// }
+    /// ```
     public func createPublishListener() -> MQTTPublishListener {
         return .init(self)
     }

Sources/MQTTNIO/MQTTClient.swift

@@ -345,12 +345,12 @@ public final class MQTTClient {
         self.closeListeners.removeListener(named: name)
     }
 
-    /// Add close listener. Called whenever the connection is closed
+    /// Add shutdown listener. Called whenever the client is shutdown
     public func addShutdownListener(named name: String, _ listener: @escaping (Result<Void, Swift.Error>) -> Void) {
         self.shutdownListeners.addListener(named: name, listener: listener)
     }
 
-    /// Remove named close listener
+    /// Remove named shutdown listener
     public func removeShutdownListener(named name: String) {
         self.shutdownListeners.removeListener(named: name)
     }