ccf::kv::UnitValue< Unit > Class Template Reference

#include <unit_value.h>

Inherits ccf::kv::GetName.

Public Types
using	ReadOnlyHandle = ccf::kv::ReadableUnitValueHandle< Unit >
using	WriteOnlyHandle = ccf::kv::WriteableUnitValueHandle< Unit >
using	Handle = ccf::kv::UnitValueHandle< Unit >
using	Write = std::optional< ccf::kv::serialisers::SerialisedEntry >
using	MapHook = ccf::kv::MapHook< Write >
using	CommitHook = ccf::kv::CommitHook< Write >

Public Member Functions
	GetName (std::string s)
Public Member Functions inherited from ccf::kv::GetName
	GetName (std::string s)
virtual	~GetName ()=default
const std::string &	get_name () const

Static Public Member Functions
static ccf::kv::serialisers::SerialisedEntry	create_unit ()
static ccf::kv::untyped::CommitHook	wrap_commit_hook (const CommitHook &hook)
static ccf::kv::untyped::MapHook	wrap_map_hook (const MapHook &hook)

Additional Inherited Members
Protected Attributes inherited from ccf::kv::GetName
std::string	name

Detailed Description

template<typename Unit = ccf::kv::serialisers::ZeroBlitUnitCreator>
class ccf::kv::UnitValue< Unit >

Defines the schema of a touched-only type accessed by a ccf::Tx. This value is a container for an optional single marker indicating whether it has been touched.

This is implemented as a ccf::kv::Map from Unit to Unit, and the serialisation of the fixed key and value are overridable with the Unit template parameter.

Member Typedef Documentation

CommitHook

template<typename Unit = ccf::kv::serialisers::ZeroBlitUnitCreator>

using ccf::kv::UnitValue< Unit >::CommitHook = ccf::kv::CommitHook<Write>

Handle

template<typename Unit = ccf::kv::serialisers::ZeroBlitUnitCreator>

using ccf::kv::UnitValue< Unit >::Handle = ccf::kv::UnitValueHandle<Unit>

MapHook

template<typename Unit = ccf::kv::serialisers::ZeroBlitUnitCreator>

using ccf::kv::UnitValue< Unit >::MapHook = ccf::kv::MapHook<Write>

ReadOnlyHandle

template<typename Unit = ccf::kv::serialisers::ZeroBlitUnitCreator>

using ccf::kv::UnitValue< Unit >::ReadOnlyHandle = ccf::kv::ReadableUnitValueHandle<Unit>

Write

template<typename Unit = ccf::kv::serialisers::ZeroBlitUnitCreator>

using ccf::kv::UnitValue< Unit >::Write = std::optional<ccf::kv::serialisers::SerialisedEntry>

WriteOnlyHandle

template<typename Unit = ccf::kv::serialisers::ZeroBlitUnitCreator>

using ccf::kv::UnitValue< Unit >::WriteOnlyHandle = ccf::kv::WriteableUnitValueHandle<Unit>

Member Function Documentation

create_unit()

template<typename Unit = ccf::kv::serialisers::ZeroBlitUnitCreator>

static ccf::kv::serialisers::SerialisedEntry ccf::kv::UnitValue< Unit >::create_unit ( )

inlinestatic

GetName()

template<typename Unit = ccf::kv::serialisers::ZeroBlitUnitCreator>

ccf::kv::GetName::GetName ( std::string  s )

inline

wrap_commit_hook()

template<typename Unit = ccf::kv::serialisers::ZeroBlitUnitCreator>

static ccf::kv::untyped::CommitHook ccf::kv::UnitValue< Unit >::wrap_commit_hook ( const CommitHook &  hook )

inlinestatic

wrap_map_hook()

template<typename Unit = ccf::kv::serialisers::ZeroBlitUnitCreator>

static ccf::kv::untyped::MapHook ccf::kv::UnitValue< Unit >::wrap_map_hook ( const MapHook &  hook )

inlinestatic

---

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

• include/ccf/kv/unit_value.h