feat: ShutdownAsync, fixes #49

richardschneider · Mar 15, 2018 · 83394c9 · 83394c9
1 parent a934fe7
commit 83394c9
Showing 1 changed file with 13 additions and 1 deletion.
diff --git a/src/CoreApi/IGenericApi.cs b/src/CoreApi/IGenericApi.cs
@@ -23,14 +23,26 @@ public interface IGenericApi
         ///   Is used to stop the task.  When cancelled, the <see cref="TaskCanceledException"/> is raised.
         /// </param>
         /// <returns>
-        ///   Information on the peer node.
+        ///    A task that represents the asynchronous operation. The task's value is
+        ///    the <see cref="Peer"/> information.
         /// </returns>
         Task<Peer> IdAsync(MultiHash peer = null, CancellationToken cancel = default(CancellationToken));
 
         /// <summary>
         ///   Get the version information.
         /// </summary>
+        /// <returns>
+        ///    A task that represents the asynchronous operation. The task's value is
+        ///    a <see cref="Dictionary{TKey, TValue}"/> of values.
+        /// </returns>
         Task<Dictionary<string, string>> VersionAsync(CancellationToken cancel = default(CancellationToken));
 
+        /// <summary>
+        ///   Stop the IPFS peer.
+        /// </summary>
+        /// <returns>
+        ///    A task that represents the asynchronous operation.
+        /// </returns>
+        Task ShutdownAsync();
     }
 }