OpenTTD Source 20260109-master-g241b5fcdfe
tcp_turn.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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
10#include "../../stdafx.h"
11#include "../../timer/timer_game_calendar.h"
12#include "../../debug.h"
13#include "tcp_turn.h"
14
15#include "../../safeguards.h"
16
24{
26
27 switch (type) {
28 case PACKET_TURN_TURN_ERROR: return this->Receive_TURN_ERROR(p);
31
32 default:
33 Debug(net, 0, "[tcp/turn] Received invalid packet type {}", type);
34 return false;
35 }
36}
37
43{
44 std::unique_ptr<Packet> p;
45 static const int MAX_PACKETS_TO_RECEIVE = 4;
46 int i = MAX_PACKETS_TO_RECEIVE;
47 while (--i != 0 && (p = this->ReceivePacket()) != nullptr) {
48 bool cont = this->HandlePacket(*p);
49 if (!cont) return true;
50 }
51
52 return i != MAX_PACKETS_TO_RECEIVE - 1;
53}
54
61{
62 Debug(net, 0, "[tcp/turn] Received illegal packet type {}", type);
63 return false;
64}
65
virtual std::unique_ptr< Packet > ReceivePacket()
Receives a packet for the given client.
Definition tcp.cpp:117
virtual bool Receive_SERCLI_CONNECT(Packet &p)
Client or servers wants to connect to the TURN server (on request by the Game Coordinator).
Definition tcp_turn.cpp:67
bool ReceivePackets()
Receive a packet at TCP level.
Definition tcp_turn.cpp:42
virtual bool Receive_TURN_CONNECTED(Packet &p)
TURN server has connected client and server together and will now relay all packets to each other.
Definition tcp_turn.cpp:68
virtual bool Receive_TURN_ERROR(Packet &p)
TURN server was unable to connect the client or server based on the token.
Definition tcp_turn.cpp:66
bool ReceiveInvalidPacket(PacketTurnType type)
Helper for logging receiving invalid packets.
Definition tcp_turn.cpp:60
bool HandlePacket(Packet &p)
Handle the given packet, i.e.
Definition tcp_turn.cpp:23
#define Debug(category, level, format_string,...)
Output a line of debugging information.
Definition debug.h:37
Internal entity of a packet.
Definition packet.h:41
uint8_t Recv_uint8()
Read a 8 bits integer from the packet.
Definition packet.cpp:316
Basic functions to receive and send TCP packets to/from the TURN server.
PacketTurnType
Enum with all types of TCP TURN packets.
Definition tcp_turn.h:19
@ PACKET_TURN_TURN_CONNECTED
TURN server indicates the socket is now being relayed.
Definition tcp_turn.h:22
@ PACKET_TURN_SERCLI_CONNECT
Client or server is connecting to the TURN server.
Definition tcp_turn.h:21
@ PACKET_TURN_TURN_ERROR
TURN server is unable to relay.
Definition tcp_turn.h:20