OpenTTD Source 20241224-master-gf74b0cf984
TCPClientConnecter Class Reference

Non blocking connection create to actually connect to servers. More...

Inheritance diagram for TCPClientConnecter:
TCPServerConnecter TCPConnecter

Public Member Functions

 TCPClientConnecter (const std::string &connection_string)
 
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 TCPServerConnecter
 TCPServerConnecter (const std::string &connection_string, uint16_t default_port)
 Create a new connecter for the server.
 
void SetConnected (SOCKET sock)
 The connection was successfully established.
 
void SetFailure ()
 The connection couldn't be established.
 
- Public Member Functions inherited from TCPConnecter
 TCPConnecter (const std::string &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

std::string connection_string
 

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.
 
- Data Fields inherited from TCPServerConnecter
ServerAddress server_address
 Address we are connecting to.
 

Detailed Description

Non blocking connection create to actually connect to servers.

Definition at line 743 of file network.cpp.

Constructor & Destructor Documentation

◆ TCPClientConnecter()

TCPClientConnecter::TCPClientConnecter ( const std::string &  connection_string)
inline

Definition at line 748 of file network.cpp.

Member Function Documentation

◆ OnConnect()

void TCPClientConnecter::OnConnect ( SOCKET  s)
inlineoverridevirtual

Callback when the connection succeeded.

Parameters
sthe socket that we opened

Reimplemented from TCPConnecter.

Definition at line 757 of file network.cpp.

References _network_own_client_id, _networking, Debug, IConsoleCmdExec(), and NetworkClient_Connected().

◆ OnFailure()

void TCPClientConnecter::OnFailure ( )
inlineoverridevirtual

Callback for when the connection attempt failed.

Reimplemented from TCPConnecter.

Definition at line 750 of file network.cpp.

References Debug.

Field Documentation

◆ connection_string

std::string TCPClientConnecter::connection_string
private

Definition at line 745 of file network.cpp.


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