OpenTTD
udp.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_UDP_H
13 #define NETWORK_CORE_UDP_H
14 
15 #include "address.h"
16 #include "game.h"
17 #include "packet.h"
18 
34 };
35 
38  SLT_IPv4 = 0,
39  SLT_IPv6 = 1,
41 
43 };
44 
47 protected:
52 
53  NetworkRecvStatus CloseConnection(bool error = true) override;
54 
56 
62  virtual void Receive_CLIENT_FIND_SERVER(Packet *p, NetworkAddress *client_addr);
63 
103  virtual void Receive_SERVER_RESPONSE(Packet *p, NetworkAddress *client_addr);
104 
110  virtual void Receive_CLIENT_DETAIL_INFO(Packet *p, NetworkAddress *client_addr);
111 
139  virtual void Receive_SERVER_DETAIL_INFO(Packet *p, NetworkAddress *client_addr);
140 
150  virtual void Receive_SERVER_REGISTER(Packet *p, NetworkAddress *client_addr);
151 
157  virtual void Receive_MASTER_ACK_REGISTER(Packet *p, NetworkAddress *client_addr);
158 
166  virtual void Receive_CLIENT_GET_LIST(Packet *p, NetworkAddress *client_addr);
167 
177  virtual void Receive_MASTER_RESPONSE_LIST(Packet *p, NetworkAddress *client_addr);
178 
186  virtual void Receive_SERVER_UNREGISTER(Packet *p, NetworkAddress *client_addr);
187 
197  virtual void Receive_CLIENT_GET_NEWGRFS(Packet *p, NetworkAddress *client_addr);
198 
209  virtual void Receive_SERVER_NEWGRFS(Packet *p, NetworkAddress *client_addr);
210 
217  virtual void Receive_MASTER_SESSION_KEY(Packet *p, NetworkAddress *client_addr);
218 
219  void HandleUDPPacket(Packet *p, NetworkAddress *client_addr);
220 
228  virtual void HandleIncomingNetworkGameInfoGRFConfig(GRFConfig *config) { NOT_REACHED(); }
229 public:
231 
233  virtual ~NetworkUDPSocketHandler() { this->Close(); }
234 
235  bool Listen();
236  void Close() override;
237 
238  void SendPacket(Packet *p, NetworkAddress *recv, bool all = false, bool broadcast = false);
239  void ReceivePackets();
240 
241  void SendNetworkGameInfo(Packet *p, const NetworkGameInfo *info);
243 };
244 
245 #endif /* NETWORK_CORE_UDP_H */
Autodetect the type based on the connection.
Definition: udp.h:40
virtual void Receive_CLIENT_GET_NEWGRFS(Packet *p, NetworkAddress *client_addr)
The client requests information about some NewGRFs.
Definition: udp.cpp:343
Internal entity of a packet.
Definition: packet.h:40
Sends a fresh session key to the client.
Definition: udp.h:32
virtual void Receive_SERVER_REGISTER(Packet *p, NetworkAddress *client_addr)
Registers the server to the master server.
Definition: udp.cpp:338
Queries a game server for game information.
Definition: udp.h:21
virtual ~NetworkUDPSocketHandler()
On destructing of this class, the socket needs to be closed.
Definition: udp.h:233
Requests the name for a list of GRFs (GRF_ID and MD5)
Definition: udp.h:30
void ReceivePackets()
Receive a packet at UDP level.
Definition: udp.cpp:115
virtual void Receive_SERVER_RESPONSE(Packet *p, NetworkAddress *client_addr)
Return of server information to the client.
Definition: udp.cpp:335
Get the IPv4 addresses.
Definition: udp.h:38
Request for serverlist from master server.
Definition: udp.h:27
void SendNetworkGameInfo(Packet *p, const NetworkGameInfo *info)
Serializes the NetworkGameInfo struct to the packet.
Definition: udp.cpp:155
Get the IPv6 addresses.
Definition: udp.h:39
virtual void Receive_SERVER_UNREGISTER(Packet *p, NetworkAddress *client_addr)
A server unregisters itself at the master server.
Definition: udp.cpp:342
SocketList sockets
The opened sockets.
Definition: udp.h:51
virtual void Receive_MASTER_SESSION_KEY(Packet *p, NetworkAddress *client_addr)
The master server sends us a session key.
Definition: udp.cpp:345
Wrapper for (un)resolved network addresses; there&#39;s no reason to transform a numeric IP to a string a...
Definition: address.h:27
PacketUDPType
Enum with all types of UDP packets.
Definition: udp.h:20
Base socket handler for all UDP sockets.
Definition: udp.h:46
Request to be removed from the server-list.
Definition: udp.h:29
Information about a game that is sent between a game server, game client and masterserver.
void ReceiveInvalidPacket(PacketUDPType, NetworkAddress *client_addr)
Helper for logging receiving invalid packets.
Definition: udp.cpp:329
The game information that is sent from the server to the clients.
Definition: game.h:32
std::vector< NetworkAddress > NetworkAddressList
Type for a list of addresses.
Definition: address.h:18
virtual void Receive_CLIENT_FIND_SERVER(Packet *p, NetworkAddress *client_addr)
Queries to the server for information about the game.
Definition: udp.cpp:334
virtual void HandleIncomingNetworkGameInfoGRFConfig(GRFConfig *config)
Function that is called for every GRFConfig that is read when receiving a NetworkGameInfo.
Definition: udp.h:228
Must ALWAYS be on the end of this list!! (period)
Definition: udp.h:33
Information about GRF, used in the game and (part of it) in savegames.
virtual void Receive_CLIENT_GET_LIST(Packet *p, NetworkAddress *client_addr)
The client requests a list of servers.
Definition: udp.cpp:340
Packet to register itself to the master server.
Definition: udp.h:25
Packet indicating registration has succeeded.
Definition: udp.h:26
virtual void Receive_SERVER_NEWGRFS(Packet *p, NetworkAddress *client_addr)
The server returns information about some NewGRFs.
Definition: udp.cpp:344
void Close() override
Close the given UDP socket.
Definition: udp.cpp:58
Reply of the game server about details of the game, such as companies.
Definition: udp.h:24
NetworkRecvStatus
Status of a network client; reasons why a client has quit.
Definition: core.h:22
ServerListType
The types of server lists we can get.
Definition: udp.h:37
Wrapper for network addresses.
NetworkRecvStatus CloseConnection(bool error=true) override
Close the current connection; for TCP this will be mostly equivalent to Close(), but for UDP it just ...
Definition: udp.cpp:66
virtual void Receive_CLIENT_DETAIL_INFO(Packet *p, NetworkAddress *client_addr)
Query for detailed information about companies.
Definition: udp.cpp:336
virtual void Receive_MASTER_ACK_REGISTER(Packet *p, NetworkAddress *client_addr)
The master server acknowledges the registration.
Definition: udp.cpp:339
bool Listen()
Start listening on the given host and port.
Definition: udp.cpp:43
void SendPacket(Packet *p, NetworkAddress *recv, bool all=false, bool broadcast=false)
Send a packet over UDP.
Definition: udp.cpp:79
Sends the list of NewGRF&#39;s requested.
Definition: udp.h:31
void HandleUDPPacket(Packet *p, NetworkAddress *client_addr)
Handle an incoming packets by sending it to the correct function.
Definition: udp.cpp:291
virtual void Receive_SERVER_DETAIL_INFO(Packet *p, NetworkAddress *client_addr)
Reply with detailed company information.
Definition: udp.cpp:337
void CDECL error(const char *s,...)
Error handling for fatal non-user errors.
Definition: openttd.cpp:112
Basic functions to create, fill and read packets.
Response from master server with server ip&#39;s + port&#39;s.
Definition: udp.h:28
NetworkAddressList bind
The address to bind to.
Definition: udp.h:49
void ReceiveNetworkGameInfo(Packet *p, NetworkGameInfo *info)
Deserializes the NetworkGameInfo struct from the packet.
Definition: udp.cpp:217
Queries a game server about details of the game, such as companies.
Definition: udp.h:23
Reply of the game server with game information.
Definition: udp.h:22
virtual void Receive_MASTER_RESPONSE_LIST(Packet *p, NetworkAddress *client_addr)
The server sends a list of servers.
Definition: udp.cpp:341
End of &#39;arrays&#39; marker.
Definition: udp.h:42
SocketHandler for all network sockets in OpenTTD.
Definition: core.h:41
NetworkUDPSocketHandler(NetworkAddressList *bind=nullptr)
Create an UDP socket but don&#39;t listen yet.
Definition: udp.cpp:23