MongoDB\Driver\Monitoring
PHP Manual

The MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent class

Introduction

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

Class synopsis

MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent
final class MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent {
/* Properties */
public readonly string $host;
public readonly int $port;
public readonly bool $awaited;
public readonly int $duration;
public readonly Exception $error;
/* Methods */
final public int getDurationMicros()
final public Exception getError()
final public string getHost()
final public int getPort()
final public bool isAwaited()
}

Properties

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.

Changelog

Version Description
PECL mongodb 2.3.0 Added public readonly properties. The duration property replaces the getDurationMicros method.
Table of Contents