Class representing MongoDB application performance monitoring. More...

#include <apm.hpp>

Public Member Functions
apm &	on_command_started (std::function< void(const mongocxx::events::command_started_event &)> command_started)
	Set the command started monitoring callback. More...

const std::function< void(const mongocxx::events::command_started_event &)> &	command_started () const
	Retrieves the command started monitoring callback. More...

apm &	on_command_failed (std::function< void(const mongocxx::events::command_failed_event &)> command_failed)
	Set the command failed monitoring callback. More...

const std::function< void(const mongocxx::events::command_failed_event &)> &	command_failed () const
	Retrieves the command failed monitoring callback. More...

apm &	on_command_succeeded (std::function< void(const mongocxx::events::command_succeeded_event &)> command_succeeded)
	Set the command succeeded monitoring callback. More...

const std::function< void(const mongocxx::events::command_succeeded_event &)> &	command_succeeded () const
	Retrieves the command succeeded monitoring callback. More...

apm &	on_server_opening (std::function< void(const mongocxx::events::server_opening_event &)> server_opening)
	Set the server opening monitoring callback. More...

const std::function< void(const mongocxx::events::server_opening_event &)> &	server_opening () const
	Retrieves the server opening monitoring callback. More...

apm &	on_server_closed (std::function< void(const mongocxx::events::server_closed_event &)> server_closed)
	Set the server closed monitoring callback. More...

const std::function< void(const mongocxx::events::server_closed_event &)> &	server_closed () const
	Retrieves the server closed monitoring callback. More...

apm &	on_server_changed (std::function< void(const mongocxx::events::server_changed_event &)> server_changed)
	Set the server description changed monitoring callback. More...

const std::function< void(const mongocxx::events::server_changed_event &)> &	server_changed () const
	Retrieves the server description changed monitoring callback. More...

apm &	on_topology_opening (std::function< void(const mongocxx::events::topology_opening_event &)> topology_opening)
	Set the topology_opening monitoring callback. More...

const std::function< void(const mongocxx::events::topology_opening_event &)> &	topology_opening () const
	Retrieves the topology_opening monitoring callback. More...

apm &	on_topology_closed (std::function< void(const mongocxx::events::topology_closed_event &)> topology_closed)
	Set the topology closed monitoring callback. More...

const std::function< void(const mongocxx::events::topology_closed_event &)> &	topology_closed () const
	Retrieves the topology closed monitoring callback. More...

apm &	on_topology_changed (std::function< void(const mongocxx::events::topology_changed_event &)> topology_changed)
	Set the topology description changed monitoring callback. More...

const std::function< void(const mongocxx::events::topology_changed_event &)> &	topology_changed () const
	Retrieves the topology description changed monitoring callback. More...

apm &	on_heartbeat_started (std::function< void(const mongocxx::events::heartbeat_started_event &)> heartbeat_started)
	Set the heartbeat started monitoring callback. More...

const std::function< void(const mongocxx::events::heartbeat_started_event &)> &	heartbeat_started () const
	Retrieves the heartbeat started monitoring callback. More...

apm &	on_heartbeat_failed (std::function< void(const mongocxx::events::heartbeat_failed_event &)> heartbeat_failed)
	Set the heartbeat failed monitoring callback. More...

const std::function< void(const mongocxx::events::heartbeat_failed_event &)> &	heartbeat_failed () const
	Retrieves the heartbeat failed monitoring callback. More...

apm &	on_heartbeat_succeeded (std::function< void(const mongocxx::events::heartbeat_succeeded_event &)> heartbeat_succeeded)
	Set the heartbeat succeeded monitoring callback. More...

const std::function< void(const mongocxx::events::heartbeat_succeeded_event &)> &	heartbeat_succeeded () const
	Retrieves the heartbeat succeeded monitoring callback. More...

Detailed Description

Class representing MongoDB application performance monitoring.

Member Function Documentation

◆ command_failed()

const std::function<void(const mongocxx::events::command_failed_event&)>& mongocxx::options::apm::command_failed ( ) const

Retrieves the command failed monitoring callback.

Returns: The command failed monitoring callback.

◆ command_started()

const std::function<void(const mongocxx::events::command_started_event&)>& mongocxx::options::apm::command_started ( ) const

Retrieves the command started monitoring callback.

Returns: The command started monitoring callback.

◆ command_succeeded()

const std::function<void(const mongocxx::events::command_succeeded_event&)>& mongocxx::options::apm::command_succeeded ( ) const

Retrieves the command succeeded monitoring callback.

Returns: The command succeeded monitoring callback.

◆ heartbeat_failed()

const std::function<void(const mongocxx::events::heartbeat_failed_event&)>& mongocxx::options::apm::heartbeat_failed ( ) const

Retrieves the heartbeat failed monitoring callback.

Returns: The heartbeat failed monitoring callback.

◆ heartbeat_started()

const std::function<void(const mongocxx::events::heartbeat_started_event&)>& mongocxx::options::apm::heartbeat_started ( ) const

Retrieves the heartbeat started monitoring callback.

Returns: The heartbeat started monitoring callback.

◆ heartbeat_succeeded()

const std::function<void(const mongocxx::events::heartbeat_succeeded_event&)>& mongocxx::options::apm::heartbeat_succeeded ( ) const

Retrieves the heartbeat succeeded monitoring callback.

Returns: The heartbeat succeeded monitoring callback.

◆ on_command_failed()

apm& mongocxx::options::apm::on_command_failed ( std::function< void(const mongocxx::events::command_failed_event &)> command_failed )

Set the command failed monitoring callback.

The callback takes a reference to a command_failed_event which will only contain valid data for the duration of the callback.

Parameters

command_failed The command failed monitoring callback.

Returns: A reference to the object on which this member function is being called. This facilitates method chaining.

◆ on_command_started()

apm& mongocxx::options::apm::on_command_started ( std::function< void(const mongocxx::events::command_started_event &)> command_started )

Set the command started monitoring callback.

The callback takes a reference to a command_started_event which will only contain valid data for the duration of the callback.

Parameters

command_started The command started monitoring callback.

Returns: A reference to the object on which this member function is being called. This facilitates method chaining.

◆ on_command_succeeded()

apm& mongocxx::options::apm::on_command_succeeded ( std::function< void(const mongocxx::events::command_succeeded_event &)> command_succeeded )

Set the command succeeded monitoring callback.

The callback takes a reference to a command_succeeded_event which will only contain valid data for the duration of the callback.

Parameters

command_succeeded The command succeeded monitoring callback.

Returns: A reference to the object on which this member function is being called. This facilitates method chaining.

◆ on_heartbeat_failed()

apm& mongocxx::options::apm::on_heartbeat_failed ( std::function< void(const mongocxx::events::heartbeat_failed_event &)> heartbeat_failed )

Set the heartbeat failed monitoring callback.

The callback takes a reference to a heartbeat_failed_event which will only contain valid data for the duration of the callback.

Parameters

heartbeat_failed The heartbeat failed monitoring callback.

Returns: A reference to the object on which this member function is being called. This facilitates method chaining.

◆ on_heartbeat_started()

apm& mongocxx::options::apm::on_heartbeat_started ( std::function< void(const mongocxx::events::heartbeat_started_event &)> heartbeat_started )

Set the heartbeat started monitoring callback.

The callback takes a reference to a heartbeat_started_event which will only contain valid data for the duration of the callback.

Parameters

heartbeat_started The heartbeat started monitoring callback.

Returns: A reference to the object on which this member function is being called. This facilitates method chaining.

◆ on_heartbeat_succeeded()

apm& mongocxx::options::apm::on_heartbeat_succeeded ( std::function< void(const mongocxx::events::heartbeat_succeeded_event &)> heartbeat_succeeded )

Set the heartbeat succeeded monitoring callback.

The callback takes a reference to a heartbeat_succeeded_event which will only contain valid data for the duration of the callback.

Parameters

heartbeat_succeeded The heartbeat succeeded monitoring callback.

Returns: A reference to the object on which this member function is being called. This facilitates method chaining.

◆ on_server_changed()

apm& mongocxx::options::apm::on_server_changed ( std::function< void(const mongocxx::events::server_changed_event &)> server_changed )

Set the server description changed monitoring callback.

The callback takes a reference to a server_changed_event which will only contain valid data for the duration of the callback.

Parameters

server_changed The server description changed monitoring callback.

Returns: A reference to the object on which this member function is being called. This facilitates method chaining.

◆ on_server_closed()

apm& mongocxx::options::apm::on_server_closed ( std::function< void(const mongocxx::events::server_closed_event &)> server_closed )

Set the server closed monitoring callback.

The callback takes a reference to a server_closed_event which will only contain valid data for the duration of the callback.

Parameters

server_closed The server closed monitoring callback.

Returns: A reference to the object on which this member function is being called. This facilitates method chaining.

◆ on_server_opening()

apm& mongocxx::options::apm::on_server_opening ( std::function< void(const mongocxx::events::server_opening_event &)> server_opening )

Set the server opening monitoring callback.

The callback takes a reference to a server_opening_event which will only contain valid data for the duration of the callback.

Parameters

server_opening The server opening monitoring callback.

Returns: A reference to the object on which this member function is being called. This facilitates method chaining.

◆ on_topology_changed()

apm& mongocxx::options::apm::on_topology_changed ( std::function< void(const mongocxx::events::topology_changed_event &)> topology_changed )

Set the topology description changed monitoring callback.

The callback takes a reference to a topology_changed_event which will only contain valid data for the duration of the callback.

Parameters

topology_changed The topology description changed monitoring callback.

Returns: A reference to the object on which this member function is being called. This facilitates method chaining.

◆ on_topology_closed()

apm& mongocxx::options::apm::on_topology_closed ( std::function< void(const mongocxx::events::topology_closed_event &)> topology_closed )

Set the topology closed monitoring callback.

The callback takes a reference to a topology_closed_event which will only contain valid data for the duration of the callback.

Parameters

topology_closed The topology closed monitoring callback.

Returns: A reference to the object on which this member function is being called. This facilitates method chaining.

◆ on_topology_opening()

apm& mongocxx::options::apm::on_topology_opening ( std::function< void(const mongocxx::events::topology_opening_event &)> topology_opening )

Set the topology_opening monitoring callback.

The callback takes a reference to a topology_opening_event which will only contain valid data for the duration of the callback.

Parameters

topology_opening The topology_opening monitoring callback.

Returns: A reference to the object on which this member function is being called. This facilitates method chaining.

◆ server_changed()

const std::function<void(const mongocxx::events::server_changed_event&)>& mongocxx::options::apm::server_changed ( ) const

Retrieves the server description changed monitoring callback.

Returns: The server description changed monitoring callback.

◆ server_closed()

const std::function<void(const mongocxx::events::server_closed_event&)>& mongocxx::options::apm::server_closed ( ) const

Retrieves the server closed monitoring callback.

Returns: The server closed monitoring callback.

◆ server_opening()

const std::function<void(const mongocxx::events::server_opening_event&)>& mongocxx::options::apm::server_opening ( ) const

Retrieves the server opening monitoring callback.

Returns: The server opening monitoring callback.

◆ topology_changed()

const std::function<void(const mongocxx::events::topology_changed_event&)>& mongocxx::options::apm::topology_changed ( ) const

Retrieves the topology description changed monitoring callback.

Returns: The topology description changed monitoring callback.

◆ topology_closed()

const std::function<void(const mongocxx::events::topology_closed_event&)>& mongocxx::options::apm::topology_closed ( ) const

Retrieves the topology closed monitoring callback.

Returns: The topology closed monitoring callback.

◆ topology_opening()

const std::function<void(const mongocxx::events::topology_opening_event&)>& mongocxx::options::apm::topology_opening ( ) const

Retrieves the topology_opening monitoring callback.

Returns: The topology_opening monitoring callback.

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

src/mongocxx/options/apm.hpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ command_failed()

◆ command_started()

◆ command_succeeded()

◆ heartbeat_failed()

◆ heartbeat_started()

◆ heartbeat_succeeded()

◆ on_command_failed()

◆ on_command_started()

◆ on_command_succeeded()

◆ on_heartbeat_failed()

◆ on_heartbeat_started()

◆ on_heartbeat_succeeded()

◆ on_server_changed()

◆ on_server_closed()

◆ on_server_opening()

◆ on_topology_changed()

◆ on_topology_closed()

◆ on_topology_opening()

◆ server_changed()

◆ server_closed()

◆ server_opening()

◆ topology_changed()

◆ topology_closed()

◆ topology_opening()