stapl::runtime::common_gang_md Class Reference

Metadata that can be shared between multiple gangs. More...

Public Member Functions
	common_gang_md (const size_type nlocs=1)
	common_gang_md (gang_description gd)
topology const &	get_topology (void) const noexcept
gang_description const &	get_description (void) const noexcept
void	add_ref (long count=1, std::memory_order order=std::memory_order_relaxed) noexcept
	Increases the reference count by count.
long	remove_ref (long count=1, std::memory_order order=std::memory_order_relaxed) noexcept
	Decreases the reference count by count. More...
bool	release (std::memory_order order=std::memory_order_relaxed) noexcept
	Decreases the reference count, destroying the object if it reached 0. More...
long	use_count (std::memory_order order=std::memory_order_relaxed) const noexcept
bool	unique (std::memory_order order=std::memory_order_relaxed) const noexcept

Public Types
using	size_type = gang_description::size_type

Detailed Description

Metadata that can be shared between multiple gangs.

Member Function Documentation

remove_ref()

long stapl::runtime::ref_counted< common_gang_md , std::default_delete<common_gang_md > >::remove_ref ( long  count = 1, std::memory_order  order = std::memory_order_relaxed  )

noexceptinherited

Decreases the reference count by count.

Returns

The new reference count.

release()

bool stapl::runtime::ref_counted< common_gang_md , std::default_delete<common_gang_md > >::release ( std::memory_order  order = std::memory_order_relaxed )

noexceptinherited

Decreases the reference count, destroying the object if it reached 0.

Warning

If release() returns true, then the object has been destroyed.

Returns

true if the object was destroyed, otherwise false.

---

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

• gang_md.hpp