hermes.h File Reference

#include <glog/logging.h>
#include <cstdint>
#include <string>
#include "buffer_pool.h"
#include "hermes_types.h"
#include "metadata_management.h"
#include "rpc.h"

Include dependency graph for hermes.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	hermes::api::Hermes

Namespaces
	hermes

Functions
std::string	hermes::api::GetVersion ()
	Return the (semantic versioning compatible) version of Hermes. More...
Status	hermes::api::RenameBucket (const std::string &old_name, const std::string &new_name, Context &ctx)
Status	hermes::api::TransferBlob (const Bucket &src_bkt, const std::string &src_blob_name, Bucket &dst_bkt, const std::string &dst_blob_name, Context &ctx)
std::shared_ptr< Hermes >	hermes::api::InitHermes (const char *config_file=NULL, bool is_daemon=false, bool is_adapter=false)
	Initialize an instance of Hermes. More...
std::shared_ptr< api::Hermes >	hermes::InitHermes (Config *config, bool is_daemon, bool is_adapter)
std::shared_ptr< api::Hermes >	hermes::InitHermesDaemon (char *config_file=NULL)
	Initialize a Hermes instance as a daemon. More...
std::shared_ptr< api::Hermes >	hermes::InitHermesDaemon (Config *config)
std::shared_ptr< api::Hermes >	hermes::InitHermesClient (const char *config_file=NULL)
	Initialize a Hermes instance as a client or adapter. More...

Function Documentation

GetVersion()

std::string hermes::api::GetVersion

(

)

Return the (semantic versioning compatible) version of Hermes.

Returns

A string in the form MAJOR.MINOR.PATCH

RenameBucket()

Status hermes::api::RenameBucket	(	const std::string &	old_name,
		const std::string &	new_name,
		Context &	ctx
	)

Renames a bucket referred to by name only

TransferBlob()

Status hermes::api::TransferBlob	(	const Bucket &	src_bkt,
		const std::string &	src_blob_name,
		Bucket &	dst_bkt,
		const std::string &	dst_blob_name,
		Context &	ctx
	)

Todo:

Not implemented yet.

InitHermes()

std::shared_ptr< api::Hermes > hermes::api::InitHermes	(	const char *	config_file = NULL,
		bool	is_daemon = false,
		bool	is_adapter = false
	)

Initialize an instance of Hermes.

Parameters

config_file	The (relative or absolute) path to a hermes configuration file
is_daemon	true if initializing this Hermes instance as a daemon.
is_adapter	true if initializing this Hermes instance as an adapter, or client to an existing daemon.

Precondition

Only one of is_daemon and is_adapter can be true.

Returns

An initialized Hermes instance.