Returns the latency of this server in milliseconds

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

### エラー / 例外

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

### 変更履歴

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

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open