CCF
Loading...
Searching...
No Matches
Public Member Functions | Protected Types | Protected Attributes | List of all members
ccf::kv::ValueHandle< V, VSerialiser, Unit > Class Template Reference

#include <value_handle.h>

Inherits ccf::kv::AbstractHandle, ccf::kv::ReadableValueHandle< V, VSerialiser, Unit >, and ccf::kv::WriteableValueHandle< V, VSerialiser, Unit >.

Public Member Functions

 ValueHandle (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::ReadableValueHandle< V, VSerialiser, Unit >
 ReadableValueHandle (ccf::kv::untyped::MapHandle &uh)
 
std::optional< V > get ()
 
std::optional< V > get_globally_committed ()
 
bool has ()
 
std::optional< Versionget_version_of_previous_write ()
 
- Public Member Functions inherited from ccf::kv::WriteableValueHandle< V, VSerialiser, Unit >
 WriteableValueHandle (ccf::kv::untyped::MapHandle &uh)
 
void put (const V &value)
 
void clear ()
 

Protected Types

using ReadableBase = ReadableValueHandle< V, VSerialiser, Unit >
 
using WriteableBase = WriteableValueHandle< V, VSerialiser, Unit >
 

Protected Attributes

ccf::kv::untyped::MapHandle untyped_handle
 
- Protected Attributes inherited from ccf::kv::ReadableValueHandle< V, VSerialiser, Unit >
ccf::kv::untyped::MapHandleread_handle
 
- Protected Attributes inherited from ccf::kv::WriteableValueHandle< V, VSerialiser, Unit >
ccf::kv::untyped::MapHandlewrite_handle
 

Additional Inherited Members

- Public Types inherited from ccf::kv::ReadableValueHandle< V, VSerialiser, Unit >
using ValueType = V
 

Detailed Description

template<typename V, typename VSerialiser, typename Unit>
class ccf::kv::ValueHandle< V, VSerialiser, Unit >

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

See also
ccf::kv::ReadableValueHandle
ccf::kv::WriteableValueHandle

Member Typedef Documentation

◆ ReadableBase

template<typename V , typename VSerialiser , typename Unit >
using ccf::kv::ValueHandle< V, VSerialiser, Unit >::ReadableBase = ReadableValueHandle<V, VSerialiser, Unit>
protected

◆ WriteableBase

template<typename V , typename VSerialiser , typename Unit >
using ccf::kv::ValueHandle< V, VSerialiser, Unit >::WriteableBase = WriteableValueHandle<V, VSerialiser, Unit>
protected

Constructor & Destructor Documentation

◆ ValueHandle()

template<typename V , typename VSerialiser , typename Unit >
ccf::kv::ValueHandle< V, VSerialiser, Unit >::ValueHandle ( ccf::kv::untyped::ChangeSet changes,
const std::string &  map_name 
)
inline

Member Data Documentation

◆ untyped_handle

template<typename V , typename VSerialiser , typename Unit >
ccf::kv::untyped::MapHandle ccf::kv::ValueHandle< V, VSerialiser, Unit >::untyped_handle
protected

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