MongoDB C++ Driver mongocxx-4.0.0
Loading...
Searching...
No Matches
server_description.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
18
21
23
24namespace mongocxx {
25namespace v_noabi {
26namespace events {
27
32 public:
33 explicit server_description(const void* event);
34
39
41 server_description& operator=(server_description&&) = default;
42
43 server_description(const server_description&) = default;
44 server_description& operator=(const server_description&) = default;
45
52 MONGOCXX_ABI_EXPORT_CDECL(std::uint32_t) id() const;
53
60
68
75 is_master() const;
76
83 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::document::view) hello() const;
84
90 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::string_view) host() const;
91
98
99 private:
100 const void* _sd;
101};
102
103} // namespace events
104} // namespace v_noabi
105} // namespace mongocxx
106
107#include <mongocxx/config/postlude.hpp>
108
A read-only, non-owning view of a BSON document.
Definition view.hpp:35
A polyfill for std::string_view.
Definition string_view.hpp:436
Class representing what the driver knows about a MongoDB server.
Definition server_description.hpp:31
std::uint16_t port() const
Returns the server port.
MONGOCXX_DEPRECATED bsoncxx::v_noabi::document::view is_master() const
std::int64_t round_trip_time() const
The duration of the last hello call, indicating network latency.
bsoncxx::v_noabi::document::view hello() const
The server's last response to the "hello" command, or an empty document if the driver has not yet rea...
std::uint32_t id() const
An opaque id, unique to this server for this mongocxx::v_noabi::client or mongocxx::v_noabi::pool.
bsoncxx::v_noabi::stdx::string_view host() const
Returns the server host name.
~server_description()
Destroys a server_description.
bsoncxx::v_noabi::stdx::string_view type() const
The server type: "Unknown", "Standalone", "Mongos", "PossiblePrimary", "RSPrimary",...
Provides bsoncxx::v_noabi::document::view.
#define MONGOCXX_DEPRECATED
Declares the associated entity as deprecated.
Definition fwd.hpp:212
#define MONGOCXX_ABI_EXPORT_CDECL(...)
Equivalent to MONGOCXX_ABI_EXPORT with MONGOCXX_ABI_CDECL.
Definition fwd.hpp:204
The mongocxx macro guard prelude header.
The top-level namespace within which all bsoncxx library entities are declared.
The top-level namespace within which all mongocxx library entities are declared.
The top-level namespace reserved for the C++ standard library.
Declares mongocxx::v_noabi::events::server_description.
Provides std::string_view-related polyfills for library API usage.