Set of options for savepoint manager. More...

Detailed Description

Set of options for savepoint manager.

This is a POD struct. Default destructor/copy-constructor/assignment operator work fine.

Definition at line 34 of file savepoint_options.hpp.

#include <savepoint_options.hpp>

Inheritance diagram for foedus::savepoint::SavepointOptions:

[legend]

Collaboration diagram for foedus::savepoint::SavepointOptions:

[legend]

Public Member Functions
	SavepointOptions ()
	Constructs option values with default values. More...

ErrorStack	load (tinyxml2::XMLElement *element) override
	Reads the content of this object from the given XML element. More...

ErrorStack	save (tinyxml2::XMLElement *element) const override
	Writes the content of this object to the given XML element. More...

const char *	get_tag_name () const override
	Returns an XML tag name for this object as a root element. More...

void	assign (const foedus::externalize::Externalizable *other) override
	Polymorphic assign operator. More...

Public Member Functions inherited from foedus::externalize::Externalizable
ErrorStack	load_from_string (const std::string &xml)
	Load the content of this object from the given XML string. More...

void	save_to_stream (std::ostream *ptr) const
	Invokes save() and directs the resulting XML text to the given stream. More...

ErrorStack	load_from_file (const fs::Path &path)
	Load the content of this object from the specified XML file. More...

ErrorStack	save_to_file (const fs::Path &path) const
	Atomically and durably writes out this object to the specified XML file. More...

Public Attributes
fs::FixedPath	savepoint_path_
	Full path of the savepoint file. More...

Friends
std::ostream &	operator<< (std::ostream &o, const SavepointOptions &v)

Additional Inherited Members
Static Public Member Functions inherited from foedus::externalize::Externalizable
static ErrorStack	insert_comment (tinyxml2::XMLElement *element, const std::string &comment)

static ErrorStack	append_comment (tinyxml2::XMLElement *parent, const std::string &comment)

static ErrorStack	create_element (tinyxml2::XMLElement parent, const std::string &name, tinyxml2::XMLElement *out)

template<typename T >
static ErrorStack	add_element (tinyxml2::XMLElement *parent, const std::string &tag, const std::string &comment, T value)
	Only declaration in header. More...

template<uint MAXLEN, typename CHAR >
static ErrorStack	add_element (tinyxml2::XMLElement *parent, const std::string &tag, const std::string &comment, const assorted::FixedString< MAXLEN, CHAR > &value)

template<typename T >
static ErrorStack	add_element (tinyxml2::XMLElement *parent, const std::string &tag, const std::string &comment, const std::vector< T > &value)
	vector version More...

template<typename ENUM >
static ErrorStack	add_enum_element (tinyxml2::XMLElement *parent, const std::string &tag, const std::string &comment, ENUM value)
	enum version More...

static ErrorStack	add_child_element (tinyxml2::XMLElement *parent, const std::string &tag, const std::string &comment, const Externalizable &child)
	child Externalizable version More...

template<typename T >
static ErrorStack	get_element (tinyxml2::XMLElement parent, const std::string &tag, T out, bool optional=false, T value=0)
	Only declaration in header. More...

static ErrorStack	get_element (tinyxml2::XMLElement parent, const std::string &tag, std::string out, bool optional=false, const char *value="")
	string type is bit special. More...

template<uint MAXLEN, typename CHAR >
static ErrorStack	get_element (tinyxml2::XMLElement parent, const std::string &tag, assorted::FixedString< MAXLEN, CHAR > out, bool optional=false, const assorted::FixedString< MAXLEN, CHAR > &value=assorted::FixedString< MAXLEN, CHAR >())

template<typename ENUM >
static ErrorStack	get_enum_element (tinyxml2::XMLElement parent, const std::string &tag, ENUM out, bool optional=false, ENUM default_value=static_cast< ENUM >(0))
	enum version More...

template<typename T >
static ErrorStack	get_element (tinyxml2::XMLElement parent, const std::string &tag, std::vector< T > out, bool optional=false)
	vector version. More...

static ErrorStack	get_child_element (tinyxml2::XMLElement parent, const std::string &tag, Externalizable child, bool optional=false)
	child Externalizable version More...

Constructor & Destructor Documentation

foedus::savepoint::SavepointOptions::SavepointOptions ( )

Constructs option values with default values.

Definition at line 26 of file savepoint_options.cpp.

References savepoint_path_.

                                    {
   savepoint_path_ = "savepoint.xml";
 }

Member Function Documentation

void foedus::savepoint::SavepointOptions::assign ( const foedus::externalize::Externalizable * other )

inlineoverridevirtual

Polymorphic assign operator.

This should invoke operator= of the derived class.

Parameters

[in] other assigned value. It must be dynamic-castable to the assignee class.

Implements foedus::externalize::Externalizable.

Definition at line 48 of file savepoint_options.hpp.

const char* foedus::savepoint::SavepointOptions::get_tag_name ( ) const

inlineoverridevirtual

Returns an XML tag name for this object as a root element.

We might want to give a different name for same externalizable objects, so this is used only when it is the root element of xml.

Implements foedus::externalize::Externalizable.

Definition at line 48 of file savepoint_options.hpp.

ErrorStack foedus::savepoint::SavepointOptions::load ( tinyxml2::XMLElement * element )

overridevirtual

Reads the content of this object from the given XML element.

Parameters

[in] element the XML element that represents this object

Expect errors due to missing-elements, out-of-range values, etc.

Implements foedus::externalize::Externalizable.

Definition at line 29 of file savepoint_options.cpp.

References EXTERNALIZE_LOAD_ELEMENT, foedus::kRetOk, and savepoint_path_.

                                                              {
   EXTERNALIZE_LOAD_ELEMENT(element, savepoint_path_);
   return kRetOk;
 }

ErrorStack foedus::savepoint::SavepointOptions::save ( tinyxml2::XMLElement * element ) const

overridevirtual

Writes the content of this object to the given XML element.

Parameters

[in] element the XML element that represents this object

Expect only out-of-memory error. We receive the XML element this object will represent, so this method does not determine the XML element name of itself. The parent object determines children's tag names because one parent object might have multiple child objects of the same type with different XML element name.

Implements foedus::externalize::Externalizable.

Definition at line 34 of file savepoint_options.cpp.

References CHECK_ERROR, EXTERNALIZE_SAVE_ELEMENT, foedus::externalize::Externalizable::insert_comment(), foedus::kRetOk, and savepoint_path_.

                                                                    {
   CHECK_ERROR(insert_comment(element, "Set of options for savepoint manager"));
   EXTERNALIZE_SAVE_ELEMENT(element, savepoint_path_, "Full path of the savepoint file.");
   return kRetOk;
 }

Here is the call graph for this function:

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	o,
		const SavepointOptions &	v
	)

friend

Definition at line 48 of file savepoint_options.hpp.

Member Data Documentation

fs::FixedPath foedus::savepoint::SavepointOptions::savepoint_path_

Full path of the savepoint file.

This file is atomically and durably updated for each epoch-based commit. Default is "savepoint.xml".

Definition at line 46 of file savepoint_options.hpp.

Referenced by foedus::savepoint::SavepointManagerPimpl::initialize_once(), load(), save(), and SavepointOptions().

The documentation for this struct was generated from the following files:

/home/shino/foedus_code/foedus-core/include/foedus/savepoint/savepoint_options.hpp
/home/shino/foedus_code/foedus-core/src/foedus/savepoint/savepoint_options.cpp

Detailed Description

Public Member Functions

Public Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation