MongoDB C++ Driver  mongocxx-3.4.0
Public Member Functions | List of all members
mongocxx::events::topology_changed_event Class Reference

An event notification sent when the driver observes a change in any of the servers it is connected to or a change in the overall server topology. More...

#include <topology_changed_event.hpp>

Public Member Functions

 ~topology_changed_event ()
 Destroys a topology_changed_event.
 
bsoncxx::oid topology_id () const
 An opaque id, unique to this topology for this mongocxx::client or mongocxx::pool. More...
 
topology_description previous_description () const
 The server's description before it changed. More...
 
topology_description new_description () const
 The server's description after it changed. More...
 

Detailed Description

An event notification sent when the driver observes a change in any of the servers it is connected to or a change in the overall server topology.

See also
"TopologyDescriptionChangedEvent" in https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-discovery-and-monitoring-monitoring.rst

Member Function Documentation

◆ new_description()

topology_description mongocxx::events::topology_changed_event::new_description ( ) const

The server's description after it changed.

Returns
The topology_description.

◆ previous_description()

topology_description mongocxx::events::topology_changed_event::previous_description ( ) const

The server's description before it changed.

Returns
The topology_description.

◆ topology_id()

bsoncxx::oid mongocxx::events::topology_changed_event::topology_id ( ) const

An opaque id, unique to this topology for this mongocxx::client or mongocxx::pool.

Returns
The id.

The documentation for this class was generated from the following file: