MongoDB C++ Driver  mongocxx-3.9.0
All Classes Namespaces Functions Typedefs Enumerations Enumerator Friends Pages
server_description.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 
29 class MONGOCXX_API server_description {
30  public:
31  MONGOCXX_PRIVATE explicit server_description(const void* event);
32 
37 
43  std::uint32_t id() const;
44 
50  std::int64_t round_trip_time() const;
51 
58  bsoncxx::stdx::string_view type() const;
59 
65  MONGOCXX_DEPRECATED bsoncxx::document::view is_master() const;
66 
73  bsoncxx::document::view hello() const;
74 
80  bsoncxx::stdx::string_view host() const;
81 
87  std::uint16_t port() const;
88 
89  private:
90  const void* _sd;
91 };
92 
93 } // namespace events
94 } // namespace v_noabi
95 } // namespace mongocxx
96 
97 #include <mongocxx/config/postlude.hpp>
Class representing what the driver knows about a MongoDB server.
Definition: server_description.hpp:29
std::uint16_t port() const
Returns the server port.
bsoncxx::stdx::string_view host() const
Returns the server host name.
bsoncxx::document::view is_master() const
bsoncxx::stdx::string_view type() const
The server type: "Unknown", "Standalone", "Mongos", "PossiblePrimary", "RSPrimary",...
bsoncxx::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::int64_t round_trip_time() const
The duration of the last hello call, indicating network latency.
std::uint32_t id() const
An opaque id, unique to this server for this mongocxx::client or mongocxx::pool.
~server_description()
Destroys a server_description.
The top-level namespace for mongocxx library entities.
Definition: bulk_write.hpp:24