The MongoDB\Driver\Monitoring\SDAMSubscriber interface

(mongodb >=1.13.0)

Introduction

Classes may implement this interface to register an event subscriber that is notified for various SDAM events. See the » Server Discovery and Monitoring and » SDAM Monitoring specifications for additional information.

Interface synopsis

class MongoDB\Driver\Monitoring\SDAMSubscriber implements MongoDB\Driver\Monitoring\Subscriber {

/* Methods */

abstract public function serverChanged(MongoDB\Driver\Monitoring\ServerChangedEvent $event): void

abstract public function serverClosed(MongoDB\Driver\Monitoring\ServerClosedEvent $event): void

abstract public function serverHeartbeatFailed(MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent $event): void

abstract public function serverHeartbeatStarted(MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent $event): void

abstract public function serverHeartbeatSucceeded(MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent $event): void

abstract public function serverOpening(MongoDB\Driver\Monitoring\ServerOpeningEvent $event): void

abstract public function topologyChanged(MongoDB\Driver\Monitoring\TopologyChangedEvent $event): void

abstract public function topologyClosed(MongoDB\Driver\Monitoring\TopologyClosedEvent $event): void

abstract public function topologyOpening(MongoDB\Driver\Monitoring\TopologyOpeningEvent $event): void

}

Changelog

Version	Description
PECL mongodb 2.0.0	Return types previously declared as tentative are now enforced.
PECL mongodb 1.15.0	Return types for methods are declared as tentative on PHP 8.0 and newer, triggering deprecation notices in code that implements this interface without declaring the appropriate return types. The `#[ReturnTypeWillChange]` attribute can be added to silence the deprecation notice.

MongoDB\Driver\Monitoring\SDAMSubscriber::serverChanged — Notification method for a server description change
MongoDB\Driver\Monitoring\SDAMSubscriber::serverClosed — Notification method for closing a server
MongoDB\Driver\Monitoring\SDAMSubscriber::serverHeartbeatFailed — Notification method for a failed server heartbeat
MongoDB\Driver\Monitoring\SDAMSubscriber::serverHeartbeatStarted — Notification method for a started server heartbeat
MongoDB\Driver\Monitoring\SDAMSubscriber::serverHeartbeatSucceeded — Notification method for a successful server heartbeat
MongoDB\Driver\Monitoring\SDAMSubscriber::serverOpening — Notification method for opening a server
MongoDB\Driver\Monitoring\SDAMSubscriber::topologyChanged — Notification method for a topology description change
MongoDB\Driver\Monitoring\SDAMSubscriber::topologyClosed — Notification method for closing the topology
MongoDB\Driver\Monitoring\SDAMSubscriber::topologyOpening — Notification method for opening the topology

The MongoDB\Driver\Monitoring\SDAMSubscriber interface

Introduction

Interface synopsis

Changelog

Table of Contents