handling when hosts disconnect voluntarily on clients

Author: LPLafontaineB

Assets/BossRoom/Scripts/Client/UI/ConnectionStatusMessageUIManager.cs

@@ -42,18 +42,21 @@ void OnConnectStatus(ConnectStatus status)
                     PopupPanel.ShowPopupPanel("Connection Failed", "The Host is full and cannot accept any additional connections.");
                     break;
                 case ConnectStatus.Success:
-                    m_PopupIdToClose = PopupPanel.ShowPopupPanel("Success!", "Joining Now", isCloseableByUser: false);
+                    m_PopupIdToClose = PopupPanel.ShowPopupPanel("Success!", "Joining Now...", isCloseableByUser: false);
                     SceneManager.sceneLoaded += ClosePopupOnsceneLoaded;
                     break;
                 case ConnectStatus.LoggedInAgain:
                     PopupPanel.ShowPopupPanel("Connection Failed", "You have logged in elsewhere using the same account.");
                     break;
                 case ConnectStatus.GenericDisconnect:
-                    PopupPanel.ShowPopupPanel("Disconnected From Host", "The connection to the host was lost");
+                    PopupPanel.ShowPopupPanel("Disconnected From Host", "The connection to the host was lost.");
                     break;
                 case ConnectStatus.Reconnecting:
                     m_PopupIdToClose = PopupPanel.ShowPopupPanel("Attempting reconnection", "Lost connection to the Host, attempting to reconnect...", isCloseableByUser: false);
                     break;
+                case ConnectStatus.HostDisconnected:
+                    PopupPanel.ShowPopupPanel("Disconnected From Host", "The host has ended the game session.");
+                    break;
                 default:
                     Debug.LogWarning($"New ConnectStatus {status} has been added, but no connect message defined for it.");
                     break;

Assets/BossRoom/Scripts/Shared/Net/ConnectionManagement/ClientGameNetPortal.cs

@@ -31,6 +31,7 @@ public class ClientGameNetPortal : MonoBehaviour
         /// Time in seconds before the client considers a lack of server response a timeout
         /// </summary>
         private const int k_TimeoutDuration = 10;
+        const int k_NbReconnectAttempts = 3;
 
         /// <summary>
         /// This event fires when the client sent out a request to start the client, but failed to hear back after an allotted amount of
@@ -150,7 +151,7 @@ private void OnDisconnectOrTimeout(ulong clientID)
                 //We have to check here in SceneManager if our active scene is the main menu, as if it is, it means we timed out rather than a raw disconnect;
                 if (SceneManager.GetActiveScene().name != "MainMenu")
                 {
-                    if (DisconnectReason.Reason == ConnectStatus.UserRequestedDisconnect || NetworkManager.Singleton.IsHost)
+                    if (DisconnectReason.Reason == ConnectStatus.UserRequestedDisconnect || DisconnectReason.Reason == ConnectStatus.HostDisconnected || NetworkManager.Singleton.IsHost)
                     {
                         // simply shut down and go back to main menu
                         NetworkManager.Singleton.Shutdown();
@@ -180,11 +181,11 @@ private IEnumerator TryToReconnect()
         {
             Debug.Log("Lost connection to host, trying to reconnect...");
             int nbTries = 0;
-            while (nbTries < 3)
+            while (nbTries < k_NbReconnectAttempts)
             {
                 NetworkManager.Singleton.Shutdown();
                 yield return new WaitWhile(() => NetworkManager.Singleton.ShutdownInProgress); // wait until NetworkManager completes shutting down
-                Debug.Log($"Reconnecting attempt {nbTries + 1}/3...");
+                Debug.Log($"Reconnecting attempt {nbTries + 1}/{k_NbReconnectAttempts}...");
                 ConnectClient(null);
                 yield return new WaitForSeconds(1.1f * k_TimeoutDuration); // wait a bit longer than the timeout duration to make sure we have enough time to stop this coroutine if successful
                 nbTries++;

Assets/BossRoom/Scripts/Shared/Net/ConnectionManagement/GameNetPortal.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections;
 using Unity.Multiplayer.Samples.BossRoom.Client;
 using Unity.Multiplayer.Samples.BossRoom.Server;
 using Unity.Multiplayer.Samples.BossRoom.Shared.Infrastructure;
@@ -19,6 +20,7 @@ public enum ConnectStatus
         UserRequestedDisconnect,  //Intentional Disconnect triggered by the user.
         GenericDisconnect,        //server disconnected, but no specific reason given.
         Reconnecting,             //client lost connection and is attempting to reconnect.
+        HostDisconnected,         //Intentional Disconnect from the host
     }
 
     public enum OnlineMode
@@ -246,6 +248,20 @@ public void RequestDisconnect()
             m_ClientPortal.OnUserDisconnectRequest();
             m_ServerPortal.OnUserDisconnectRequest();
             SessionManager<SessionPlayerData>.Instance.OnUserDisconnectRequest();
+
+            if (NetManager.IsServer)
+            {
+                StartCoroutine(WaitToShutdown());
+            }
+            else
+            {
+                NetManager.Shutdown();
+            }
+        }
+
+        IEnumerator WaitToShutdown()
+        {
+            yield return new WaitForSeconds(0.5f);
             NetManager.Shutdown();
         }
     }

Assets/BossRoom/Scripts/Shared/Net/ConnectionManagement/ServerGameNetPortal.cs

@@ -106,6 +106,10 @@ public void OnClientSceneChanged(ulong clientId, int sceneIndex)
         public void OnUserDisconnectRequest()
         {
             Clear();
+            if (m_Portal.NetManager.IsServer)
+            {
+                SendServerToAllClientsSetDisconnectReason(ConnectStatus.HostDisconnected);
+            }
         }
 
         private void Clear()
@@ -230,6 +234,16 @@ public void SendServerToClientSetDisconnectReason(ulong clientID, ConnectStatus
             writer.WriteValueSafe(status);
             NetworkManager.Singleton.CustomMessagingManager.SendNamedMessage(nameof(ClientGameNetPortal.ReceiveServerToClientSetDisconnectReason_CustomMessage), clientID, writer);
         }
+        /// <summary>
+        /// Sends a DisconnectReason to all connected clients. This should only be done on the server, prior to disconnecting the clients.
+        /// </summary>
+        /// <param name="status"> The reason for the upcoming disconnect.</param>
+        public void SendServerToAllClientsSetDisconnectReason(ConnectStatus status)
+        {
+            var writer = new FastBufferWriter(sizeof(ConnectStatus), Allocator.Temp);
+            writer.WriteValueSafe(status);
+            NetworkManager.Singleton.CustomMessagingManager.SendNamedMessageToAll(nameof(ClientGameNetPortal.ReceiveServerToClientSetDisconnectReason_CustomMessage), writer);
+        }
 
         /// <summary>
         /// Responsible for the Server->Client custom message of the connection result.