feat(Swarm): deregister a peer

richardschneider · Aug 10, 2019 · 5b6491d · 5b6491d
1 parent 9e40a37
commit 5b6491d
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 0 deletions.
diff --git a/src/Swarm.cs b/src/Swarm.cs
@@ -78,6 +78,16 @@ public class Swarm : IService, IPolicy<MultiAddress>
         /// </summary>
         public event EventHandler<Peer> PeerDisconnected;
 
+        /// <summary>
+        ///   Raised when a peer should no longer be used.
+        /// </summary>
+        /// <remarks>
+        ///   This event indicates that the peer has been removed
+        ///   from the <see cref="KnownPeers"/> and should no longer
+        ///   be used.
+        /// </remarks>
+        public event EventHandler<Peer> PeerRemoved;
+
         /// <summary>
         ///  The local peer.
         /// </summary>
@@ -307,6 +317,30 @@ public Peer RegisterPeer(Peer peer)
             return p;
         }
 
+        /// <summary>
+        ///   Deregister a peer.
+        /// </summary>
+        /// <param name="peer">
+        ///   The peer to remove..
+        /// </param>
+        /// <remarks>
+        ///   Remove all knowledge of the peer. The <see cref="PeerRemoved"/> event
+        ///   is raised.
+        /// </remarks>
+        public void DeregisterPeer(Peer peer)
+        {
+            if (peer.Id == null)
+            {
+                throw new ArgumentNullException("peer.ID");
+            }
+
+            if (otherPeers.TryRemove(peer.Id.ToBase58(), out Peer found))
+            {
+                peer = found;
+            }
+            PeerRemoved?.Invoke(this, peer);
+        }
+
         /// <summary>
         ///   Determines if a connection is being made to the peer.
         /// </summary>

diff --git a/test/SwarmTest.cs b/test/SwarmTest.cs
@@ -1059,6 +1059,7 @@ public async Task IsRunning()
             await swarm.StopAsync();
             Assert.IsFalse(swarm.IsRunning);
         }
+
         [TestMethod]
         public async Task Connect_PrivateNetwork()
         {
@@ -1087,6 +1088,20 @@ public async Task Connect_PrivateNetwork()
                 await swarmB.StopAsync();
             }
         }
+
+        [TestMethod]
+        public void DeregisterPeer()
+        {
+            var swarm = new Swarm { LocalPeer = self };
+            swarm.RegisterPeer(other);
+            Assert.IsTrue(swarm.KnownPeers.Contains(other));
+
+            Peer removedPeer = null;
+            swarm.PeerRemoved += (s, e) => removedPeer = e;
+            swarm.DeregisterPeer(other);
+            Assert.IsFalse(swarm.KnownPeers.Contains(other));
+            Assert.AreEqual(other, removedPeer);
+        }
     }
 
     /// <summary>