Home/ Manual/ driver / monitoring/ The MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent class

The MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent class

Guide Edit on GitHub ✎

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

Intro

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

Class synopsis

class MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent { }

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.

Serverheartbeatstartedevent

In this section

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

Source: reference/mongodb/mongodb/driver/monitoring/serverheartbeatstartedevent.xml · from the official PHP manual (php/doc-en)