refactor: renaming NetworkConnection to NetworkPlayer (MirageNet#684)

* refactor: renaming NetworkConnection to NetworkPlayer

part of Transport rewrite MirageNet#679

BREAKING CHANGE: renaming NetworkConnection to NetworkPlayer

* renaming types in weaver tests

* fixing test message

* fixing xref in docs

Author: James-Frowen

Assets/Mirage/Authenticators/BasicAuthenticator.cs

@@ -26,13 +26,13 @@ public struct AuthResponseMessage
             public string Message;
         }
 
-        public override void OnServerAuthenticate(INetworkConnection conn)
+        public override void OnServerAuthenticate(INetworkPlayer conn)
         {
             // wait for AuthRequestMessage from client
             conn.RegisterHandler<AuthRequestMessage>(OnAuthRequestMessage);
         }
 
-        public override void OnClientAuthenticate(INetworkConnection conn)
+        public override void OnClientAuthenticate(INetworkPlayer conn)
         {
             conn.RegisterHandler<AuthResponseMessage>(OnAuthResponseMessage);
 
@@ -45,7 +45,7 @@ public override void OnClientAuthenticate(INetworkConnection conn)
             conn.Send(authRequestMessage);
         }
 
-        public void OnAuthRequestMessage(INetworkConnection conn, AuthRequestMessage msg)
+        public void OnAuthRequestMessage(INetworkPlayer conn, AuthRequestMessage msg)
         {
             if (logger.LogEnabled()) logger.LogFormat(LogType.Log, "Authentication Request: {0} {1}", msg.AuthUsername, msg.AuthPassword);
 
@@ -80,13 +80,13 @@ public void OnAuthRequestMessage(INetworkConnection conn, AuthRequestMessage msg
             }
         }
 
-        public IEnumerator DelayedDisconnect(INetworkConnection conn, float waitTime)
+        public IEnumerator DelayedDisconnect(INetworkPlayer conn, float waitTime)
         {
             yield return new WaitForSeconds(waitTime);
             conn.Disconnect();
         }
 
-        public void OnAuthResponseMessage(INetworkConnection conn, AuthResponseMessage msg)
+        public void OnAuthResponseMessage(INetworkPlayer conn, AuthResponseMessage msg)
         {
             if (msg.Code == 100)
             {

Assets/Mirage/Authenticators/TimeoutAuthenticator.cs

@@ -24,21 +24,21 @@ public void Awake()
             Authenticator.OnServerAuthenticated += HandleServerAuthenticated;
         }
 
-        private readonly HashSet<INetworkConnection> pendingAuthentication = new HashSet<INetworkConnection>();
+        private readonly HashSet<INetworkPlayer> pendingAuthentication = new HashSet<INetworkPlayer>();
 
-        private void HandleServerAuthenticated(INetworkConnection connection)
+        private void HandleServerAuthenticated(INetworkPlayer connection)
         {
             pendingAuthentication.Remove(connection);
             base.OnClientAuthenticate(connection);
         }
 
-        private void HandleClientAuthenticated(INetworkConnection connection)
+        private void HandleClientAuthenticated(INetworkPlayer connection)
         {
             pendingAuthentication.Remove(connection);
             base.OnServerAuthenticate(connection);
         }
 
-        public override void OnClientAuthenticate(INetworkConnection conn)
+        public override void OnClientAuthenticate(INetworkPlayer conn)
         {
             pendingAuthentication.Add(conn);
             Authenticator.OnClientAuthenticate(conn);
@@ -47,15 +47,15 @@ public override void OnClientAuthenticate(INetworkConnection conn)
                 StartCoroutine(BeginAuthentication(conn));
         }
 
-        public override void OnServerAuthenticate(INetworkConnection conn)
+        public override void OnServerAuthenticate(INetworkPlayer conn)
         {
             pendingAuthentication.Add(conn);
             Authenticator.OnServerAuthenticate(conn);
             if (Timeout > 0)
                 StartCoroutine(BeginAuthentication(conn));
         }
 
-        IEnumerator BeginAuthentication(INetworkConnection conn)
+        IEnumerator BeginAuthentication(INetworkPlayer conn)
         {
             if (logger.LogEnabled()) logger.Log($"Authentication countdown started {conn} {Timeout}");
 

Assets/Mirage/Components/LobbyReady.cs

@@ -11,7 +11,7 @@ public class LobbyReady : MonoBehaviour
 
         // just a cached memory area where we can collect connections
         // for broadcasting messages
-        private static readonly List<INetworkConnection> connectionsCache = new List<INetworkConnection>();
+        private static readonly List<INetworkPlayer> connectionsCache = new List<INetworkPlayer>();
 
         public void SetAllClientsNotReady()
         {
@@ -36,7 +36,7 @@ public void SendToReady<T>(NetworkIdentity identity, T msg, bool includeOwner =
                 }
             }
 
-            NetworkConnection.Send(connectionsCache, msg, channelId);
+            NetworkPlayer.Send(connectionsCache, msg, channelId);
         }
     }
 }

Assets/Mirage/Components/NetworkMatchChecker.cs

@@ -105,7 +105,7 @@ void RebuildMatchObservers(Guid specificMatch)
         /// </summary>
         /// <param name="conn">Network connection of a player.</param>
         /// <returns>True if the player can see this object.</returns>
-        public override bool OnCheckObserver(INetworkConnection conn)
+        public override bool OnCheckObserver(INetworkPlayer conn)
         {
             // Not Visible if not in a match
             if (MatchId == Guid.Empty)
@@ -125,7 +125,7 @@ public override bool OnCheckObserver(INetworkConnection conn)
         /// </summary>
         /// <param name="observers">The new set of observers for this object.</param>
         /// <param name="initialize">True if the set of observers is being built for the first time.</param>
-        public override void OnRebuildObservers(HashSet<INetworkConnection> observers, bool initialize)
+        public override void OnRebuildObservers(HashSet<INetworkPlayer> observers, bool initialize)
         {
             if (currentMatch == Guid.Empty) return;
 

Assets/Mirage/Components/NetworkProximityChecker.cs

@@ -58,7 +58,7 @@ void RebuildObservers()
 
         /// <param name="conn">Network connection of a player.</param>
         /// <returns>True if the player can see this object.</returns>
-        public override bool OnCheckObserver(INetworkConnection conn)
+        public override bool OnCheckObserver(INetworkPlayer conn)
         {
             if (ForceHidden)
                 return false;
@@ -72,7 +72,7 @@ public override bool OnCheckObserver(INetworkConnection conn)
         /// </summary>
         /// <param name="observers">The new set of observers for this object.</param>
         /// <param name="initialize">True if the set of observers is being built for the first time.</param>
-        public override void OnRebuildObservers(HashSet<INetworkConnection> observers, bool initialize)
+        public override void OnRebuildObservers(HashSet<INetworkPlayer> observers, bool initialize)
         {
             // if force hidden then return without adding any observers.
             if (ForceHidden)
@@ -88,7 +88,7 @@ public override void OnRebuildObservers(HashSet<INetworkConnection> observers, b
             //    magnitude faster. if we have 10k monsters and run a sphere
             //    cast 10k times, we will see a noticeable lag even with physics
             //    layers. but checking to every connection is fast.
-            foreach (INetworkConnection conn in Server.connections)
+            foreach (INetworkPlayer conn in Server.connections)
             {
                 // check distance
                 if (conn != null && conn.Identity != null && Vector3.Distance(conn.Identity.transform.position, position) < VisibilityRange)

Assets/Mirage/Components/NetworkSceneChecker.cs

@@ -88,7 +88,7 @@ void RebuildSceneObservers()
         /// </summary>
         /// <param name="conn">Network connection of a player.</param>
         /// <returns>True if the player can see this object.</returns>
-        public override bool OnCheckObserver(INetworkConnection conn)
+        public override bool OnCheckObserver(INetworkPlayer conn)
         {
             if (forceHidden)
                 return false;
@@ -102,7 +102,7 @@ public override bool OnCheckObserver(INetworkConnection conn)
         /// </summary>
         /// <param name="observers">The new set of observers for this object.</param>
         /// <param name="initialize">True if the set of observers is being built for the first time.</param>
-        public override void OnRebuildObservers(HashSet<INetworkConnection> observers, bool initialize)
+        public override void OnRebuildObservers(HashSet<INetworkPlayer> observers, bool initialize)
         {
             // If forceHidden then return without adding any observers.
             if (forceHidden)

Assets/Mirage/Editor/NetworkInformationPreview.cs

@@ -181,7 +181,7 @@ float DrawObservers(NetworkIdentity identity, float initialX, float Y)
                 observerRect.x += 20;
                 observerRect.y += observerRect.height;
 
-                foreach (INetworkConnection conn in identity.observers)
+                foreach (INetworkPlayer conn in identity.observers)
                 {
 
                     GUI.Label(observerRect, conn.Address + ":" + conn, styles.ComponentName);

Assets/Mirage/Runtime/ClientObjectManager.cs

@@ -94,7 +94,7 @@ public void Start()
             }
         }
 
-        void OnClientConnected(INetworkConnection conn)
+        void OnClientConnected(INetworkPlayer conn)
         {
             RegisterSpawnPrefabs();
 
@@ -593,7 +593,7 @@ void CheckForLocalPlayer(NetworkIdentity identity)
             }
         }
 
-        private void OnServerRpcReply(INetworkConnection connection, ServerRpcReply reply)
+        private void OnServerRpcReply(INetworkPlayer connection, ServerRpcReply reply)
         {
             // find the callback that was waiting for this and invoke it.
             if (callbacks.TryGetValue(reply.replyId, out Action<NetworkReader> action))

Assets/Mirage/Runtime/INetworkClient.cs

@@ -23,7 +23,7 @@ public interface INetworkClient : IMessageSender
         /// <summary>
         /// The NetworkConnection object this client is using.
         /// </summary>
-        INetworkConnection Connection { get; }
+        INetworkPlayer Connection { get; }
 
         /// <summary>
         /// active is true while a client is connecting/connected

Assets/Mirage/Runtime/INetworkConnection.cs Assets/Mirage/Runtime/INetworkPlayer.cs

@@ -19,7 +19,7 @@ public interface IMessageSender
     /// </summary>
     public interface IMessageReceiver
     {
-        void RegisterHandler<T>(Action<INetworkConnection, T> handler);
+        void RegisterHandler<T>(Action<INetworkPlayer, T> handler);
 
         void RegisterHandler<T>(Action<T> handler);
 
@@ -56,12 +56,12 @@ public interface INotifyReceiver
         /// <summary>
         /// Raised when a message is delivered
         /// </summary>
-        event Action<INetworkConnection, object> NotifyDelivered;
+        event Action<INetworkPlayer, object> NotifyDelivered;
 
         /// <summary>
         /// Raised when a message is lost
         /// </summary>
-        event Action<INetworkConnection, object> NotifyLost;
+        event Action<INetworkPlayer, object> NotifyLost;
     }
 
     /// <summary>
@@ -98,7 +98,7 @@ public interface IObjectOwner
     /// A connection to a remote endpoint.
     /// May be from the server to client or from client to server
     /// </summary>
-    public interface INetworkConnection : IMessageHandler, IVisibilityTracker, IObjectOwner
+    public interface INetworkPlayer : IMessageHandler, IVisibilityTracker, IObjectOwner
     {
         bool IsReady { get; set; }
         EndPoint Address { get; }

Assets/Mirage/Runtime/INetworkConnection.cs.meta Assets/Mirage/Runtime/INetworkPlayer.cs.meta

@@ -40,7 +40,7 @@ public interface INetworkServer
         /// <summary>
         /// The connection to the host mode client (if any).
         /// </summary>
-        INetworkConnection LocalConnection { get; }
+        INetworkPlayer LocalConnection { get; }
 
         /// <summary>
         /// The host client for this server 
@@ -60,9 +60,9 @@ public interface INetworkServer
 
         void Disconnect();
 
-        void AddConnection(INetworkConnection conn);
+        void AddConnection(INetworkPlayer conn);
 
-        void RemoveConnection(INetworkConnection conn);
+        void RemoveConnection(INetworkPlayer conn);
 
         void SendToAll<T>(T msg, int channelId = Channel.Reliable);
     }

Assets/Mirage/Runtime/INetworkServer.cs

@@ -16,19 +16,19 @@ public interface IServerObjectManager
         /// </summary>
         SpawnEvent UnSpawned { get; }
 
-        bool AddPlayerForConnection(INetworkConnection conn, GameObject player);
+        bool AddPlayerForConnection(INetworkPlayer conn, GameObject player);
 
-        bool AddPlayerForConnection(INetworkConnection conn, GameObject player, Guid assetId);
+        bool AddPlayerForConnection(INetworkPlayer conn, GameObject player, Guid assetId);
 
-        bool ReplacePlayerForConnection(INetworkConnection conn, NetworkClient client, GameObject player, bool keepAuthority = false);
+        bool ReplacePlayerForConnection(INetworkPlayer conn, NetworkClient client, GameObject player, bool keepAuthority = false);
 
-        bool ReplacePlayerForConnection(INetworkConnection conn, NetworkClient client, GameObject player, Guid assetId, bool keepAuthority = false);
+        bool ReplacePlayerForConnection(INetworkPlayer conn, NetworkClient client, GameObject player, Guid assetId, bool keepAuthority = false);
 
         void Spawn(GameObject obj, GameObject ownerPlayer);
 
-        void Spawn(GameObject obj, INetworkConnection ownerConnection = null);
+        void Spawn(GameObject obj, INetworkPlayer ownerConnection = null);
 
-        void Spawn(GameObject obj, Guid assetId, INetworkConnection ownerConnection = null);
+        void Spawn(GameObject obj, Guid assetId, INetworkPlayer ownerConnection = null);
 
         void Destroy(GameObject obj);
 

Assets/Mirage/Runtime/IServerObjectManager.cs

@@ -12,17 +12,17 @@ public abstract class NetworkAuthenticator : MonoBehaviour
         /// <summary>
         /// Notify subscribers on the server when a client is authenticated
         /// </summary>
-        public event Action<INetworkConnection> OnServerAuthenticated;
+        public event Action<INetworkPlayer> OnServerAuthenticated;
 
         /// <summary>
         /// Notify subscribers on the client when the client is authenticated
         /// </summary>
-        public event Action<INetworkConnection> OnClientAuthenticated;
+        public event Action<INetworkPlayer> OnClientAuthenticated;
 
         #region server
 
         // This will get more code in the near future
-        internal void OnServerAuthenticateInternal(INetworkConnection conn)
+        internal void OnServerAuthenticateInternal(INetworkPlayer conn)
         {
             OnServerAuthenticate(conn);
         }
@@ -31,7 +31,7 @@ internal void OnServerAuthenticateInternal(INetworkConnection conn)
         /// Called on server from OnServerAuthenticateInternal when a client needs to authenticate
         /// </summary>
         /// <param name="conn">Connection to client.</param>
-        public virtual void OnServerAuthenticate(INetworkConnection conn)
+        public virtual void OnServerAuthenticate(INetworkPlayer conn)
         {
             OnServerAuthenticated?.Invoke(conn);
         }
@@ -41,7 +41,7 @@ public virtual void OnServerAuthenticate(INetworkConnection conn)
         #region client
 
         // This will get more code in the near future
-        internal void OnClientAuthenticateInternal(INetworkConnection conn)
+        internal void OnClientAuthenticateInternal(INetworkPlayer conn)
         {
             OnClientAuthenticate(conn);
         }
@@ -50,7 +50,7 @@ internal void OnClientAuthenticateInternal(INetworkConnection conn)
         /// Called on client from OnClientAuthenticateInternal when a client needs to authenticate
         /// </summary>
         /// <param name="conn">Connection of the client.</param>
-        public virtual void OnClientAuthenticate(INetworkConnection conn)
+        public virtual void OnClientAuthenticate(INetworkPlayer conn)
         {
             OnClientAuthenticated?.Invoke(conn);
         }

Assets/Mirage/Runtime/NetworkAuthenticator.cs

@@ -107,14 +107,14 @@ public abstract class NetworkBehaviour : MonoBehaviour
         public ClientObjectManager ClientObjectManager => NetIdentity.ClientObjectManager;
 
         /// <summary>
-        /// The <see cref="NetworkConnection">NetworkConnection</see> associated with this <see cref="NetworkIdentity">NetworkIdentity.</see> This is only valid for player objects on the client.
+        /// The <see cref="NetworkPlayer">NetworkConnection</see> associated with this <see cref="NetworkIdentity">NetworkIdentity.</see> This is only valid for player objects on the client.
         /// </summary>
-        public INetworkConnection ConnectionToServer => NetIdentity.ConnectionToServer;
+        public INetworkPlayer ConnectionToServer => NetIdentity.ConnectionToServer;
 
         /// <summary>
-        /// The <see cref="NetworkConnection">NetworkConnection</see> associated with this <see cref="NetworkIdentity">NetworkIdentity.</see> This is only valid for player objects on the server.
+        /// The <see cref="NetworkPlayer">NetworkConnection</see> associated with this <see cref="NetworkIdentity">NetworkIdentity.</see> This is only valid for player objects on the server.
         /// </summary>
-        public INetworkConnection ConnectionToClient => NetIdentity.ConnectionToClient;
+        public INetworkPlayer ConnectionToClient => NetIdentity.ConnectionToClient;
 
         /// <summary>
         /// Returns the appropriate NetworkTime instance based on if this NetworkBehaviour is running as a Server or Client.
@@ -321,7 +321,7 @@ protected internal void SendRpcInternal(Type invokeClass, string rpcName, Networ
             NetIdentity.SendToObservers(message, includeOwner, channelId);
         }
 
-        protected internal void SendTargetRpcInternal(INetworkConnection conn, Type invokeClass, string rpcName, NetworkWriter writer, int channelId)
+        protected internal void SendTargetRpcInternal(INetworkPlayer conn, Type invokeClass, string rpcName, NetworkWriter writer, int channelId)
         {
             // this was in Weaver before
             if (!Server || !Server.Active)