Class representing what the driver knows about a topology of MongoDB servers: either a standalone, a replica set, or a sharded cluster. More...

#include <topology_description.hpp>

Classes
class	server_descriptions
	An array of server_description instances. More...

Public Member Functions
	~topology_description ()
	Destroys a topology_description.

bsoncxx::stdx::string_view	type () const
	The topology type: "Unknown", "Sharded", "ReplicaSetNoPrimary", "ReplicaSetWithPrimary", or "Single". More...

bool	has_readable_server (const mongocxx::read_preference &pref) const
	Determines if the topology has a readable server available. More...

bool	has_writable_server () const
	Determines if the topology has a writable server available, such as a primary, mongos, or standalone. More...

server_descriptions	servers () const
	Fetches descriptions for all known servers in the topology. More...

Detailed Description

Class representing what the driver knows about a topology of MongoDB servers: either a standalone, a replica set, or a sharded cluster.

Member Function Documentation

◆ has_readable_server()

bool mongocxx::events::topology_description::has_readable_server ( const mongocxx::read_preference & pref ) const

Determines if the topology has a readable server available.

Servers are filtered by the given read preferences only if the driver is connected to a replica set, otherwise the read preferences are ignored. This function uses the driver's current knowledge of the state of the MongoDB server or servers it is connected to; it does no I/O.

Returns: Whether there is a readable server available.

◆ has_writable_server()

bool mongocxx::events::topology_description::has_writable_server ( ) const

Determines if the topology has a writable server available, such as a primary, mongos, or standalone.

This function uses the driver's current knowledge of the state of the MongoDB server or servers it is connected to; it does no I/O.

Returns: Whether there is a writable server available.

◆ servers()

server_descriptions mongocxx::events::topology_description::servers ( ) const

Fetches descriptions for all known servers in the topology.

Returns: An array of server_description objects.

◆ type()

bsoncxx::stdx::string_view mongocxx::events::topology_description::type ( ) const

The topology type: "Unknown", "Sharded", "ReplicaSetNoPrimary", "ReplicaSetWithPrimary", or "Single".

Returns: The type as a short-lived string view.

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

src/mongocxx/events/topology_description.hpp
src/mongocxx/read_preference.hpp