MongoDB C++ Driver current
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
22namespace mongocxx {
23MONGOCXX_INLINE_NAMESPACE_BEGIN
24
25namespace events {
26
30class MONGOCXX_API server_description {
31 public:
32 MONGOCXX_PRIVATE explicit server_description(const void* event);
33
38
44 std::uint32_t id() const;
45
51 std::int64_t round_trip_time() const;
52
59 bsoncxx::stdx::string_view type() const;
60
66 MONGOCXX_DEPRECATED bsoncxx::document::view is_master() const;
67
75
81 bsoncxx::stdx::string_view host() const;
82
88 std::uint16_t port() const;
89
90 private:
91 const void* _sd;
92};
93
94} // namespace events
95MONGOCXX_INLINE_NAMESPACE_END
96} // namespace mongocxx
97
98#include <mongocxx/config/postlude.hpp>
A read-only, non-owning view of a BSON document.
Definition: view.hpp:33
Class representing what the driver knows about a MongoDB server.
Definition: server_description.hpp:30
std::int64_t round_trip_time() const
The duration of the last hello call, indicating network latency.
bsoncxx::stdx::string_view host() const
Returns the server host name.
~server_description()
Destroys a server_description.
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::uint16_t port() const
Returns the server port.
MONGOCXX_DEPRECATED bsoncxx::document::view is_master() const
std::uint32_t id() const
An opaque id, unique to this server for this mongocxx::client or mongocxx::pool.
bsoncxx::stdx::string_view type() const
The server type: "Unknown", "Standalone", "Mongos", "PossiblePrimary", "RSPrimary",...
Top level namespace for the MongoDB C++ driver.
Definition: bulk_write.hpp:24