ccf::kv::CommittableTx Class Reference

#include <committable_tx.h>

Inherits ccf::kv::Tx.

Inherited by ccf::kv::ReservedTx.

Public Types
enum class	TxFlag : TxFlags { LEDGER_CHUNK_AT_NEXT_SIGNATURE = 0x01 , SNAPSHOT_AT_NEXT_SIGNATURE = 0x02 , LEDGER_CHUNK_BEFORE_THIS_TX = 0x04 }
using	TxFlags = uint8_t

Public Member Functions
	CommittableTx (AbstractStore *_store)
CommitResult	commit (const ccf::ClaimsDigest &claims=ccf::empty_claims(), std::function< std::tuple< Version, Version >(bool has_new_map)> version_resolver=nullptr, std::function< void(const std::vector< uint8_t > &write_set, const std::string &commit_evidence)> write_set_observer=nullptr)
Version	commit_version () const
Version	commit_term () const
std::optional< TxID >	get_txid () const
void	set_read_txid (const TxID &tx_id, Term commit_view_)
void	set_root_at_read_version (const ccf::crypto::Sha256Hash &r)
virtual void	set_tx_flag (TxFlag flag)
virtual void	unset_tx_flag (TxFlag flag)
virtual bool	tx_flag_enabled (TxFlag f) const
Public Member Functions inherited from ccf::kv::Tx
template<class M >
M::Handle *	rw (M &m)
template<class M >
M::Handle *	rw (const std::string &map_name)
template<class M >
M::WriteOnlyHandle *	wo (M &m)
template<class M >
M::WriteOnlyHandle *	wo (const std::string &map_name)
Public Member Functions inherited from ccf::kv::ReadOnlyTx
template<class M >
M::ReadOnlyHandle *	ro (M &m)
template<class M >
M::ReadOnlyHandle *	ro (const std::string &map_name)
	BaseTx (AbstractStore *store_)
	BaseTx (const BaseTx &that)=delete
Public Member Functions inherited from ccf::kv::BaseTx
	BaseTx (AbstractStore *store_)
	BaseTx (const BaseTx &that)=delete
BaseTx &	operator= (BaseTx &&other)=default
virtual	~BaseTx ()
std::optional< ccf::crypto::Sha256Hash >	get_root_at_read_version ()

Protected Member Functions
std::vector< uint8_t >	serialise (ccf::crypto::Sha256Hash &commit_evidence_digest, std::string &commit_evidence, const ccf::ClaimsDigest &claims_digest_, bool include_reads=false)
Protected Member Functions inherited from ccf::kv::BaseTx
void	retain_change_set (const std::string &map_name, std::unique_ptr< untyped::ChangeSet > &&change_set, const std::shared_ptr< AbstractMap > &abstract_map)
void	retain_handle (const std::string &map_name, std::unique_ptr< AbstractHandle > &&handle)
MapChanges	get_map_and_change_set_by_name (const std::string &map_name, bool track_deletes_on_missing_keys)
std::list< AbstractHandle * >	get_possible_handles (const std::string &map_name)
void	compacted_version_conflict (const std::string &map_name)
template<class THandle >
THandle *	get_handle_by_name (const std::string &map_name, bool track_deletes_on_missing_keys)

Protected Attributes
bool	committed = false
bool	success = false
Version	version = NoVersion
TxFlags	flags = 0
SerialisedEntryFlags	entry_flags = 0
Protected Attributes inherited from ccf::kv::BaseTx
std::unique_ptr< PrivateImpl >	pimpl
OrderedChanges	all_changes
std::optional< ccf::crypto::Sha256Hash >	root_at_read_version = std::nullopt

Member Typedef Documentation

TxFlags

using ccf::kv::CommittableTx::TxFlags = uint8_t

Member Enumeration Documentation

TxFlag

enum class ccf::kv::CommittableTx::TxFlag : TxFlags

strong

Enumerator
LEDGER_CHUNK_AT_NEXT_SIGNATURE
SNAPSHOT_AT_NEXT_SIGNATURE
LEDGER_CHUNK_BEFORE_THIS_TX

Constructor & Destructor Documentation

CommittableTx()

ccf::kv::CommittableTx::CommittableTx ( AbstractStore *  _store )

inline

Member Function Documentation

commit()

CommitResult ccf::kv::CommittableTx::commit ( const ccf::ClaimsDigest &  claims = ccf::empty_claims(), std::function< std::tuple< Version, Version >(bool has_new_map)>  version_resolver = nullptr, std::function< void(const std::vector< uint8_t > &write_set, const std::string &commit_evidence)>  write_set_observer = nullptr  )

inline

Commit this transaction to the local KV and submit it to consensus for replication

A transaction can either succeed and replicate (ccf::kv::CommitResult::SUCCESS), fail because of a conflict with other transactions (ccf::kv::CommitResult::FAIL_CONFLICT), or succeed locally, but fail to replicate (ccf::kv::CommitResult::FAIL_NO_REPLICATE).

Transactions that fail are rolled back, no matter the reason.

Returns

transaction outcome

commit_term()

Version ccf::kv::CommittableTx::commit_term ( ) const

inline

Get term in which this transaction was committed.

Throws if this is not successfully committed - should only be called if an earlier call to commit() returned CommitResult::SUCCESS

Returns

Commit term

commit_version()

Version ccf::kv::CommittableTx::commit_version ( ) const

inline

Get version at which this transaction was committed.

Throws if this is not successfully committed - should only be called if an earlier call to commit() returned CommitResult::SUCCESS

Returns

Commit version

get_txid()

std::optional< TxID > ccf::kv::CommittableTx::get_txid ( ) const

inline

serialise()

std::vector< uint8_t > ccf::kv::CommittableTx::serialise ( ccf::crypto::Sha256Hash &  commit_evidence_digest, std::string &  commit_evidence, const ccf::ClaimsDigest &  claims_digest_, bool  include_reads = false  )

inlineprotected

set_read_txid()

void ccf::kv::CommittableTx::set_read_txid ( const TxID &  tx_id, Term  commit_view_  )

inline

set_root_at_read_version()

void ccf::kv::CommittableTx::set_root_at_read_version ( const ccf::crypto::Sha256Hash &  r )

inline

set_tx_flag()

virtual void ccf::kv::CommittableTx::set_tx_flag ( TxFlag  flag )

inlinevirtual

tx_flag_enabled()

virtual bool ccf::kv::CommittableTx::tx_flag_enabled ( TxFlag  f ) const

inlinevirtual

unset_tx_flag()

virtual void ccf::kv::CommittableTx::unset_tx_flag ( TxFlag  flag )

inlinevirtual

Member Data Documentation

committed

bool ccf::kv::CommittableTx::committed = false

protected

entry_flags

SerialisedEntryFlags ccf::kv::CommittableTx::entry_flags = 0

protected

flags

TxFlags ccf::kv::CommittableTx::flags = 0

protected

success

bool ccf::kv::CommittableTx::success = false

protected

version

Version ccf::kv::CommittableTx::version = NoVersion

protected

---

The documentation for this class was generated from the following file:

• src/kv/committable_tx.h