stapl::runtime::rmi_handle_info Class Reference

Distributed object handle information. More...

Public Member Functions
constexpr	rmi_handle_info (std::pair< object_virtual_address, epoch_type > const &p, const gang_id gid) noexcept
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	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
constexpr bool	operator== (rmi_handle_info const &x, rmi_handle_info const &y) noexcept
	Returns true of the x and y are associated with the same registered object. More...
constexpr bool	operator!= (rmi_handle_info const &x, rmi_handle_info const &y) noexcept
std::ostream &	operator<< (std::ostream &, rmi_handle_info const &)

Detailed Description

Distributed object handle information.

This class provides basic information about a registered distributed object, such as the object_virtual_address, the registration epoch, the current epoch and the gang id.

This class is the basis of the implementation of rmi_handle::light_reference and rmi_handle::const_light_reference. It is also the base information class for rmi_handle, rmi_handle::reference and rmi_handle::const_reference.

See also

rmi_handle

Member Function Documentation

get_uid()

std::string stapl::runtime::rmi_handle_info::get_uid

(

void

)

const

Returns a unique id of the registered object.

Warning

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

Friends And Related Function Documentation

operator==

constexpr bool operator== ( rmi_handle_info const &  x, rmi_handle_info const &  y  )

friend

Returns true of the x and y are associated with the same registered object.

Warning

While this function compares the epoch the object was registered in, it does not compare the object's current epoch.

---

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

• rmi_handle_fwd.hpp