vbucket.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 VBUCKET_H_
#define VBUCKET_H_
 
#include <glog/logging.h>
 
#include <list>
#include <memory>
#include <string>
#include <utility>
#include <vector>
 
#include "hermes.h"
#include "traits.h"
 
namespace hermes {
 
namespace api {
 
class VBucket {
 private:
  std::string name_;
  VBucketID id_;
  std::list<Trait *> attached_traits_;
  std::shared_ptr<Hermes> hermes_;
  Context ctx_;
 
 public:
  VBucket(std::string initial_name, std::shared_ptr<Hermes> const &hermes,
          Context ctx = Context());
 
  ~VBucket();
 
  bool IsValid() const;
 
  std::string GetName() const;
 
  void WaitForBackgroundFlush();
 
  Status Link(std::string blob_name, std::string bucket_name);
 
  Status Link(std::string blob_name, std::string bucket_name, Context &ctx);
 
  Status Unlink(std::string blob_name, std::string bucket_name, Context &ctx);
  Status Unlink(std::string blob_name, std::string bucket_name);
 
  bool ContainsBlob(std::string blob_name, std::string bucket_name);
 
  size_t Get(const std::string &name, Bucket &bkt, Blob &user_blob,
             const Context &ctx);
 
  size_t Get(const std::string &name, Bucket &bkt, Blob &user_blob);
 
  size_t Get(const std::string &name, Bucket &bkt, void *user_blob,
             size_t blob_size, const Context &ctx);
 
  size_t Get(const std::string &name, Bucket *bkt, Blob &user_blob,
             const Context &ctx);
 
  size_t Get(const std::string &name, Bucket *bkt, Blob &user_blob);
 
  size_t Get(const std::string &name, Bucket *bkt, void *user_blob,
             size_t blob_size, const Context &ctx);
 
  std::vector<std::string> GetLinks(Context &ctx);
 
  Status Attach(Trait *trait);
 
  Status Attach(Trait *trait, Context &ctx);
 
  Status Detach(Trait *trait);
 
  Status Detach(Trait *trait, Context &ctx);
 
  template <class Predicate>
  std::vector<TraitID> GetTraits(Predicate pred, Context &ctx);
 
  Trait *GetTrait(TraitType type);
 
  Status Release();
 
  Status Release(Context &ctx);
 
  Status Destroy();
 
  Status Destroy(Context &ctx);
};  // class VBucket
 
}  // namespace api
}  // namespace hermes
 
#endif  //  VBUCKET_H_