MongoDB\Driver\Server::getLatency

Returns the latency of this server

Description

final public string MongoDB\Driver\Server::getLatency ( void )

Returns the latency of this server (i.e. the client's measured » round trip time of an ismaster command).

Parameters

This function has no parameters.

Return Values

Returns the latency of this server.

Errors/Exceptions

  • Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.

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