Differential D3737 Diff 16793 source/network/NetServerTurnManager.h

Changeset View

Standalone View

source/network/NetServerTurnManager.h

	/* Copyright (C) 2018 Wildfire Games.			/* Copyright (C) 2021 Wildfire Games.
	* This file is part of 0 A.D.			* This file is part of 0 A.D.
	*			*
	* 0 A.D. is free software: you can redistribute it and/or modify			* 0 A.D. is free software: you can redistribute it and/or modify
	* it under the terms of the GNU General Public License as published by			* it under the terms of the GNU General Public License as published by
	* the Free Software Foundation, either version 2 of the License, or			* the Free Software Foundation, either version 2 of the License, or
	* (at your option) any later version.			* (at your option) any later version.
	*			*
	* 0 A.D. is distributed in the hope that it will be useful,			* 0 A.D. is distributed in the hope that it will be useful,
	* but WITHOUT ANY WARRANTY; without even the implied warranty of			* but WITHOUT ANY WARRANTY; without even the implied warranty of
	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	* GNU General Public License for more details.			* GNU General Public License for more details.
	*			*
	* You should have received a copy of the GNU General Public License			* You should have received a copy of the GNU General Public License
	* along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.			* along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
	*/			*/

	#ifndef INCLUDED_NETSERVERTURNMANAGER			#ifndef INCLUDED_NETSERVERTURNMANAGER
	#define INCLUDED_NETSERVERTURNMANAGER			#define INCLUDED_NETSERVERTURNMANAGER

	#include <map>
	#include "ps/CStr.h"			#include "ps/CStr.h"

				#include <map>
				#include <unordered_map>

	class CNetServerWorker;			class CNetServerWorker;
	class CNetServerSession;			class CNetServerSession;

	/**			/**
	* The server-side counterpart to CNetClientTurnManager.			* The server-side counterpart to CNetClientTurnManager.
	* Records the turn state of each client, and sends turn advancement messages			* Records the turn state of each client, and sends turn advancement messages
	* when all clients are ready.			* when clients are ready.
	*			*
	* Thread-safety:			* Thread-safety:
	* - This is constructed and used by CNetServerWorker in the network server thread.			* - This is constructed and used by CNetServerWorker in the network server thread.
	*/			*/
	class CNetServerTurnManager			class CNetServerTurnManager
	{			{
	NONCOPYABLE(CNetServerTurnManager);			NONCOPYABLE(CNetServerTurnManager);
	public:			public:
	CNetServerTurnManager(CNetServerWorker& server);			CNetServerTurnManager(CNetServerWorker& server);

	void NotifyFinishedClientCommands(CNetServerSession& session, u32 turn);			void NotifyFinishedClientCommands(CNetServerSession& session, u32 turn);

	void NotifyFinishedClientUpdate(CNetServerSession& session, u32 turn, const CStr& hash);			void NotifyFinishedClientUpdate(CNetServerSession& session, u32 turn, const CStr& hash);

	/**			/**
	* Inform the turn manager of a new client who will be sending commands.			* Inform the turn manager of a new client
				* @param observer - whether this client is an observer.
	*/			*/
	void InitialiseClient(int client, u32 turn);			void InitialiseClient(int client, u32 turn, bool observer);

	/**			/**
	* Inform the turn manager that a previously-initialised client has left the game			* Inform the turn manager that a previously-initialised client has left the game.
	* and will no longer be sending commands.
	*/			*/
	void UninitialiseClient(int client);			void UninitialiseClient(int client);

	void SetTurnLength(u32 msecs);			void SetTurnLength(u32 msecs);

	/**			/**
	* Returns the latest turn for which all clients are ready;			* Returns the latest turn for which all clients are ready;
	* they will have already been told to execute this turn.			* they will have already been told to execute this turn.
	*/			*/
	u32 GetReadyTurn() { return m_ReadyTurn; }			u32 GetReadyTurn() { return m_ReadyTurn; }
				vladislavbelovUnsubmitted Not Done Inline Actions Btw `const`. vladislavbelov: Btw `const`.

	/**			/**
	* Returns the turn length that was used for the given turn.			* Returns the turn length that was used for the given turn.
	* Requires turn <= GetReadyTurn().			* Requires turn <= GetReadyTurn().
	*/			*/
	u32 GetSavedTurnLength(u32 turn);			u32 GetSavedTurnLength(u32 turn);

	private:			private:
	void CheckClientsReady();			void CheckClientsReady();

	/// The latest turn for which we have received all commands from all clients			/// The latest turn for which we have received all commands from all clients
	u32 m_ReadyTurn;			u32 m_ReadyTurn;

				// Client ID -> whether they are only an observer.
				std::unordered_map<int, bool> m_ClientsObserver;

	// Client ID -> ready turn number (the latest turn for which all commands have been received from that client)			// Client ID -> ready turn number (the latest turn for which all commands have been received from that client)
	std::map<int, u32> m_ClientsReady;			std::map<int, u32> m_ClientsReady;

	// Client ID -> last known simulated turn number (for which we have the state hash)			// Client ID -> last known simulated turn number (for which we have the state hash)
	// (the client has reached the start of this turn, not done the update for it yet)			// (the client has reached the start of this turn, not done the update for it yet)
	std::map<int, u32> m_ClientsSimulated;			std::map<int, u32> m_ClientsSimulated;

	// Map of turn -> {Client ID -> state hash}; old indexes <= min(m_ClientsSimulated) are deleted			// Map of turn -> {Client ID -> state hash}; old indexes <= min(m_ClientsSimulated) are deleted
	std::map<u32, std::map<int, std::string>> m_ClientStateHashes;			std::map<u32, std::map<int, std::string>> m_ClientStateHashes;

	// Map of client ID -> playername			// Map of client ID -> playername
	std::map<u32, CStrW> m_ClientPlayernames;			std::map<int, CStrW> m_ClientPlayernames;

	// Current turn length			// Current turn length
	u32 m_TurnLength;			u32 m_TurnLength;

	// Turn lengths for all previously executed turns			// Turn lengths for all previously executed turns
	std::vector<u32> m_SavedTurnLengths;			std::vector<u32> m_SavedTurnLengths;

	CNetServerWorker& m_NetServer;			CNetServerWorker& m_NetServer;

	bool m_HasSyncError;			bool m_HasSyncError;
	};			};

	#endif // INCLUDED_NETSERVERTURNMANAGER			#endif // INCLUDED_NETSERVERTURNMANAGER