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 <mongocxx/v1/client_session-fwd.hpp> // IWYU pragma: export
 
//
 
#include <mongocxx/v1/detail/prelude.hpp>
 
#include <bsoncxx/v1/document/view-fwd.hpp>
#include <bsoncxx/v1/types/view-fwd.hpp>
 
#include <mongocxx/v1/client-fwd.hpp>
#include <mongocxx/v1/transaction_options-fwd.hpp>
 
#include <bsoncxx/v1/stdx/optional.hpp>
 
#include <mongocxx/v1/config/export.hpp>
 
#include <cstdint>
#include <functional>
 
namespace mongocxx {
namespace v1 {

class client_session {
   private:
    class impl;
    void* _impl;
 
   public:
    class options;

    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();

    MONGOCXX_ABI_EXPORT_CDECL() client_session(client_session&& other) noexcept;

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

    client_session(client_session const&) = delete;

    client_session& operator=(client_session const&) = delete;

    MONGOCXX_ABI_EXPORT_CDECL(v1::client const&) client() const;

    MONGOCXX_ABI_EXPORT_CDECL(options) opts() const;

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::document::view) id() const;

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::document::view) cluster_time() const;

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::types::b_timestamp) operation_time() const;

    MONGOCXX_ABI_EXPORT_CDECL(std::uint32_t) server_id() const;

    MONGOCXX_ABI_EXPORT_CDECL(transaction_state) get_transaction_state() const;

    MONGOCXX_ABI_EXPORT_CDECL(bool) get_dirty() const;

    MONGOCXX_ABI_EXPORT_CDECL(void) advance_cluster_time(bsoncxx::v1::document::view v);

    MONGOCXX_ABI_EXPORT_CDECL(void) advance_operation_time(bsoncxx::v1::types::b_timestamp v);

    MONGOCXX_ABI_EXPORT_CDECL(void) start_transaction(v1::transaction_options const& opts);

    MONGOCXX_ABI_EXPORT_CDECL(void) start_transaction();

    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 const& fn,
        v1::transaction_options const& opts);

    MONGOCXX_ABI_EXPORT_CDECL(void) with_transaction(with_transaction_cb const& fn);
 
    class internal;
 
   private:
    /* explicit(false) */ client_session(void* impl);
};

class client_session::options {
   private:
    void* _impl; // mongoc_session_opt_t
 
   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);

    MONGOCXX_ABI_EXPORT_CDECL() options();

    MONGOCXX_ABI_EXPORT_CDECL(options&) causal_consistency(bool v);

    MONGOCXX_ABI_EXPORT_CDECL(bool) causal_consistency() const;

    MONGOCXX_ABI_EXPORT_CDECL(options&) snapshot(bool v);

    MONGOCXX_ABI_EXPORT_CDECL(bool) snapshot() const;

    MONGOCXX_ABI_EXPORT_CDECL(options&) default_transaction_opts(v1::transaction_options const& v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<v1::transaction_options>) default_transaction_opts() const;
 
    class internal;
 
   private:
    /* explicit(false) */ options(void* impl);
};
 
} // namespace v1
} // namespace mongocxx
 
#include <mongocxx/v1/detail/postlude.hpp>