Concurrency::details::_TaskCollectionBase Class Reference

#include <concrt.h>

Inheritance diagram for Concurrency::details::_TaskCollectionBase:

Public Member Functions
	_TaskCollectionBase ()
	_TaskCollectionBase (const _TaskCollectionBase &)=delete
	_TaskCollectionBase (_CancellationTokenState *_PTokenState)
_TaskCollectionBase &	operator= (const _TaskCollectionBase &)=delete
void *	_OwningContext () const
int	_InliningDepth () const
bool	_IsCurrentlyInlined () const
bool	_IsStructured ()
_CancellationTokenState *	_GetTokenState (_CancellationTokenRegistration **_PRegistration=NULL)

Protected Types
enum	_TaskCollectionBaseState { _CollectionNotInitialized = LONG_MIN, _CollectionInitializationInProgress = LONG_MIN+1, _CollectionInitialized = 0 }

Protected Member Functions
std::exception_ptr *	_Exception () const
bool	_IsAbnormalExit () const
size_t	_CancelState () const
bool	_IsMarkedForCancellation () const
bool	_PerformedInlineCancel () const
bool	_PerformedPendingCancel () const
_TaskCollectionBase *	_SafeGetParent ()
bool	_WillInterruptForPendingCancel ()
void	_RaisedException ()
void	_RethrowException ()
bool	_MarkCancellation ()
void	_FinishCancelState (size_t _NewCancelState)
void	_RaisedCancel ()

Protected Attributes
_TaskCollectionBase *	_M_pParent
int	_M_inliningDepth: 28
int	_M_inlineFlags: 4
_CancellationTokenState *	_M_pTokenState
void *	_M_pOwningContext
long	_M_unpoppedChores
volatile long	_M_completedStolenChores
std::exception_ptr *	_M_pException

Static Protected Attributes
static const size_t	_S_cancelBitsMask = 0x3
static const size_t	_S_cancelNone = 0x0
static const size_t	_S_cancelStarted = 0x1
static const size_t	_S_cancelDeferredShootdownOwner = 0x2
static const size_t	_S_cancelShotdownOwner = 0x3
static const size_t	_S_nonNull = 0x8
static const size_t	_S_cancelException = 0xC
static const int	_S_notInlined = -1
static const int	_S_structured = 0x00000001
static const int	_S_localCancel = 0x00000002
static const int	_S_reserved = 0x0000000C

Friends
class	::Concurrency::details::_UnrealizedChore
class	::Concurrency::details::ContextBase

Member Enumeration Documentation

enum Concurrency::details::_TaskCollectionBase::_TaskCollectionBaseState

protected

Enumerator
_CollectionNotInitialized
_CollectionInitializationInProgress
_CollectionInitialized

        {
            _CollectionNotInitialized = LONG_MIN,
            _CollectionInitializationInProgress = LONG_MIN+1,
            _CollectionInitialized = 0
        };

Constructor & Destructor Documentation

Concurrency::details::_TaskCollectionBase::_TaskCollectionBase ( )

inline

                              :
            _M_pTokenState(NULL),
            _M_completedStolenChores(_CollectionNotInitialized),
            _M_unpoppedChores(0),
            _M_pException(NULL),
            _M_inliningDepth(_S_notInlined)
        {
        }

Concurrency::details::_TaskCollectionBase::_TaskCollectionBase ( const _TaskCollectionBase &  )

delete

Concurrency::details::_TaskCollectionBase::_TaskCollectionBase ( _CancellationTokenState *  _PTokenState )

inline

                                                                   :
            _M_pTokenState(_PTokenState),
            _M_completedStolenChores(_CollectionNotInitialized),
            _M_unpoppedChores(0),
            _M_pException(NULL),
            _M_inliningDepth(_S_notInlined)
        {
        }

Member Function Documentation

size_t Concurrency::details::_TaskCollectionBase::_CancelState ( ) const

inlineprotected

        {
            return (size_t) _M_pException & _S_cancelBitsMask;
        }

std::exception_ptr* Concurrency::details::_TaskCollectionBase::_Exception ( ) const

inlineprotected

        {
            return (std::exception_ptr *) ((size_t)_M_pException & ~_S_cancelBitsMask);
        }

void Concurrency::details::_TaskCollectionBase::_FinishCancelState ( size_t  _NewCancelState )

protected

_CancellationTokenState* Concurrency::details::_TaskCollectionBase::_GetTokenState

(

_CancellationTokenRegistration **

_PRegistration = NULL

)

int Concurrency::details::_TaskCollectionBase::_InliningDepth ( ) const

inline

        {
            return _M_inliningDepth;
        }

bool Concurrency::details::_TaskCollectionBase::_IsAbnormalExit ( ) const

inlineprotected

        {
            return _M_pException != NULL;
        }

bool Concurrency::details::_TaskCollectionBase::_IsCurrentlyInlined ( ) const

inline

        {
            return (_M_inliningDepth != _S_notInlined);
        }

bool Concurrency::details::_TaskCollectionBase::_IsMarkedForCancellation ( ) const

inlineprotected

        {
            return (_CancelState() & _S_cancelBitsMask) != 0;
        }

bool Concurrency::details::_TaskCollectionBase::_IsStructured ( )

inline

        {
            return (_M_inlineFlags & _S_structured) != 0;
        }

bool Concurrency::details::_TaskCollectionBase::_MarkCancellation ( )

protected

void* Concurrency::details::_TaskCollectionBase::_OwningContext ( ) const

inline

        {
            return _M_pOwningContext;
        }

bool Concurrency::details::_TaskCollectionBase::_PerformedInlineCancel ( ) const

inlineprotected

        {
            _CONCRT_ASSERT(_CancelState() != _S_cancelStarted);
            return _CancelState() == _S_cancelShotdownOwner;
        }

bool Concurrency::details::_TaskCollectionBase::_PerformedPendingCancel ( ) const

inlineprotected

        {
            _CONCRT_ASSERT(_CancelState() != _S_cancelStarted);
            return _CancelState() == _S_cancelDeferredShootdownOwner;
        }

void Concurrency::details::_TaskCollectionBase::_RaisedCancel ( )

protected

void Concurrency::details::_TaskCollectionBase::_RaisedException ( )

protected

void Concurrency::details::_TaskCollectionBase::_RethrowException ( )

protected

_TaskCollectionBase* Concurrency::details::_TaskCollectionBase::_SafeGetParent ( )

inlineprotected

        {
            return ((_M_inliningDepth != _S_notInlined) ? _M_pParent : NULL);
        }

bool Concurrency::details::_TaskCollectionBase::_WillInterruptForPendingCancel ( )

protected

_TaskCollectionBase& Concurrency::details::_TaskCollectionBase::operator= ( const _TaskCollectionBase &  )

delete

Friends And Related Function Documentation

friend class ::Concurrency::details::_UnrealizedChore

friend

friend class ::Concurrency::details::ContextBase

friend

Member Data Documentation

volatile long Concurrency::details::_TaskCollectionBase::_M_completedStolenChores

protected

int Concurrency::details::_TaskCollectionBase::_M_inlineFlags

protected

int Concurrency::details::_TaskCollectionBase::_M_inliningDepth

protected

std::exception_ptr* Concurrency::details::_TaskCollectionBase::_M_pException

protected

void* Concurrency::details::_TaskCollectionBase::_M_pOwningContext

protected

_TaskCollectionBase* Concurrency::details::_TaskCollectionBase::_M_pParent

protected

_CancellationTokenState* Concurrency::details::_TaskCollectionBase::_M_pTokenState

protected

long Concurrency::details::_TaskCollectionBase::_M_unpoppedChores

protected

const size_t Concurrency::details::_TaskCollectionBase::_S_cancelBitsMask = 0x3

staticprotected

const size_t Concurrency::details::_TaskCollectionBase::_S_cancelDeferredShootdownOwner = 0x2

staticprotected

const size_t Concurrency::details::_TaskCollectionBase::_S_cancelException = 0xC

staticprotected

const size_t Concurrency::details::_TaskCollectionBase::_S_cancelNone = 0x0

staticprotected

const size_t Concurrency::details::_TaskCollectionBase::_S_cancelShotdownOwner = 0x3

staticprotected

const size_t Concurrency::details::_TaskCollectionBase::_S_cancelStarted = 0x1

staticprotected

const int Concurrency::details::_TaskCollectionBase::_S_localCancel = 0x00000002

staticprotected

const size_t Concurrency::details::_TaskCollectionBase::_S_nonNull = 0x8

staticprotected

const int Concurrency::details::_TaskCollectionBase::_S_notInlined = -1

staticprotected

const int Concurrency::details::_TaskCollectionBase::_S_reserved = 0x0000000C

staticprotected

const int Concurrency::details::_TaskCollectionBase::_S_structured = 0x00000001

staticprotected

---

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

• VS2017/inc/concrt.h