Function template get

Function template get_ptr

hpx::get_ptr — Returns a future referring to a the pointer to the underlying memory of a component.

Synopsis

// In header: <hpx/runtime/get_ptr.hpp>


template<typename Component> 
  hpx::future< boost::shared_ptr< Component > > 
  get_ptr(naming::id_type const & id);

Description

The function hpx::get_ptr can be used to extract a future referring to the pointer to the underlying memory of a given component.

	Note
	This function will successfully return the requested result only if the given component is currently located on the the calling locality. Otherwise the function will raise an error.

Parameters:

`id`	[in] The global id of the component for which the pointer to the underlying memory should be retrieved.

Returns:

This function returns a future representing the pointer to the underlying memory for the component instance with the given id.