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/pool-fwd.hpp> // IWYU pragma: export
 
//
 
#include <bsoncxx/v1/stdx/optional.hpp>
#include <bsoncxx/v1/stdx/string_view.hpp>
 
#include <mongocxx/v1/pool.hpp> // IWYU pragma: export
 
#include <cstddef>
#include <functional>
#include <memory>
#include <utility>
 
#include <mongocxx/options/auto_encryption-fwd.hpp> // IWYU pragma: keep: backward compatibility, to be removed.
 
#include <bsoncxx/stdx/optional.hpp>
#include <bsoncxx/string/view_or_value.hpp>
 
#include <mongocxx/client.hpp>
#include <mongocxx/database.hpp>
#include <mongocxx/options/pool.hpp>
#include <mongocxx/uri.hpp>
 
#include <mongocxx/config/prelude.hpp>
 
namespace mongocxx {
namespace v_noabi {

class pool {
   private:
    v1::pool _pool;
 
   public:
    explicit MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE() pool(
        v_noabi::uri const& mongodb_uri = {},
        v_noabi::options::pool const& options = {});

    ~pool() = default;
 
    pool(pool&&) = delete;
    pool& operator=(pool&&) = delete;
 
    pool(pool const&) = delete;
    pool& operator=(pool const&) = delete;

    class entry {
       public:
        v_noabi::client* operator->() const& noexcept {
            return _client.get();
        }
        v_noabi::client* operator->() && = delete;

        v_noabi::client& operator*() const& noexcept {
            return *_client;
        }
        v_noabi::client& operator*() && = delete;

        entry& operator=(std::nullptr_t) noexcept {
            _client.reset();
            return *this;
        }

        explicit operator bool() const noexcept {
            return _client != nullptr;
        }
 
        // Allows the pool_entry["db_name"] syntax to be used to access a database within the
        // entry's underlying client.
        v_noabi::database operator[](bsoncxx::v_noabi::string::view_or_value name) const& {
            return (*_client)[name];
        }
        v_noabi::database operator[](bsoncxx::v_noabi::string::view_or_value name) && = delete;
 
        class internal;
 
       private:
        using ptr_type = std::unique_ptr<v_noabi::client, std::function<void MONGOCXX_ABI_CDECL(v_noabi::client*)>>;
 
        ptr_type _client;
 
        /* explicit(false) */ entry(ptr_type client) : _client{std::move(client)} {}
    };

    MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE(entry) acquire();

    MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE(bsoncxx::v_noabi::stdx::optional<entry>) try_acquire();

    MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE(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 = {});
 
    class internal;
};
 
} // namespace v_noabi
} // namespace mongocxx
 
#include <mongocxx/config/postlude.hpp>