MongoDB C++ Driver mongocxx-3.11.0
Loading...
Searching...
No Matches
mongocxx::v_noabi::events::heartbeat_succeeded_event Class Reference

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

Description

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

See also

Public Member Functions

 ~heartbeat_succeeded_event ()
 Destroys a heartbeat_succeeded_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 successful operation.
 
bsoncxx::v_noabi::stdx::string_view host () const
 Returns the host name.
 
std::uint16_t port () const
 Returns the port.
 
bsoncxx::v_noabi::document::view reply () const
 Returns the server reply for the succeeded operation.
 

Constructor & Destructor Documentation

◆ ~heartbeat_succeeded_event()

mongocxx::v_noabi::events::heartbeat_succeeded_event::~heartbeat_succeeded_event ( )

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: