STAPL API Reference          
Overview   Containers   Algorithms   Views   Skeletons   Run-Time System
Modules     Classes    
List of all members | Public Member Functions | Public Types | Protected Member Functions
stapl::rmi_handle::const_light_reference Class Reference

Const light reference to an object that was registered through rmi_handle. More...

Public Member Functions

template<typename Handle >
 const_light_reference (Handle &&h)
 
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.
 

Detailed Description

Const light reference to an object that was registered through rmi_handle.

It can be constructed from any reference to rmi_handle.

Once an rmi_handle::const_light_reference is created, one can retrieve a const reference to the object, but cannot do an RMI through it.

The size of an rmi_handle::const_light_reference is smaller than that of a rmi_handle::const_reference.

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: