MongoDB C++ Driver 4.2.0
Loading...
Searching...
No Matches
heartbeat_started_event.hpp
Go to the documentation of this file.
1// Copyright 2009-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 <mongocxx/events/heartbeat_started_event-fwd.hpp> // IWYU pragma: export
18
19//
20
21#include <mongocxx/v1/events/server_heartbeat_started.hpp> // IWYU pragma: export
22
23#include <cstdint>
24#include <utility> // IWYU pragma: keep: backward compatibility, to be removed.
25
27
29
30namespace mongocxx {
31namespace v_noabi {
32namespace events {
33
41 private:
43
44 public:
49
53 /* explicit(false) */ heartbeat_started_event(v1::events::server_heartbeat_started const& event) : _event{event} {}
54
58 explicit operator v1::events::server_heartbeat_started() const {
59 return _event;
60 }
61
68 return _event.host();
69 }
70
76 std::uint16_t port() const {
77 return _event.port();
78 }
79
85 bool awaited() const {
86 return _event.awaited();
87 }
88};
89
90} // namespace events
91} // namespace v_noabi
92} // namespace mongocxx
93
94namespace mongocxx {
95namespace v_noabi {
96
103
110
111} // namespace v_noabi
112} // namespace mongocxx
113
115
A polyfill for std::string_view.
Definition string_view.hpp:412
ServerHeartbeatStartedEvent from the SDAM Logging and Monitoring specification.
Definition server_heartbeat_started.hpp:41
The start of the execution of a heartbeat ("hello") command.
Definition heartbeat_started_event.hpp:40
std::uint16_t port() const
Returns the port.
Definition heartbeat_started_event.hpp:76
bsoncxx::v_noabi::stdx::string_view host() const
Returns the host name.
Definition heartbeat_started_event.hpp:67
heartbeat_started_event(v1::events::server_heartbeat_started const &event)
Construct with the mongocxx::v1 equivalent.
Definition heartbeat_started_event.hpp:53
bool awaited() const
Returns a boolean indicating whether this heartbeat event is from an awaitable hello.
Definition heartbeat_started_event.hpp:85
Declares mongocxx::v_noabi::events::heartbeat_started_event.
#define MONGOCXX_ABI_NO_EXPORT
Excludes the associated entity from being part of the ABI.
Definition export.hpp:20
The mongocxx v_noabi macro guard postlude header.
The mongocxx v_noabi macro guard prelude header.
Declares entities describing APM events.
Declares entities whose ABI stability is NOT guaranteed.
v1::bulk_write to_v1(v_noabi::bulk_write v)
Convert to the mongocxx::v1 equivalent of v.
Definition bulk_write.hpp:162
v_noabi::bulk_write from_v1(v1::bulk_write v)
Convert to the mongocxx::v_noabi equivalent of v.
Definition bulk_write.hpp:155
The top-level namespace within which all mongocxx library entities are declared.
Provides mongocxx::v1::events::server_heartbeat_started.
Provides std::string_view-related polyfills for library API usage.