HPX - High Performance ParalleX

Application Specific Component Example

In this section we assume to have a simple application component which exposes one member function as a component action. The header file app_server.hpp declares the C++ type to be exposed as a component. This type has a member function print_greating() which is exposed as an action (print_greating_action). We assume the source files for this example are located in a directory referenced by $APP_ROOT:

// file: $APP_ROOT/app_server.hpp
#include <hpx/hpx.hpp>
#include <hpx/include/iostreams.hpp>

namespace app
    // Define a simple component exposing one action 'print_greating'
    class HPX_COMPONENT_EXPORT server
      : public hpx::components::simple_component_base<server>
        void print_greating ()
            hpx::cout << "Hey, how are you?\n" << hpx::flush;

        // Component actions need to be declared, this also defines the
        // type 'print_greating_action' representing the action.
        HPX_DEFINE_COMPONENT_ACTION(server, print_greating, print_greating_action);

// Declare boilerplate code required for each of the component actions.

The corresponding source file contains mainly macro invocations which define boilerplate code needed for HPX to function properly:

// file: $APP_ROOT/app_server.cpp
#include "app_server.hpp"

// Define boilerplate required once per component module.

// Define factory object associated with our component of type 'app::server'.

// Define boilerplate code required for each of the component actions. Use the
// same argument as used for HPX_REGISTER_ACTION_DECLARATION above.

The following gives an example of how the component can be used. We create one instance of the app::server component on the current locality and invoke the exposed action print_greating_action using the global id of the newly created instance. Note, that no special code is required to delete the component instance after it is not needed anymore. It will be deleted automatically when its last reference goes out of scope, here at the closing brace of the block surrounding the code.

// file: $APP_ROOT/use_app_server_example.cpp
#include <hpx/hpx_init.hpp>
#include "app_server.hpp"

int hpx_main()
        // Create an instance of the app_server component on the current locality.
        hpx::naming:id_type app_server_instance =

        // Create an instance of the action 'print_greating_action'.
        app::server::print_greating_action print_greating;

        // Invoke the action 'print_greating' on the newly created component.
    return hpx::finalize();

int main(int argc, char* argv[])
    return hpx::init(argc, argv);

In order to make sure that the application will be able to use the component app::server, special configuration information must be passed to HPX. The simples way to allow HPX to 'find' the component is to provide special ini configuration files, which add the necessary information to the internal configuration database. The component should have a special ini file containing the information specific to the component app_server:

# file: $APP_ROOT/app_server.ini
name = app_server

Here $APP_LOCATION is the directory where the (binary) component shared library is located. HPX will attempt to load the shared library from there. The section name hpx.components.app_server reflects the instance name of the component (app_server is an arbitrary, but unique name) . The property value for hpx.components.app_server.name should be the same as used for the second argument to the macro HPX_REGISTER_MINIMAL_COMPONENT_FACTORY above.

Additionally a file .hpx.ini which could be located in the current working directory (see step 3 as described in the section Loading INI Files) allows to add the directory to the ini search path where the above ini file specific to the component is located:

# file: $PWD/.hpx.ini
ini_path = $[hpx.ini_path]:$APP_ROOT/

This assumes that the above ini file specific to the component is located in the directory $APP_ROOT.

[Note] Note

It is possible to reference the defined property from inside its value. HPX will gracefully use the previous value of hpx.ini_path for the reference on the right hand side and assign the overall (now expanded) value to the property.