replicated_shard_interface.hpp

Go to the documentation of this file.

// Copyright (c) 2022 MIT Digital Currency Initiative,
//                    Federal Reserve Bank of Boston
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
#ifndef OPENCBDC_TX_SRC_PARSEC_RUNTIME_LOCKING_SHARD_REPLICATED_SHARD_INTERFACE_H_
#define OPENCBDC_TX_SRC_PARSEC_RUNTIME_LOCKING_SHARD_REPLICATED_SHARD_INTERFACE_H_
 
#include "interface.hpp"
 
namespace cbdc::parsec::runtime_locking_shard {
    class replicated_shard_interface {
      public:
        enum class error_code : uint8_t {
            unknown_ticket,
            internal_error
        };
 
        enum class ticket_state : uint8_t {
            prepared,
            committed
        };
 
        struct ticket_type {
            broker_id_type m_broker_id{};
            state_update_type m_state_update;
            ticket_state m_state{};
        };
 
        using state_type
            = std::unordered_map<key_type,
                                 value_type,
                                 hashing::const_sip_hash<key_type>>;
 
        using tickets_type
            = std::unordered_map<ticket_number_type, ticket_type>;
 
        using return_type = std::optional<error_code>;
        using callback_type = std::function<void(return_type)>;
 
        virtual ~replicated_shard_interface() = default;
 
        replicated_shard_interface() = default;
        replicated_shard_interface(const replicated_shard_interface&)
            = default;
        auto operator=(const replicated_shard_interface&)
            -> replicated_shard_interface& = default;
        replicated_shard_interface(replicated_shard_interface&&) = default;
        auto operator=(replicated_shard_interface&&)
            -> replicated_shard_interface& = default;
 
        virtual auto prepare(ticket_number_type ticket_number,
                             broker_id_type broker_id,
                             state_type state_update,
                             callback_type result_callback) -> bool
            = 0;
 
        virtual auto commit(ticket_number_type ticket_number,
                            callback_type result_callback) -> bool
            = 0;
 
        virtual auto finish(ticket_number_type ticket_number,
                            callback_type result_callback) -> bool
            = 0;
 
        using get_tickets_return_type = std::variant<tickets_type, error_code>;
        using get_tickets_callback_type
            = std::function<void(get_tickets_return_type)>;
 
        [[nodiscard]] virtual auto
        get_tickets(get_tickets_callback_type result_callback) const -> bool
            = 0;
    };
}
 
#endif