OpenTTD Source 20260108-master-g8ba1860eaa
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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
10#ifndef NETWORK_CORE_CORE_H
11#define NETWORK_CORE_CORE_H
12
13#include "../../newgrf_config.h"
14#include "../network_crypto.h"
15#include "config.h"
16
19
34
36struct Packet;
37
42private:
43 bool has_quit = false;
44
45protected:
46 friend struct Packet;
47 std::unique_ptr<class NetworkEncryptionHandler> receive_encryption_handler = nullptr;
48 std::unique_ptr<class NetworkEncryptionHandler> send_encryption_handler = nullptr;
49
50public:
53
55 virtual ~NetworkSocketHandler() = default;
56
64 void MarkClosed() { this->has_quit = true; }
65
72 bool HasClientQuit() const { return this->has_quit; }
73
77 void Reopen() { this->has_quit = false; }
78};
79
80#endif /* NETWORK_CORE_CORE_H */
SocketHandler for all network sockets in OpenTTD.
Definition core.h:41
virtual ~NetworkSocketHandler()=default
Close the socket when destructing the socket handler.
void MarkClosed()
Mark the connection as closed.
Definition core.h:64
bool HasClientQuit() const
Whether the current client connected to the socket has quit.
Definition core.h:72
std::unique_ptr< class NetworkEncryptionHandler > send_encryption_handler
The handler for encrypting sent packets.
Definition core.h:48
void Reopen()
Reopen the socket so we can send/receive stuff again.
Definition core.h:77
std::unique_ptr< class NetworkEncryptionHandler > receive_encryption_handler
The handler for decrypting received packets.
Definition core.h:47
bool has_quit
Whether the current client has quit/send a bad packet.
Definition core.h:43
NetworkSocketHandler()=default
Create a new unbound socket.
Configuration options of the network stuff.
NetworkRecvStatus
Status of a network client; reasons why a client has quit.
Definition core.h:21
@ NETWORK_RECV_STATUS_DESYNC
A desync did occur.
Definition core.h:23
@ NETWORK_RECV_STATUS_CLIENT_QUIT
The connection is lost gracefully. Other clients are already informed of this leaving client.
Definition core.h:26
@ NETWORK_RECV_STATUS_SERVER_ERROR
The server told us we made an error.
Definition core.h:28
@ NETWORK_RECV_STATUS_SAVEGAME
Something went wrong (down)loading the savegame.
Definition core.h:25
@ NETWORK_RECV_STATUS_CLOSE_QUERY
Done querying the server.
Definition core.h:31
@ NETWORK_RECV_STATUS_OKAY
Everything is okay.
Definition core.h:22
@ NETWORK_RECV_STATUS_NEWGRF_MISMATCH
We did not have the required NewGRFs.
Definition core.h:24
@ NETWORK_RECV_STATUS_CONNECTION_LOST
The connection is lost unexpectedly.
Definition core.h:32
@ NETWORK_RECV_STATUS_SERVER_FULL
The server is full.
Definition core.h:29
@ NETWORK_RECV_STATUS_MALFORMED_PACKET
We apparently send a malformed packet.
Definition core.h:27
@ NETWORK_RECV_STATUS_SERVER_BANNED
The server has banned us.
Definition core.h:30
void NetworkCoreShutdown()
Shuts down the network core (as that is needed for some platforms.
Definition core.cpp:42
bool NetworkCoreInitialize()
Initializes the network core (as that is needed for some platforms.
Definition core.cpp:22
Internal entity of a packet.
Definition packet.h:41