hpx/components/component_storage/migrate_from_storage.hpp#

Defined in header hpx/components/component_storage/migrate_from_storage.hpp.

See Public API for a list of names and headers that are part of the public HPX API.

namespace hpx#
namespace components#

Functions

template<typename Component>
future<hpx::id_type> migrate_from_storage(hpx::id_type const &to_resurrect, hpx::id_type const &target = hpx::invalid_id)#

Migrate the component with the given id from the specified target storage (resurrect the object)

The function migrate_from_storage<Component> will migrate the component referenced by to_resurrect from the storage facility specified where the object is currently stored on. It returns a future referring to the migrated component instance. The component instance is resurrected on the locality specified by target_locality.

Parameters
  • to_resurrect – [in] The global id of the component to migrate.

  • target – [in] The optional locality to resurrect the object on. By default the object is resurrected on the locality it was located on last.

Template Parameters

The – only template argument specifies the component type of the component to migrate from the given storage facility.

Returns

A future representing the global id of the migrated component instance. This should be the same as to_resurrect.