hpx/components_base/component_startup_shutdown.hpp

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

Defines

HPX_DEFINE_COMPONENT_STARTUP_SHUTDOWN(startup_, shutdown_)

HPX_REGISTER_STARTUP_SHUTDOWN_MODULE_(startup, shutdown)

HPX_REGISTER_STARTUP_SHUTDOWN_MODULE(startup, shutdown)

HPX_REGISTER_STARTUP_SHUTDOWN_MODULE_DYNAMIC(startup, shutdown)

HPX_REGISTER_STARTUP_MODULE(startup)

HPX_REGISTER_STARTUP_MODULE_DYNAMIC(startup)

HPX_REGISTER_SHUTDOWN_MODULE(shutdown)

HPX_REGISTER_SHUTDOWN_MODULE_DYNAMIC(shutdown)

namespace hpx

namespace components

template<bool (*Startup)(startup_function_type&, bool&), bool (*Shutdown)(shutdown_function_type&, bool&)>
struct component_startup_shutdown : public component_startup_shutdown_base

#include <component_startup_shutdown.hpp>

The component_startup_shutdown class provides a minimal implementation of a component’s startup/shutdown function provider.

Public Functions

inline bool get_startup_function(startup_function_type &startup, bool &pre_startup) override

Return any startup function for this component.

Parameters

startup – [in, out] The module is expected to fill this function object with a reference to a startup function. This function will be executed by the runtime system during system startup.

Returns

Returns true if the parameter startup has been successfully initialized with the startup function.

inline bool get_shutdown_function(shutdown_function_type &shutdown, bool &pre_shutdown) override

Return any startup function for this component.

Parameters

shutdown – [in, out] The module is expected to fill this function object with a reference to a startup function. This function will be executed by the runtime system during system startup.

Returns

Returns true if the parameter shutdown has been successfully initialized with the shutdown function.