OpenTTD Source  12.0-beta2
TCPServerConnecter Class Reference
Inheritance diagram for TCPServerConnecter:
TCPConnecter TCPClientConnecter TCPQueryConnecter

Public Member Functions

 TCPServerConnecter (const std::string &connection_string, uint16 default_port)
 Create a new connecter for the server. More...
 
void SetConnected (SOCKET sock)
 The connection was successfully established. More...
 
void SetFailure ()
 The connection couldn't be established.
 
- Public Member Functions inherited from TCPConnecter
 TCPConnecter (const std::string &connection_string, uint16 default_port, NetworkAddress bind_address={}, int family=AF_UNSPEC)
 Create a new connecter for the given address. More...
 
virtual void OnConnect (SOCKET s)
 Callback when the connection succeeded. More...
 
virtual void OnFailure ()
 Callback for when the connection attempt failed.
 
void Kill ()
 Kill this connecter. More...
 

Data Fields

ServerAddress server_address
 Address we are connecting to.
 

Private Member Functions

bool CheckActivity () override
 Check if there was activity for this connecter. More...
 

Private Attributes

SOCKET socket = INVALID_SOCKET
 The socket when a connection is established.
 

Additional Inherited Members

- Static Public Member Functions inherited from TCPConnecter
static void CheckCallbacks ()
 Check whether we need to call the callback, i.e. More...
 
static void KillAll ()
 Kill all connection attempts.
 

Detailed Description

Definition at line 138 of file tcp.h.

Constructor & Destructor Documentation

◆ TCPServerConnecter()

TCPServerConnecter::TCPServerConnecter ( const std::string &  connection_string,
uint16  default_port 
)

Create a new connecter for the server.

Parameters
connection_stringThe address to connect to.
default_portIf not indicated in connection_string, what port to use.

Definition at line 46 of file tcp_connect.cpp.

References _network_coordinator_client, TCPConnecter::CONNECTING, ServerAddress::connection_string, ClientNetworkCoordinatorSocketHandler::ConnectToServer(), server_address, SERVER_ADDRESS_DIRECT, SERVER_ADDRESS_INVITE_CODE, TCPConnecter::status, TCPServerConnecter(), and ServerAddress::type.

Referenced by TCPServerConnecter().

Member Function Documentation

◆ CheckActivity()

bool TCPServerConnecter::CheckActivity ( )
overrideprivatevirtual

◆ SetConnected()

void TCPServerConnecter::SetConnected ( SOCKET  sock)

The connection was successfully established.

This socket is fully setup and ready to send/recv game protocol packets.

Parameters
sockThe socket of the established connection.

Definition at line 448 of file tcp_connect.cpp.

References TCPConnecter::CONNECTED, socket, and TCPConnecter::status.


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