HPX - High Performance ParalleX

PrevUpHomeNext

Function get_colocation_id_sync

hpx::get_colocation_id_sync — Return the id of the locality where the object referenced by the given id is currently located on.

Synopsis

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


naming::id_type 
get_colocation_id_sync(naming::id_type const & id, error_code & ec = throws);

Description

The function hpx::get_colocation_id() returns the id of the locality where the given object is currently located.

[Note] 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.

See Also:

hpx::get_colocation_id()

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.

id

[in] The id of the object to locate.


PrevUpHomeNext