The MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent class

(mongodb >=1.13.0)

Introduction

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

Class synopsis

final class MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent {

/* Properties */

public readonly string $host;

public readonly int $port;

public readonly bool $awaited;

/* Methods */

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.

Changelog

Version	Description
PECL mongodb 2.3.0	Added public readonly properties.

MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent::getHost — Returns the hostname of the server
MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent::getPort — Returns the port on which this server is listening
MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent::isAwaited — Returns whether the heartbeat used a streaming protocol

The MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent class

Introduction

Class synopsis

Properties

Changelog

Table of Contents