client_session.hpp

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