Open 3D Engine AzNetworking API Reference  2205.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
AzNetworking::ConnectionComputeRtt Class Reference

helper class used to compute round trip time to an connection. More...

#include <ConnectionMetrics.h>

Public Member Functions

void LogPacketSent (PacketId packetId, AZ::TimeMs currentTimeMs)
 
void LogPacketAcked (PacketId packetId, AZ::TimeMs currentTimeMs)
 
void LogPacketTimeout (PacketId packetId)
 
float GetRoundTripTimeSeconds () const
 

Detailed Description

helper class used to compute round trip time to an connection.

Member Function Documentation

◆ GetRoundTripTimeSeconds()

float AzNetworking::ConnectionComputeRtt::GetRoundTripTimeSeconds ( ) const
inline

Retrieve a sample of the computed round trip time for this connection.

Returns
estimated round trip time (ping) for the given connection in seconds

◆ LogPacketAcked()

void AzNetworking::ConnectionComputeRtt::LogPacketAcked ( PacketId  packetId,
AZ::TimeMs  currentTimeMs 
)

Invoked whenever traffic is acknowledged from the connection this instance is responsible for.

Parameters
packetIdidentifier of the packet being acked
currentTimeMscurrent process time in milliseconds

◆ LogPacketSent()

void AzNetworking::ConnectionComputeRtt::LogPacketSent ( PacketId  packetId,
AZ::TimeMs  currentTimeMs 
)

Invoked whenever traffic is sent through the connection this instance is responsible for.

Parameters
packetIdidentifier of the packet being sent
currentTimeMscurrent process time in milliseconds

◆ LogPacketTimeout()

void AzNetworking::ConnectionComputeRtt::LogPacketTimeout ( PacketId  packetId)

Invoked whenever traffic times out from the connection this instance is responsible for.

Parameters
packetIdidentifier of the packet timing out

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