#include <kv_types.h>

Inherited by ccf::kv::Store.

Classes
class	AbstractSnapshot

Public Types
enum class	StoreFlag : uint8_t { SNAPSHOT_AT_NEXT_SIGNATURE = 0x02 }

Public Member Functions
virtual	~AbstractStore ()=default

virtual void	lock_map_set ()=0

virtual void	unlock_map_set ()=0

virtual Version	next_version ()=0

virtual std::tuple< Version, Version >	next_version (bool commit_new_map)=0

virtual ccf::TxID	next_txid ()=0

virtual Version	current_version ()=0

virtual ccf::TxID	current_txid ()=0

virtual std::pair< ccf::TxID, Term >	current_txid_and_commit_term ()=0

virtual Version	compacted_version ()=0

virtual Term	commit_view ()=0

virtual std::shared_ptr< AbstractMap >	get_map (Version v, const std::string &map_name)=0

virtual std::shared_ptr< AbstractMap >	get_map_unsafe (Version v, const std::string &map_name)=0

virtual void	add_dynamic_map (Version v, const std::shared_ptr< AbstractMap > &map)=0

virtual std::shared_ptr< Consensus >	get_consensus ()=0

virtual std::shared_ptr< TxHistory >	get_history ()=0

virtual std::shared_ptr< ILedgerChunker >	get_chunker ()=0

virtual EncryptorPtr	get_encryptor ()=0

virtual std::unique_ptr< AbstractExecutionWrapper >	deserialize (const std::vector< uint8_t > &data, bool public_only=false, const std::optional< ccf::TxID > &expected_txid=std::nullopt)=0

virtual void	compact (Version v)=0

virtual void	rollback (const ccf::TxID &tx_id, Term write_term_)=0

virtual void	initialise_term (Term t)=0

virtual CommitResult	commit (const ccf::TxID &txid, std::unique_ptr< PendingTx > pending_tx, bool globally_committable)=0

virtual bool	check_rollback_count (Version count)=0

virtual std::unique_ptr< AbstractSnapshot >	snapshot_unsafe_maps (Version v)=0

virtual void	lock_maps ()=0

virtual void	unlock_maps ()=0

virtual std::vector< uint8_t >	serialise_snapshot (std::unique_ptr< AbstractSnapshot > snapshot)=0

virtual ApplyResult	deserialise_snapshot (const uint8_t data, size_t size, ConsensusHookPtrs &hooks, std::vector< Version > view_history=nullptr, bool public_only=false)=0

virtual bool	should_create_ledger_chunk (Version version)=0

virtual bool	should_create_ledger_chunk_unsafe (Version version)=0

virtual size_t	committable_gap ()=0

virtual void	set_flag (StoreFlag f)=0

virtual void	unset_flag (StoreFlag f)=0

virtual bool	flag_enabled (StoreFlag f)=0

virtual void	set_flag_unsafe (StoreFlag f)=0

virtual void	unset_flag_unsafe (StoreFlag f)=0

virtual bool	flag_enabled_unsafe (StoreFlag f) const =0

Member Enumeration Documentation

◆ StoreFlag

enum class ccf::kv::AbstractStore::StoreFlag : uint8_t

strong

Enumerator
SNAPSHOT_AT_NEXT_SIGNATURE

Constructor & Destructor Documentation

◆ ~AbstractStore()

virtual ccf::kv::AbstractStore::~AbstractStore ( )

virtualdefault

Member Function Documentation

◆ add_dynamic_map()

virtual void ccf::kv::AbstractStore::add_dynamic_map	(	Version	v,
		const std::shared_ptr< AbstractMap > &	map
	)

pure virtual

Implemented in ccf::kv::Store.

◆ check_rollback_count()

virtual bool ccf::kv::AbstractStore::check_rollback_count ( Version count )

pure virtual

Implemented in ccf::kv::Store.

◆ commit()

virtual CommitResult ccf::kv::AbstractStore::commit	(	const ccf::TxID &	txid,
		std::unique_ptr< PendingTx >	pending_tx,
		bool	globally_committable
	)

pure virtual

Implemented in ccf::kv::Store.

◆ commit_view()

virtual Term ccf::kv::AbstractStore::commit_view ( )

pure virtual

Implemented in ccf::kv::Store.

◆ committable_gap()

virtual size_t ccf::kv::AbstractStore::committable_gap ( )

pure virtual

Implemented in ccf::kv::Store.

◆ compact()

virtual void ccf::kv::AbstractStore::compact ( Version v )

pure virtual

Implemented in ccf::kv::Store.

◆ compacted_version()

virtual Version ccf::kv::AbstractStore::compacted_version ( )

pure virtual

Implemented in ccf::kv::Store.

◆ current_txid()

virtual ccf::TxID ccf::kv::AbstractStore::current_txid ( )

pure virtual

Implemented in ccf::kv::Store.

◆ current_txid_and_commit_term()

virtual std::pair< ccf::TxID, Term > ccf::kv::AbstractStore::current_txid_and_commit_term ( )

pure virtual

Implemented in ccf::kv::Store.

◆ current_version()

virtual Version ccf::kv::AbstractStore::current_version ( )

pure virtual

Implemented in ccf::kv::Store.

◆ deserialise_snapshot()

virtual ApplyResult ccf::kv::AbstractStore::deserialise_snapshot	(	const uint8_t *	data,
		size_t	size,
		ConsensusHookPtrs &	hooks,
		std::vector< Version > *	view_history = `nullptr`,
		bool	public_only = `false`
	)

pure virtual

Implemented in ccf::kv::Store.

◆ deserialize()

virtual std::unique_ptr< AbstractExecutionWrapper > ccf::kv::AbstractStore::deserialize	(	const std::vector< uint8_t > &	data,
		bool	public_only = `false`,
		const std::optional< ccf::TxID > &	expected_txid = `std::nullopt`
	)

pure virtual

◆ flag_enabled()

virtual bool ccf::kv::AbstractStore::flag_enabled ( StoreFlag f )

pure virtual

Implemented in ccf::kv::Store.

◆ flag_enabled_unsafe()

virtual bool ccf::kv::AbstractStore::flag_enabled_unsafe ( StoreFlag f ) const

pure virtual

Implemented in ccf::kv::Store.

◆ get_chunker()

virtual std::shared_ptr< ILedgerChunker > ccf::kv::AbstractStore::get_chunker ( )

pure virtual

Implemented in ccf::kv::Store.

◆ get_consensus()

virtual std::shared_ptr< Consensus > ccf::kv::AbstractStore::get_consensus ( )

pure virtual

Implemented in ccf::kv::Store.

◆ get_encryptor()

virtual EncryptorPtr ccf::kv::AbstractStore::get_encryptor ( )

pure virtual

Implemented in ccf::kv::Store.

◆ get_history()

virtual std::shared_ptr< TxHistory > ccf::kv::AbstractStore::get_history ( )

pure virtual

Implemented in ccf::kv::Store.

◆ get_map()

virtual std::shared_ptr< AbstractMap > ccf::kv::AbstractStore::get_map	(	Version	v,
		const std::string &	map_name
	)

pure virtual

Implemented in ccf::kv::Store.

◆ get_map_unsafe()

virtual std::shared_ptr< AbstractMap > ccf::kv::AbstractStore::get_map_unsafe	(	Version	v,
		const std::string &	map_name
	)

pure virtual

Implemented in ccf::kv::Store.

◆ initialise_term()

virtual void ccf::kv::AbstractStore::initialise_term ( Term t )

pure virtual

Implemented in ccf::kv::Store.

◆ lock_map_set()

virtual void ccf::kv::AbstractStore::lock_map_set ( )

pure virtual

Implemented in ccf::kv::Store.

◆ lock_maps()

virtual void ccf::kv::AbstractStore::lock_maps ( )

pure virtual

Implemented in ccf::kv::Store.

◆ next_txid()

virtual ccf::TxID ccf::kv::AbstractStore::next_txid ( )

pure virtual

Implemented in ccf::kv::Store.

◆ next_version() [1/2]

virtual Version ccf::kv::AbstractStore::next_version ( )

pure virtual

Implemented in ccf::kv::Store.

◆ next_version() [2/2]

virtual std::tuple< Version, Version > ccf::kv::AbstractStore::next_version ( bool commit_new_map )

pure virtual

Implemented in ccf::kv::Store.

◆ rollback()

virtual void ccf::kv::AbstractStore::rollback	(	const ccf::TxID &	tx_id,
		Term	write_term_
	)

pure virtual

Implemented in ccf::kv::Store.

◆ serialise_snapshot()

virtual std::vector< uint8_t > ccf::kv::AbstractStore::serialise_snapshot ( std::unique_ptr< AbstractSnapshot > snapshot )

pure virtual

Implemented in ccf::kv::Store.

◆ set_flag()

virtual void ccf::kv::AbstractStore::set_flag ( StoreFlag f )

pure virtual

Implemented in ccf::kv::Store.

◆ set_flag_unsafe()

virtual void ccf::kv::AbstractStore::set_flag_unsafe ( StoreFlag f )

pure virtual

Implemented in ccf::kv::Store.

◆ should_create_ledger_chunk()

virtual bool ccf::kv::AbstractStore::should_create_ledger_chunk ( Version version )

pure virtual

Implemented in ccf::kv::Store.

◆ should_create_ledger_chunk_unsafe()

virtual bool ccf::kv::AbstractStore::should_create_ledger_chunk_unsafe ( Version version )

pure virtual

Implemented in ccf::kv::Store.

◆ snapshot_unsafe_maps()

virtual std::unique_ptr< AbstractSnapshot > ccf::kv::AbstractStore::snapshot_unsafe_maps ( Version v )

pure virtual

Implemented in ccf::kv::Store.

◆ unlock_map_set()

virtual void ccf::kv::AbstractStore::unlock_map_set ( )

pure virtual

Implemented in ccf::kv::Store.

◆ unlock_maps()

virtual void ccf::kv::AbstractStore::unlock_maps ( )

pure virtual

Implemented in ccf::kv::Store.

◆ unset_flag()

virtual void ccf::kv::AbstractStore::unset_flag ( StoreFlag f )

pure virtual

Implemented in ccf::kv::Store.

◆ unset_flag_unsafe()

virtual void ccf::kv::AbstractStore::unset_flag_unsafe ( StoreFlag f )

pure virtual

Implemented in ccf::kv::Store.

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

src/kv/kv_types.h

Classes

Public Types

Public Member Functions

Member Enumeration Documentation

◆ StoreFlag

Constructor & Destructor Documentation

◆ ~AbstractStore()

Member Function Documentation

◆ add_dynamic_map()

◆ check_rollback_count()

◆ commit()

◆ commit_view()

◆ committable_gap()

◆ compact()

◆ compacted_version()

◆ current_txid()

◆ current_txid_and_commit_term()

◆ current_version()

◆ deserialise_snapshot()

◆ deserialize()

◆ flag_enabled()

◆ flag_enabled_unsafe()

◆ get_chunker()

◆ get_consensus()

◆ get_encryptor()

◆ get_history()

◆ get_map()

◆ get_map_unsafe()

◆ initialise_term()

◆ lock_map_set()

◆ lock_maps()

◆ next_txid()

◆ next_version() [1/2]

◆ next_version() [2/2]

◆ rollback()

◆ serialise_snapshot()

◆ set_flag()

◆ set_flag_unsafe()

◆ should_create_ledger_chunk()

◆ should_create_ledger_chunk_unsafe()

◆ snapshot_unsafe_maps()

◆ unlock_map_set()

◆ unlock_maps()

◆ unset_flag()

◆ unset_flag_unsafe()