IHashDatabase.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* IHashDatabase.h                                             (C) 2000-2023 */
/*                                                                           */
/* Interface of a hash database.                                             */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_STD_INTERNAL_IHASHDATABASE_H
#define ARCANE_STD_INTERNAL_IHASHDATABASE_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/utils/ArrayView.h"
#include "arcane/utils/Ref.h"
 
#include "arcane/utils/String.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class HashDatabaseReadArgs
{
 public:
 
  HashDatabaseReadArgs() = default;
 
  HashDatabaseReadArgs(const String& hash_value, Span<std::byte> v)
  : m_hash_value(hash_value)
  , m_values(v)
  {}
 
 public:
 
  void setKey(const String& v) { m_key = v; }
  const String& key() const { return m_key; }
 
  void setValues(const Span<std::byte>& v) { m_values = v; }
  Span<std::byte> values() const { return m_values; }
 
  const String& hashValueAsString() const { return m_hash_value; }
  void setHashValueAsString(const String& v) { m_hash_value = v; }
 
 private:
 
  String m_key;
  String m_hash_value;
  Span<std::byte> m_values;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class HashDatabaseWriteArgs
{
 public:
 
  HashDatabaseWriteArgs() = default;
 
  HashDatabaseWriteArgs(Span<const std::byte> v, const String& hash_value)
  : m_values(v)
  , m_hash_value(hash_value)
  {}
 
 public:
 
  void setKey(const String& v) { m_key = v; }
  const String& key() const { return m_key; }
 
  void setValues(const Span<const std::byte>& v) { m_values = v; }
  Span<const std::byte> values() const { return m_values; }
 
  void setHashValue(const String& v) { m_hash_value = v; }
  const String& hashValue() const { return m_hash_value; }
 
 private:
 
  String m_key;
  Span<const std::byte> m_values;
  String m_hash_value;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class HashDatabaseWriteResult
{
 public:
 
  const String& hashValueAsString() const { return m_hash_value; }
  void setHashValueAsString(const String& v) { m_hash_value = v; }
 
 private:
 
  String m_hash_value;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class IHashDatabase
{
 public:
 
  virtual ~IHashDatabase() = default;
 
 public:
 
  virtual void writeValues(const HashDatabaseWriteArgs& args, HashDatabaseWriteResult& result) = 0;
  virtual void readValues(const HashDatabaseReadArgs& args) = 0;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
extern "C++" Ref<IHashDatabase>
createFileHashDatabase(ITraceMng* tm, const String& directory);
 
extern "C++" Ref<IHashDatabase>
createRedisHashDatabase(ITraceMng* tm, const String& machine_ip, Int32 port);
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif