arene::base::barrier< CompletionFunction >::arrival_token Class Reference

A class holding the result of a call to arrive, which can then be passed to wait to wait for the end of the completion step associated with the call to arrive. More...

Public Member Functions
	arrival_token (arrival_token &&other) noexcept=default
	Default move constructor.
	arrival_token (arrival_token const &other)=delete
	not copyable
	arrival_token (private_construction_tag, std::uint64_t phase) noexcept
	Construct a new arrival token for the phase.
	~arrival_token ()=default
	Default destructor.
auto	get_phase () const noexcept -> std::uint64_t
	Get the phase this token is associated with.
auto	operator= (arrival_token &&other) noexcept -> arrival_token &=default
	Default move assignment.
auto	operator= (arrival_token const &other) -> arrival_token &=delete
	not copyable

Detailed Description

template<typename CompletionFunction = barrier_detail::default_completion_function>
class arene::base::barrier< CompletionFunction >::arrival_token

A class holding the result of a call to arrive, which can then be passed to wait to wait for the end of the completion step associated with the call to arrive.

Constructor & Destructor Documentation

arrival_token() [1/3]

template<typename CompletionFunction = barrier_detail::default_completion_function>

arene::base::barrier< CompletionFunction >::arrival_token::arrival_token ( private_construction_tag , std::uint64_t phase )

inlinenoexcept

Construct a new arrival token for the phase.

Parameters

phase

The phase number

arrival_token() [2/3]

template<typename CompletionFunction = barrier_detail::default_completion_function>

arene::base::barrier< CompletionFunction >::arrival_token::arrival_token ( arrival_token && other )

defaultnoexcept

Default move constructor.

arrival_token() [3/3]

template<typename CompletionFunction = barrier_detail::default_completion_function>

arene::base::barrier< CompletionFunction >::arrival_token::arrival_token ( arrival_token const & other )

delete

not copyable

~arrival_token()

template<typename CompletionFunction = barrier_detail::default_completion_function>

arene::base::barrier< CompletionFunction >::arrival_token::~arrival_token ( )

default

Default destructor.

Member Function Documentation

get_phase()

template<typename CompletionFunction = barrier_detail::default_completion_function>

auto arene::base::barrier< CompletionFunction >::arrival_token::get_phase ( ) const -> std::uint64_t

inlinenoexcept

Get the phase this token is associated with.

Returns

the phase

operator=() [1/2]

template<typename CompletionFunction = barrier_detail::default_completion_function>

auto arene::base::barrier< CompletionFunction >::arrival_token::operator= ( arrival_token && other ) -> arrival_token &=default

defaultnoexcept

Default move assignment.

operator=() [2/2]

template<typename CompletionFunction = barrier_detail::default_completion_function>

auto arene::base::barrier< CompletionFunction >::arrival_token::operator= ( arrival_token const & other ) -> arrival_token &=delete

delete

not copyable

---

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

• arene/base/synchronization/barrier.hpp