ccf::kv::MapHandle< K, V, KSerialiser, VSerialiser > Class Template Reference

#include <map_handle.h>

Inherits ccf::kv::AbstractHandle, ccf::kv::ReadableMapHandle< K, V, KSerialiser, VSerialiser >, and ccf::kv::WriteableMapHandle< K, V, KSerialiser, VSerialiser >.

Public Member Functions
	MapHandle (ccf::kv::untyped::ChangeSet &changes, const std::string &map_name)
Public Member Functions inherited from ccf::kv::AbstractHandle
virtual	~AbstractHandle ()=default
Public Member Functions inherited from ccf::kv::ReadableMapHandle< K, V, KSerialiser, VSerialiser >
	ReadableMapHandle (ccf::kv::untyped::MapHandle &uh)
std::string	get_name_of_map () const
std::optional< V >	get (const K &key)
std::optional< V >	get_globally_committed (const K &key)
bool	has (const K &key)
std::optional< Version >	get_version_of_previous_write (const K &key)
template<class F >
void	foreach (F &&f)
template<class F >
void	foreach_key (F &&f)
template<class F >
void	foreach_value (F &&f)
size_t	size ()
Public Member Functions inherited from ccf::kv::WriteableMapHandle< K, V, KSerialiser, VSerialiser >
	WriteableMapHandle (ccf::kv::untyped::MapHandle &uh)
void	put (const K &key, const V &value)
void	remove (const K &key)
void	clear ()

Protected Types
using	ReadableBase = ReadableMapHandle< K, V, KSerialiser, VSerialiser >
using	WriteableBase = WriteableMapHandle< K, V, KSerialiser, VSerialiser >

Protected Attributes
ccf::kv::untyped::MapHandle	untyped_handle
Protected Attributes inherited from ccf::kv::ReadableMapHandle< K, V, KSerialiser, VSerialiser >
ccf::kv::untyped::MapHandle &	read_handle
Protected Attributes inherited from ccf::kv::WriteableMapHandle< K, V, KSerialiser, VSerialiser >
ccf::kv::untyped::MapHandle &	write_handle

Additional Inherited Members
Public Types inherited from ccf::kv::ReadableMapHandle< K, V, KSerialiser, VSerialiser >
using	KeyType = K
using	ValueType = V

Detailed Description

template<typename K, typename V, typename KSerialiser, typename VSerialiser>
class ccf::kv::MapHandle< K, V, KSerialiser, VSerialiser >

Grants read and write access to a ccf::kv::Map, as part of a ccf::kv::Tx.

See also

ccf::kv::ReadableMapHandle

ccf::kv::WriteableMapHandle

Member Typedef Documentation

ReadableBase

template<typename K , typename V , typename KSerialiser , typename VSerialiser >

using ccf::kv::MapHandle< K, V, KSerialiser, VSerialiser >::ReadableBase = ReadableMapHandle<K, V, KSerialiser, VSerialiser>

protected

WriteableBase

template<typename K , typename V , typename KSerialiser , typename VSerialiser >

using ccf::kv::MapHandle< K, V, KSerialiser, VSerialiser >::WriteableBase = WriteableMapHandle<K, V, KSerialiser, VSerialiser>

protected

Constructor & Destructor Documentation

MapHandle()

template<typename K , typename V , typename KSerialiser , typename VSerialiser >

ccf::kv::MapHandle< K, V, KSerialiser, VSerialiser >::MapHandle ( ccf::kv::untyped::ChangeSet &  changes, const std::string &  map_name  )

inline

Member Data Documentation

untyped_handle

template<typename K , typename V , typename KSerialiser , typename VSerialiser >

ccf::kv::untyped::MapHandle ccf::kv::MapHandle< K, V, KSerialiser, VSerialiser >::untyped_handle

protected

---

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

• include/ccf/kv/map_handle.h