MongoDB\Driver\Server::getLatency
(mongodb >=1.0.0)
MongoDB\Driver\Server::getLatency — Returns the latency of this server in milliseconds
Description
Returns the latency of this server in milliseconds. This is the client's
measured
» round trip time
of a hello command.
Parameters
This function has no parameters.
Return Values
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).
Errors/Exceptions
- Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.
Changelog
| 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.
|
Examples
Example #1 MongoDB\Driver\Server::getLatency() example
<?php
$manager = new MongoDB\Driver\Manager("mongodb://localhost:27017/");
$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_PRIMARY);
$server = $manager->selectServer($rp);
var_dump($server->getLatency());
?>The above example will output something similar to:
int(592)
See Also
- MongoDB\Driver\Server::getInfo() - Returns an array of information describing this server
- MongoDB\Driver\ServerDescription::getRoundTripTime() - Returns the server's round trip time in milliseconds
- » Server Discovery and Monitoring Specification
add a note
User Contributed Notes
There are no user contributed notes for this page.
