OpenTTD Source 20250508-master-g6680169251
NetworkTurnConnecter Class Reference

Connect to the TURN server. More...

Inheritance diagram for NetworkTurnConnecter:
TCPConnecter

Public Member Functions

 NetworkTurnConnecter (ClientNetworkTurnSocketHandler *handler, std::string_view connection_string)
 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

ClientNetworkTurnSocketHandlerhandler
 

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 TURN server.

Definition at line 19 of file network_turn.cpp.

Constructor & Destructor Documentation

◆ NetworkTurnConnecter()

NetworkTurnConnecter::NetworkTurnConnecter ( ClientNetworkTurnSocketHandler handler,
std::string_view  connection_string 
)
inline

Initiate the connecting.

Parameters
connection_stringThe address of the TURN server.

Definition at line 28 of file network_turn.cpp.

Member Function Documentation

◆ OnConnect()

void NetworkTurnConnecter::OnConnect ( SOCKET  s)
inlineoverridevirtual

Callback when the connection succeeded.

Parameters
sthe socket that we opened

Reimplemented from TCPConnecter.

Definition at line 39 of file network_turn.cpp.

References ClientNetworkTurnSocketHandler::connecter, Debug, and NetworkTCPSocketHandler::sock.

◆ OnFailure()

void NetworkTurnConnecter::OnFailure ( )
inlineoverridevirtual

Callback for when the connection attempt failed.

Reimplemented from TCPConnecter.

Definition at line 30 of file network_turn.cpp.

References ClientNetworkTurnSocketHandler::connecter, and Debug.

Field Documentation

◆ handler

ClientNetworkTurnSocketHandler* NetworkTurnConnecter::handler
private

Definition at line 21 of file network_turn.cpp.


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