hpx/runtime_components/component_registry.hpp#

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

Defines

HPX_REGISTER_MINIMAL_COMPONENT_REGISTRY(...)#

This macro is used create and to register a minimal component registry with Hpx.Plugin.

HPX_REGISTER_MINIMAL_COMPONENT_REGISTRY_(...)#
HPX_REGISTER_MINIMAL_COMPONENT_REGISTRY_2(ComponentType, componentname)#
HPX_REGISTER_MINIMAL_COMPONENT_REGISTRY_3(ComponentType, componentname, state)#
HPX_REGISTER_MINIMAL_COMPONENT_REGISTRY_DYNAMIC(...)#
HPX_REGISTER_MINIMAL_COMPONENT_REGISTRY_DYNAMIC_(...)#
HPX_REGISTER_MINIMAL_COMPONENT_REGISTRY_DYNAMIC_2(ComponentType, componentname)#
HPX_REGISTER_MINIMAL_COMPONENT_REGISTRY_DYNAMIC_3(ComponentType, componentname, state)#
namespace hpx
namespace components
template<typename Component, factory_state_enum state>
struct component_registry : public component_registry_base#
#include <component_registry.hpp>

The component_registry provides a minimal implementation of a component’s registry. If no additional functionality is required this type can be used to implement the full set of minimally required functions to be exposed by a component’s registry instance.

Template Parameters

Component – The component type this registry should be responsible for.

Public Functions

inline bool get_component_info(std::vector<std::string> &fillini, std::string const &filepath, bool is_static = false) override#

Return the ini-information for all contained components.

Parameters

fillini – [in] The module is expected to fill this vector with the ini-information (one line per vector element) for all components implemented in this module.

Returns

Returns true if the parameter fillini has been successfully initialized with the registry data of all implemented in this module.

inline void register_component_type() override#

Return the unique identifier of the component type this factory is responsible for.

Parameters
  • locality – [in] The id of the locality this factory is responsible for.

  • agas_client – [in] The AGAS client to use for component id registration (if needed).

Returns

Returns the unique identifier of the component type this factory instance is responsible for. This function throws on any error.