Home/ Manual/ driver / server/ MongoDB\Driver\Server::getLatency

MongoDB\Driver\Server::getLatency

PHP function Edit on GitHub ✎

(mongodb >=1.0.0)

Returns the latency of this server in milliseconds

Description

MongoDB\Driver\Server::getLatency(): integer|null

Returns the latency of this server in milliseconds. This is the client's measured round trip time of a hello command.

Returns the latency of this server in milliseconds, or null if no latency has been measured (e.g. client is connected to a load balancer).

Version	Description
PECL mongodb 1.11.0	This method will return null if no latency has been measured. In earlier versions, an integer was always returned and an unset value might be reported as `-1`.

php

<?php

$manager = new MongoDB\Driver\Manager("mongodb://localhost:27017/");
$server = $manager->selectServer();

var_dump($server->getLatency());

?>

The above example will output something similar to:

output

int(592)