read_preference.hpp

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