pool.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/pool-fwd.hpp> // IWYU pragma: export
 
//
 
#include <mongocxx/v1/detail/prelude.hpp>
 
#include <mongocxx/v1/database-fwd.hpp>
#include <mongocxx/v1/uri-fwd.hpp>
 
#include <bsoncxx/v1/stdx/optional.hpp>
#include <bsoncxx/v1/stdx/string_view.hpp>
 
#include <mongocxx/v1/client.hpp> // IWYU pragma: export
#include <mongocxx/v1/config/export.hpp>
 
#include <cstddef>
#include <system_error>
#include <type_traits>
 
namespace mongocxx {
namespace v1 {

class pool {
   private:
    class impl;
    void* _impl;
 
   public:
    class options;
    class entry;

    MONGOCXX_ABI_EXPORT_CDECL() ~pool();

    MONGOCXX_ABI_EXPORT_CDECL() pool(pool&& other) noexcept;

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

    pool(pool const& other) = delete;

    pool& operator=(pool const& other) = delete;

    MONGOCXX_ABI_EXPORT_CDECL() pool(v1::uri const& uri, options opts);
 
    /* explicit(false) */ MONGOCXX_ABI_EXPORT_CDECL() pool(v1::uri const& uri);

    explicit MONGOCXX_ABI_EXPORT_CDECL() pool();

    explicit MONGOCXX_ABI_EXPORT_CDECL() operator bool() const;

    MONGOCXX_ABI_EXPORT_CDECL(entry) acquire();

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<entry>) try_acquire();

    MONGOCXX_ABI_EXPORT_CDECL(void)
    append_metadata(
        bsoncxx::v1::stdx::string_view name,
        bsoncxx::v1::stdx::optional<bsoncxx::v1::stdx::string_view> version = {},
        bsoncxx::v1::stdx::optional<bsoncxx::v1::stdx::string_view> platform = {});

    enum class errc {
        zero,                    
        wait_queue_timeout,      
        append_metadata_failure, 
    };

    static MONGOCXX_ABI_EXPORT_CDECL(std::error_category const&) error_category();

    friend std::error_code make_error_code(errc v) {
        return {static_cast<int>(v), error_category()};
    }
 
    class internal;
 
   private:
    /* explicit(false) */ pool(void* impl);
};

class pool::options {
   private:
    class impl;
    void* _impl;
 
   public:
    MONGOCXX_ABI_EXPORT_CDECL() ~options();

    MONGOCXX_ABI_EXPORT_CDECL() options(options&& other) noexcept;

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

    MONGOCXX_ABI_EXPORT_CDECL() options(options const& other);

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

    /* explicit(false) */ MONGOCXX_ABI_EXPORT_CDECL() options(v1::client::options opts);

    MONGOCXX_ABI_EXPORT_CDECL() options();

    MONGOCXX_ABI_EXPORT_CDECL(v1::client::options) client_opts() const;
 
    class internal;
};

class pool::entry {
   private:
    class impl;
    void* _impl;
 
   public:
    MONGOCXX_ABI_EXPORT_CDECL() ~entry();

    MONGOCXX_ABI_EXPORT_CDECL() entry(entry&& other) noexcept;

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

    entry(entry const& other) = delete;

    entry& operator=(entry const& other) = delete;

    MONGOCXX_ABI_EXPORT_CDECL(v1::client*) operator->();

    MONGOCXX_ABI_EXPORT_CDECL(v1::client&) operator*();

    MONGOCXX_ABI_EXPORT_CDECL(entry&) operator=(std::nullptr_t);

    explicit MONGOCXX_ABI_EXPORT_CDECL() operator bool() const;

    MONGOCXX_ABI_EXPORT_CDECL(v1::database) database(bsoncxx::v1::stdx::string_view name);
    MONGOCXX_ABI_EXPORT_CDECL(v1::database) operator[](bsoncxx::v1::stdx::string_view name);
 
    class internal;
 
   private:
    /* explicit(false) */ entry(void* impl);
};
 
} // namespace v1
} // namespace mongocxx
 
namespace std {
 
template <>
struct is_error_code_enum<mongocxx::v1::pool::errc> : true_type {};
 
} // namespace std
 
#include <mongocxx/v1/detail/postlude.hpp>