HPX_REGISTER_COMMANDLINE_MODULE

Defined in header hpx/components.hpp.

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

Defines

HPX_DEFINE_COMPONENT_COMMANDLINE_OPTIONS(add_options_function)

HPX_REGISTER_COMMANDLINE_MODULE(add_options_function)

Macro to register a command-line module with the HPX runtime.

This macro facilitates the registration of a command-line module with the HPX runtime system. A command-line module typically provides additional command-line options that can be used to configure the HPX application.

Parameters

• add_options_function – The function that adds custom command-line options.

HPX_REGISTER_COMMANDLINE_MODULE_DYNAMIC(add_options_function)

namespace hpx

namespace components

struct component_commandline : public component_commandline_base

#include <component_commandline.hpp>

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

Public Functions

inline hpx::program_options::options_description add_commandline_options() override

Return any additional command line options valid for this component.

Note

This function will be executed by the runtime system during system startup.

Returns

The module is expected to fill a options_description object with any additional command line options this component will handle.

namespace commandline_options_provider

Functions

hpx::program_options::options_description add_commandline_options()