tsm::cancellation_token< MaxWaiters > Class Template Reference

Read-only cancellation capability for cooperative tasks. More...

#include <sync.h>

Collaboration diagram for tsm::cancellation_token< MaxWaiters >:

Classes
class	wait_awaitable

Public Member Functions
	cancellation_token ()=default
bool	stop_requested () const noexcept
wait_awaitable	wait () const noexcept

Friends
class	cancellation_source< MaxWaiters >

Detailed Description

template<std::size_t MaxWaiters = 4U>
class tsm::cancellation_token< MaxWaiters >

Read-only cancellation capability for cooperative tasks.

Constructor & Destructor Documentation

cancellation_token()

template<std::size_t MaxWaiters = 4U>

tsm::cancellation_token< MaxWaiters >::cancellation_token ( )

default

Member Function Documentation

stop_requested()

template<std::size_t MaxWaiters = 4U>

bool tsm::cancellation_token< MaxWaiters >::stop_requested ( ) const

inlinenoexcept

wait()

template<std::size_t MaxWaiters = 4U>

wait_awaitable tsm::cancellation_token< MaxWaiters >::wait ( ) const

inlinenoexcept

Friends And Related Function Documentation

cancellation_source< MaxWaiters >

template<std::size_t MaxWaiters = 4U>

friend class cancellation_source< MaxWaiters >

friend

---

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

• include/tsm/runtime/sync.h