Merge pull request #23 from robotdotnet/RemoteChanges

Updates IRemote to return the ConnectionInfo of the connected remote
robotdotnet · Feb 7, 2016 · 70db749 · 70db749
2 parents 6d9772c + 27f7c68
commit 70db749
Show file tree

Hide file tree

Showing 4 changed files with 63 additions and 7 deletions.
diff --git a/NetworkTablesCore.Test/TestNetworkTableAPIListeners.cs b/NetworkTablesCore.Test/TestNetworkTableAPIListeners.cs
@@ -27,12 +27,12 @@ internal class MockConnectionListener : IRemoteConnectionListener
         public IRemote ConnectedRemote = null;
         public IRemote DisconnectedRemote = null;
 
-        public void Connected(IRemote remote)
+        public void Connected(IRemote remote, ConnectionInfo info)
         {
             ConnectedRemote = remote;
         }
 
-        public void Disconnected(IRemote remote)
+        public void Disconnected(IRemote remote, ConnectionInfo info)
         {
             DisconnectedRemote = remote;
         }

diff --git a/NetworkTablesCore/NetworkTable.cs b/NetworkTablesCore/NetworkTable.cs
@@ -938,6 +938,9 @@ public void RemoveTableListener(Action<ITable, string, object, NotifyFlags> list
         private readonly Dictionary<IRemoteConnectionListener, int> m_connectionListenerMap =
             new Dictionary<IRemoteConnectionListener, int>();
 
+        private readonly Dictionary<Action<IRemote, ConnectionInfo, bool>, int> m_actionConnectionListenerMap
+            = new Dictionary<Action<IRemote, ConnectionInfo, bool>, int>();
+
         ///<inheritdoc/>
         public void AddConnectionListener(IRemoteConnectionListener listener, bool immediateNotify)
         {
@@ -949,8 +952,8 @@ public void AddConnectionListener(IRemoteConnectionListener listener, bool immed
 
             ConnectionListenerFunction func = (uid, connected, conn) =>
             {
-                if (connected) listener.Connected(this);
-                else listener.Disconnected(this);
+                if (connected) listener.Connected(this, conn);
+                else listener.Disconnected(this, conn);
             };
 
             int id = CoreMethods.AddConnectionListener(func, immediateNotify);
@@ -969,6 +972,34 @@ public void RemoveConnectionListener(IRemoteConnectionListener listener)
             }
         }
 
+        /// <inheritdoc/>
+        public void AddConnectionListener(Action<IRemote, ConnectionInfo, bool> listener, bool immediateNotify)
+        {
+            if (m_actionConnectionListenerMap.ContainsKey(listener))
+            {
+                throw new ArgumentException("Cannot add the same listener twice", nameof(listener));
+            }
+
+            ConnectionListenerFunction func = (uid, connected, conn) =>
+            {
+                listener(this, conn, connected);
+            };
+
+            int id = CoreMethods.AddConnectionListener(func, immediateNotify);
+
+            m_actionConnectionListenerMap.Add(listener, id);
+        }
+
+        /// <inheritdoc/>
+        public void RemoveConnectionListener(Action<IRemote, ConnectionInfo, bool> listener)
+        {
+            int val;
+            if (m_actionConnectionListenerMap.TryGetValue(listener, out val))
+            {
+                CoreMethods.RemoveConnectionListener(val);
+            }
+        }
+
         /// <summary>
         /// Gets if the NetworkTables is connected to a client or server.
         /// </summary>

diff --git a/NetworkTablesCore/Tables/IRemote.cs b/NetworkTablesCore/Tables/IRemote.cs
@@ -1,4 +1,6 @@
-namespace NetworkTables.Tables
+using System;
+
+namespace NetworkTables.Tables
 {
     /// <summary>
     /// Represents an object that has a remote connection.
@@ -19,6 +21,25 @@ public interface IRemote
         /// <param name="listener">The listener to be unregistered.</param>
         void RemoveConnectionListener(IRemoteConnectionListener listener);
 
+        /// <summary>
+        /// Register a delegate to listen for connection and disconnection events.
+        /// </summary>
+        /// <param name="listener">The listener to be registered.</param>
+        /// <param name="immediateNotify">True if the listener object should be notified of the current
+        /// connection state immediately.</param>
+        /// <remarks>
+        /// The <see cref="IRemote"/> of the action is the current table, the <see cref="ConnectionInfo"/>
+        /// is the info of the connected or disconnected target, and the bool is true if the event is
+        /// a connect, otherwise false.
+        /// </remarks>
+        void AddConnectionListener(Action<IRemote, ConnectionInfo, bool> listener, bool immediateNotify);
+
+        /// <summary>
+        /// Unregister a listener delegate from connection events.
+        /// </summary>
+        /// <param name="listener">The listener to be unregistered.</param>
+        void RemoveConnectionListener(Action<IRemote, ConnectionInfo, bool> listener);
+
         /// <summary>
         /// Gets if the current object is connected.
         /// </summary>

diff --git a/NetworkTablesCore/Tables/IRemoteConnectionListener.cs b/NetworkTablesCore/Tables/IRemoteConnectionListener.cs
@@ -9,12 +9,16 @@ public interface IRemoteConnectionListener
         /// Called when an <see cref="IRemote"/> is connected
         /// </summary>
         /// <param name="remote">The object that connected.</param>
-        void Connected(IRemote remote);
+        /// <param name="info">An object containing information about the 
+        /// connected remote.</param>
+        void Connected(IRemote remote, ConnectionInfo info);
 
         /// <summary>
         /// Called when an <see cref="IRemote"/> is disconnected.
         /// </summary>
         /// <param name="remote">The object that disconnected.</param>
-        void Disconnected(IRemote remote);
+        /// <param name="info">An object containing information about the
+        /// disconnected remote.</param>
+        void Disconnected(IRemote remote, ConnectionInfo info);
     }
 }