Function find_remote

Function find_remote_localities

hpx::find_remote_localities — Return the list of locality ids of remote localities supporting the given component type. By default this function will return the list of all remote localities (all but the current locality).

Synopsis

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


std::vector< naming::id_type > 
find_remote_localities(components::component_type type, 
                       error_code & ec = throws);

Description

The function find_remote_localities() can be used to retrieve the global ids of all remote localities currently available to this application (i.e. all localities except the current one) which support the creation of instances of the given component type.

	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.
`type`	[in] The type of the components for which the function should return the available remote localities.

Returns:

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