The MongoDB\Driver\Monitoring\ServerChangedEvent class

(mongodb >=1.13.0)

Introduction

The MongoDB\Driver\Monitoring\ServerChangedEvent class encapsulates information about a changed server description. For example, a server's type changing from secondary to primary would cause its server description to change.

Class synopsis

final class MongoDB\Driver\Monitoring\ServerChangedEvent {

/* Properties */

public readonly string $host;

public readonly int $port;

public readonly MongoDB\BSON\ObjectId $topologyId;

public readonly MongoDB\Driver\ServerDescription $newDescription;

public readonly MongoDB\Driver\ServerDescription $previousDescription;

/* Methods */

final public function getHost(): string

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

final public function getPort(): int

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

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

}

Properties

host: The hostname of the server.
port: The port of the server.
topologyId: The topology ID.
newDescription: The new server description.
previousDescription: The previous server description.

Changelog

Version	Description
PECL mongodb 2.3.0	Added public readonly properties.

MongoDB\Driver\Monitoring\ServerChangedEvent::getHost — Returns the hostname of the server
MongoDB\Driver\Monitoring\ServerChangedEvent::getNewDescription — Returns the new description for the server
MongoDB\Driver\Monitoring\ServerChangedEvent::getPort — Returns the port on which this server is listening
MongoDB\Driver\Monitoring\ServerChangedEvent::getPreviousDescription — Returns the previous description for the server
MongoDB\Driver\Monitoring\ServerChangedEvent::getTopologyId — Returns the topology ID associated with this server

The MongoDB\Driver\Monitoring\ServerChangedEvent class

Introduction

Class synopsis

Properties

Changelog

Table of Contents