Open 3D Engine AzNetworking API Reference
2305.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
|
A class for managing a TCP listen socket and accepting new incoming connections. More...
#include <TcpListenThread.h>
Inherits AzNetworking::TimedThread.
Public Member Functions | |
bool | Listen (TcpNetworkInterface &tcpNetworkInterface) |
bool | StopListening (TcpNetworkInterface &tcpNetworkInterface) |
uint32_t | GetSocketCount () const |
AZ::TimeMs | GetUpdateTimeMs () const |
Public Member Functions inherited from AzNetworking::TimedThread | |
void | Start () |
Starts the thread. | |
void | Stop () |
Stops the thread. | |
void | Join () |
Joins the thread. | |
bool | IsRunning () const |
TimedThread (const char *name, AZ::TimeMs updateRate) | |
Additional Inherited Members |
A class for managing a TCP listen socket and accepting new incoming connections.
uint32_t AzNetworking::TcpListenThread::GetSocketCount | ( | ) | const |
Returns the number of active listen ports bound to this thread.
AZ::TimeMs AzNetworking::TcpListenThread::GetUpdateTimeMs | ( | ) | const |
Gets the total elapsed time spent updating the background thread in milliseconds
bool AzNetworking::TcpListenThread::Listen | ( | TcpNetworkInterface & | tcpNetworkInterface | ) |
Opens a new listen socket capable of accepting incoming connections for the provided TcpNetworkInterface.
tcpNetworkInterface | the TcpNetworkInterface being opened to incoming connections |
bool AzNetworking::TcpListenThread::StopListening | ( | TcpNetworkInterface & | tcpNetworkInterface | ) |
Stops listening for incoming connections for the provided TcpNetworkInterface.
tcpNetworkInterface | the TcpNetworkInterface being closed to new incoming connections |