rad::StopToken Class Reference

#include <stopToken.hpp>

Public Member Functions
	StopToken () noexcept=default
	StopToken (StopToken const &) noexcept
	StopToken (StopToken &&) noexcept=default
StopToken &	operator= (StopToken const &)
	~StopToken ()
void	Swap (StopToken &other) noexcept
bool	StopRequested () const noexcept
bool	StopPossible () const noexcept
bool	operator== (StopToken const &rhs) const noexcept
bool	operator!= (StopToken const &rhs) const noexcept

Friends
class	StopSource

Detailed Description

Object receiving request to stop from associated StopSource object.

This is modelled after std::stop_token, c.f.: https://en.cppreference.com/w/cpp/header/stop_token

Constructor & Destructor Documentation

StopToken() [1/3]

rad::StopToken::StopToken ( )

defaultnoexcept

Creates a StopToken without a stop source

Postcondition

StopPossible() == false;

StopToken() [2/3]

rad::StopToken::StopToken ( StopToken const & rhs )

noexcept

StopToken() [3/3]

rad::StopToken::StopToken ( StopToken && )

defaultnoexcept

~StopToken()

rad::StopToken::~StopToken

(

)

Member Function Documentation

operator!=()

bool rad::StopToken::operator!= ( StopToken const & rhs ) const

noexcept

operator=()

StopToken & rad::StopToken::operator=

(

StopToken const &

rhs

)

operator==()

bool rad::StopToken::operator== ( StopToken const & rhs ) const

noexcept

Returns

true if rhs and *this references the same shared state.

StopPossible()

bool rad::StopToken::StopPossible ( ) const

noexcept

Returns

true if there's at least 1 associated StopSource for this StopToken.

false otherwise.

StopRequested()

bool rad::StopToken::StopRequested ( ) const

noexcept

Returns

true if stop has been requested.

false otherwise.

Swap()

void rad::StopToken::Swap ( StopToken & other )

noexcept

Swaps two StopTokens

Friends And Related Symbol Documentation

StopSource

friend class StopSource

friend

---

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

• rad/cpp/core/src/include/rad/stopToken.hpp
• rad/cpp/core/src/stopToken.cpp