Function find_all

Function find_all_localities

hpx::find_all_localities — Return the list of global ids representing all localities available to this application.

Synopsis

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


std::vector< naming::id_type > find_all_localities(error_code & ec = throws);

Description

The function find_all_localities() can be used to retrieve the global ids of all localities currently available to this application.

	Note
	Generally, the id of a locality can be used for instance to create new instances of components and to invoke plain actions (global functions).

Note

As long as ec is not pre-initialized to hpx::throws this function doesn't throw but returns the result code using the parameter ec. Otherwise it throws an instance of hpx::exception.

This function will return meaningful results only if called from an HPX-thread. It will return an empty vector otherwise.

See Also:

hpx::find_here(), hpx::find_locality()

Parameters:

`ec`	[in,out] this represents the error status on exit, if this is pre-initialized to hpx::throws the function will throw on error instead.

Returns:

The global ids representing the localities currently available to this application.