OpenTTD Source 20260206-master-g4d4e37dbf1
NetworkStunConnecter Class Reference

Connect to the STUN server. More...

Inheritance diagram for NetworkStunConnecter:
TCPConnecter

Public Member Functions

 NetworkStunConnecter (ClientNetworkStunSocketHandler *stun_handler, std::string_view connection_string, std::string_view token, uint8_t family)
 Initiate the connecting.
void OnFailure () override
 Callback for when the connection attempt failed.
void OnConnect (SOCKET s) override
 Callback when the connection succeeded.
Public Member Functions inherited from TCPConnecter
 TCPConnecter (std::string_view connection_string, uint16_t default_port, const NetworkAddress &bind_address={}, int family=AF_UNSPEC)
 Create a new connecter for the given address.
void Kill ()
 Kill this connecter.

Private Attributes

ClientNetworkStunSocketHandlerstun_handler
std::string token
uint8_t family

Additional Inherited Members

Static Public Member Functions inherited from TCPConnecter
static void CheckCallbacks ()
 Check whether we need to call the callback, i.e.
static void KillAll ()
 Kill all connection attempts.
template<class T, typename... Args>
static std::shared_ptr< TCPConnecterCreate (Args &&... args)
 Create the connecter, and initiate connecting by putting it in the collection of TCP connections to make.

Detailed Description

Connect to the STUN server.

Definition at line 19 of file network_stun.cpp.

Constructor & Destructor Documentation

◆ NetworkStunConnecter()

NetworkStunConnecter::NetworkStunConnecter ( ClientNetworkStunSocketHandler * stun_handler,
std::string_view connection_string,
std::string_view token,
uint8_t family )
inline

Initiate the connecting.

Parameters
stun_handlerThe handler for this request.
connection_stringThe address of the server.
tokenThe (server) token for the STUN action.
familyThe IP-family to connect with.

Definition at line 33 of file network_stun.cpp.

References TCPConnecter::connection_string, and NETWORK_STUN_SERVER_PORT.

Member Function Documentation

◆ OnConnect()

void NetworkStunConnecter::OnConnect ( SOCKET s)
inlineoverridevirtual

Callback when the connection succeeded.

Parameters
sthe socket that we opened

Reimplemented from TCPConnecter.

Definition at line 53 of file network_stun.cpp.

References ClientNetworkStunSocketHandler::connecter, Debug, NetworkAddress::GetSockAddress(), ClientNetworkStunSocketHandler::local_addr, and NetworkTCPSocketHandler::sock.

◆ OnFailure()

void NetworkStunConnecter::OnFailure ( )
inlineoverridevirtual

Callback for when the connection attempt failed.

Reimplemented from TCPConnecter.

Definition at line 41 of file network_stun.cpp.

References _network_coordinator_client, ClientNetworkStunSocketHandler::connecter, and Debug.

Field Documentation

◆ family

uint8_t NetworkStunConnecter::family
private

Definition at line 23 of file network_stun.cpp.

◆ stun_handler

ClientNetworkStunSocketHandler* NetworkStunConnecter::stun_handler
private

Definition at line 21 of file network_stun.cpp.

◆ token

std::string NetworkStunConnecter::token
private

Definition at line 22 of file network_stun.cpp.


The documentation for this class was generated from the following file: