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

#include <set_handle.h>

Inherits ccf::kv::AbstractHandle, ccf::kv::ReadableSetHandle< K, KSerialiser >, and ccf::kv::WriteableSetHandle< K, KSerialiser, Unit >.

Public Member Functions

 SetHandle (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::ReadableSetHandle< K, KSerialiser >
 ReadableSetHandle (ccf::kv::untyped::MapHandle &uh)
 
bool contains (const K &key)
 
bool contains_globally_committed (const K &key)
 
std::optional< Versionget_version_of_previous_write (const K &key)
 
template<class F >
void foreach (F &&f)
 
size_t size ()
 
- Public Member Functions inherited from ccf::kv::WriteableSetHandle< K, KSerialiser, Unit >
 WriteableSetHandle (ccf::kv::untyped::MapHandle &uh)
 
void insert (const K &key)
 
void remove (const K &key)
 
void clear ()
 

Protected Types

using ReadableBase = ReadableSetHandle< K, KSerialiser >
 
using WriteableBase = WriteableSetHandle< K, KSerialiser, Unit >
 

Protected Attributes

ccf::kv::untyped::MapHandle untyped_handle
 
- Protected Attributes inherited from ccf::kv::ReadableSetHandle< K, KSerialiser >
ccf::kv::untyped::MapHandleread_handle
 
- Protected Attributes inherited from ccf::kv::WriteableSetHandle< K, KSerialiser, Unit >
ccf::kv::untyped::MapHandlewrite_handle
 

Additional Inherited Members

- Public Types inherited from ccf::kv::ReadableSetHandle< K, KSerialiser >
using KeyType = K
 

Detailed Description

template<typename K, typename KSerialiser, typename Unit>
class ccf::kv::SetHandle< K, KSerialiser, Unit >

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

See also
ccf::kv::ReadableSetHandle
ccf::kv::WriteableSetHandle

Member Typedef Documentation

◆ ReadableBase

template<typename K , typename KSerialiser , typename Unit >
using ccf::kv::SetHandle< K, KSerialiser, Unit >::ReadableBase = ReadableSetHandle<K, KSerialiser>
protected

◆ WriteableBase

template<typename K , typename KSerialiser , typename Unit >
using ccf::kv::SetHandle< K, KSerialiser, Unit >::WriteableBase = WriteableSetHandle<K, KSerialiser, Unit>
protected

Constructor & Destructor Documentation

◆ SetHandle()

template<typename K , typename KSerialiser , typename Unit >
ccf::kv::SetHandle< K, KSerialiser, Unit >::SetHandle ( ccf::kv::untyped::ChangeSet changes,
const std::string &  map_name 
)
inline

Member Data Documentation

◆ untyped_handle

template<typename K , typename KSerialiser , typename Unit >
ccf::kv::untyped::MapHandle ccf::kv::SetHandle< K, KSerialiser, Unit >::untyped_handle
protected

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