set_handle.h

Go to the documentation of this file.

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the Apache 2.0 License.
#pragma once
 
#include "ccf/kv/unit.h"
#include "ccf/kv/untyped_map_handle.h"
 
namespace ccf::kv
{
  template <typename K, typename KSerialiser>
  class ReadableSetHandle
  {
  protected:
    ccf::kv::untyped::MapHandle& read_handle;
 
  public:
    using KeyType = K;
 
    ReadableSetHandle(ccf::kv::untyped::MapHandle& uh) : read_handle(uh) {}
 
    bool contains(const K& key)
    {
      return read_handle.has(KSerialiser::to_serialised(key));
    }
 
    bool contains_globally_committed(const K& key)
    {
      return read_handle.has_globally_committed(
        KSerialiser::to_serialised(key));
    }
 
    std::optional<Version> get_version_of_previous_write(const K& key)
    {
      return read_handle.get_version_of_previous_write(
        KSerialiser::to_serialised(key));
    }
 
    template <class F>
    void foreach(F&& f)
    {
      auto g = [&](
                 const ccf::kv::serialisers::SerialisedEntry& k_rep,
                 const ccf::kv::serialisers::SerialisedEntry&) {
        return f(KSerialiser::from_serialised(k_rep));
      };
      read_handle.foreach(g);
    }
 
    size_t size()
    {
      return read_handle.size();
    }
  };
 
  template <typename K, typename KSerialiser, typename Unit>
  class WriteableSetHandle
  {
  protected:
    ccf::kv::untyped::MapHandle& write_handle;
 
  public:
    WriteableSetHandle(ccf::kv::untyped::MapHandle& uh) : write_handle(uh) {}
 
    void insert(const K& key)
    {
      write_handle.put(KSerialiser::to_serialised(key), Unit::get());
    }
 
    void remove(const K& key)
    {
      write_handle.remove(KSerialiser::to_serialised(key));
    }
 
    void clear()
    {
      write_handle.clear();
    }
  };
 
  template <typename K, typename KSerialiser, typename Unit>
  class SetHandle : public ccf::kv::AbstractHandle,
                    public ReadableSetHandle<K, KSerialiser>,
                    public WriteableSetHandle<K, KSerialiser, Unit>
  {
  protected:
    ccf::kv::untyped::MapHandle untyped_handle;
 
    using ReadableBase = ReadableSetHandle<K, KSerialiser>;
    using WriteableBase = WriteableSetHandle<K, KSerialiser, Unit>;
 
  public:
    SetHandle(
      ccf::kv::untyped::ChangeSet& changes, const std::string& map_name) :
      ReadableBase(untyped_handle),
      WriteableBase(untyped_handle),
      untyped_handle(changes, map_name)
    {}
  };
}