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/v1/read_preference-fwd.hpp> // IWYU pragma: export
 
//
 
#include <mongocxx/v1/detail/prelude.hpp>
 
#include <bsoncxx/v1/array/view-fwd.hpp>
#include <bsoncxx/v1/document/view-fwd.hpp>
 
#include <bsoncxx/v1/stdx/optional.hpp>
 
#include <mongocxx/v1/config/export.hpp>
 
#include <chrono>
 
namespace mongocxx {
namespace v1 {

class read_preference {
   private:
    void* _impl; // mongoc_read_prefs_t
 
   public:
    enum class read_mode {
        k_primary,

        k_primary_preferred,

        k_secondary,

        k_secondary_preferred,

        k_nearest,
    };

    MONGOCXX_ABI_EXPORT_CDECL() ~read_preference();

    MONGOCXX_ABI_EXPORT_CDECL() read_preference(read_preference&& other) noexcept;

    MONGOCXX_ABI_EXPORT_CDECL(read_preference&) operator=(read_preference&& other) noexcept;

    MONGOCXX_ABI_EXPORT_CDECL() read_preference(read_preference const& other);

    MONGOCXX_ABI_EXPORT_CDECL(read_preference&) operator=(read_preference const& other);

    MONGOCXX_ABI_EXPORT_CDECL() read_preference();

    MONGOCXX_DEPRECATED MONGOCXX_ABI_EXPORT_CDECL(read_preference&) hedge(bsoncxx::v1::document::view v);

    MONGOCXX_DEPRECATED MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bsoncxx::v1::document::view>) hedge()
        const;

    MONGOCXX_ABI_EXPORT_CDECL(read_preference&) mode(read_mode v);

    MONGOCXX_ABI_EXPORT_CDECL(read_mode) mode() const;

    MONGOCXX_ABI_EXPORT_CDECL(read_preference&) tags(bsoncxx::v1::array::view v);
    MONGOCXX_ABI_EXPORT_CDECL(read_preference&) tags(bsoncxx::v1::document::view v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::array::view) tags() const;

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

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<std::chrono::seconds>) max_staleness() const;

    friend MONGOCXX_ABI_EXPORT_CDECL(bool) operator==(read_preference const& lhs, read_preference const& rhs);
 
    friend bool operator!=(read_preference const& lhs, read_preference const& rhs) {
        return !(lhs == rhs);
    }

 
    class internal;
 
   private:
    /* explicit(false) */ read_preference(void* impl);
};
 
} // namespace v1
} // namespace mongocxx
 
#include <mongocxx/v1/detail/postlude.hpp>