The contents of this module can be included with the header
hpx/modules/async_colocated.hpp. These headers may be used by user-code but are not
guaranteed stable (neither header location nor contents). You are using these at
your own risk. If you wish to use non-public functionality from a module we
strongly suggest only including the module header
the particular header in which the functionality you would like to use is
defined. See Public API for a list of names that are part of the public
get_colocation_id(launch::sync_policy, naming::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.