Concurrency::details::_CancellationTokenRegistration Class Reference

#include <pplcancellation_token.h>

Inheritance diagram for Concurrency::details::_CancellationTokenRegistration:

Public Member Functions
	_CancellationTokenRegistration (long _InitialRefs=1)
_CancellationTokenState *	_GetToken () const
Public Member Functions inherited from Concurrency::details::_RefCounter
virtual	~_RefCounter ()
long	_Reference ()
long	_Release ()

Protected Member Functions
virtual	~_CancellationTokenRegistration ()
virtual void	_Exec ()=0
Protected Member Functions inherited from Concurrency::details::_RefCounter
virtual void	_Destroy ()
	_RefCounter (long _InitialCount=1)

Private Member Functions
void	_Invoke ()

Private Attributes
atomic_long	_M_state
std::condition_variable	_M_CondVar
std::mutex	_M_Mutex
bool	_M_signaled
_CancellationTokenState *	_M_pTokenState

Static Private Attributes
static const long	_STATE_CLEAR = 0
static const long	_STATE_DEFER_DELETE = 1
static const long	_STATE_SYNCHRONIZE = 2
static const long	_STATE_CALLED = 3

Friends
class	_CancellationTokenState

Additional Inherited Members
Protected Attributes inherited from Concurrency::details::_RefCounter
volatile long	_M_refCount

Constructor & Destructor Documentation

Concurrency::details::_CancellationTokenRegistration::_CancellationTokenRegistration ( long  _InitialRefs = 1 )

inline

                                                              :
            _RefCounter(_InitialRefs),
            _M_state(_STATE_CALLED),
            _M_signaled(false),
            _M_pTokenState(NULL)
        {
        }

virtual Concurrency::details::_CancellationTokenRegistration::~_CancellationTokenRegistration ( )

inlineprotectedvirtual

        {
            _ASSERTE(_M_state != _STATE_CLEAR);
        }

Member Function Documentation

virtual void Concurrency::details::_CancellationTokenRegistration::_Exec ( )

protectedpure virtual

Implemented in Concurrency::details::CancellationTokenRegistration_TaskProc, and Concurrency::details::_CancellationTokenCallback< _Function >.

_CancellationTokenState* Concurrency::details::_CancellationTokenRegistration::_GetToken ( ) const

inline

        {
            return _M_pTokenState;
        }

void Concurrency::details::_CancellationTokenRegistration::_Invoke ( )

inlineprivate

        {
            long _Tid = ::Concurrency::details::platform::GetCurrentThreadId();
            _ASSERTE((_Tid & 0x3) == 0); // If this ever fires, we need a different encoding for this.

            long _Result = atomic_compare_exchange(_M_state, _Tid, _STATE_CLEAR);

            if (_Result == _STATE_CLEAR)
            {
                _Exec();

                _Result = atomic_compare_exchange(_M_state, _STATE_CALLED, _Tid);

                if (_Result == _STATE_SYNCHRONIZE)
                {
                    {
                        std::lock_guard<std::mutex> _Lock(_M_Mutex);
                        _M_signaled = true;
                    }
                    _M_CondVar.notify_all();
                }
            }
            _Release();
        }

Friends And Related Function Documentation

friend class _CancellationTokenState

friend

Member Data Documentation

std::condition_variable Concurrency::details::_CancellationTokenRegistration::_M_CondVar

private

std::mutex Concurrency::details::_CancellationTokenRegistration::_M_Mutex

private

_CancellationTokenState* Concurrency::details::_CancellationTokenRegistration::_M_pTokenState

private

bool Concurrency::details::_CancellationTokenRegistration::_M_signaled

private

atomic_long Concurrency::details::_CancellationTokenRegistration::_M_state

private

const long Concurrency::details::_CancellationTokenRegistration::_STATE_CALLED = 3

staticprivate

const long Concurrency::details::_CancellationTokenRegistration::_STATE_CLEAR = 0

staticprivate

const long Concurrency::details::_CancellationTokenRegistration::_STATE_DEFER_DELETE = 1

staticprivate

const long Concurrency::details::_CancellationTokenRegistration::_STATE_SYNCHRONIZE = 2

staticprivate

---

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

• VS2017/inc/pplcancellation_token.h