MongoDB C++ Driver  mongocxx-3.10.2
Public Member Functions | List of all members
mongocxx::v_noabi::events::heartbeat_started_event Class Reference

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

#include <heartbeat_started_event.hpp>

Public Member Functions

 ~heartbeat_started_event ()
 Destroys a heartbeat_started_event.
 
bsoncxx::v_noabi::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 begins executing a "hello" command to check the status of a server.

See also
"ServerHeartbeatStartedEvent" 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_started_event::awaited ( ) const

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

Returns
A boolean.

◆ host()

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

Returns the host name.

Returns
The host name.

◆ port()

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

Returns the port.

Returns
The port.

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