checkpoint_base

The contents of this module can be included with the header hpx/modules/checkpoint_base.hpp. These headers may be used by user-code but are not guaranteed stable (neither header location nor contents). You are using these at your own risk. If you wish to use non-public functionality from a module we strongly suggest only including the module header hpx/modules/checkpoint_base.hpp, not the particular header in which the functionality you would like to use is defined. See Public API for a list of names that are part of the public HPX API.

namespace hpx
namespace util

Functions

template<typename Container, typename ...Ts>
void save_checkpoint_data(Container &data, Ts&&... ts)

save_checkpoint_data

Save_checkpoint_data takes any number of objects which a user may wish to store in the given container.

Template Parameters

  • Container: Container used to store the check-pointed data.

  • Ts: Types of variables to checkpoint

Parameters

  • cont: Container instance used to store the checkpoint data

  • ts: Variable instances to be inserted into the checkpoint.

template<typename ...Ts>
std::size_t prepare_checkpoint_data(Ts const&... ts)

prepare_checkpoint_data

prepare_checkpoint_data takes any number of objects which a user may wish to store in a subsequent save_checkpoint_data operation. The function will return the number of bytes necessary to store the data that will be produced.

Template Parameters

  • Ts: Types of variables to checkpoint

Parameters

  • ts: Variable instances to be inserted into the checkpoint.

template<typename Container, typename ...Ts>
void restore_checkpoint_data(Container const &cont, Ts&... ts)

restore_checkpoint_data

restore_checkpoint_data takes any number of objects which a user may wish to restore from the given container. The sequence of objects has to correspond to the sequence of objects for the corresponding call to save_checkpoint_data that had used the given container instance.

Template Parameters

  • Container: Container used to restore the check-pointed data.

  • Ts: Types of variables to restore

Parameters

  • cont: Container instance used to restore the checkpoint data

  • ts: Variable instances to be restored from the container