OpenTTD Source  20241109-master-g5e4f8db7d6
tcp_coordinator.cpp
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 #include "../../stdafx.h"
13 #include "../../timer/timer_game_calendar.h"
14 #include "../../debug.h"
15 #include "tcp_coordinator.h"
16 
17 #include "../../safeguards.h"
18 
26 {
28 
29  switch (type) {
30  case PACKET_COORDINATOR_GC_ERROR: return this->Receive_GC_ERROR(p);
47 
48  default:
49  Debug(net, 0, "[tcp/coordinator] Received invalid packet type {}", type);
50  return false;
51  }
52 }
53 
59 {
60  /*
61  * We read only a few of the packets. This allows the GUI to update when
62  * a large set of servers is being received. Otherwise the interface
63  * "hangs" while the game is updating the server-list.
64  *
65  * What arbitrary number to choose is the ultimate question though.
66  */
67  std::unique_ptr<Packet> p;
68  static const int MAX_PACKETS_TO_RECEIVE = 42;
69  int i = MAX_PACKETS_TO_RECEIVE;
70  while (--i != 0 && (p = this->ReceivePacket()) != nullptr) {
71  bool cont = this->HandlePacket(*p);
72  if (!cont) return true;
73  }
74 
75  return i != MAX_PACKETS_TO_RECEIVE - 1;
76 }
77 
84 {
85  Debug(net, 0, "[tcp/coordinator] Received illegal packet type {}", type);
86  return false;
87 }
88 
virtual bool Receive_SERCLI_STUN_RESULT(Packet &p)
Client/server informs the Game Coordinator the result of a STUN request.
virtual bool Receive_CLIENT_LISTING(Packet &p)
Client requests a list of all public servers.
bool ReceiveInvalidPacket(PacketCoordinatorType type)
Helper for logging receiving invalid packets.
virtual bool Receive_GC_ERROR(Packet &p)
Game Coordinator indicates there was an error.
virtual bool Receive_CLIENT_CONNECTED(Packet &p)
Client informs the Game Coordinator the connection with the Server is established.
virtual bool Receive_GC_STUN_CONNECT(Packet &p)
Game Coordinator informs the client/server of its STUN peer (the host:ip of the other side).
virtual bool Receive_GC_NEWGRF_LOOKUP(Packet &p)
Game Coordinator informs the client of updates for the NewGRFs lookup table as used by the NewGRF des...
virtual bool Receive_GC_REGISTER_ACK(Packet &p)
Game Coordinator acknowledges the registration.
virtual bool Receive_GC_TURN_CONNECT(Packet &p)
Game Coordinator requests that we make a connection to the indicated peer, which is a TURN server.
virtual bool Receive_GC_LISTING(Packet &p)
Game Coordinator replies with a list of all public servers.
virtual bool Receive_GC_DIRECT_CONNECT(Packet &p)
Game Coordinator requests that the Client makes a direct connection to the indicated peer,...
virtual bool Receive_CLIENT_CONNECT(Packet &p)
Client wants to connect to a Server.
virtual bool Receive_SERCLI_CONNECT_FAILED(Packet &p)
Client or Server failed to connect to the remote side.
virtual bool Receive_GC_CONNECTING(Packet &p)
Game Coordinator informs the Client under what token it will start the attempt to connect the Server ...
virtual bool Receive_GC_STUN_REQUEST(Packet &p)
Game Coordinator requests the client/server to do a STUN request to the STUN server.
virtual bool Receive_SERVER_REGISTER(Packet &p)
Server is starting a multiplayer game and wants to let the Game Coordinator know.
virtual bool Receive_GC_CONNECT_FAILED(Packet &p)
Game Coordinator informs the Client that it failed to find a way to connect the Client to the Server.
bool HandlePacket(Packet &p)
Handle the given packet, i.e.
virtual bool Receive_SERVER_UPDATE(Packet &p)
Send an update of the current state of the server to the Game Coordinator.
bool ReceivePackets()
Receive a packet at TCP level.
virtual std::unique_ptr< Packet > ReceivePacket()
Receives a packet for the given client.
Definition: tcp.cpp:129
#define Debug(category, level, format_string,...)
Ouptut a line of debugging information.
Definition: debug.h:37
Internal entity of a packet.
Definition: packet.h:42
uint8_t Recv_uint8()
Read a 8 bits integer from the packet.
Definition: packet.cpp:318
Basic functions to receive and send TCP packets to/from the Game Coordinator server.
PacketCoordinatorType
Enum with all types of TCP Game Coordinator packets.
@ PACKET_COORDINATOR_GC_STUN_CONNECT
Game Coordinator tells client/server to connect() reusing the STUN local address.
@ PACKET_COORDINATOR_GC_LISTING
Game Coordinator returns a listing of all public servers.
@ PACKET_COORDINATOR_SERCLI_CONNECT_FAILED
Client/server tells the Game Coordinator the current connection attempt failed.
@ PACKET_COORDINATOR_GC_TURN_CONNECT
Game Coordinator tells client/server to connect to a specific TURN server.
@ PACKET_COORDINATOR_SERCLI_STUN_RESULT
Client/server informs the Game Coordinator of the result of the STUN request.
@ PACKET_COORDINATOR_CLIENT_LISTING
Client is requesting a listing of all public servers.
@ PACKET_COORDINATOR_GC_STUN_REQUEST
Game Coordinator tells client/server to initiate a STUN request.
@ PACKET_COORDINATOR_GC_DIRECT_CONNECT
Game Coordinator tells client to directly connect to the hostname:port of the server.
@ PACKET_COORDINATOR_GC_NEWGRF_LOOKUP
Game Coordinator informs client about NewGRF lookup table updates needed for GC_LISTING.
@ PACKET_COORDINATOR_SERVER_REGISTER
Server registration.
@ PACKET_COORDINATOR_GC_REGISTER_ACK
Game Coordinator accepts the registration.
@ PACKET_COORDINATOR_CLIENT_CONNECT
Client wants to connect to a server based on an invite code.
@ PACKET_COORDINATOR_GC_CONNECTING
Game Coordinator informs the client of the token assigned to the connection attempt.
@ PACKET_COORDINATOR_GC_ERROR
Game Coordinator indicates there was an error.
@ PACKET_COORDINATOR_CLIENT_CONNECTED
Client informs the Game Coordinator the connection with the server is established.
@ PACKET_COORDINATOR_GC_CONNECT_FAILED
Game Coordinator informs client/server it has given up on the connection attempt.
@ PACKET_COORDINATOR_SERVER_UPDATE
Server sends an set intervals an update of the server.