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 <mongocxx/read_preference-fwd.hpp> // IWYU pragma: export
 
//
 
#include <bsoncxx/v1/detail/macros.hpp>
 
#include <mongocxx/v1/read_preference.hpp>
 
#include <chrono>
#include <cstdint>
#include <memory> // IWYU pragma: keep: backward compatibility, to be removed.
#include <string> // IWYU pragma: keep: backward compatibility, to be removed.
#include <utility>
 
#include <mongocxx/client-fwd.hpp>                      // IWYU pragma: keep: backward compatibility, to be removed.
#include <mongocxx/collection-fwd.hpp>                  // IWYU pragma: keep: backward compatibility, to be removed.
#include <mongocxx/database-fwd.hpp>                    // IWYU pragma: keep: backward compatibility, to be removed.
#include <mongocxx/events/topology_description-fwd.hpp> // IWYU pragma: keep: backward compatibility, to be removed.
#include <mongocxx/options/transaction-fwd.hpp>         // IWYU pragma: keep: backward compatibility, to be removed.
#include <mongocxx/search_index_view-fwd.hpp>           // IWYU pragma: keep: backward compatibility, to be removed.
#include <mongocxx/uri-fwd.hpp>                         // IWYU pragma: keep: backward compatibility, to be removed.
 
#include <bsoncxx/array/view.hpp>
#include <bsoncxx/array/view_or_value.hpp>
#include <bsoncxx/document/view.hpp>
#include <bsoncxx/document/view_or_value.hpp>
#include <bsoncxx/stdx/optional.hpp>
 
#include <mongocxx/options/transaction.hpp> // IWYU pragma: keep: backward compatibility, to be removed.
 
#include <mongocxx/config/prelude.hpp>
 
namespace mongocxx {
namespace v_noabi {

class read_preference {
   private:
    v1::read_preference _rp;
 
   public:
    enum class read_mode : std::uint8_t {
        k_primary,

        k_primary_preferred,

        k_secondary,

        k_secondary_preferred,

        k_nearest
    };

    read_preference() = default;

    /* explicit(false) */ read_preference(v1::read_preference rp) : _rp{std::move(rp)} {}

    explicit operator v1::read_preference() && {
        return std::move(_rp);
    }

    explicit operator v1::read_preference() const& {
        return _rp;
    }
 
    // @cond DOXYGEN_DISABLE
    struct deprecated_tag {};
    // @endcond

    MONGOCXX_DEPRECATED read_preference(read_mode mode) : read_preference{mode, deprecated_tag{}} {}
 
    // @cond DOXYGEN_DISABLE
    read_preference(read_mode mode, deprecated_tag) {
        this->mode(mode);
    }
    // @endcond

    MONGOCXX_DEPRECATED read_preference(read_mode mode, bsoncxx::v_noabi::document::view_or_value tags)
        : read_preference{mode, tags, deprecated_tag{}} {}
 
    // @cond DOXYGEN_DISABLE
    read_preference(read_mode mode, bsoncxx::v_noabi::document::view_or_value tags, deprecated_tag) {
        this->mode(mode).tags(tags.view());
    }
    // @endcond

    read_preference& mode(read_mode mode) {
        _rp.mode(static_cast<v1::read_preference::read_mode>(mode));
        return *this;
    }

    read_mode mode() const {
        return static_cast<read_mode>(_rp.mode());
    }

    read_preference& tags(bsoncxx::v_noabi::document::view_or_value tag_set_list) {
        _rp.tags(bsoncxx::v_noabi::to_v1(tag_set_list.view()));
        return *this;
    }

    read_preference& tags(bsoncxx::v_noabi::array::view_or_value tag_set_list) {
        _rp.tags(bsoncxx::v_noabi::to_v1(tag_set_list.view()));
        return *this;
    }

    bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view> tags() const {
        bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view> ret;
 
        auto const v = _rp.tags();
 
        if (!v.empty()) {
            ret.emplace(v);
        }
 
        return ret;
    }

    MONGOCXX_ABI_EXPORT_CDECL(read_preference&) max_staleness(std::chrono::seconds max_staleness);

    bsoncxx::v_noabi::stdx::optional<std::chrono::seconds> max_staleness() const {
        return _rp.max_staleness();
    }
 
    BSONCXX_PRIVATE_WARNINGS_PUSH();
    BSONCXX_PRIVATE_WARNINGS_DISABLE(GNU("-Wdeprecated-declarations"));
    BSONCXX_PRIVATE_WARNINGS_DISABLE(MSVC(4996));

    MONGOCXX_DEPRECATED read_preference& hedge(bsoncxx::v_noabi::document::view_or_value hedge) {
        _rp.hedge(bsoncxx::v_noabi::to_v1(hedge.view()));
        return *this;
    }

    MONGOCXX_DEPRECATED bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view> const hedge() const {
        bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view> ret;
        if (auto const opt = _rp.hedge()) {
            ret.emplace(*opt);
        }
        return ret;
    }
 
    BSONCXX_PRIVATE_WARNINGS_POP();

    friend bool operator==(read_preference const& lhs, read_preference const& rhs) {
        return (lhs.mode() == rhs.mode()) && (lhs.tags() == rhs.tags()) && (lhs.max_staleness() == rhs.max_staleness());
    }
 
    friend bool operator!=(read_preference const& lhs, read_preference const& rhs) {
        return !(lhs == rhs);
    }

 
    class internal;
};

inline v_noabi::read_preference from_v1(v1::read_preference v) {
    return {std::move(v)};
}

inline v1::read_preference to_v1(v_noabi::read_preference v) {
    return v1::read_preference{std::move(v)};
}
 
} // namespace v_noabi
} // namespace mongocxx
 
#include <mongocxx/config/postlude.hpp>