mongocxx::events::heartbeat_failed_event Class Reference

An event notification sent when the driver failed to send an "hello" command to check the status of a server. More...

#include <heartbeat_failed_event.hpp>

Public Member Functions
	~heartbeat_failed_event ()
	Destroys a heartbeat_failed_event.
std::string	message () const
	Returns the failed operation's error message. More...
std::int64_t	duration () const
	Returns the duration of the failed operation. More...
bsoncxx::stdx::string_view	host () const
	Returns the host name. More...
std::uint16_t	port () const
	Returns the port. More...
bool	awaited () const
	Returns a boolean indicating whether this heartbeat event is from an awaitable hello. More...

Detailed Description

An event notification sent when the driver failed to send an "hello" command to check the status of a server.

See also

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

Member Function Documentation

awaited()

bool mongocxx::events::heartbeat_failed_event::awaited

(

)

const

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

Returns

A boolean.

duration()

std::int64_t mongocxx::events::heartbeat_failed_event::duration

(

)

const

Returns the duration of the failed operation.

Returns

The duration in microseconds.

host()

bsoncxx::stdx::string_view mongocxx::events::heartbeat_failed_event::host

(

)

const

Returns the host name.

Returns

The host name.

message()

std::string mongocxx::events::heartbeat_failed_event::message

(

)

const

Returns the failed operation's error message.

Returns

The message.

port()

std::uint16_t mongocxx::events::heartbeat_failed_event::port

(

)

const

Returns the port.

Returns

The port.

---

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

• src/mongocxx/events/heartbeat_failed_event.hpp