Function template migrate

hpx::components::migrate — Migrate the given component to the specified target locality.

Synopsis

// In header: <hpx/runtime/components/migrate_component.hpp>


template<typename Component> 
  future< naming::id_type > 
  migrate(naming::id_type const & to_migrate, 
          naming::id_type const & target_locality);

Description

The function migrate<Component> will migrate the component referenced by to_migrate to the locality specified with target_locality. It returns a future referring to the migrated component instance.

	Note
	If the second argument is omitted (or is invalid_id) the new component instance is created on the locality of the component instance which is to be copied.

Parameters:

`target_locality`	[in] The locality where the component should be migrated to.
`to_migrate`	[in] The global id of the component to migrate.

Returns:

A future representing the global id of the newly (copied) component instance.