MongoDB C++ Driver
mongocxx-4.0.0
Loading...
Searching...
No Matches
mongocxx
v_noabi
mongocxx
events
heartbeat_succeeded_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_succeeded_event-fwd.hpp
>
18
19
#include <
bsoncxx/document/view.hpp
>
20
#include <
bsoncxx/stdx/string_view.hpp
>
21
22
#include <
mongocxx/config/prelude.hpp
>
23
24
namespace
mongocxx
{
25
namespace
v_noabi {
26
namespace
events {
27
35
class
heartbeat_succeeded_event
{
36
public
:
37
explicit
heartbeat_succeeded_event
(
const
void
* event);
38
42
MONGOCXX_ABI_EXPORT_CDECL
()
~heartbeat_succeeded_event
();
43
44
heartbeat_succeeded_event
(
heartbeat_succeeded_event
&&) =
default
;
45
heartbeat_succeeded_event
& operator=(
heartbeat_succeeded_event
&&) =
default
;
46
47
heartbeat_succeeded_event
(
const
heartbeat_succeeded_event
&) =
default
;
48
heartbeat_succeeded_event
& operator=(
const
heartbeat_succeeded_event
&) =
default
;
49
55
MONGOCXX_ABI_EXPORT_CDECL
(
bsoncxx::v_noabi::document::view
)
reply
()
const
;
56
62
MONGOCXX_ABI_EXPORT_CDECL
(std::int64_t)
duration
()
const
;
63
69
MONGOCXX_ABI_EXPORT_CDECL
(
bsoncxx::v_noabi::stdx::string_view
)
host
()
const
;
70
76
MONGOCXX_ABI_EXPORT_CDECL
(std::uint16_t)
port
()
const
;
77
83
MONGOCXX_ABI_EXPORT_CDECL
(
bool
)
awaited
()
const
;
84
85
private
:
86
const
void
* _succeeded_event;
87
};
88
89
}
// namespace events
90
}
// namespace v_noabi
91
}
// namespace mongocxx
92
93
#include <
mongocxx/config/postlude.hpp
>
94
bsoncxx::v_noabi::document::view
A read-only, non-owning view of a BSON document.
Definition
view.hpp:35
bsoncxx::v_noabi::stdx::string_view
A polyfill for std::string_view.
Definition
string_view.hpp:436
mongocxx::v_noabi::events::heartbeat_succeeded_event
An event notification sent when the driver completes a "hello" command to check the status of a serve...
Definition
heartbeat_succeeded_event.hpp:35
mongocxx::v_noabi::events::heartbeat_succeeded_event::reply
bsoncxx::v_noabi::document::view reply() const
Returns the server reply for the succeeded operation.
mongocxx::v_noabi::events::heartbeat_succeeded_event::~heartbeat_succeeded_event
~heartbeat_succeeded_event()
Destroys a heartbeat_succeeded_event.
mongocxx::v_noabi::events::heartbeat_succeeded_event::duration
std::int64_t duration() const
Returns the duration of the successful operation.
mongocxx::v_noabi::events::heartbeat_succeeded_event::awaited
bool awaited() const
Returns a boolean indicating whether this heartbeat event is from an awaitable hello.
mongocxx::v_noabi::events::heartbeat_succeeded_event::host
bsoncxx::v_noabi::stdx::string_view host() const
Returns the host name.
mongocxx::v_noabi::events::heartbeat_succeeded_event::port
std::uint16_t port() const
Returns the port.
view.hpp
Provides bsoncxx::v_noabi::document::view.
MONGOCXX_ABI_EXPORT_CDECL
#define MONGOCXX_ABI_EXPORT_CDECL(...)
Equivalent to MONGOCXX_ABI_EXPORT with MONGOCXX_ABI_CDECL.
Definition
fwd.hpp:204
heartbeat_succeeded_event-fwd.hpp
Declares mongocxx::v_noabi::events::heartbeat_succeeded_event.
postlude.hpp
The mongocxx macro guard postlude header.
prelude.hpp
The mongocxx macro guard prelude header.
mongocxx
The top-level namespace within which all mongocxx library entities are declared.
string_view.hpp
Provides std::string_view-related polyfills for library API usage.
Generated by
1.12.0