LagValue

Represents the latency between client and server in a round-robin fashion (client sends 'ping', server replies with 'pong', lag is the elapsed time between the two events).


A LagValue is received through the SFSEvent.PING_PONG event.

Members

(readonly) average :number

The average value of the last ten measured lag values, expressed in milliseconds.
Type:
  • number

(readonly) maximum :number

The maximum lag value measured during the current lag monitoring session, expressed in milliseconds.
Type:
  • number

(readonly) minimum :number

The minimum lag value measured during the current lag monitoring session, expressed in milliseconds.
Type:
  • number

Methods

toString() → {string}

Returns a string containing the average, minimum and maximum lag values, rounded to two decimals.
Returns:
The string representation of the LagValue object.
Type: 
string