interface class for managing a set of connections. More...
#include <IConnectionSet.h>
Inherited by AzNetworking::TcpConnectionSet, and AzNetworking::UdpConnectionSet.
Public Types | |
using | ConnectionVisitor = AZStd::function< void(IConnection &)> |
Public Member Functions | |
virtual void | VisitConnections (const ConnectionVisitor &visitor)=0 |
virtual bool | DeleteConnection (ConnectionId connectionId)=0 |
virtual IConnection * | GetConnection (ConnectionId connectionId) const =0 |
virtual ConnectionId | GetNextConnectionId ()=0 |
virtual uint32_t | GetConnectionCount () const =0 |
virtual uint32_t | GetActiveConnectionCount () const =0 |
interface class for managing a set of connections.
IConnectionSet defines a simple interface for working with an abstract set of IConnections bound to an INetworkInterface. Generally users of AzNetworking will not have reason to interact directly with the IConnectionSet, as its interface is completely wrapped by INetworkInterface.
|
pure virtual |
Deletes a connection from this connection list instance by connection identifier.
connectionId | connection identifier of the connection to delete |
Implemented in AzNetworking::TcpConnectionSet, and AzNetworking::UdpConnectionSet.
|
pure virtual |
Returns the current total count of connections not pending disconnect for this connection set
Implemented in AzNetworking::TcpConnectionSet, and AzNetworking::UdpConnectionSet.
|
pure virtual |
Retrieves a connection from this connection set by connection identifier.
connectionId | connection identifier of the connection to retrieve |
Implemented in AzNetworking::TcpConnectionSet, and AzNetworking::UdpConnectionSet.
|
pure virtual |
Returns the current total connection count for this connection set
Implemented in AzNetworking::TcpConnectionSet, and AzNetworking::UdpConnectionSet.
|
pure virtual |
Returns the next valid connection identifier for this connection list instance.
Implemented in AzNetworking::TcpConnectionSet, and AzNetworking::UdpConnectionSet.
|
pure virtual |
Will visit each active connection in the connection set and invoke the provided connection visitor.
visitor | the visitor to visit each connection with |
Implemented in AzNetworking::TcpConnectionSet, and AzNetworking::UdpConnectionSet.