MongoDB C++ Driver  mongocxx-3.9.0
All Classes Namespaces Functions Typedefs Enumerations Enumerator Friends Pages
heartbeat_succeeded_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 <bsoncxx/document/view.hpp>
18 #include <bsoncxx/stdx/string_view.hpp>
19 
20 #include <mongocxx/config/prelude.hpp>
21 
22 namespace mongocxx {
23 inline namespace v_noabi {
24 namespace events {
25 
33 class MONGOCXX_API heartbeat_succeeded_event {
34  public:
35  MONGOCXX_PRIVATE explicit heartbeat_succeeded_event(const void* event);
36 
41 
47  bsoncxx::document::view reply() const;
48 
54  std::int64_t duration() const;
55 
61  bsoncxx::stdx::string_view host() const;
62 
68  std::uint16_t port() const;
69 
75  bool awaited() const;
76 
77  private:
78  const void* _succeeded_event;
79 };
80 
81 } // namespace events
82 } // namespace v_noabi
83 } // namespace mongocxx
84 
85 #include <mongocxx/config/postlude.hpp>
An event notification sent when the driver completes a "hello" command to check the status of a serve...
Definition: heartbeat_succeeded_event.hpp:33
~heartbeat_succeeded_event()
Destroys a heartbeat_succeeded_event.
std::int64_t duration() const
Returns the duration of the successful operation.
bool awaited() const
Returns a boolean indicating whether this heartbeat event is from an awaitable hello.
bsoncxx::document::view reply() const
Returns the server reply for the succeeded operation.
std::uint16_t port() const
Returns the port.
bsoncxx::stdx::string_view host() const
Returns the host name.
The top-level namespace for mongocxx library entities.
Definition: bulk_write.hpp:24