1 /* Copyright (C) 2021 Wildfire Games.
2 * This file is part of 0 A.D.
4 * 0 A.D. is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 2 of the License, or
7 * (at your option) any later version.
9 * 0 A.D. is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
18 #ifndef INCLUDED_NETSERVERTURNMANAGER
19 #define INCLUDED_NETSERVERTURNMANAGER
24 #include <unordered_map>
26 class CNetServerWorker
;
27 class CNetServerSession
;
30 * The server-side counterpart to CNetClientTurnManager.
31 * Records the turn state of each client, and sends turn advancement messages
32 * when clients are ready.
35 * - This is constructed and used by CNetServerWorker in the network server thread.
37 class CNetServerTurnManager
39 NONCOPYABLE(CNetServerTurnManager
);
41 CNetServerTurnManager(CNetServerWorker
& server
);
43 void NotifyFinishedClientCommands(CNetServerSession
& session
, u32 turn
);
45 void NotifyFinishedClientUpdate(CNetServerSession
& session
, u32 turn
, const CStr
& hash
);
48 * Inform the turn manager of a new client
49 * @param observer - whether this client is an observer.
51 void InitialiseClient(int client
, u32 turn
, bool observer
);
54 * Inform the turn manager that a previously-initialised client has left the game.
56 void UninitialiseClient(int client
);
58 void SetTurnLength(u32 msecs
);
61 * Returns the latest turn for which all clients are ready;
62 * they will have already been told to execute this turn.
64 u32
GetReadyTurn() { return m_ReadyTurn
; }
67 * Returns the turn length that was used for the given turn.
68 * Requires turn <= GetReadyTurn().
70 u32
GetSavedTurnLength(u32 turn
);
73 void CheckClientsReady();
78 // Latest turn for which all commands have been received.
80 // Last known simulated turn.
86 std::unordered_map
<int, Client
> m_ClientsData
;
88 // Cached value - is any client OOS? This is reset when the OOS client leaves.
89 bool m_HasSyncError
= false;
91 // Map of turn -> {Client ID -> state hash}; old indexes <= min(m_ClientsSimulated) are deleted
92 std::map
<u32
, std::map
<int, std::string
>> m_ClientStateHashes
;
94 /// The latest turn for which we have received all commands from all clients
97 // Current turn length
100 // Turn lengths for all previously executed turns
101 std::vector
<u32
> m_SavedTurnLengths
;
103 CNetServerWorker
& m_NetServer
;
106 #endif // INCLUDED_NETSERVERTURNMANAGER