.rst .pdf

repository open issue

Contents

Full API

The full API of HPX is presented below. The listings for the public API above refer to the full documentation below.

Note

Most names listed in the full API reference are implementation details or considered unstable. They are listed mostly for completeness. If there is a particular feature you think deserves being in the public API we may consider promoting it. In general we prioritize making sure features corresponding to C++ standard library features are stable and complete.

• affinity
• algorithms
• allocator_support
• asio
• assertion
• async_base
• async_combinators
• async_cuda
• async_local
• async_mpi
• batch_environments
• cache
• command_line_handling_local
• concepts
• concurrency
• config
• config_registry
• coroutines
• datastructures
• debugging
• errors
• execution
• execution_base
• executors
• filesystem
• format
• functional
• futures
• hardware
• hashing
• include_local
• ini
• init_runtime_local
• io_service
• iterator_support
• itt_notify
• lci_base
• lcos_local
• logging
• memory
• mpi_base
• pack_traversal
• plugin
• prefix
• preprocessor
• program_options
• properties
• resiliency
• resource_partitioner
• runtime_configuration
• runtime_local
• schedulers
• serialization
• static_reinit
• string_util
• synchronization
• tag_invoke
• testing
• thread_pool_util
• thread_pools
• thread_support
• threading
• threading_base
• threadmanager
• timed_execution
• timing
• topology
• type_support
• util
• version
• actions
• actions_base
• agas
• agas_base
• async_colocated
• async_distributed
• checkpoint
• checkpoint_base
• collectives
• command_line_handling
• components
• components_base
• compute
• distribution_policies
• executors_distributed
• include
• init_runtime
• lcos_distributed
• naming
• naming_base
• parcelport_lci
• parcelport_libfabric
• parcelport_mpi
• parcelport_tcp
• parcelset
• parcelset_base
• performance_counters
• plugin_factories
• resiliency_distributed
• runtime_components
• runtime_distributed
• segmented_algorithms
• statistics

Main HPX library

This lists functionality in the main HPX library that has not been moved to modules yet.

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.

Return

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

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.

template<typename Component>
future<hpx::id_type> migrate_to_storage(hpx::id_type const &to_migrate, hpx::id_type const &target_storage)

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

The function migrate_to_storage<Component> will migrate the component referenced by to_migrate to the storage facility specified with target_storage. It returns a future referring to the migrated component instance.

Return

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

Parameters

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

• target_storage: [in] The id of the storage facility to migrate this object to.

Template Parameters

• The: only template argument specifies the component type of the component to migrate to the given storage facility.

template<typename Derived, typename Stub>
Derived migrate_to_storage(client_base<Derived, Stub> const &to_migrate, hpx::components::component_storage const &target_storage)

Migrate the given component to the specified target storage

The function migrate_to_storage will migrate the component referenced by to_migrate to the storage facility specified with target_storage. It returns a future referring to the migrated component instance.

Return

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

Parameters

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

• target_storage: [in] The id of the storage facility to migrate this object to.

file migrate_from_storage.hpp

#include <hpx/config.hpp>#include <hpx/components_base/traits/is_component.hpp>#include <hpx/futures/future.hpp>#include <hpx/naming_base/id_type.hpp>#include <hpx/components/component_storage/server/migrate_from_storage.hpp>#include <type_traits>

file migrate_to_storage.hpp

#include <hpx/config.hpp>#include <hpx/components/client_base.hpp>#include <hpx/components_base/traits/is_component.hpp>#include <hpx/futures/future.hpp>#include <hpx/naming_base/id_type.hpp>#include <hpx/components/component_storage/component_storage.hpp>#include <hpx/components/component_storage/server/migrate_to_storage.hpp>#include <type_traits>

dir /hpx/source/components/component_storage

dir /hpx/source/components/component_storage/include/hpx/components/component_storage

dir /hpx/source/components/component_storage/include/hpx/components

dir /hpx/source/components

dir /hpx/source/components/component_storage/include/hpx

dir /hpx/source/components/component_storage/include

dir /hpx/source

previous

Public API

next

affinity