OpenTTD Source 20260421-master-gc2fbc6fdeb
TCPQueryConnecter Class Reference

Non blocking connection to query servers for their game info. More...

Inheritance diagram for TCPQueryConnecter:
TCPServerConnecter TCPConnecter

Public Member Functions

 TCPQueryConnecter (std::string_view connection_string)
 Create the connecter.
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 (std::string_view 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 (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.
virtual ~TCPConnecter ()
 Wait until the resolving is done, then release the sockets.
void Kill ()
 Kill this connecter.

Private Attributes

std::string connection_string
 The address that this connecter is trying to query.

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 to query servers for their game info.

Definition at line 655 of file network.cpp.

Constructor & Destructor Documentation

◆ TCPQueryConnecter()

TCPQueryConnecter::TCPQueryConnecter ( std::string_view connection_string)
inline

Create the connecter.

Parameters
connection_stringThe address to connect to.

Definition at line 664 of file network.cpp.

References connection_string, NETWORK_DEFAULT_PORT, and TCPServerConnecter::TCPServerConnecter().

Member Function Documentation

◆ OnConnect()

void TCPQueryConnecter::OnConnect ( SOCKET s)
inlineoverridevirtual

Callback when the connection succeeded.

Parameters
sthe socket that we opened

Reimplemented from TCPConnecter.

Definition at line 677 of file network.cpp.

References Debug, and QueryNetworkGameSocketHandler::QueryServer().

◆ OnFailure()

void TCPQueryConnecter::OnFailure ( )
inlineoverridevirtual

Callback for when the connection attempt failed.

Reimplemented from TCPConnecter.

Definition at line 666 of file network.cpp.

References connection_string, Debug, NetworkGameListAddItem(), NGLS_OFFLINE, NetworkGame::refreshing, NetworkGame::status, and UpdateNetworkGameWindow().

Field Documentation

◆ connection_string

std::string TCPQueryConnecter::connection_string
private

The address that this connecter is trying to query.

Definition at line 657 of file network.cpp.

Referenced by OnFailure(), and TCPQueryConnecter().


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