feat(IGenericApi): add ping methods; closes #39

richardschneider · richardschneider · commit f0efcf56d83d · 2019-08-29T11:53:49.000+12:00
diff --git a/src/CoreApi/IGenericApi.cs b/src/CoreApi/IGenericApi.cs
@@ -71,5 +71,48 @@ Task<string> ResolveAsync(
             CancellationToken cancel = default(CancellationToken)
             );
 
+        /// <summary>
+        ///   Send echo requests to a peer.
+        /// </summary>
+        /// <param name="peer">
+        ///   The peer ID to receive the echo requests.
+        /// </param>
+        /// <param name="count">
+        ///   The number of echo requests to send.  Defaults to 10.
+        /// </param>
+        /// <param name="cancel">
+        ///   Is used to stop the task.  When cancelled, the <see cref="TaskCanceledException"/> is raised.
+        /// </param>
+        /// <returns>
+        ///   A task that represents the asynchronous operation. The task's value is
+        ///   the sequence of <see cref="PingResult"/>.
+        /// </returns>
+        Task<IEnumerable<PingResult>> PingAsync(
+            MultiHash peer,
+            int count = 10,
+            CancellationToken cancel = default(CancellationToken)
+            );
+
+        /// <summary>
+        ///   Send echo requests to a peer.
+        /// </summary>
+        /// <param name="address">
+        ///   The address of a peer to receive the echo requests.
+        /// </param>
+        /// <param name="count">
+        ///   The number of echo requests to send.  Defaults to 10.
+        /// </param>
+        /// <param name="cancel">
+        ///   Is used to stop the task.  When cancelled, the <see cref="TaskCanceledException"/> is raised.
+        /// </param>
+        /// <returns>
+        ///   A task that represents the asynchronous operation. The task's value is
+        ///   the sequence of <see cref="PingResult"/>.
+        /// </returns>
+        Task<IEnumerable<PingResult>> PingAsync(
+            MultiAddress address,
+            int count = 10,
+            CancellationToken cancel = default(CancellationToken)
+            );
     }
 }
diff --git a/src/CoreApi/PingResult.cs b/src/CoreApi/PingResult.cs
@@ -0,0 +1,27 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace Ipfs.CoreApi
+{
+    /// <summary>
+    ///   The result from sending a <see cref="IGenericApi.PingAsync(MultiHash, int, System.Threading.CancellationToken)"/>.
+    /// </summary>
+    public class PingResult
+    {
+        /// <summary>
+        ///   Indicates success or failure.
+        /// </summary>
+        public bool Success { get; set; }
+
+        /// <summary>
+        ///   The round trip time; nano second resolution.
+        /// </summary>
+        public TimeSpan Time { get; set; }
+
+        /// <summary>
+        ///   The text to echo.
+        /// </summary>
+        public string Text { get; set; }
+    }
+}
