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 getHost(): string
final public getNewDescription(): MongoDB\Driver\ServerDescription
final public getPort(): int
final public getPreviousDescription(): MongoDB\Driver\ServerDescription
final public 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.

Table of Contents