Pyrogenesis  trunk
NetClientTurnManager.h
Go to the documentation of this file.
1 /* Copyright (C) 2017 Wildfire Games.
2  * This file is part of 0 A.D.
3  *
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.
8  *
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.
13  *
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/>.
16  */
17 
18 #ifndef INCLUDED_NETCLIENTTURNMANAGER
19 #define INCLUDED_NETCLIENTTURNMANAGER
20 
22 #include "NetMessage.h"
23 
24 class CNetClient;
25 
26 /**
27  * Implementation of CTurnManager for network clients.
28  */
30 {
32 public:
33  CNetClientTurnManager(CSimulation2& simulation, CNetClient& client, int clientId, IReplayLogger& replay);
34 
35  void OnSimulationMessage(CSimulationMessage* msg) override;
36 
37  void PostCommand(JS::HandleValue data) override;
38 
39  /**
40  * Notify the server that all commands are sent to prepare the connection for termination.
41  */
42  void OnDestroyConnection();
43 
44  void OnSyncError(u32 turn, const CStr& expectedHash, const std::vector<CSyncErrorMessage::S_m_PlayerNames>& playerNames);
45 
46 private:
47  void NotifyFinishedOwnCommands(u32 turn) override;
48 
49  void NotifyFinishedUpdate(u32 turn) override;
50 
52 };
53 
54 #endif // INCLUDED_NETCLIENTTURNMANAGER
CNetClientTurnManager(CSimulation2 &simulation, CNetClient &client, int clientId, IReplayLogger &replay)
Definition: NetClientTurnManager.cpp:36
NONCOPYABLE(CNetClientTurnManager)
void OnDestroyConnection()
Notify the server that all commands are sent to prepare the connection for termination.
Definition: NetClientTurnManager.cpp:94
Replay log recorder interface.
Definition: Replay.h:30
void NotifyFinishedOwnCommands(u32 turn) override
Called when this client has finished sending all its commands scheduled for the given turn...
Definition: NetClientTurnManager.cpp:54
This file defines the base class of the turn managers for clients, local games and replays...
Definition: TurnManager.h:57
Public API for simulation system.
Definition: Simulation2.h:47
uint32_t u32
Definition: types.h:39
void NotifyFinishedUpdate(u32 turn) override
Called when this client has finished a simulation update.
Definition: NetClientTurnManager.cpp:70
void OnSimulationMessage(CSimulationMessage *msg) override
Called by networking code when a simulation message is received.
Definition: NetClientTurnManager.cpp:99
Network client.
Definition: NetClient.h:57
Implementation of CTurnManager for network clients.
Definition: NetClientTurnManager.h:29
CNetClient & m_NetClient
Definition: NetClientTurnManager.h:51
void OnSyncError(u32 turn, const CStr &expectedHash, const std::vector< CSyncErrorMessage::S_m_PlayerNames > &playerNames)
Definition: NetClientTurnManager.cpp:105
void PostCommand(JS::HandleValue data) override
Called by simulation code, to add a new command to be distributed to all clients and executed soon...
Definition: NetClientTurnManager.cpp:41
Special message type for simulation commands.
Definition: NetMessage.h:113