Server Disconnect is now an event not a message (#121)

BREAKING CHANGE: OnServerDisconnect is gone

Assets/Mirror/Components/NetworkRoomManager.cs

@@ -81,6 +81,7 @@ void Awake()
             client.Authenticated.AddListener(OnAuthenticated);
             server.Stopped.AddListener(Stopped);
             client.Disconnected.AddListener(Disconnected);
+            server.Disconnected.AddListener(OnServerDisconnect);
         }
 
         public override void Start()
@@ -253,7 +254,7 @@ public override void OnServerConnect(NetworkConnection conn)
         /// <para>This is called on the Server when a Client disconnects from the Server. Use an override to decide what should happen when a disconnection is detected.</para>
         /// </summary>
         /// <param name="conn">Connection from client.</param>
-        public override void OnServerDisconnect(NetworkConnection conn)
+        public void OnServerDisconnect(NetworkConnection conn)
         {
             if (conn.identity != null)
             {
@@ -274,7 +275,6 @@ public override void OnServerDisconnect(NetworkConnection conn)
             if (SceneManager.GetActiveScene().name == RoomScene)
                 RecalculateRoomPlayerIndices();
 
-            base.OnServerDisconnect(conn);
             OnRoomServerDisconnect(conn);
         }
 
@@ -426,17 +426,6 @@ public void OnAuthenticated(NetworkConnection conn)
             CallOnClientEnterRoom();
         }
 
-        /// <summary>
-        /// Called on clients when disconnected from a server.
-        /// <para>This is called on the client when it disconnects from the server. Override this function to decide what happens when the client disconnects.</para>
-        /// </summary>
-        /// <param name="conn">Connection to the server.</param>
-        public override void OnClientDisconnect(NetworkConnection conn)
-        {
-            OnRoomClientDisconnect(conn);
-            base.OnClientDisconnect(conn);
-        }
-
         /// <summary>
         /// This is invoked when a client is stopped.
         /// </summary>
@@ -598,12 +587,6 @@ public virtual void OnRoomServerPlayersReady()
         /// <param name="conn">The connection that connected.</param>
         public virtual void OnRoomClientConnect(NetworkConnection conn) { }
 
-        /// <summary>
-        /// This is called on the client when disconnected from a server.
-        /// </summary>
-        /// <param name="conn">The connection that disconnected.</param>
-        public virtual void OnRoomClientDisconnect(NetworkConnection conn) { }
-
         /// <summary>
         /// This is called on the client when the client stops.
         /// </summary>

Assets/Mirror/Examples/Pong/Scripts/NetworkManagerPong.cs

@@ -12,6 +12,11 @@ public class NetworkManagerPong : NetworkManager
         public Transform rightRacketSpawn;
         GameObject ball;
 
+        public void Awake()
+        {
+            server.Disconnected.AddListener(OnServerDisconnect);
+        }
+
         public override void OnServerAddPlayer(NetworkConnection conn)
         {
             // add player at correct spawn position
@@ -27,14 +32,11 @@ public override void OnServerAddPlayer(NetworkConnection conn)
             }
         }
 
-        public override void OnServerDisconnect(NetworkConnection conn)
+        public void OnServerDisconnect(NetworkConnection conn)
         {
             // destroy ball
             if (ball != null)
                 server.Destroy(ball);
-
-            // call base functionality (actually destroys the player)
-            base.OnServerDisconnect(conn);
         }
     }
 }

Assets/Mirror/Runtime/LocalConnections.cs

@@ -111,7 +111,7 @@ internal void DisconnectInternal()
 
             // TODO: this does not work if there is no player yet
             if (identity != null)
-                identity.client.HandleClientDisconnect(this);
+                identity.client.HandleClientDisconnect();
         }
 
         /// <summary>

Assets/Mirror/Runtime/Messages.cs

@@ -68,13 +68,6 @@ public struct RemovePlayerMessage : IMessageBase
         public void Serialize(NetworkWriter writer) { /* nothing to serialize */ }
     }
 
-    public struct DisconnectMessage : IMessageBase
-    {
-        public void Deserialize(NetworkReader reader) { /* nothing to serialize */ }
-
-        public void Serialize(NetworkWriter writer) { /* nothing to serialize */ }
-    }
-
     public struct SceneMessage : IMessageBase
     {
         public string sceneName;

Assets/Mirror/Runtime/NetworkClient.cs

@@ -225,8 +225,7 @@ void OnError(Exception exception)
         void OnDisconnected()
         {
             connectState = ConnectState.Disconnected;
-            connection?.InvokeHandler(new DisconnectMessage(), -1);
-            HandleClientDisconnect(connection);
+            HandleClientDisconnect();
         }
 
         /// <summary>
@@ -279,7 +278,7 @@ public void Disconnect()
             {
                 if (isConnected)
                 {
-                    hostServer.localConnection.Send(new DisconnectMessage());
+                    hostServer.Disconnected.Invoke(hostServer.localConnection);
                 }
                 hostServer.RemoveLocalConnection();
             }
@@ -291,7 +290,7 @@ public void Disconnect()
                     RemoveTransportHandlers();
                 }
             }
-            HandleClientDisconnect(connection);
+            HandleClientDisconnect();
         }
 
         void RemoveTransportHandlers()
@@ -523,13 +522,11 @@ internal void InternalAddPlayer(NetworkIdentity identity)
             }
         }
 
-        internal void HandleClientDisconnect(NetworkConnection conn)
+        internal void HandleClientDisconnect()
         {
-            if (connection == conn && ready)
-            {
-                ready = false;
-                connection = null;
-            }
+            DestroyAllClientObjects();
+            ready = false;
+            connection = null;
 
             Disconnected.Invoke();
         }

Assets/Mirror/Runtime/NetworkConnectionToServer.cs

@@ -24,7 +24,7 @@ public override void Disconnect()
             isReady = false;
             // TODO: This does not work if there is no player yet
             if (identity != null)
-                identity.client.HandleClientDisconnect(this);
+                identity.client.HandleClientDisconnect();
             Transport.activeTransport.ClientDisconnect();
         }
     }

Assets/Mirror/Runtime/NetworkManager.cs

@@ -472,7 +472,6 @@ public void StopServer()
             {
                 ServerChangeScene(offlineScene);
             }
-            CleanupNetworkIdentities();
 
             startPositionIndex = 0;
         }
@@ -500,7 +499,6 @@ public void StopClient()
                 ClientChangeScene(offlineScene, SceneOperation.Normal);
             }
 
-            CleanupNetworkIdentities();
         }
 
         /// <summary>
@@ -581,14 +579,6 @@ void Initialize()
                 client.Authenticated.AddListener(OnClientAuthenticated);
         }
 
-        void CleanupNetworkIdentities()
-        {
-            foreach (NetworkIdentity identity in Resources.FindObjectsOfTypeAll<NetworkIdentity>())
-            {
-                identity.MarkForReset();
-            }
-        }
-
         /// <summary>
         /// virtual so that inheriting classes' OnDestroy() can call base.OnDestroy() too
         /// </summary>
@@ -903,7 +893,6 @@ public void UnRegisterStartPosition(Transform start)
 
         void RegisterServerMessages(NetworkConnection connection)
         {
-            connection.RegisterHandler<NetworkConnectionToClient, DisconnectMessage>(OnServerDisconnectInternal, false);
             connection.RegisterHandler<NetworkConnectionToClient, ReadyMessage>(OnServerReadyMessageInternal);
             connection.RegisterHandler<NetworkConnectionToClient, AddPlayerMessage>(OnServerAddPlayerInternal);
             connection.RegisterHandler<NetworkConnectionToClient, RemovePlayerMessage>(OnServerRemovePlayerMessageInternal);
@@ -928,12 +917,6 @@ void OnServerAuthenticated(NetworkConnectionToClient conn)
             OnServerConnect(conn);
         }
 
-        void OnServerDisconnectInternal(NetworkConnection conn, DisconnectMessage msg)
-        {
-            if (LogFilter.Debug) Debug.Log("NetworkManager.OnServerDisconnectInternal");
-            OnServerDisconnect(conn);
-        }
-
         void OnServerReadyMessageInternal(NetworkConnection conn, ReadyMessage msg)
         {
             if (LogFilter.Debug) Debug.Log("NetworkManager.OnServerReadyMessageInternal");
@@ -988,7 +971,6 @@ void OnServerErrorInternal(NetworkConnection conn, ErrorMessage msg)
 
         void RegisterClientMessages(NetworkConnection connection)
         {
-            connection.RegisterHandler<NetworkConnectionToServer, DisconnectMessage>(OnClientDisconnectInternal, false);
             connection.RegisterHandler<NetworkConnectionToServer, NotReadyMessage>(OnClientNotReadyMessageInternal);
             connection.RegisterHandler<NetworkConnectionToServer, ErrorMessage>(OnClientErrorInternal, false);
             connection.RegisterHandler<NetworkConnectionToServer, SceneMessage>(OnClientSceneInternal, false);
@@ -1015,12 +997,6 @@ void OnClientAuthenticated(NetworkConnectionToServer conn)
             }
         }
 
-        void OnClientDisconnectInternal(NetworkConnection conn, DisconnectMessage msg)
-        {
-            if (LogFilter.Debug) Debug.Log("NetworkManager.OnClientDisconnectInternal");
-            OnClientDisconnect(conn);
-        }
-
         void OnClientNotReadyMessageInternal(NetworkConnection conn, NotReadyMessage msg)
         {
             if (LogFilter.Debug) Debug.Log("NetworkManager.OnClientNotReadyMessageInternal");
@@ -1058,16 +1034,6 @@ void OnClientSceneInternal(NetworkConnection conn, SceneMessage msg)
         /// <param name="conn">Connection from client.</param>
         public virtual void OnServerConnect(NetworkConnection conn) { }
 
-        /// <summary>
-        /// Called on the server when a client disconnects.
-        /// <para>This is called on the Server when a Client disconnects from the Server. Use an override to decide what should happen when a disconnection is detected.</para>
-        /// </summary>
-        /// <param name="conn">Connection from client.</param>
-        public virtual void OnServerDisconnect(NetworkConnection conn)
-        {
-            server.DestroyPlayerForConnection(conn);
-            if (LogFilter.Debug) Debug.Log("OnServerDisconnect: Client disconnected.");
-        }
 
         /// <summary>
         /// Called on the server when a client is ready.
@@ -1183,16 +1149,6 @@ public void OnAuthenticated(NetworkConnectionToServer conn)
             }
         }
 
-        /// <summary>
-        /// Called on clients when disconnected from a server.
-        /// <para>This is called on the client when it disconnects from the server. Override this function to decide what happens when the client disconnects.</para>
-        /// </summary>
-        /// <param name="conn">Connection to the server.</param>
-        public virtual void OnClientDisconnect(NetworkConnection conn)
-        {
-            StopClient();
-        }
-
         /// <summary>
         /// Called on clients when a network error occurs.
         /// </summary>

Assets/Mirror/Runtime/NetworkServer.cs

@@ -33,6 +33,7 @@ public class NetworkServer : MonoBehaviour
 
         public NetworkConnectionEvent Connected = new NetworkConnectionEvent();
         public NetworkConnectionEvent Authenticated = new NetworkConnectionEvent();
+        public NetworkConnectionEvent Disconnected = new NetworkConnectionEvent();
         public UnityEvent Stopped = new UnityEvent();
 
         [Header("Authentication")]
@@ -337,12 +338,12 @@ public void DisconnectAll()
         /// </summary>
         public void DisconnectAllConnections()
         {
-            foreach (NetworkConnection conn in connections.Values)
+            foreach (NetworkConnectionToClient conn in connections.Values)
             {
                 conn.Disconnect();
                 // call OnDisconnected unless local player in host mode
                 if (conn.connectionId != 0)
-                    OnDisconnected(conn);
+                    Disconnected.Invoke(conn);
                 conn.Dispose();
             }
             connections.Clear();
@@ -428,14 +429,10 @@ void OnDisconnected(int connectionId)
                 RemoveConnection(connectionId);
                 if (LogFilter.Debug) Debug.Log("Server lost client:" + connectionId);
 
-                OnDisconnected(conn);
-            }
-        }
+                DestroyPlayerForConnection(conn);
 
-        void OnDisconnected(NetworkConnection conn)
-        {
-            conn.InvokeHandler(new DisconnectMessage(), -1);
-            if (LogFilter.Debug) Debug.Log("Server lost client:" + conn);
+                Disconnected.Invoke(conn);
+            }
         }
 
         internal void OnAuthenticated(NetworkConnectionToClient conn)

Assets/Mirror/Tests/Editor/MessagePackerTest.cs

@@ -32,7 +32,7 @@ public void UnpackWrongMessage()
 
             Assert.Throws<FormatException>(() =>
             {
-                DisconnectMessage unpacked = MessagePacker.Unpack<DisconnectMessage>(data);
+                AddPlayerMessage unpacked = MessagePacker.Unpack<AddPlayerMessage>(data);
             });
         }
 

Assets/Mirror/Tests/Editor/MessageTests.cs

@@ -38,12 +38,6 @@ private void TestSerializeDeserialize<T>(T message) where T : IMessageBase, new(
             Assert.That(fresh, Is.EqualTo(message));
         }
 
-        [Test]
-        public void DisconnectMessageTest()
-        {
-            TestSerializeDeserialize(new DisconnectMessage());
-        }
-
         [Test]
         public void ErrorMessageTest()
         {

Assets/Mirror/Tests/Runtime/NetworkServerTest.cs

@@ -152,14 +152,13 @@ public void MaxConnectionsTest()
             Assert.That(server.connections.Count, Is.EqualTo(1));
         }
 
-        /*
+
         [Test]
         public void DisconnectMessageHandlerTest()
         {
             // message handlers
             bool disconnectCalled = false;
-            server.RegisterHandler<DisconnectMessage>((conn, msg) => { disconnectCalled = true; }, false);
-            server.RegisterHandler<ErrorMessage>((conn, msg) => {}, false);
+            server.Disconnected.AddListener(conn => { disconnectCalled = true; });
 
             // listen
             server.Listen();
@@ -172,7 +171,7 @@ public void DisconnectMessageHandlerTest()
             // disconnect
             Transport.activeTransport.OnServerDisconnected.Invoke(42);
             Assert.That(disconnectCalled, Is.True);
-        }*/
+        }
 
         [Test]
         public void ConnectionsDictTest()
@@ -595,7 +594,6 @@ public void RegisterUnregisterClearHandlerTest()
             // unregister second handler via ClearHandlers to test that one too. send, should fail
             connection.ClearHandlers();
             // (only add this one to avoid disconnect error)
-            connection.RegisterHandler<DisconnectMessage>(msg => { }, false);
             writer = new NetworkWriter();
             MessagePacker.Pack(new TestMessage(), writer);
             // log error messages are expected