stapl::runtime::rmi_handle_base Class Reference

Distributed object base handle. More...

Public Member Functions
void	set_flags (const unsigned int flags) noexcept
	Sets the flags for this object.
constexpr unsigned int	get_flags (void) const noexcept
	Returns the flags of this object.
constexpr size_type	get_num_locations (void) const noexcept
	Returns the size of the gang this object registered in.
constexpr bool	is_valid (const size_type n) const noexcept
	Returns if the given location id is valid for the gang this object registered in.
constexpr bool	valid (void) const noexcept
	Returns true if this handle is associated with an object.
constexpr internal_handle_type const &	internal_handle (void) const noexcept
constexpr epoch_type	get_registration_epoch (void) const noexcept
	Returns the epoch that the object was registered in.
constexpr epoch_type	get_epoch (void) const noexcept
	Returns the epoch that the object is currently in.
constexpr gang_id	get_gang_id (void) const noexcept
	Returns the gang id of the gang this object registered in.
std::string	get_uid (void) const
	Returns a unique id of the registered object. More...

Public Types
using	size_type = location_id
using	internal_handle_type = object_virtual_address
using	epoch_type = logical_clock::time_type

Protected Member Functions
void	set_epoch (epoch_type e) noexcept
	Sets the epoch that the object is currently in.

Friends
class	stapl::rmi_handle

Detailed Description

Distributed object base handle.

This class provides information about a registered distributed object, such as the registration id, the registration epoch, the current epoch, communication related flags, gang id and number of locations in the gang.

This class is also the implementation of rmi_handle::const_reference.

See also

rmi_handle

Member Function Documentation

get_uid()

std::string stapl::runtime::rmi_handle_info::get_uid ( void  ) const

inherited

Returns a unique id of the registered object.

Warning

This should not be used to deduce locality information about a handle.

---

The documentation for this class was generated from the following file:

• rmi_handle_fwd.hpp