metall Namespace Reference

The top level of namespace of Metall. More...

Namespaces
	attraccs_detail
	Namespace for the details of attribute accessor.
	container
	Namespace for Metall container.
	json
	Namespace for Metall JSON container, which is in an experimental phase.
	utility
	Namespace for utility items.

Classes
class	basic_manager
	A generalized Metall manager class. More...
class	logger
class	named_object_attr_accessor
	Objet attribute accessor for named object. More...
class	unique_object_attr_accessor
	Objet attribute accessor for unique object. More...
class	anonymous_object_attr_accessor
class	stl_allocator
	A STL compatible allocator. More...
struct	create_only_t
	Tag type to create the segment always. The existing segment with the same name is over written. More...
struct	open_only_t
	Tag type to open an already created segment. More...
struct	open_read_only_t
	Tag type to open an already created segment as read only. More...

Typedefs
using	manager = basic_manager<>
	Default Metall manager class which is an alias of basic_manager with the default template parameters. More...
template<typename T >
using	offset_ptr = boost::interprocess::offset_ptr< T >
	Holds an offset between the address pointing at and itself. More...
using	version_type = uint32_t
	Variable type to handle a version data. More...

Functions
template<typename T , typename kernel >
bool	operator== (const stl_allocator< T, kernel > &rhd, const stl_allocator< T, kernel > &lhd)
template<typename T , typename kernel >
bool	operator!= (const stl_allocator< T, kernel > &rhd, const stl_allocator< T, kernel > &lhd)
std::string	to_version_string (const version_type version)
	Converts a raw version number to a std::string with format 'MAJOR.MINOR.PATCH'. More...

Detailed Description

The top level of namespace of Metall.

Typedef Documentation

manager

using metall::manager = typedef basic_manager<>

Default Metall manager class which is an alias of basic_manager with the default template parameters.

Examples

adjacency_list_graph.cpp, allocator_aware_type.cpp, c_api.c, complex_map.cpp, concurrent_map.cpp, csr_graph.cpp, datastore_description.cpp, fallback_allocator.cpp, jgraph.cpp, json_create.cpp, json_open.cpp, logger.cpp, metall_containers.cpp, multilevel_containers.cpp, object_attribute.cpp, object_attribute_api_list.cpp, offset_pointer.cpp, simple.cpp, snapshot.cpp, string.cpp, string_map.cpp, and vector_of_vectors.cpp.

offset_ptr

template<typename T >

using metall::offset_ptr = typedef boost::interprocess::offset_ptr<T>

Holds an offset between the address pointing at and itself.

Template Parameters

T

A type.

version_type

using metall::version_type = typedef uint32_t

Variable type to handle a version data.

Function Documentation

operator==()

template<typename T , typename kernel >

bool metall::operator== ( const stl_allocator< T, kernel > &  rhd, const stl_allocator< T, kernel > &  lhd  )

inline

operator!=()

template<typename T , typename kernel >

bool metall::operator!= ( const stl_allocator< T, kernel > &  rhd, const stl_allocator< T, kernel > &  lhd  )

inline

to_version_string()

std::string metall::to_version_string ( const version_type  version )

inline

Converts a raw version number to a std::string with format 'MAJOR.MINOR.PATCH'.

// Example usage
std::string ver_string = to_version_string(METALL_VERSION);

Parameters

version

A version number.

Returns

A version string.