ServerPingSite Interface Reference

Inheritance diagram for ServerPingSite:

Public Member Functions
proto external string	GetId ()
	Returns unique ID of this site.
proto external string	GetName ()
	Returns prettified name of this site.
proto external bool	IsReady ()
	Returns true if this site was already measured and has usable metrics available.
proto external int	GetMinRTT ()
	Returns min measured Round-Trip Time of ping in ms.
proto external int	GetAvgRTT ()
	Returns average measured Round-Trip Time of ping in ms.
proto external int	GetMaxRTT ()
	Returns max measured Round-Trip Time of ping in ms.
Public Member Functions inherited from Managed
proto external ref Managed	Clone ()
	Return shallow copy of object, or null if it is not allowed (not public constructor)

Member Function Documentation

GetAvgRTT()

proto external int ServerPingSite.GetAvgRTT

(

)

Returns average measured Round-Trip Time of ping in ms.

Note

Returns -1 when measurement is not ready yet.

GetId()

proto external string ServerPingSite.GetId

(

)

Returns unique ID of this site.

GetMaxRTT()

proto external int ServerPingSite.GetMaxRTT

(

)

Returns max measured Round-Trip Time of ping in ms.

Note

Returns -1 when measurement is not ready yet.

GetMinRTT()

proto external int ServerPingSite.GetMinRTT

(

)

Returns min measured Round-Trip Time of ping in ms.

Note

Returns -1 when measurement is not ready yet.

GetName()

proto external string ServerPingSite.GetName

(

)

Returns prettified name of this site.

Note

This can possibly return localization key which could be used to show name in UI and proper language preference.

IsReady()

proto external bool ServerPingSite.IsReady

(

)

Returns true if this site was already measured and has usable metrics available.

---

The documentation for this interface was generated from the following file:

• GameLib/generated/online/server/ServerPingSite.c