mongocxx::events::heartbeat_failed_event Class Reference

#include <mongocxx/v_noabi/mongocxx/events/heartbeat_failed_event.hpp>

Description

The failed execution of a heartbeat ("hello") command.

See also

• SDAM Logging and Monitoring Specification (MongoDB Specifications)

Public Member Functions
	heartbeat_failed_event (v1::events::server_heartbeat_failed const &event)
	Construct with the mongocxx::v1 equivalent.
	heartbeat_failed_event (void const *event)
bool	awaited () const
	Returns a boolean indicating whether this heartbeat event is from an awaitable hello.
std::int64_t	duration () const
	Returns the duration of the failed operation.
bsoncxx::v_noabi::stdx::string_view	host () const
	Returns the host name.
std::string	message () const
	Returns the failed operation's error message.
	operator v1::events::server_heartbeat_failed () const
	Convert to the mongocxx::v1 equivalent.
std::uint16_t	port () const
	Returns the port.

Constructor & Destructor Documentation

heartbeat_failed_event() [1/2]

mongocxx::v_noabi::events::heartbeat_failed_event::heartbeat_failed_event ( void const * event )

explicit

Deprecated

For internal use only.

heartbeat_failed_event() [2/2]

mongocxx::v_noabi::events::heartbeat_failed_event::heartbeat_failed_event ( v1::events::server_heartbeat_failed const & event )

inline

Construct with the mongocxx::v1 equivalent.

Member Function Documentation

awaited()

bool mongocxx::v_noabi::events::heartbeat_failed_event::awaited ( ) const

inline

Returns a boolean indicating whether this heartbeat event is from an awaitable hello.

Returns

A boolean.

duration()

std::int64_t mongocxx::v_noabi::events::heartbeat_failed_event::duration ( ) const

inline

Returns the duration of the failed operation.

Returns

The duration in microseconds.

host()

bsoncxx::v_noabi::stdx::string_view mongocxx::v_noabi::events::heartbeat_failed_event::host ( ) const

inline

Returns the host name.

Returns

The host name.

message()

std::string mongocxx::v_noabi::events::heartbeat_failed_event::message ( ) const

inline

Returns the failed operation's error message.

Returns

The message.

operator v1::events::server_heartbeat_failed()

mongocxx::v_noabi::events::heartbeat_failed_event::operator v1::events::server_heartbeat_failed ( ) const

inlineexplicit

Convert to the mongocxx::v1 equivalent.

port()

std::uint16_t mongocxx::v_noabi::events::heartbeat_failed_event::port ( ) const

inline

Returns the port.

Returns

The port.

---

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

• mongocxx/v_noabi/mongocxx/events/heartbeat_failed_event.hpp