hpx/runtime_distributed/migrate_component.hpp#

Defined in header hpx/runtime_distributed/migrate_component.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, typename DistPolicy>
future<hpx::id_type> migrate(hpx::id_type const &to_migrate, [[maybe_unused]] DistPolicy const &policy)#

Migrate the given component to the specified target locality

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.

Parameters

  • to_migrate – [in] The client side representation of the component to migrate.

  • policy – [in] A distribution policy which will be used to determine the locality to migrate this object to.

Template Parameters

  • Component – Specifies the component type of the component to migrate.

  • DistPolicy – Specifies the distribution policy to use to determine the destination locality.

Returns

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

template<typename Derived, typename Stub, typename Data, typename DistPolicy>
Derived migrate(client_base<Derived, Stub, Data> const &to_migrate, DistPolicy const &policy)#

Migrate the given component to the specified target locality

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.

Parameters

  • to_migrate – [in] The client side representation of the component to migrate.

  • policy – [in] A distribution policy which will be used to determine the locality to migrate this object to.

Template Parameters

  • Derived – Specifies the component type of the component to migrate.

  • DistPolicy – Specifies the distribution policy to use to determine the destination locality.

Returns

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

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

Migrate the component with the given id to the specified target locality

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.

Parameters

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

  • target_locality – [in] The locality where the component should be migrated to.

Template Parameters

Component – Specifies the component type of the component to migrate.

Returns

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

template<typename Derived, typename Stub, typename Data>
Derived migrate(client_base<Derived, Stub, Data> const &to_migrate, hpx::id_type const &target_locality)#

Migrate the given component to the specified target locality

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.

Parameters

  • to_migrate – [in] The client side representation of the component to migrate.

  • target_locality – [in] The id of the locality to migrate this object to.

Template Parameters

Derived – Specifies the component type of the component to migrate.

Returns

A client side representation of representing of the migrated component instance. This should be the same as migrate_to.