hpx::get_locality_name

hpx::get_locality_name#

Defined in header hpx/runtime.hpp.

See Public API for a list of names and headers that are part of the public HPX API.

std::string hpx::get_locality_name()#

Return the name of the locality this function is called on.

This function returns the name for the locality on which this function is called.

See also

future<std::string> get_locality_name(hpx::id_type const& id)

Returns:

This function returns the name for the locality on which the function is called. The name is retrieved from the underlying networking layer and may be different for different parcelports.

future<std::string> hpx::get_locality_name(hpx::id_type const &id)#

Return the name of the referenced locality.

This function returns a future referring to the name for the locality of the given id.

See also

std::string get_locality_name()

Parameters:

id – [in] The global id of the locality for which the name should be retrieved

Returns:

This function returns the name for the locality of the given id. The name is retrieved from the underlying networking layer and may be different for different parcel ports.