Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Ping

Ping feature

The main purpose of a ping is to test, at a very basic level, the current network conditions that exist between the client session and the server it is connected to. The ping response includes the time taken to make a round-trip call to the server.

There are no permission requirements associated with this feature.

Hierarchy

Index

Methods

Methods

pingServer

  • Send a ping request to the server.

    Example:

    session.pingServer().then(function(pingDetails) {
        console.log("Round-trip call to server took: " + pingDetails.rtt + " milliseconds");
    });

    Returns Result<PingDetails>

    a result that completes when a response is received from the server.