Public Member Functions | |
| TCPServerConnecter (const std::string &connection_string, uint16_t 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_t default_port, const NetworkAddress &bind_address={}, int family=AF_UNSPEC) | |
| Create a new connecter for the given address. More... | |
| virtual void | OnConnect ([[maybe_unused]] 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. | |
| template<class T , typename... Args> | |
| static std::shared_ptr< TCPConnecter > | Create (Args &&... args) |
| Create the connecter, and initiate connecting by putting it in the collection of TCP connections to make. More... | |
Detailed Description
Constructor & Destructor Documentation
◆ TCPServerConnecter()
| TCPServerConnecter::TCPServerConnecter | ( | const std::string & | connection_string, |
| uint16_t | default_port | ||
| ) |
Create a new connecter for the server.
- Parameters
-
connection_string The address to connect to. default_port If not indicated in connection_string, what port to use.
Definition at line 41 of file tcp_connect.cpp.
References TCPServerConnecter().
Referenced by TCPServerConnecter().
Member Function Documentation
◆ CheckActivity()
|
overrideprivatevirtual |
Check if there was activity for this connecter.
- Returns
- True iff the TCPConnecter is done and can be cleaned up.
Reimplemented from TCPConnecter.
Definition at line 406 of file tcp_connect.cpp.
References TCPConnecter::CheckActivity(), TCPConnecter::Connected, TCPConnecter::Failure, TCPConnecter::killed, TCPConnecter::OnConnect(), TCPConnecter::OnFailure(), server_address, SERVER_ADDRESS_DIRECT, SERVER_ADDRESS_INVITE_CODE, socket, TCPConnecter::status, and ServerAddress::type.
◆ 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
-
sock The socket of the established connection.
Definition at line 441 of file tcp_connect.cpp.
References TCPConnecter::Connected, socket, and TCPConnecter::status.
The documentation for this class was generated from the following files:
- src/network/core/tcp.h
- src/network/core/tcp_connect.cpp
