read_preference.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 <chrono>
#include <cstdint>
#include <memory>
#include <string>
 
#include <mongocxx/client-fwd.hpp>
#include <mongocxx/collection-fwd.hpp>
#include <mongocxx/database-fwd.hpp>
#include <mongocxx/events/topology_description-fwd.hpp>
#include <mongocxx/options/transaction-fwd.hpp>
#include <mongocxx/read_preference-fwd.hpp>
#include <mongocxx/search_index_view-fwd.hpp>
#include <mongocxx/uri-fwd.hpp>
 
#include <bsoncxx/array/view_or_value.hpp>
#include <bsoncxx/document/view_or_value.hpp>
#include <bsoncxx/stdx/optional.hpp>
 
#include <mongocxx/options/transaction.hpp>
 
#include <mongocxx/config/prelude.hpp>
 
namespace mongocxx {
namespace v_noabi {
 
class read_preference {
   public:
    enum class read_mode : std::uint8_t {
        k_primary,
 
        k_primary_preferred,
 
        k_secondary,
 
        k_secondary_preferred,
 
        k_nearest
    };
 
    MONGOCXX_ABI_EXPORT_CDECL() read_preference();
 
    // @cond DOXYGEN_DISABLE
    struct deprecated_tag {};
    // @endcond
 
    MONGOCXX_DEPRECATED MONGOCXX_ABI_EXPORT_CDECL() read_preference(read_mode mode);
 
    // @cond DOXYGEN_DISABLE
    MONGOCXX_ABI_EXPORT_CDECL() read_preference(read_mode mode, deprecated_tag);
    // @endcond
 
    MONGOCXX_DEPRECATED MONGOCXX_ABI_EXPORT_CDECL() read_preference(
        read_mode mode,
        bsoncxx::v_noabi::document::view_or_value tags);
 
    // @cond DOXYGEN_DISABLE
    MONGOCXX_ABI_EXPORT_CDECL()
    read_preference(read_mode mode, bsoncxx::v_noabi::document::view_or_value tags, deprecated_tag);
    // @endcond
 
    MONGOCXX_ABI_EXPORT_CDECL() read_preference(read_preference const&);
 
    MONGOCXX_ABI_EXPORT_CDECL(read_preference&) operator=(read_preference const&);
 
    MONGOCXX_ABI_EXPORT_CDECL() read_preference(read_preference&&) noexcept;
 
    MONGOCXX_ABI_EXPORT_CDECL(read_preference&) operator=(read_preference&&) noexcept;
 
    MONGOCXX_ABI_EXPORT_CDECL() ~read_preference();
 
    MONGOCXX_ABI_EXPORT_CDECL(read_preference&) mode(read_mode mode);
 
    MONGOCXX_ABI_EXPORT_CDECL(read_mode) mode() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(read_preference&)
    tags(bsoncxx::v_noabi::document::view_or_value tag_set_list);
 
    MONGOCXX_ABI_EXPORT_CDECL(read_preference&)
    tags(bsoncxx::v_noabi::array::view_or_value tag_set_list);
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view>)
    tags() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(read_preference&) max_staleness(std::chrono::seconds max_staleness);
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<std::chrono::seconds>)
    max_staleness() const;
 
    MONGOCXX_DEPRECATED MONGOCXX_ABI_EXPORT_CDECL(read_preference&) hedge(
        bsoncxx::v_noabi::document::view_or_value hedge);
 
    MONGOCXX_DEPRECATED MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<
                                                  bsoncxx::v_noabi::document::view> const)
    hedge() const;
 
    friend MONGOCXX_ABI_EXPORT_CDECL(bool) operator==(read_preference const&, read_preference const&);
    friend MONGOCXX_ABI_EXPORT_CDECL(bool) operator!=(read_preference const&, read_preference const&);
 
   private:
    friend ::mongocxx::v_noabi::client;
    friend ::mongocxx::v_noabi::collection;
    friend ::mongocxx::v_noabi::database;
    friend ::mongocxx::v_noabi::events::topology_description;
    friend ::mongocxx::v_noabi::options::transaction;
    friend ::mongocxx::v_noabi::search_index_view;
    friend ::mongocxx::v_noabi::uri;
 
    class impl;
 
    read_preference(std::unique_ptr<impl>&& implementation);
 
    std::unique_ptr<impl> _impl;
};
 
} // namespace v_noabi
} // namespace mongocxx
 
#include <mongocxx/config/postlude.hpp>