client_session.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 <functional>
#include <memory>
 
#include <mongocxx/bulk_write-fwd.hpp>
#include <mongocxx/client-fwd.hpp>
#include <mongocxx/client_session-fwd.hpp>
#include <mongocxx/collection-fwd.hpp>
#include <mongocxx/database-fwd.hpp>
#include <mongocxx/index_view-fwd.hpp>
#include <mongocxx/search_index_view-fwd.hpp>
 
#include <bsoncxx/document/view.hpp>
#include <bsoncxx/stdx/optional.hpp>
 
#include <mongocxx/options/client_session.hpp>
 
#include <mongocxx/config/prelude.hpp>
 
namespace mongocxx {
namespace v_noabi {
 
class client_session {
   public:
    enum class transaction_state {
        k_transaction_none,
        k_transaction_starting,
        k_transaction_in_progress,
        k_transaction_committed,
        k_transaction_aborted,
    };
 
    MONGOCXX_ABI_EXPORT_CDECL() client_session(client_session&&) noexcept;
 
    MONGOCXX_ABI_EXPORT_CDECL(client_session&) operator=(client_session&&) noexcept;
 
    client_session(const client_session&) = delete;
    MONGOCXX_ABI_EXPORT_CDECL(client_session&) operator=(const client_session&) = delete;
 
    MONGOCXX_ABI_EXPORT_CDECL() ~client_session() noexcept;
 
    MONGOCXX_ABI_EXPORT_CDECL(const mongocxx::v_noabi::client&) client() const noexcept;
 
    MONGOCXX_ABI_EXPORT_CDECL(const options::client_session&) options() const noexcept;
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::document::view) id() const noexcept;
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::document::view) cluster_time() const noexcept;
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::types::b_timestamp) operation_time() const noexcept;
 
    MONGOCXX_ABI_EXPORT_CDECL(std::uint32_t) server_id() const noexcept;
 
    MONGOCXX_ABI_EXPORT_CDECL(transaction_state) get_transaction_state() const noexcept;
 
    MONGOCXX_ABI_EXPORT_CDECL(bool) get_dirty() const noexcept;
 
    MONGOCXX_ABI_EXPORT_CDECL(void)
    advance_cluster_time(const bsoncxx::v_noabi::document::view& cluster_time);
 
    MONGOCXX_ABI_EXPORT_CDECL(void)
    advance_operation_time(const bsoncxx::v_noabi::types::b_timestamp& operation_time);
 
    MONGOCXX_ABI_EXPORT_CDECL(void)
    start_transaction(
        const bsoncxx::v_noabi::stdx::optional<options::transaction>& transaction_opts = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(void) commit_transaction();
 
    MONGOCXX_ABI_EXPORT_CDECL(void) abort_transaction();
 
    using with_transaction_cb = std::function<void MONGOCXX_ABI_CDECL(client_session*)>;
 
    MONGOCXX_ABI_EXPORT_CDECL(void)
    with_transaction(with_transaction_cb cb, options::transaction opts = {});
 
   private:
    friend ::mongocxx::v_noabi::bulk_write;
    friend ::mongocxx::v_noabi::client;
    friend ::mongocxx::v_noabi::collection;
    friend ::mongocxx::v_noabi::database;
    friend ::mongocxx::v_noabi::index_view;
    friend ::mongocxx::v_noabi::search_index_view;
 
    class impl;
 
    client_session(const mongocxx::v_noabi::client* client, const options::client_session& options);
 
    impl& _get_impl();
    const impl& _get_impl() const;
 
    std::unique_ptr<impl> _impl;
};
 
}  // namespace v_noabi
}  // namespace mongocxx
 
#include <mongocxx/config/postlude.hpp>