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 function getDurationMicros(): int
final public function getError(): Exception
final public function getHost(): string
final public function getPort(): int
final public function 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.

Зміст

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top