« MongoDB\Driver\Server::getInfo
MongoDB\Driver\Server::getPort »

MongoDB\Driver\Server::getLatency

(mongodb >=1.0.0)

MongoDB\Driver\Server::getLatency — Returns the latency of this server in milliseconds

説明

final public function MongoDB\Driver\Server::getLatency(): ?integer

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).

エラー / 例外

変更履歴

バージョン 説明
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.

例

例1 MongoDB\Driver\Server::getLatency() example

<?php

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

var_dump($server->getLatency());

?>

上の例の出力は、 たとえば以下のようになります。

int(592)

参考

関連キーワード:
MongoDB   Driver   server   Server   latency   milliseconds   getLatency   mongodb   measured   getInfo   integer   client   round   trip   time   manager   getPort   final   hello   command   connected   load balancer   Throws   Exception   InvalidArgumentException
関連する関数・ページ:
mongodb-driver-server.gethost   mongodb-driver-server.getport   mongodb-driver-server.getinfo   mongodb-driver-serverdescription.getroundtriptime   mongodb-driver-server.getserverdescription   mongodb-driver-server.gettype