traits.h

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * Distributed under BSD 3-Clause license.                                   *
 * Copyright by The HDF Group.                                               *
 * Copyright by the Illinois Institute of Technology.                        *
 * All rights reserved.                                                      *
 *                                                                           *
 * This file is part of Hermes. The full Hermes copyright notice, including  *
 * terms governing use, modification, and redistribution, is contained in    *
 * the COPYING file, which can be found at the top directory. If you do not  *
 * have access to the file, you may request a copy from help@hdfgroup.org.   *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
#ifndef HERMES_TRAITS_H
#define HERMES_TRAITS_H
 
#include <unordered_map>
 
#include "hermes.h"
#include "hermes_types.h"
 
namespace hermes {
namespace api {
 
#define HERMES_PERSIST_TRAIT 11
#define HERMES_WRITE_ONLY_TRAIT 12
 
struct BlobInfo {
  std::string bucket_name;
  std::string blob_name;
};
 
typedef BlobInfo TraitInput;
struct Trait;
using HermesPtr = std::shared_ptr<Hermes>;
 
// TODO(chogan): I don't think we need to pass a Trait* to these callbacks
// anymore. That is a relic of an old implementation.
 
typedef std::function<void(HermesPtr, TraitInput &, Trait *)> OnLinkCallback;
typedef std::function<void(HermesPtr, VBucketID, Trait *)> OnAttachCallback;
 
struct Trait {
  TraitID id;
  std::vector<TraitID> conflict_traits;
  TraitType type;
  OnAttachCallback onAttachFn;
  OnAttachCallback onDetachFn;
  OnLinkCallback onLinkFn;
  OnLinkCallback onUnlinkFn;
  OnLinkCallback onGetFn;
 
  Trait() {}
 
  Trait(TraitID id, const std::vector<TraitID> &conflict_traits,
        TraitType type);
};
 
struct PersistTrait : public Trait {
  std::string filename;
  std::unordered_map<std::string, u64> offset_map;
  bool synchronous;
 
  using OffsetMap = std::unordered_map<std::string, u64>;
 
  explicit PersistTrait(bool synchronous);
 
  explicit PersistTrait(const std::string &filename,
                        const OffsetMap &offset_map, bool synchronous = false);
 
  void onAttach(HermesPtr hermes, VBucketID id, Trait *trait);
 
  void onDetach(HermesPtr hermes, VBucketID id, Trait *trait);
 
  void onLink(HermesPtr hermes, TraitInput &input, Trait *trait);
 
  void onUnlink(HermesPtr hermes, TraitInput &input, Trait *trait);
};
 
struct WriteOnlyTrait : public Trait {
  WriteOnlyTrait();
 
  void onAttach(HermesPtr hermes, VBucketID id, Trait *trait);
 
  void onDetach(HermesPtr hermes, VBucketID id, Trait *trait);
 
  void onLink(HermesPtr hermes, TraitInput &input, Trait *trait);
 
  void onUnlink(HermesPtr hermes, TraitInput &input, Trait *trait);
};
 
}  // namespace api
}  // namespace hermes
 
#endif  // HERMES_TRAITS_H