The MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent class

(mongodb >=1.13.0)

はじめに

The MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent class encapsulates information about a failed server heartbeat (i.e. » hello command issued through » server monitoring).

クラス概要

final class MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent {
/* プロパティ */
public readonly string $host;
public readonly int $port;
public readonly bool $awaited;
public readonly int $duration;
public readonly Exception $error;
/* メソッド */
final public getDurationMicros(): int
final public getError(): Exception
final public getHost(): string
final public getPort(): int
final public isAwaited(): bool
}

プロパティ

host
The hostname of the server.
port
The port of the server.
awaited
Whether the heartbeat used a streaming protocol. The extension does not use the streaming protocol for monitoring, so this method will always return false.
duration
The duration of the heartbeat in microseconds. The duration is a calculated value that includes the time to send the message and receive the response from the server.
error
The exception that was thrown when the heartbeat failed.

変更履歴

バージョン 説明
PECL mongodb 2.3.0 Added public readonly properties. The duration property replaces the getDurationMicros() method.

目次