mirror of
https://gitea.wildfiregames.com/0ad/0ad
synced 2026-06-16 05:13:58 -07:00
05afbf1805
The synchronous client-side SendHolePunchingMessages and the server worker each implemented the fw_punch config reading, the target resolution and the message pacing. Move them to a StunClient::HolePuncher class which sends due messages without blocking, and express the blocking client-side variant as a loop over it. The single-message StunClient::SendHolePunchingMessage is no longer needed. As a side effect, the client no longer sleeps for fw_punch.delay after the last message, and skips sending if the server address cannot be resolved instead of punching an unresolvable address. Requested by Phosit in the review of #8977.
98 lines
3 KiB
C++
98 lines
3 KiB
C++
/* Copyright (C) 2026 Wildfire Games.
|
|
* Copyright (C) 2013-2016 SuperTuxKart-Team.
|
|
* This file is part of 0 A.D.
|
|
*
|
|
* 0 A.D. 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, either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* 0 A.D. 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. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef STUNCLIENT_H
|
|
#define STUNCLIENT_H
|
|
|
|
#include "lib/external_libraries/enet.h"
|
|
#include "lib/types.h"
|
|
|
|
#include <chrono>
|
|
#include <optional>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
class CStr8;
|
|
|
|
typedef struct _ENetHost ENetHost;
|
|
|
|
namespace StunClient
|
|
{
|
|
/**
|
|
* Return the publicly accessible IP of the given ENet host/socket.
|
|
* This is done by contacting STUN server.
|
|
* The return IP & port should only be considered valid for the give host/socket.
|
|
*/
|
|
bool FindPublicIP(ENetHost& enetClient, CStr8& ip, u16& port);
|
|
|
|
/**
|
|
* Send a message to the target server with the given ENet host/socket.
|
|
* This will open a port on the local gateway (if any) to receive trafic,
|
|
* allowing the recipient to answer (thus 'punching a hole' in the NAT).
|
|
* NB: this assumes consistent NAT, i.e. the outgoing port is always the same for the given client,
|
|
* thus allowing the IP discovered via STUN to be sent to the target server.
|
|
*/
|
|
void SendHolePunchingMessages(ENetHost& enetClient, const std::string& serverAddress, u16 serverPort);
|
|
|
|
/**
|
|
* Sends hole punching messages (@see SendHolePunchingMessages) to any number
|
|
* of targets without blocking: each call to Tick sends the messages that are
|
|
* due and returns when the next one is. Not thread-safe.
|
|
*/
|
|
class HolePuncher
|
|
{
|
|
public:
|
|
/**
|
|
* Resolve the target and schedule lobby.fw_punch.num_msg messages to it
|
|
* (a negative number meaning until RemoveTarget is called).
|
|
* @return whether messages were scheduled.
|
|
*/
|
|
bool AddTarget(const std::string& address, u16 port);
|
|
|
|
/**
|
|
* Stop sending messages to the target, e.g. because it connected.
|
|
*/
|
|
void RemoveTarget(const ENetAddress& address);
|
|
|
|
/**
|
|
* Send all due messages from the given ENet host/socket.
|
|
* @return the time the next message is due, or std::nullopt if no
|
|
* messages remain to be sent.
|
|
*/
|
|
std::optional<std::chrono::steady_clock::time_point> Tick(ENetHost& enetClient);
|
|
|
|
private:
|
|
struct Target
|
|
{
|
|
ENetAddress address;
|
|
/// A negative number means sending until RemoveTarget is called.
|
|
int remainingMessages;
|
|
std::chrono::steady_clock::time_point nextSendTime;
|
|
};
|
|
|
|
std::vector<Target> m_Targets;
|
|
};
|
|
|
|
/**
|
|
* Return the local IP.
|
|
* Technically not a STUN method, but convenient to define here.
|
|
*/
|
|
bool FindLocalIP(CStr8& ip);
|
|
}
|
|
|
|
#endif // STUNCLIENT_H
|