Holds settings for checkpoints to load or save. More...

#include <CheckpointSettings.h>

Collaboration diagram for madara::knowledge::CheckpointSettings:

Public Member Functions
	CheckpointSettings ()
	Constructor. More...

	CheckpointSettings (bool t_buffer_size, bool t_clear_knowledge, std::string t_filename="", uint64_t t_initial_timestamp=0, uint64_t t_last_timestamp=0, uint64_t t_initial_lamport_clock=0, uint64_t t_last_lamport_clock=0, std::string t_originator="", const std::vector< std::string > &t_prefixes={}, uint64_t t_states=0, std::string t_version="")
	Constructor. More...

	CheckpointSettings (const CheckpointSettings &rhs)
	Copy constructor. More...

Public Attributes
size_t	buffer_size
	the size of the buffer needed for the checkpoint More...

bool	clear_knowledge
	If true, during loads, clear the KnowledgeBase first. More...

std::string	filename
	path to files More...

uint64_t	initial_lamport_clock
	initial lamport clock saved in the checkpoint More...

uint64_t	initial_timestamp
	initial wallclock time saved in the checkpoint More...

uint64_t	last_lamport_clock
	final lamport clock saved in the checkpoint More...

uint64_t	last_timestamp
	final wallclock time saved in the checkpoint More...

std::string	originator
	the originator id of the checkpoint More...

std::vector< std::string >	prefixes
	A list of prefixes to save/load. More...

uint64_t	states
	the number of states checkpointed in the file stream More...

std::string	version
	the MADARA version More...

Detailed Description

Holds settings for checkpoints to load or save.

Definition at line 27 of file CheckpointSettings.h.

Constructor & Destructor Documentation

madara::knowledge::CheckpointSettings::CheckpointSettings ( )

inline

Constructor.

Definition at line 32 of file CheckpointSettings.h.

madara::knowledge::CheckpointSettings::CheckpointSettings	(	bool	t_buffer_size,
		bool	t_clear_knowledge,
		std::string	t_filename = `""`,
		uint64_t	t_initial_timestamp = `0`,
		uint64_t	t_last_timestamp = `0`,
		uint64_t	t_initial_lamport_clock = `0`,
		uint64_t	t_last_lamport_clock = `0`,
		std::string	t_originator = `""`,
		const std::vector< std::string > &	t_prefixes = `{}`,
		uint64_t	t_states = `0`,
		std::string	t_version = `""`
	)

inline

Constructor.

Parameters

t_buffer_size	size in bytes to allocate for a buffer
t_clear_knowledge	if true, during loads, clear knowledge
t_filename	the filename, including path to load/save
t_originator	the originator id
t_initial_timestamp	the wallclock time the checkpoint started
t_last_timestamp	the wallclock time the checkpoint ended
t_initial_lamport_clock	the clock when checkpoint started
t_last_lamport_clock	the clock when checkpoint ended
t_prefixes	the prefixes to save or load (empty = all)
t_states	number of states in checkpoint

Definition at line 54 of file CheckpointSettings.h.

madara::knowledge::CheckpointSettings::CheckpointSettings ( const CheckpointSettings & rhs )

inline

Copy constructor.

Parameters

rhs	settings instance to copy

Definition at line 83 of file CheckpointSettings.h.

Member Data Documentation

size_t madara::knowledge::CheckpointSettings::buffer_size

the size of the buffer needed for the checkpoint

Definition at line 101 of file CheckpointSettings.h.

bool madara::knowledge::CheckpointSettings::clear_knowledge

If true, during loads, clear the KnowledgeBase first.

Definition at line 106 of file CheckpointSettings.h.

std::string madara::knowledge::CheckpointSettings::filename

path to files

Definition at line 111 of file CheckpointSettings.h.

uint64_t madara::knowledge::CheckpointSettings::initial_lamport_clock

initial lamport clock saved in the checkpoint

Definition at line 126 of file CheckpointSettings.h.

uint64_t madara::knowledge::CheckpointSettings::initial_timestamp

initial wallclock time saved in the checkpoint

Definition at line 116 of file CheckpointSettings.h.

uint64_t madara::knowledge::CheckpointSettings::last_lamport_clock

final lamport clock saved in the checkpoint

Definition at line 131 of file CheckpointSettings.h.

uint64_t madara::knowledge::CheckpointSettings::last_timestamp

final wallclock time saved in the checkpoint

Definition at line 121 of file CheckpointSettings.h.

std::string madara::knowledge::CheckpointSettings::originator

the originator id of the checkpoint

Definition at line 136 of file CheckpointSettings.h.

std::vector<std::string> madara::knowledge::CheckpointSettings::prefixes

A list of prefixes to save/load.

If empty, all prefixes are valid.

Definition at line 141 of file CheckpointSettings.h.

uint64_t madara::knowledge::CheckpointSettings::states

the number of states checkpointed in the file stream

Definition at line 146 of file CheckpointSettings.h.

std::string madara::knowledge::CheckpointSettings::version

the MADARA version

Definition at line 151 of file CheckpointSettings.h.

The documentation for this class was generated from the following file:

include/madara/knowledge/CheckpointSettings.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Data Documentation