Function register_id_with

Function register_id_with_basename

hpx::register_id_with_basename — Register the given id using the given base name.

Synopsis

// In header: <hpx/hpx_fwd.hpp>


hpx::future< bool > 
register_id_with_basename(char const * base_name, hpx::id_type id, 
                          std::size_t sequence_nr = ~0U);

Description

The function registers the given ids using the provided base name.

	Note
	The operation will fail if the given sequence number is not unique.

Parameters:

`base_name`	[in] The base name for which to retrieve the registered ids.
`id`	[in] The id to register using the given base name.
`sequence_nr`	[in, optional] The sequential number to use for the registration of the id. This number has to be unique system wide for each registration using the same base name. The default is the current locality identifier. Also, the sequence numbers have to be consecutive starting from zero.

Returns:

A future representing the result of the registration operation itself.