See Public API for a list of names and headers that are part of the public HPX API.
get_colocation_id(launch::sync_policy, hpx::id_type const &id, error_code &ec = throws)¶
Return the id of the locality where the object referenced by the given id is currently located on.
The function hpx::get_colocation_id() returns the id of the locality where the given object is currently located.
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.
id: [in] The id of the object to locate.
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.