RADLib
RADical C++ application framework
RADCore::RADCancellationSource Class Reference

Owner object used to request cancellation on associated tokens. More...

#include <RADCore.h>

Public Member Functions

 RADCancellationSource ()
 Creates a source with a fresh token. More...
 
RADCancellationToken token () const
 Returns the token that observers should poll. More...
 
void cancel ()
 Requests cancellation. More...
 
bool isCancellationRequested () const
 Returns true when cancellation was requested. More...
 

Detailed Description

Owner object used to request cancellation on associated tokens.

Constructor & Destructor Documentation

◆ RADCancellationSource()

RADCore::RADCancellationSource::RADCancellationSource ( )
inline

Creates a source with a fresh token.

Member Function Documentation

◆ cancel()

void RADCore::RADCancellationSource::cancel ( )
inline

Requests cancellation.

◆ isCancellationRequested()

bool RADCore::RADCancellationSource::isCancellationRequested ( ) const
inline

Returns true when cancellation was requested.

◆ token()

RADCancellationToken RADCore::RADCancellationSource::token ( ) const
inline

Returns the token that observers should poll.


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