Remove debug logs and fix xml doc

Author: EmandM

com.unity.netcode.gameobjects/Runtime/Connection/NetworkConnectionManager.cs

@@ -444,7 +444,6 @@ internal void HandleNetworkEvent(NetworkEvent networkEvent, ulong transportClien
             switch (networkEvent)
             {
                 case NetworkEvent.Connect:
-                    Debug.Log("Handling connection event");
                     ConnectEventHandler(transportClientId);
                     break;
                 case NetworkEvent.Data:
@@ -493,7 +492,6 @@ internal void ConnectEventHandler(ulong transportClientId)
                     var hostServer = NetworkManager.IsHost ? "Host" : "Server";
                     NetworkLog.LogInfo($"[{hostServer}-Side] Transport connection established with pending Client-{clientId}.");
                 }
-                Debug.Log("adding pending client");
                 AddPendingClient(clientId);
             }
             else
@@ -504,7 +502,6 @@ internal void ConnectEventHandler(ulong transportClientId)
                     NetworkLog.LogInfo($"[Approval Pending][Client] Transport connection with {serverOrService} established! Awaiting connection approval...");
                 }
 
-                Debug.Log("Sending connection request");
                 SendConnectionRequest();
                 StartClientApprovalCoroutine(clientId);
             }
@@ -538,14 +535,16 @@ internal void DataEventHandler(ulong transportClientId, ref ArraySegment<byte> p
         /// </summary>
         internal void DisconnectEventHandler(ulong transportClientId)
         {
-#if DEVELOPMENT_BUILD || UNITY_EDITOR
-            s_TransportDisconnect.Begin();
-#endif
             var (clientId, wasConnectedClient) = TransportIdCleanUp(transportClientId);
             if (!wasConnectedClient)
             {
                 return;
             }
+
+#if DEVELOPMENT_BUILD || UNITY_EDITOR
+            s_TransportDisconnect.Begin();
+#endif
+
             if (NetworkLog.CurrentLogLevel <= LogLevel.Developer)
             {
                 NetworkLog.LogInfo($"Disconnect Event From {clientId}");
@@ -1085,13 +1084,8 @@ internal NetworkClient AddClient(ulong clientId)
 
             if (!ConnectedClientIds.Contains(clientId))
             {
-                Debug.Log($"[Client-{NetworkManager.LocalClientId}] Adding newly added client {clientId} to ConnectedClientIds");
                 ConnectedClientIds.Add(clientId);
             }
-            else
-            {
-                Debug.Log($"[Client-{NetworkManager.LocalClientId}] Newly added client {clientId} was already in ConnectedClientIds");
-            }
 
             var distributedAuthority = NetworkManager.DistributedAuthorityMode;
 

com.unity.netcode.gameobjects/Runtime/Core/NetworkManager.cs

@@ -1468,18 +1468,22 @@ private void HostServerInitialize()
         /// Get the TransportId from the associated ClientId.
         /// </summary>
         /// <param name="clientId">The ClientId to get the TransportId from</param>
-        /// <returns>The TransportId associated with the given ClientId</returns>
+        /// <returns>
+        /// The TransportId associated with the given ClientId if the given clientId is valid; otherwise <see cref="ulong.MaxValue"/>
+        /// </returns>
         public ulong GetTransportIdFromClientId(ulong clientId)
         {
-            var (id, success) = ConnectionManager.TransportIdToClientId(clientId);
+            var (id, success) = ConnectionManager.ClientIdToTransportId(clientId);
             return success ? id : ulong.MaxValue;
         }
 
         /// <summary>
         /// Get the ClientId from the associated TransportId.
         /// </summary>
         /// <param name="transportId">The TransportId to get the ClientId from</param>
-        /// <returns>The ClientId from the associated TransportId</returns>
+        /// <returns>
+        /// The ClientId from the associated TransportId if the given transportId is valid; otherwise <see cref="ulong.MaxValue"/>
+        /// </returns>
         public ulong GetClientIdFromTransportId(ulong transportId)
         {
             var (id, success) = ConnectionManager.TransportIdToClientId(transportId);

com.unity.netcode.gameobjects/Tests/Runtime/TestHelpers/NetcodeIntegrationTest.cs

@@ -484,6 +484,15 @@ protected void SetDistributedAuthorityProperties(NetworkManager networkManager)
         /// </summary>
         protected virtual bool m_EnableTimeTravel => false;
 
+        /// <summary>
+        /// When true, <see cref="CreateServerAndClients()"/> and <see cref="CreateNewClient"/> will use a <see cref="MockTransport"/>
+        /// as the <see cref="NetworkConfig.NetworkTransport"/> on the created server and/or clients.
+        /// When false, a <see cref="UnityTransport"/> is used.
+        /// </summary>
+        /// <remarks>
+        /// This defaults to, and is required to be true when <see cref="m_EnableTimeTravel"/> is true.
+        /// <see cref="m_EnableTimeTravel"/> will not work with the <see cref="UnityTransport"/> component.
+        /// </remarks>
         protected virtual bool m_UseMockTransport => m_EnableTimeTravel;
 
         /// <summary>
@@ -649,12 +658,12 @@ public IEnumerator SetUp()
                 {
                     MockTransport.Reset();
                 }
+            }
 
-                // Setup the frames per tick for time travel advance to next tick
-                if (m_EnableTimeTravel)
-                {
-                    ConfigureFramesPerTick();
-                }
+            // Setup the frames per tick for time travel advance to next tick
+            if (m_EnableTimeTravel)
+            {
+                ConfigureFramesPerTick();
             }
 
             if (m_SetupIsACoroutine)

com.unity.netcode.gameobjects/Tests/Runtime/TestHelpers/NetcodeIntegrationTestHelpers.cs

@@ -327,7 +327,18 @@ public static bool Create(int clientCount, out NetworkManager server, out Networ
             return true;
         }
 
-        internal static NetworkManager CreateNewClient(int identifier, bool mockTransport = false, bool useCmbService = false)
+        /// <summary>
+        /// Creates a new <see cref="NetworkManager"/> and configures it for use in a multi instance setting.
+        /// </summary>
+        /// <param name="identifier">The ClientId representation that is used in the name of the NetworkManager</param>
+        /// <param name="mockTransport">
+        /// When true, the client is created with a <see cref="MockTransport"/>; otherwise a <see cref="UnityTransport"/> is added
+        /// </param>
+        /// <param name="useCmbService">
+        /// Whether to configure the client to run against a hosted build of the CMB Service. Only applies if mockTransport is set to false.
+        /// </param>
+        /// <returns>The newly created <see cref="NetworkManager"/> component.</returns>
+        public static NetworkManager CreateNewClient(int identifier, bool mockTransport = false, bool useCmbService = false)
         {
             // Create gameObject
             var go = new GameObject("NetworkManager - Client - " + identifier);
@@ -351,7 +362,7 @@ internal static NetworkManager CreateNewClient(int identifier, bool mockTranspor
         /// <param name="clients">Output array containing the created NetworkManager instances</param>
         /// <param name="useMockTransport">When true, uses mock transport for testing, otherwise uses real transport. Default value is false</param>
         /// <param name="useCmbService">If true, each client will be created with transport configured to connect to a locally hosted da service</param>
-        /// <returns> Returns <see cref="true"/> if the clients were successfully created and configured, otherwise <see cref="false"/>.</returns>
+        /// <returns> Returns true if the clients were successfully created and configured, otherwise false.</returns>
         public static bool CreateNewClients(int clientCount, out NetworkManager[] clients, bool useMockTransport = false, bool useCmbService = false)
         {
             clients = new NetworkManager[clientCount];