From d722758741dfff2e017866148382b735a34432ff Mon Sep 17 00:00:00 2001
From: James Frowen <jamesfrowendev@gmail.com>
Date: Tue, 9 Jul 2024 18:25:39 +0100
Subject: [PATCH] feat: IsConnecting and IsConnected helper methods to
 NetworkPlayer

---
 Assets/Mirage/Runtime/INetworkPlayer.cs  | 28 +++++++++++++++++-------
 Assets/Mirage/Runtime/NetworkIdentity.cs |  2 +-
 Assets/Mirage/Runtime/NetworkPlayer.cs   | 11 +++++++++-
 3 files changed, 31 insertions(+), 10 deletions(-)

diff --git a/Assets/Mirage/Runtime/INetworkPlayer.cs b/Assets/Mirage/Runtime/INetworkPlayer.cs
index f0a309081a..340a11f5dd 100644
--- a/Assets/Mirage/Runtime/INetworkPlayer.cs
+++ b/Assets/Mirage/Runtime/INetworkPlayer.cs
@@ -120,14 +120,28 @@ public interface IObjectOwner
     /// </summary>
     public interface INetworkPlayer : IMessageSender, IVisibilityTracker, IObjectOwner, ISceneLoader
     {
-        SocketLayer.IEndPoint Address { get; }
-        SocketLayer.IConnection Connection { get; }
+        IConnection Connection { get; }
+
+        /// <summary>
+        /// The IP address / URL / FQDN associated with the connection.
+        /// Can be useful for a game master to do IP Bans etc.
+        /// <para>
+        /// Best used to get concrete Endpoint type based on the <see cref="SocketFactory"/> being used
+        /// </para>
+        /// </summary>
+        IEndPoint Address { get; }
+
+        /// <summary>Connect called on client, but server has not replied yet</summary>
+        bool IsConnecting { get; }
+
+        /// <summary>Server and Client are connected and can send messages</summary>
+        bool IsConnected { get; }
+
         PlayerAuthentication Authentication { get; }
         void SetAuthentication(PlayerAuthentication authentication, bool allowReplace = false);
         bool IsAuthenticated { get; }
-        /// <summary>
-        /// True if this Player is the local player on the server or client
-        /// </summary>
+
+        /// <summary>True if this Player is the local player on the server or client</summary>
         bool IsHost { get; }
 
         void Disconnect();
@@ -136,9 +150,7 @@ public interface INetworkPlayer : IMessageSender, IVisibilityTracker, IObjectOwn
 
     public interface ISceneLoader
     {
-        /// <summary>
-        ///     Scene is fully loaded and we now can do things with player.
-        /// </summary>
+        /// <summary>Scene is fully loaded and we now can do things with player.</summary>
         bool SceneIsReady { get; set; }
     }
 }
diff --git a/Assets/Mirage/Runtime/NetworkIdentity.cs b/Assets/Mirage/Runtime/NetworkIdentity.cs
index 8f124fed97..d4f21cb992 100644
--- a/Assets/Mirage/Runtime/NetworkIdentity.cs
+++ b/Assets/Mirage/Runtime/NetworkIdentity.cs
@@ -950,7 +950,7 @@ internal void AddObserver(INetworkPlayer player)
                 return;
             }
 
-            if (logger.LogEnabled()) logger.Log($"Adding '{player.Connection.EndPoint}' as an observer for {gameObject}");
+            if (logger.LogEnabled()) logger.Log($"Adding '{player}' as an observer for {gameObject}");
             observers.Add(player);
             player.AddToVisList(this);
 
diff --git a/Assets/Mirage/Runtime/NetworkPlayer.cs b/Assets/Mirage/Runtime/NetworkPlayer.cs
index b8053d0a41..620ea77306 100644
--- a/Assets/Mirage/Runtime/NetworkPlayer.cs
+++ b/Assets/Mirage/Runtime/NetworkPlayer.cs
@@ -82,13 +82,22 @@ public void SetAuthentication(PlayerAuthentication authentication, bool allowRep
         /// </summary>
         public bool HasCharacter => Identity != null;
 
+        public IConnection Connection => _connection;
+
         /// <summary>
         /// The IP address / URL / FQDN associated with the connection.
         /// Can be useful for a game master to do IP Bans etc.
+        /// <para>
+        /// Best used to get concrete Endpoint type based on the <see cref="SocketFactory"/> being used
+        /// </para>
         /// </summary>
         public IEndPoint Address => _connection.EndPoint;
 
-        public IConnection Connection => _connection;
+        /// <summary>Connect called on client, but server has not replied yet</summary>
+        public bool IsConnecting => _connection.State == ConnectionState.Connecting;
+
+        /// <summary>Server and Client are connected and can send messages</summary>
+        public bool IsConnected => _connection.State == ConnectionState.Connected;
 
         /// <summary>
         /// List of all networkIdentity that this player can see