Ticket #3953: disable_timeouts_differently_v1.patch

source/gui/scripting/ScriptFunctions.cpp

@@ -357 +357 @@
         SAFE_DELETE(g_NetServer);
         return;
     }
 
     g_Game = new CGame();
-    g_NetClient = new CNetClient(g_Game);
+    g_NetClient = new CNetClient(g_Game, true);
     g_NetClient->SetUserName(playerName);
 
     if (!g_NetClient->SetupConnection("127.0.0.1"))
     {
         pCxPrivate->pScriptInterface->ReportError("Failed to connect to server");
@@ -375 +375 @@
     ENSURE(!g_NetClient);
     ENSURE(!g_NetServer);
     ENSURE(!g_Game);
 
     g_Game = new CGame();
-    g_NetClient = new CNetClient(g_Game);
+    g_NetClient = new CNetClient(g_Game, false);
     g_NetClient->SetUserName(playerName);
     if (!g_NetClient->SetupConnection(serverAddress))
     {
         pCxPrivate->pScriptInterface->ReportError("Failed to connect to server");
         SAFE_DELETE(g_NetClient);

source/network/NetClient.cpp

@@ -64 +64 @@
 
 private:
     CNetClient& m_Client;
 };
 
-CNetClient::CNetClient(CGame* game) :
+CNetClient::CNetClient(CGame* game, bool disableTimeout) :
     m_Session(NULL),
     m_UserName(L"anonymous"),
     m_GUID(ps_generate_guid()), m_HostID((u32)-1), m_ClientTurnManager(NULL), m_Game(game),
     m_GameAttributes(game->GetSimulation2()->GetScriptInterface().GetContext()),
+    m_DisableTimeout(disableTimeout),
     m_LastConnectionCheck(0)
 {
     m_Game->SetTurnManager(NULL); // delete the old local turn manager so we don't accidentally use it
 
     void* context = this;
@@ -152 +153 @@
 }
 
 bool CNetClient::SetupConnection(const CStr& server)
 {
     CNetClientSession* session = new CNetClientSession(*this);
-    bool ok = session->Connect(PS_DEFAULT_PORT, server);
+    bool ok = session->Connect(PS_DEFAULT_PORT, server, m_DisableTimeout);
     SetAndOwnSession(session);
     return ok;
 }
 
 void CNetClient::SetAndOwnSession(CNetClientSession* session)
@@ -465 +466 @@
 
     CAuthenticateMessage authenticate;
     authenticate.m_GUID = client->m_GUID;
     authenticate.m_Name = client->m_UserName;
     authenticate.m_Password = L""; // TODO
+    authenticate.m_DisableTimeout = client->m_DisableTimeout;
     client->SendMessage(&authenticate);
 
     return true;
 }
 

source/network/NetClient.h

@@ -63 +63 @@
 public:
     /**
      * Construct a client associated with the given game object.
      * The game must exist for the lifetime of this object.
      */
-    CNetClient(CGame* game);
+    CNetClient(CGame* game, bool disableTimeout);
 
     virtual ~CNetClient();
 
     /**
      * We assume that adding a tracing function that's only called
@@ -237 +237 @@
     CNetClientTurnManager* m_ClientTurnManager;
 
     /// Unique-per-game identifier of this client, used to identify the sender of simulation commands
     u32 m_HostID;
 
+    /// Whether to prevent the client of the host from timing out
+    bool m_DisableTimeout;
+
     /// Latest copy of game setup attributes heard from the server
     JS::PersistentRootedValue m_GameAttributes;
 
     /// Latest copy of player assignments heard from the server
     PlayerAssignmentMap m_PlayerAssignments;

source/network/NetMessages.h

@@ -26 +26 @@
 #include "ps/CStr.h"
 #include "scriptinterface/ScriptVal.h"
 
 #define PS_PROTOCOL_MAGIC               0x5073013f      // 'P', 's', 0x01, '?'
 #define PS_PROTOCOL_MAGIC_RESPONSE      0x50630121      // 'P', 'c', 0x01, '!'
-#define PS_PROTOCOL_VERSION             0x01010011      // Arbitrary protocol
+#define PS_PROTOCOL_VERSION             0x01010012      // Arbitrary protocol
 #define PS_DEFAULT_PORT                 0x5073          // 'P', 's'
 
 // Defines the list of message types. The order of the list must not change.
 // The message types having a negative value are used internally and not sent
 // over the network. The message types used for network communication have
@@ -110 +110 @@
 
 START_NMT_CLASS_(Authenticate, NMT_AUTHENTICATE)
     NMT_FIELD(CStr8, m_GUID)
     NMT_FIELD(CStrW, m_Name)
     NMT_FIELD(CStrW, m_Password)
+    NMT_FIELD_INT(m_DisableTimeout, u8, 1)
 END_NMT_CLASS()
 
 START_NMT_CLASS_(AuthenticateResult, NMT_AUTHENTICATE_RESULT)
     NMT_FIELD_INT(m_Code, u32, 4)
     NMT_FIELD_INT(m_HostID, u32, 2)

source/network/NetServer.cpp

@@ -484 +484 @@
 
         // Set up a session object for this peer
 
         CNetServerSession* session = new CNetServerSession(*this, event.peer);
 
-        // Prevent the local client of the host from timing out too quickly
-#if (ENET_VERSION >= ENET_VERSION_CREATE(1, 3, 4))
-        if (session->GetIPAddress() == "127.0.0.1")
-            enet_peer_timeout(event.peer, 0, MAXIMUM_HOST_TIMEOUT, MAXIMUM_HOST_TIMEOUT);
-#endif
-
         m_Sessions.push_back(session);
 
         SetupSession(session);
 
         ENSURE(event.peer->data == NULL);
@@ -684 +678 @@
     handshake.m_ProtocolVersion = PS_PROTOCOL_VERSION;
     handshake.m_SoftwareVersion = PS_PROTOCOL_VERSION;
     return session->SendMessage(&handshake);
 }
 
-void CNetServerWorker::OnUserJoin(CNetServerSession* session)
+void CNetServerWorker::OnUserJoin(CNetServerSession* session, bool disableTimeout)
 {
     AddPlayer(session->GetGUID(), session->GetUserName());
 
-    if (m_HostGUID.empty() && session->GetIPAddress() == "127.0.0.1")
+    if (m_HostGUID.empty())
         m_HostGUID = session->GetGUID();
 
+    if (disableTimeout)
+        session->DisableTimeout();
+
     CGameSetupMessage gameSetupMessage(GetScriptInterface());
     gameSetupMessage.m_Data = m_GameAttributes.get();
     session->SendMessage(&gameSetupMessage);
 
     CPlayerAssignmentMessage assignMessage;
@@ -1004 +1001 @@
     authenticateResult.m_Code = isRejoining ? ARC_OK_REJOINING : ARC_OK;
     authenticateResult.m_HostID = newHostID;
     authenticateResult.m_Message = L"Logged in";
     session->SendMessage(&authenticateResult);
 
-    server.OnUserJoin(session);
+    server.OnUserJoin(session, message->m_DisableTimeout);
 
     if (isRejoining)
     {
         // Request a copy of the current game state from an existing player,
         // so we can send it on to the new player

source/network/NetServer.h

@@ -260 +260 @@
     void ClearAllPlayerReady();
 
     void SetupSession(CNetServerSession* session);
     bool HandleConnect(CNetServerSession* session);
 
-    void OnUserJoin(CNetServerSession* session);
+    void OnUserJoin(CNetServerSession* session, bool disableTimeout);
     void OnUserLeave(CNetServerSession* session);
 
     static bool OnClientHandshake(void* context, CFsmEvent* event);
     static bool OnAuthenticate(void* context, CFsmEvent* event);
     static bool OnInGame(void* context, CFsmEvent* event);

source/network/NetSession.cpp

@@ -49 +49 @@
         m_Host = NULL;
         m_Server = NULL;
     }
 }
 
-bool CNetClientSession::Connect(u16 port, const CStr& server)
+bool CNetClientSession::Connect(u16 port, const CStr& server, bool disableTimeout)
 {
     ENSURE(!m_Host);
     ENSURE(!m_Server);
 
     // Create ENet host
@@ -75 +75 @@
     m_Host = host;
     m_Server = peer;
 
     // Prevent the local client of the host from timing out too quickly.
 #if (ENET_VERSION >= ENET_VERSION_CREATE(1, 3, 4))
-    if (GetIPAddress() == "127.0.0.1")
+    if (disableTimeout)
         enet_peer_timeout(peer, 1, MAXIMUM_HOST_TIMEOUT, MAXIMUM_HOST_TIMEOUT);
 #endif
 
     m_Stats = new CNetStatsTable(m_Server);
     if (CProfileViewer::IsInitialised())
@@ -176 +176 @@
     ENSURE(m_Host && m_Server);
 
     return CNetHost::SendMessage(message, m_Server, "server");
 }
 
-CStr CNetClientSession::GetIPAddress() const
-{
-    char ipAddress[256] = "";
-    if (enet_address_get_host_ip(&m_Server->address, ipAddress, ARRAY_SIZE(ipAddress)) < 0)
-        LOGMESSAGE("Could not get IP address of the server!");
-
-    return ipAddress;
-}
-
 u32 CNetClientSession::GetLastReceivedTime() const
 {
     if (!m_Server)
         return 0;
 
@@ -249 +240 @@
 
 bool CNetServerSession::SendMessage(const CNetMessage* message)
 {
     return m_Server.SendMessage(m_Peer, message);
 }
+
+void CNetServerSession::DisableTimeout()
+{
+    // Prevent the local client of the host from timing out too quickly
+#if (ENET_VERSION >= ENET_VERSION_CREATE(1, 3, 4))
+    enet_peer_timeout(m_Peer, 0, MAXIMUM_HOST_TIMEOUT, MAXIMUM_HOST_TIMEOUT);
+#endif
+}

source/network/NetSession.h

@@ -68 +68 @@
 
 public:
     CNetClientSession(CNetClient& client);
     ~CNetClientSession();
 
-    bool Connect(u16 port, const CStr& server);
+    bool Connect(u16 port, const CStr& server, bool disableTimeout);
 
     /**
      * Process queued incoming messages.
      */
     void Poll();
@@ -91 +91 @@
     /**
      * Send a message to the server.
      */
     virtual bool SendMessage(const CNetMessage* message);
 
-    CStr GetIPAddress() const;
-
     /**
      * Number of milliseconds since the most recent packet of the server was received.
      */
     u32 GetLastReceivedTime() const;
 
@@ -170 +168 @@
      * The server will not receive any further messages sent via this session.
      */
     void DisconnectNow(u32 reason);
 
     /**
+     * Prevent the client of the host from timing out.
+     */
+    void DisableTimeout();
+
+    /**
      * Send a message to the client.
      */
     virtual bool SendMessage(const CNetMessage* message);
 
     CNetFileTransferer& GetFileTransferer() { return m_FileTransferer; }

source/network/tests/test_Net.h

@@ -150 +150 @@
 
         JS::RootedValue attrs(cx);
         scriptInterface.Eval("({mapType:'scenario',map:'maps/scenarios/Saharan Oases',mapPath:'maps/scenarios/',thing:'example'})", &attrs);
         server.UpdateGameAttributes(&attrs, scriptInterface);
 
-        CNetClient client1(&client1Game);
-        CNetClient client2(&client2Game);
-        CNetClient client3(&client3Game);
+        CNetClient client1(&client1Game, false);
+        CNetClient client2(&client2Game, false);
+        CNetClient client3(&client3Game, false);
 
         clients.push_back(&client1);
         clients.push_back(&client2);
         clients.push_back(&client3);
 
@@ -215 +215 @@
 
         JS::RootedValue attrs(cx);
         scriptInterface.Eval("({mapType:'scenario',map:'maps/scenarios/Saharan Oases',mapPath:'maps/scenarios/',thing:'example'})", &attrs);
         server.UpdateGameAttributes(&attrs, scriptInterface);
 
-        CNetClient client1(&client1Game);
-        CNetClient client2(&client2Game);
-        CNetClient client3(&client3Game);
+        CNetClient client1(&client1Game, false);
+        CNetClient client2(&client2Game, false);
+        CNetClient client3(&client3Game, false);
 
         client1.SetUserName(L"alice");
         client2.SetUserName(L"bob");
         client3.SetUserName(L"charlie");
 
@@ -267 +267 @@
         clients.erase(clients.begin()+1);
 
         debug_printf("==== Connecting client 2B\n");
 
         CGame client2BGame(true);
-        CNetClient client2B(&client2BGame);
+        CNetClient client2B(&client2BGame, false);
         client2B.SetUserName(L"bob");
         clients.push_back(&client2B);
 
         TS_ASSERT(client2B.SetupConnection("127.0.0.1"));
 

source/ps/GameSetup/GameSetup.cpp

@@ -1445 +1445 @@
         g_NetServer->UpdateGameAttributes(&attrs, scriptInterface);
 
         bool ok = g_NetServer->SetupConnection();
         ENSURE(ok);
 
-        g_NetClient = new CNetClient(g_Game);
+        g_NetClient = new CNetClient(g_Game, true);
         g_NetClient->SetUserName(userName);
         g_NetClient->SetupConnection("127.0.0.1");
     }
     else if (args.Has("autostart-client"))
     {
         InitPs(true, L"page_loading.xml", &scriptInterface, mpInitData);
 
-        g_NetClient = new CNetClient(g_Game);
+        g_NetClient = new CNetClient(g_Game, false);
         g_NetClient->SetUserName(userName);
 
         CStr ip = args.Get("autostart-client");
         if (ip.empty())
             ip = "127.0.0.1";