feat: persisting address filters

richardschneider · Jan 25, 2018 · 350e311 · 350e311
1 parent f037f6e
commit 350e311
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 3 deletions.
diff --git a/src/CoreApi/IBootstrapApi.cs b/src/CoreApi/IBootstrapApi.cs
@@ -50,6 +50,9 @@ public interface IBootstrapApi
         /// <summary>
         ///   List all the peers.
         /// </summary>
+        /// <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 result is
         ///   a sequence of addresses.

diff --git a/src/CoreApi/ISwarmApi.cs b/src/CoreApi/ISwarmApi.cs
@@ -70,6 +70,9 @@ public interface ISwarmApi
         ///   An allowed address.  For example "/ip4/104.131.131.82" or
         ///   "/ip4/192.168.0.0/ipcidr/16".
         /// </param>
+        /// <param name="persist">
+        ///   If <b>true</b> the filter will persist across daemon reboots. 
+        /// </param>
         /// <param name="cancel">
         ///   Is used to stop the task.  When cancelled, the <see cref="TaskCanceledException"/> is raised.
         /// </param>
@@ -78,17 +81,23 @@ public interface ISwarmApi
         ///   the address filter that was added.
         /// </returns>
         /// <seealso href="https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing"/>
-        Task<MultiAddress> AddAddressFilterAsync(MultiAddress address, CancellationToken cancel = default(CancellationToken));
+        Task<MultiAddress> AddAddressFilterAsync(MultiAddress address, bool persist = false, CancellationToken cancel = default(CancellationToken));
 
         /// <summary>
         ///   List all the address filters.
         /// </summary>
+        /// <param name="persist">
+        ///   If <b>true</b> only persisted filters are listed.
+        /// </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 result is
         ///   a sequence of addresses filters.
         /// </returns>
         /// <seealso href="https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing"/>
-        Task<IEnumerable<MultiAddress>> ListAddressFiltersAsync(CancellationToken cancel = default(CancellationToken));
+        Task<IEnumerable<MultiAddress>> ListAddressFiltersAsync(bool persist = false, CancellationToken cancel = default(CancellationToken));
 
         /// <summary>
         ///   Delete the specified address filter.
@@ -97,6 +106,9 @@ public interface ISwarmApi
         ///   For example "/ip4/104.131.131.82" or
         ///   "/ip4/192.168.0.0/ipcidr/16".
         /// </param>
+        /// <param name="persist">
+        ///   If <b>true</b> the filter is also removed from the persistent store. 
+        /// </param>
         /// <param name="cancel">
         ///   Is used to stop the task.  When cancelled, the <see cref="TaskCanceledException"/> is raised.
         /// </param>
@@ -105,7 +117,7 @@ public interface ISwarmApi
         ///   the address filter that was removed.
         /// </returns>
         /// <seealso href="https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing"/>
-        Task<MultiAddress> RemoveAddressFilterAsync(MultiAddress address, CancellationToken cancel = default(CancellationToken));
+        Task<MultiAddress> RemoveAddressFilterAsync(MultiAddress address, bool persist = false, CancellationToken cancel = default(CancellationToken));
 
     }
 }