Loading...
Searching...
No Matches
server_description.hpp
Go to the documentation of this file.
// Copyright 2009-present MongoDB, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#pragma once
#include <mongocxx/v1/events/server_description-fwd.hpp> // IWYU pragma: export
//
#include <mongocxx/v1/detail/prelude.hpp>
#include <bsoncxx/v1/document/view-fwd.hpp>
#include <bsoncxx/v1/stdx/optional.hpp>
#include <bsoncxx/v1/stdx/string_view.hpp>
#include <mongocxx/v1/config/export.hpp>
#include <cstdint>
namespace mongocxx {
namespace v1 {
namespace events {
class server_description {
private:
void* _impl; // mongoc_server_description_t
public:
MONGOCXX_ABI_EXPORT_CDECL() ~server_description();
MONGOCXX_ABI_EXPORT_CDECL() server_description(server_description&& other) noexcept;
MONGOCXX_ABI_EXPORT_CDECL(server_description&) operator=(server_description&& other) noexcept;
MONGOCXX_ABI_EXPORT_CDECL() server_description(server_description const& other);
MONGOCXX_ABI_EXPORT_CDECL(server_description&) operator=(server_description const& other);
MONGOCXX_ABI_EXPORT_CDECL(std::uint32_t) id() const;
MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<std::int64_t>) round_trip_time() const;
MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::string_view) type() const;
MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::document::view) hello() const;
MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::string_view) host() const;
MONGOCXX_ABI_EXPORT_CDECL(std::uint16_t) port() const;
class internal;
private:
/* explicit(false) */ server_description(void* impl);
};
} // namespace events
} // namespace v1
} // namespace mongocxx
#include <mongocxx/v1/detail/postlude.hpp>
mongocxx::v1::events::server_description::round_trip_time
bsoncxx::v1::stdx::optional< std::int64_t > round_trip_time() const
Return the client-measured execution time of the "hello" command.
mongocxx::v1::events::server_description::server_description
server_description(server_description &&other) noexcept
Move constructor.
mongocxx::v1::events::server_description::port
std::uint16_t port() const
Return the port number for the connection used by the command.
mongocxx::v1::events::server_description::~server_description
~server_description()
Destroy this object.
mongocxx::v1::events::server_description::host
bsoncxx::v1::stdx::string_view host() const
Return the hostname for the connection used by the command.
mongocxx::v1::events::server_description::type
bsoncxx::v1::stdx::string_view type() const
Return the topology type.
mongocxx::v1::events::server_description::hello
bsoncxx::v1::document::view hello() const
Return the raw server response to the "hello" command.
export.hpp
Provides macros to control the set of symbols exported in the ABI.
MONGOCXX_ABI_EXPORT_CDECL
#define MONGOCXX_ABI_EXPORT_CDECL(...)
Equivalent to MONGOCXX_ABI_EXPORT with MONGOCXX_ABI_CDECL.
Definition export.hpp:52
prelude.hpp
The mongocxx v1 macro guard prelude header.
bsoncxx
The top-level namespace within which all bsoncxx library entities are declared.
mongocxx::v1::events
Declares entities describing APM events.
mongocxx::v1
Declares entities whose ABI stability is guaranteed for documented symbols.
mongocxx
The top-level namespace within which all mongocxx library entities are declared.
view-fwd.hpp
Declares bsoncxx::v1::document::view.
server_description-fwd.hpp
Declares mongocxx::v1::events::server_description.
optional.hpp
Provides std::optional-related polyfills for library API usage.
string_view.hpp
Provides std::string_view-related polyfills for library API usage.