The MongoDB\Driver\Monitoring\TopologyChangedEvent class

(mongodb >=1.13.0)

Introduction

The MongoDB\Driver\Monitoring\TopologyChangedEvent class encapsulates information about a changed topology description. For example, a topology discovering a new replica set primary would cause its topology description to change.

Class synopsis

final class MongoDB\Driver\Monitoring\TopologyChangedEvent {

/* Properties */

public readonly MongoDB\BSON\ObjectId $topologyId;

public readonly MongoDB\Driver\TopologyDescription $newDescription;

public readonly MongoDB\Driver\TopologyDescription $previousDescription;

/* Methods */

final public function getNewDescription(): MongoDB\Driver\TopologyDescription

final public function getPreviousDescription(): MongoDB\Driver\TopologyDescription

final public function getTopologyId(): MongoDB\BSON\ObjectId

}

Properties

topologyId: The topology ID.
newDescription: The new topology description.
previousDescription: The previous topology description.

Changelog

Version	Description
PECL mongodb 2.3.0	Added public readonly properties.

MongoDB\Driver\Monitoring\TopologyChangedEvent::getNewDescription — Returns the new description for the topology
MongoDB\Driver\Monitoring\TopologyChangedEvent::getPreviousDescription — Returns the previous description for the topology
MongoDB\Driver\Monitoring\TopologyChangedEvent::getTopologyId — Returns the topology ID

The MongoDB\Driver\Monitoring\TopologyChangedEvent class

Introduction

Class synopsis

Properties

Changelog

Table of Contents