The MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent class

(mongodb >=1.13.0)

Introduction

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

Class synopsis

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 function getDurationMicros(): int

final public function getError(): Exception

final public function getHost(): string

final public function getPort(): int

final public function isAwaited(): bool

}

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.

MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getDurationMicros — Returns the heartbeat's duration in microseconds
MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getError — Returns the Exception associated with the failed heartbeat
MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getHost — Returns the hostname of the server
MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getPort — Returns the port on which this server is listening
MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::isAwaited — Returns whether the heartbeat used a streaming protocol

The MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent class

Introduction

Class synopsis

Properties

Changelog

Table of Contents