mongocxx::v_noabi::events::heartbeat_succeeded_event Class Reference

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

#include <heartbeat_succeeded_event.hpp>

Public Member Functions
	~heartbeat_succeeded_event ()
	Destroys a heartbeat_succeeded_event.
bsoncxx::v_noabi::document::view	reply () const
	Returns the server reply for the succeeded operation.
std::int64_t	duration () const
	Returns the duration of the successful operation.
bsoncxx::v_noabi::stdx::string_view	host () const
	Returns the host name.
std::uint16_t	port () const
	Returns the port.
bool	awaited () const
	Returns a boolean indicating whether this heartbeat event is from an awaitable hello.

Detailed Description

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

See also

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

Member Function Documentation

awaited()

bool mongocxx::v_noabi::events::heartbeat_succeeded_event::awaited

(

)

const

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_succeeded_event::duration

(

)

const

Returns the duration of the successful operation.

Returns

The duration in microseconds.

host()

bsoncxx::v_noabi::stdx::string_view mongocxx::v_noabi::events::heartbeat_succeeded_event::host

(

)

const

Returns the host name.

Returns

The host name.

port()

std::uint16_t mongocxx::v_noabi::events::heartbeat_succeeded_event::port

(

)

const

Returns the port.

Returns

The port.

reply()

bsoncxx::v_noabi::document::view mongocxx::v_noabi::events::heartbeat_succeeded_event::reply

(

)

const

Returns the server reply for the succeeded operation.

Returns

The reply.

---

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

• src/mongocxx/include/mongocxx/v_noabi/mongocxx/events/heartbeat_succeeded_event.hpp