internal helper implementation that manages basic details related to handling large numbers of TCP sockets efficiently.
More...
#include <TcpSocketManager.h>
|
using | SocketEventCallback = AZStd::function< void(SocketFd)> |
|
|
bool | AddSocket (SocketFd socketFd) |
|
bool | ClearSocket (SocketFd socketFd) |
|
void | ProcessEvents (AZ::TimeMs maxBlockMs, const SocketEventCallback &readCallback, const SocketEventCallback &writeCallback) |
|
internal helper implementation that manages basic details related to handling large numbers of TCP sockets efficiently.
◆ AddSocket()
bool AzNetworking::TcpSocketManager::AddSocket |
( |
SocketFd |
socketFd | ) |
|
Adds the provided socket to the internal socket management mechanism.
- Parameters
-
socketFd | the socket file descriptor to add |
- Returns
- boolean true on success, false otherwise
◆ ClearSocket()
bool AzNetworking::TcpSocketManager::ClearSocket |
( |
SocketFd |
socketFd | ) |
|
Removes the requested socket from the internal socket management mechanism.
- Parameters
-
socketFd | the socket file descriptor to remove |
- Returns
- boolean true on success, false otherwise
◆ ProcessEvents()
void AzNetworking::TcpSocketManager::ProcessEvents |
( |
AZ::TimeMs |
maxBlockMs, |
|
|
const SocketEventCallback & |
readCallback, |
|
|
const SocketEventCallback & |
writeCallback |
|
) |
| |
Processes any pending events for the set of sockets currently managed by this instance.
- Parameters
-
maxBlockMs | the maximum milliseconds to block while gathering events |
readCallback | functor to invoke if a socket has pending data to read |
writeCallback | functor to invoke if a socket is ready for writing |
The documentation for this class was generated from the following file:
- Code/Framework/AzNetworking/AzNetworking/TcpTransport/TcpSocketManager.h