Changeset 21842 for ps

Timestamp:

06/07/18 00:09:38 (7 years ago)

Author:

elexis

Message:

Prevent players from disconnecting during the loading screen by increasing the timeout tolerance to 60 seconds for that period, fixes #5163.

The NetClient runs in the main thread, so any part of the loading screen consuming several seconds makes that client timeout.
This is a workaround because threading the NetClient would have prevent these timeouts, refs #3700.
Coutnerintuitively, since enet timeout tolerance is proportional to the latency, the better the connection of the player, the more likely it was to drop on gamestart.

This problem became very frequent in Alpha 23, at least due to the Aura bugfix rP21785, AIInterface being particularly slow and that not having been disabled yet in the loading screen resulting in additional 10 second freezes during the loading screen, even on empty maps, refs #5200, rP21838.

Differential Revision: ​https://code.wildfiregames.com/D1513
Based on patch by: causative

Location:

ps/trunk

Files:

• binaries/data/config/default.cfg (modified) (1 diff)
• source/network/NetClient.cpp (modified) (4 diffs)
• source/network/NetServer.cpp (modified) (4 diffs)
• source/network/NetSession.cpp (modified) (4 diffs)
• source/network/NetSession.h (modified) (2 diffs)

ps/trunk/binaries/data/config/default.cfg

@@ -446 +446 @@
 lateobservers = everyone          ; Allow observers to join the game after it started. Possible values: everyone, buddies, disabled.
 observerlimit = 8                 ; Prevent further observer joins in running games if this limit is reached
+gamestarttimeout = 60000          ; Don't disconnect clients timing out in the loading screen and rejoin process before exceeding this timeout.
 
 [overlay]

ps/trunk/source/network/NetClient.cpp

@@ -673 +673 @@
 }
 
+// This is called either when the host clicks the StartGame button or
+// if this client rejoins and finishes the download of the simstate.
 bool CNetClient::OnGameStart(void* context, CFsmEvent* event)
 {
@@ -680 +682 @@
     JSContext* cx = client->GetScriptInterface().GetContext();
     JSAutoRequest rq(cx);
+
+    client->m_Session->SetLongTimeout(true);
 
     // Find the player assigned to our GUID
@@ -821 +825 @@
     CClientsLoadingMessage* message = (CClientsLoadingMessage*)event->GetParamRef();
 
+    CNetClient* client = (CNetClient*)context;
+    JSContext* cx = client->GetScriptInterface().GetContext();
+    JSAutoRequest rq(cx);
+
+    bool finished = true;
     std::vector<CStr> guids;
     guids.reserve(message->m_Clients.size());
-    for (const CClientsLoadingMessage::S_m_Clients& client : message->m_Clients)
-        guids.push_back(client.m_GUID);
-
-    CNetClient* client = (CNetClient*)context;
-    JSContext* cx = client->GetScriptInterface().GetContext();
-    JSAutoRequest rq(cx);
+    for (const CClientsLoadingMessage::S_m_Clients& mClient : message->m_Clients)
+    {
+        if (client->m_GUID == mClient.m_GUID)
+            finished = false;
+
+        guids.push_back(mClient.m_GUID);
+    }
+
+    // Disable the timeout here after processing the enet message, so as to ensure that the connection isn't currently
+    // timing out (as it is when just leaving the loading screen in LoadFinished).
+    if (finished)
+        client->m_Session->SetLongTimeout(false);
 
     JS::RootedValue msg(cx);
@@ -875 +890 @@
     if (client->m_Rejoin)
         client->SendRejoinedMessage();
+
+    // The last client to leave the loading screen didn't receive the CClientsLoadingMessage, so disable here.
+    client->m_Session->SetLongTimeout(false);
 
     return true;

ps/trunk/source/network/NetServer.cpp

@@ -1096 +1096 @@
         // the most efficient client to request a copy from
         CNetServerSession* sourceSession = server.m_Sessions.at(0);
+
+        session->SetLongTimeout(true);
+
         sourceSession->GetFileTransferer().StartTask(
             shared_ptr<CNetFileReceiveTask>(new CNetFileReceiveTask_ServerRejoin(server, newHostID))
@@ -1264 +1267 @@
     CNetServerWorker& server = loadedSession->GetServer();
 
+    loadedSession->SetLongTimeout(false);
+
     // We're in the loading state, so wait until every client has loaded
     // before starting the game
@@ -1361 +1366 @@
     }
 
+    session->SetLongTimeout(false);
+
     return true;
 }
@@ -1451 +1458 @@
     m_ServerTurnManager = new CNetServerTurnManager(*this);
 
-    for (const CNetServerSession* session : m_Sessions)
+    for (CNetServerSession* session : m_Sessions)
+    {
         m_ServerTurnManager->InitialiseClient(session->GetHostID(), 0); // TODO: only for non-observers
+        session->SetLongTimeout(true);
+    }
 
     m_State = SERVER_STATE_LOADING;

ps/trunk/source/network/NetSession.cpp

@@ -24 +24 @@
 #include "lib/external_libraries/enet.h"
 #include "ps/CLogger.h"
+#include "ps/ConfigDB.h"
 #include "ps/Profile.h"
 #include "scriptinterface/ScriptInterface.h"
@@ -32 +33 @@
 
 static const int CHANNEL_COUNT = 1;
+
+// Only disable long timeouts after a packet from the remote enet peer has been processed.
+// Otherwise a long timeout can still be in progress when disabling it here.
+void SetEnetLongTimeout(ENetPeer* peer, bool isLocalClient, bool enabled)
+{
+#if (ENET_VERSION >= ENET_VERSION_CREATE(1, 3, 4))
+    if (!peer || isLocalClient)
+        return;
+
+    if (enabled)
+    {
+        u32 timeout;
+        CFG_GET_VAL("network.gamestarttimeout", timeout);
+        enet_peer_timeout(peer, 0, timeout, timeout);
+    }
+    else
+        enet_peer_timeout(peer, 0, 0, 0);
+#endif
+}
 
 CNetClientSession::CNetClientSession(CNetClient& client) :
@@ -202 +222 @@
 }
 
+void CNetClientSession::SetLongTimeout(bool enabled)
+{
+    SetEnetLongTimeout(m_Server, m_IsLocalClient, enabled);
+}
+
 CNetServerSession::CNetServerSession(CNetServerWorker& server, ENetPeer* peer) :
     m_Server(server), m_FileTransferer(this), m_Peer(peer), m_IsLocalClient(false), m_HostID(0), m_GUID(), m_UserName()
@@ -262 +287 @@
 #endif
 }
+
+void CNetServerSession::SetLongTimeout(bool enabled)
+{
+    SetEnetLongTimeout(m_Peer, m_IsLocalClient, enabled);
+}

ps/trunk/source/network/NetSession.h

@@ -106 +106 @@
     u32 GetMeanRTT() const;
 
+    /**
+     * Allows increasing the timeout to prevent drops during an expensive operation,
+     * and decreasing it back to normal afterwards.
+     */
+    void SetLongTimeout(bool longTimeout);
+
     CNetFileTransferer& GetFileTransferer() { return m_FileTransferer; }
 
@@ -185 +191 @@
 
     /**
+     * Allows increasing the timeout to prevent drops during an expensive operation,
+     * and decreasing it back to normal afterwards.
+     */
+    void SetLongTimeout(bool longTimeout);
+
+    /**
      * Send a message to the client.
      */