MongoDB C++ Driver  mongocxx-3.10.2
heartbeat_started_event.hpp
1 // Copyright 2018-present MongoDB Inc.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #pragma once
16 
17 #include <cstdint>
18 
19 #include <mongocxx/events/heartbeat_started_event-fwd.hpp>
20 
21 #include <bsoncxx/stdx/string_view.hpp>
22 
23 #include <mongocxx/config/prelude.hpp>
24 
25 namespace mongocxx {
26 namespace v_noabi {
27 namespace events {
28 
37  public:
38  MONGOCXX_PRIVATE explicit heartbeat_started_event(const void* event);
39 
44 
50  bsoncxx::v_noabi::stdx::string_view host() const;
51 
57  std::uint16_t port() const;
58 
64  bool awaited() const;
65 
66  private:
67  const void* _started_event;
68 };
69 
70 } // namespace events
71 } // namespace v_noabi
72 } // namespace mongocxx
73 
74 #include <mongocxx/config/postlude.hpp>
An event notification sent when the driver begins executing a "hello" command to check the status of ...
Definition: heartbeat_started_event.hpp:36
std::uint16_t port() const
Returns the port.
~heartbeat_started_event()
Destroys a heartbeat_started_event.
bsoncxx::v_noabi::stdx::string_view host() const
Returns the host name.
bool awaited() const
Returns a boolean indicating whether this heartbeat event is from an awaitable hello.
The top-level namespace for mongocxx library entities.
Definition: bulk_write-fwd.hpp:19