- Improved online startup and tear down flows

- improved version check flow

Author: x64-dev

GeneralsMD/Code/GameEngine/Include/Common/GameEngine.h

@@ -55,6 +55,9 @@ class Radar;
 class WebBrowser;
 class ParticleSystemManager;
 
+void InitGeneralsOnline();
+void TearDownGeneralsOnline();
+
 /**
  * The implementation of the game engine
  */

GeneralsMD/Code/GameEngine/Include/GameNetwork/GeneralsOnline/HTTP/HTTPManager.h

@@ -91,6 +91,8 @@ class HTTPManager
 	std::string m_strProxyAddr;
 	uint16_t m_proxyPort;
 
+	bool m_bExitRequested = false;
+
 	std::thread* m_backgroundThread = nullptr;
 
 	std::recursive_mutex m_mutex;

GeneralsMD/Code/GameEngine/Include/GameNetwork/GeneralsOnline/OnlineServices_Init.h

@@ -34,6 +34,8 @@ class WebSocket
 	void Connect(const char* url);
 	void Disconnect();
 
+	void Shutdown();
+
 	void SendData_RoomChatMessage(const char* szMessage);
 	void SendData_JoinNetworkRoom(int roomID);
 	void SendData_MarkReady(bool bReady);
@@ -105,6 +107,7 @@ class NGMP_OnlineServicesManager
 		return m_pOnlineServicesManager;
 	}
 
+	void Shutdown();
 
 	~NGMP_OnlineServicesManager()
 	{
@@ -125,9 +128,21 @@ class NGMP_OnlineServicesManager
 			delete m_pRoomInterface;
 			m_pRoomInterface = nullptr;
 		}
+
+		if (m_pHTTPManager != nullptr)
+		{
+			delete m_pHTTPManager;
+			m_pHTTPManager = nullptr;
+		}
+
+		if (m_pWebSocket != nullptr)
+		{
+			delete m_pWebSocket;
+			m_pWebSocket = nullptr;
+		}
 	}
 
-	void StartVersionCheck(std::function<void(bool bNeedsUpdate)> fnCallback);
+	void StartVersionCheck(std::function<void(bool bSuccess, bool bNeedsUpdate)> fnCallback);
 
 	WebSocket* GetWebSocket() const { return m_pWebSocket; }
 	HTTPManager* GetHTTPManager() const { return m_pHTTPManager; }

GeneralsMD/Code/GameEngine/Source/Common/GameEngine.cpp

@@ -111,6 +111,20 @@
 // GENERALS ONLINE
 #include "../OnlineServices_Init.h"
 static NGMP_OnlineServicesManager* g_pOnlineServicesMgr = nullptr;
+static bool g_bTearDownGeneralsOnlineRequested = false;
+void InitGeneralsOnline()
+{
+	// GENERALS ONLINE
+	if (g_pOnlineServicesMgr == nullptr)
+	{
+		g_pOnlineServicesMgr = new NGMP_OnlineServicesManager();
+	}
+}
+
+void TearDownGeneralsOnline()
+{
+	g_bTearDownGeneralsOnlineRequested = true;
+}
 
 #ifdef _INTERNAL
 // for occasional debugging...
@@ -712,12 +726,6 @@ void GameEngine::init( int argc, char *argv[] )
 
 	TheSubsystemList->resetAll();
 	HideControlBar();
-
-	// GENERALS ONLINE
-	if (g_pOnlineServicesMgr == nullptr)
-	{
-		g_pOnlineServicesMgr = new NGMP_OnlineServicesManager();
-	}
 }  // end init
 
 /** -----------------------------------------------------------------------------------------------
@@ -778,6 +786,18 @@ void GameEngine::update( void )
 			TheGameClient->UPDATE();
 			TheMessageStream->propagateMessages();
 
+			if (g_bTearDownGeneralsOnlineRequested) // delayed tear down
+			{
+				g_bTearDownGeneralsOnlineRequested = false;
+
+				if (g_pOnlineServicesMgr != nullptr)
+				{
+					g_pOnlineServicesMgr->Shutdown();
+					delete g_pOnlineServicesMgr;
+					g_pOnlineServicesMgr = nullptr;
+				}
+
+			}
 			if (g_pOnlineServicesMgr != nullptr)
 			{
 				g_pOnlineServicesMgr->Tick();

GeneralsMD/Code/GameEngine/Source/GameClient/GUI/GUICallbacks/Menus/WOLWelcomeMenu.cpp

@@ -868,6 +868,7 @@ WindowMsgHandledType WOLWelcomeMenuSystem( GameWindow *window, UnsignedInt msg,
 
 		case GBM_SELECTED:
 			{
+			// TODO_NGMP: Support exiting online again
 				if (buttonPushed)
 					break;
 
@@ -879,22 +880,10 @@ WindowMsgHandledType WOLWelcomeMenuSystem( GameWindow *window, UnsignedInt msg,
 					//DEBUG_ASSERTCRASH(TheGameSpyChat->getPeer(), ("No GameSpy Peer object!"));
 					//TheGameSpyChat->disconnectFromChat();
 
-					PeerRequest req;
-					req.peerRequestType = PeerRequest::PEERREQUEST_LOGOUT;
-					TheGameSpyPeerMessageQueue->addRequest( req );
-					BuddyRequest breq;
-					breq.buddyRequestType = BuddyRequest::BUDDYREQUEST_LOGOUT;
-					TheGameSpyBuddyMessageQueue->addRequest( breq );
+					// NGMP: Don't need to logout here, just kill the WS connection, that triggers a log out
+					TearDownGeneralsOnline();
 
-					DEBUG_LOG(("Tearing down GameSpy from WOLWelcomeMenuSystem(GBM_SELECTED)\n"));
-					TearDownGameSpy();
-
-					/*
-					if (TheGameSpyChat->getPeer())
-					{
-						peerDisconnect(TheGameSpyChat->getPeer());
-					}
-					*/
+					DEBUG_LOG(("Tearing down GeneralsOnline from WOLWelcomeMenuSystem(GBM_SELECTED)\n"));
 
 					buttonPushed = TRUE;
 

GeneralsMD/Code/GameEngine/Source/GameNetwork/GameSpy/MainMenuUtils.cpp

@@ -54,6 +54,7 @@
 #include "WWDownload/Registry.h"
 #include "WWDownload/urlBuilder.h"
 #include "../OnlineServices_Init.h"
+#include "Common/GameEngine.h"
 
 #ifdef _INTERNAL
 // for occasional debugging...
@@ -772,6 +773,9 @@ void StopAsyncDNSCheck( void )
 
 void StartPatchCheck( void )
 {
+	// GENERALS ONLINE
+	InitGeneralsOnline();
+
 	checkingForPatchBeforeGameSpy = TRUE;
 	cantConnectBeforeOnline = FALSE;
 	timeThroughOnline++;
@@ -784,23 +788,43 @@ void StartPatchCheck( void )
 	// TODO_NGMP: Uninit this when leaving MP, waste of resources and cycles
 	NGMP_OnlineServicesManager::GetInstance()->Init();
 
-	NGMP_OnlineServicesManager::GetInstance()->StartVersionCheck([](bool bNeedsUpdate)
+	NGMP_OnlineServicesManager::GetInstance()->StartVersionCheck([](bool bSuccess, bool bNeedsUpdate)
 		{
-			if (!bNeedsUpdate)
-			{
-				startOnline();
-			}
-			else
+			cantConnectBeforeOnline = !bSuccess;
+			mustDownloadPatch = bNeedsUpdate;
+
+			if (!bSuccess)
 			{
-				// TODO_NGMP: Later we should allow in-game updates
 				if (onlineCancelWindow)
 				{
 					TheWindowManager->winDestroy(onlineCancelWindow);
 					onlineCancelWindow = NULL;
 				}
 
-				onlineCancelWindow = MessageBoxOk(TheGameText->fetch("GUI:PatchAvailable"),
-					UnicodeString(L"An update is required.\n\nPlease visit www.playgenerals.online to download the latest update"), CancelPatchCheckCallbackAndReopenDropdown);
+				TearDownGeneralsOnline();
+
+				MessageBoxOk(TheGameText->fetch("GUI:CannotConnectToServservTitle"),
+					TheGameText->fetch("GUI:CannotConnectToServserv"),
+					noPatchBeforeOnlineCallback);
+			}
+			else
+			{
+				if (!bNeedsUpdate)
+				{
+					startOnline();
+				}
+				else
+				{
+					// TODO_NGMP: Later we should allow in-game updates
+					if (onlineCancelWindow)
+					{
+						TheWindowManager->winDestroy(onlineCancelWindow);
+						onlineCancelWindow = NULL;
+					}
+
+					onlineCancelWindow = MessageBoxOk(TheGameText->fetch("GUI:PatchAvailable"),
+						UnicodeString(L"An update is required.\n\nPlease visit www.playgenerals.online to download the latest update"), CancelPatchCheckCallbackAndReopenDropdown);
+				}
 			}
 		});
 

GeneralsMD/Code/GameEngine/Source/GameNetwork/GeneralsOnline/HTTP/HTTPManager.cpp

@@ -72,13 +72,20 @@ void HTTPManager::PlatformThreadedTick_Locked()
 
 void HTTPManager::Shutdown()
 {
+	m_mutex.lock();
+	curl_multi_cleanup(m_pCurl);
+	m_pCurl = nullptr;
 
+	m_mutex.unlock();
+
+	// TODO_HTTP: Wait for background thread to finish
+	m_bExitRequested = true;
 }
 
 void HTTPManager::BackgroundThreadRun()
 {
 	// TODO_HTTP: While should be until core is existing
-	while (true)
+	while (!m_bExitRequested)
 	{
 		PlatformThreadedTick_PreLock();
 
@@ -123,7 +130,7 @@ HTTPRequest* HTTPManager::PlatformCreateRequest(EHTTPVerb httpVerb, EIPProtocolV
 
 HTTPManager::~HTTPManager()
 {
-	curl_multi_cleanup(m_pCurl);
+	Shutdown();
 }
 
 void HTTPManager::MainThreadTick()

GeneralsMD/Code/GameEngine/Source/GameNetwork/GeneralsOnline/OnlineServices_Init.cpp

@@ -53,7 +53,20 @@ std::string NGMP_OnlineServicesManager::GetAPIEndpoint(const char* szEndpoint, b
 	}
 }
 
-void NGMP_OnlineServicesManager::StartVersionCheck(std::function<void(bool bNeedsUpdate)> fnCallback)
+void NGMP_OnlineServicesManager::Shutdown()
+{
+	if (m_pHTTPManager != nullptr)
+	{
+		m_pHTTPManager->Shutdown();
+	}
+
+	if (m_pWebSocket != nullptr)
+	{
+		m_pWebSocket->Shutdown();
+	}
+}
+
+void NGMP_OnlineServicesManager::StartVersionCheck(std::function<void(bool bSuccess, bool bNeedsUpdate)> fnCallback)
 {
 	std::string strURI = NGMP_OnlineServicesManager::GetAPIEndpoint("VersionCheck", false);
 
@@ -74,16 +87,17 @@ void NGMP_OnlineServicesManager::StartVersionCheck(std::function<void(bool bNeed
 				if (authResp.result == EVersionCheckResponseResult::OK)
 				{
 					NetworkLog("VERSION CHECK: Up To Date");
-					fnCallback(false);
+					fnCallback(true, false);
 				}
 				else
 				{
-					fnCallback(true);
+					fnCallback(true, true);
 				}
 			}
 			catch (...)
 			{
 				NetworkLog("VERSION CHECK: Failed to parse response");
+				fnCallback(false, false);
 			}
 		});
 }
@@ -317,3 +331,8 @@ void NGMP_OnlineServicesManager::Tick()
 		}
 	};
 }
+
+void WebSocket::Shutdown()
+{
+	Disconnect();
+}

GeneralsMD/Code/GameEngine/Source/GameNetwork/GeneralsOnline/OnlineServices_RoomsInterface.cpp

@@ -13,7 +13,7 @@ WebSocket::WebSocket()
 
 WebSocket::~WebSocket()
 {
-	Disconnect();
+	Shutdown();
 }
 
 int WebSocket::Ping()
@@ -103,12 +103,16 @@ void WebSocket::Disconnect()
 		return;
 	}
 
-	// send close
-	size_t sent;
-	(void)curl_ws_send(m_pCurl, "", 0, &sent, 0, CURLWS_CLOSE);
+	if (m_pCurl != nullptr)
+	{
+		// send close
+		size_t sent;
+		(void)curl_ws_send(m_pCurl, "", 0, &sent, 0, CURLWS_CLOSE);
 
-	// cleanup
-	curl_easy_cleanup(m_pCurl);
+		// cleanup
+		curl_easy_cleanup(m_pCurl);
+		m_pCurl = nullptr;
+	}
 }
 
 void WebSocket::Send(const char* send_payload)