OpenTTD Source: src/network/core/core.h Source File

OpenTTD Source 14.1

core.h
Go to the documentation of this file.
1 /*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
7
12 #ifndef NETWORK_CORE_CORE_H
13 #define NETWORK_CORE_CORE_H
14
15 #include "../../newgrf_config.h"
16 #include "config.h"
17
18 bool NetworkCoreInitialize();
19 void NetworkCoreShutdown();
20
22 enum NetworkRecvStatus {
23 NETWORK_RECV_STATUS_OKAY,
24 NETWORK_RECV_STATUS_DESYNC,
25 NETWORK_RECV_STATUS_NEWGRF_MISMATCH,
26 NETWORK_RECV_STATUS_SAVEGAME,
27 NETWORK_RECV_STATUS_CLIENT_QUIT,
28 NETWORK_RECV_STATUS_MALFORMED_PACKET,
29 NETWORK_RECV_STATUS_SERVER_ERROR,
30 NETWORK_RECV_STATUS_SERVER_FULL,
31 NETWORK_RECV_STATUS_SERVER_BANNED,
32 NETWORK_RECV_STATUS_CLOSE_QUERY,
33 NETWORK_RECV_STATUS_CONNECTION_LOST,
34 };
35
37 struct Packet;
38
42 class NetworkSocketHandler {
43 private:
44 bool has_quit;
45
46 public:
48 NetworkSocketHandler() { this->has_quit = false; }
49
51 virtual ~NetworkSocketHandler() = default;
52
60 void MarkClosed() { this->has_quit = true; }
61
68 bool HasClientQuit() const { return this->has_quit; }
69
73 void Reopen() { this->has_quit = false; }
74 };
75
76 #endif /* NETWORK_CORE_CORE_H */
NETWORK_RECV_STATUS_CLIENT_QUIT
@ NETWORK_RECV_STATUS_CLIENT_QUIT
The connection is lost gracefully. Other clients are already informed of this leaving client.
Definition: core.h:27
NETWORK_RECV_STATUS_DESYNC
@ NETWORK_RECV_STATUS_DESYNC
A desync did occur.
Definition: core.h:24
NetworkSocketHandler
SocketHandler for all network sockets in OpenTTD.
Definition: core.h:42
NetworkSocketHandler::~NetworkSocketHandler
virtual ~NetworkSocketHandler()=default
Close the socket when destructing the socket handler.
NetworkSocketHandler::has_quit
bool has_quit
Whether the current client has quit/send a bad packet.
Definition: core.h:44
NetworkCoreShutdown
void NetworkCoreShutdown()
Shuts down the network core (as that is needed for some platforms.
Definition: core.cpp:44
NetworkSocketHandler::Reopen
void Reopen()
Reopen the socket so we can send/receive stuff again.
Definition: core.h:73
NETWORK_RECV_STATUS_NEWGRF_MISMATCH
@ NETWORK_RECV_STATUS_NEWGRF_MISMATCH
We did not have the required NewGRFs.
Definition: core.h:25
NETWORK_RECV_STATUS_SERVER_FULL
@ NETWORK_RECV_STATUS_SERVER_FULL
The server is full.
Definition: core.h:30
NETWORK_RECV_STATUS_SERVER_ERROR
@ NETWORK_RECV_STATUS_SERVER_ERROR
The server told us we made an error.
Definition: core.h:29
NetworkSocketHandler::NetworkSocketHandler
NetworkSocketHandler()
Create a new unbound socket.
Definition: core.h:48
NETWORK_RECV_STATUS_SERVER_BANNED
@ NETWORK_RECV_STATUS_SERVER_BANNED
The server has banned us.
Definition: core.h:31
NetworkSocketHandler::MarkClosed
void MarkClosed()
Mark the connection as closed.
Definition: core.h:60
NETWORK_RECV_STATUS_CLOSE_QUERY
@ NETWORK_RECV_STATUS_CLOSE_QUERY
Done querying the server.
Definition: core.h:32
Packet
Internal entity of a packet.
Definition: packet.h:42
NetworkSocketHandler::HasClientQuit
bool HasClientQuit() const
Whether the current client connected to the socket has quit.
Definition: core.h:68
NetworkRecvStatus
NetworkRecvStatus
Status of a network client; reasons why a client has quit.
Definition: core.h:22
NetworkCoreInitialize
bool NetworkCoreInitialize()
Initializes the network core (as that is needed for some platforms.
Definition: core.cpp:24
NETWORK_RECV_STATUS_CONNECTION_LOST
@ NETWORK_RECV_STATUS_CONNECTION_LOST
The connection is lost unexpectedly.
Definition: core.h:33
config.h
NETWORK_RECV_STATUS_OKAY
@ NETWORK_RECV_STATUS_OKAY
Everything is okay.
Definition: core.h:23
NETWORK_RECV_STATUS_SAVEGAME
@ NETWORK_RECV_STATUS_SAVEGAME
Something went wrong (down)loading the savegame.
Definition: core.h:26
NETWORK_RECV_STATUS_MALFORMED_PACKET
@ NETWORK_RECV_STATUS_MALFORMED_PACKET
We apparently send a malformed packet.
Definition: core.h:28