Concurrency::cancellation_token_source Class Reference

The cancellation_token_source class represents the ability to cancel some cancelable operation. More...

#include <pplcancellation_token.h>

Public Types
typedef ::Concurrency::details::_CancellationTokenState *	_ImplType

Public Member Functions
	cancellation_token_source ()
	Constructs a new cancellation_token_source. The source can be used to flag cancellation of some cancelable operation. More...
	cancellation_token_source (const cancellation_token_source &_Src)
	cancellation_token_source (cancellation_token_source &&_Src)
cancellation_token_source &	operator= (const cancellation_token_source &_Src)
cancellation_token_source &	operator= (cancellation_token_source &&_Src)
bool	operator== (const cancellation_token_source &_Src) const
bool	operator!= (const cancellation_token_source &_Src) const
	~cancellation_token_source ()
cancellation_token	get_token () const
	Returns a cancellation token associated with this source. The returned token can be polled for cancellation or provide a callback if and when cancellation occurs. More...
void	cancel () const
	Cancels the token. Any task_group, structured_task_group, or task which utilizes the token will be canceled upon this call and throw an exception at the next interruption point. More...
_ImplType	_GetImpl () const

Static Public Member Functions
static cancellation_token_source	create_linked_source (cancellation_token &_Src)
	Creates a cancellation_token_source which is canceled when the provided token is canceled. More...
template<typename _Iter >
static cancellation_token_source	create_linked_source (_Iter _Begin, _Iter _End)
	Creates a cancellation_token_source which is canceled when one of a series of tokens represented by an STL iterator pair is canceled. More...
static cancellation_token_source	_FromImpl (_ImplType _Impl)

Private Member Functions
void	_Clear ()
void	_Assign (_ImplType _Impl)
void	_Move (_ImplType &_Impl)
	cancellation_token_source (_ImplType _Impl)

Private Attributes
_ImplType	_M_Impl

Detailed Description

The cancellation_token_source class represents the ability to cancel some cancelable operation.

Member Typedef Documentation

typedef ::Concurrency::details::_CancellationTokenState* Concurrency::cancellation_token_source::_ImplType

Constructor & Destructor Documentation

Concurrency::cancellation_token_source::cancellation_token_source ( )

inline

Constructs a new cancellation_token_source. The source can be used to flag cancellation of some cancelable operation.

    {
        _M_Impl = new ::Concurrency::details::_CancellationTokenState;
    }

Concurrency::cancellation_token_source::cancellation_token_source ( const cancellation_token_source &  _Src )

inline

    {
        _Assign(_Src._M_Impl);
    }

Concurrency::cancellation_token_source::cancellation_token_source ( cancellation_token_source &&  _Src )

inline

    {
        _Move(_Src._M_Impl);
    }

Concurrency::cancellation_token_source::~cancellation_token_source ( )

inline

    {
        if (_M_Impl != NULL)
        {
            _M_Impl->_Release();
        }
    }

Concurrency::cancellation_token_source::cancellation_token_source ( _ImplType  _Impl )

inlineprivate

                                               :
        _M_Impl(_Impl)
    {
        if (_M_Impl == ::Concurrency::details::_CancellationTokenState::_None())
        {
            _M_Impl = NULL;
        }

        if (_M_Impl != NULL)
        {
            _M_Impl->_Reference();
        }
    }

Member Function Documentation

void Concurrency::cancellation_token_source::_Assign ( _ImplType  _Impl )

inlineprivate

    {
        if (_Impl != NULL)
        {
            _Impl->_Reference();
        }
        _M_Impl = _Impl;
    }

void Concurrency::cancellation_token_source::_Clear ( )

inlineprivate

    {
        if (_M_Impl != NULL)
        {
            _M_Impl->_Release();
        }
        _M_Impl = NULL;
    }

static cancellation_token_source Concurrency::cancellation_token_source::_FromImpl ( _ImplType  _Impl )

inlinestatic

    {
        return cancellation_token_source(_Impl);
    }

_ImplType Concurrency::cancellation_token_source::_GetImpl ( ) const

inline

    {
        return _M_Impl;
    }

void Concurrency::cancellation_token_source::_Move ( _ImplType &  _Impl )

inlineprivate

    {
        _M_Impl = _Impl;
        _Impl = NULL;
    }

void Concurrency::cancellation_token_source::cancel ( ) const

inline

Cancels the token. Any task_group, structured_task_group, or task which utilizes the token will be canceled upon this call and throw an exception at the next interruption point.

    {
        _M_Impl->_Cancel();
    }

static cancellation_token_source Concurrency::cancellation_token_source::create_linked_source ( cancellation_token &  _Src )

inlinestatic

Creates a cancellation_token_source which is canceled when the provided token is canceled.

Parameters

_Src	A token whose cancellation will cause cancellation of the returned token source. Note that the returned token source can also be canceled independently of the source contained in this parameter.

Returns

A cancellation_token_source which is canceled when the token provided by the _Src parameter is canceled.

    {
        cancellation_token_source _NewSource;
        _Src.register_callback( [_NewSource](){ _NewSource.cancel(); } );
        return _NewSource;
    }

template<typename _Iter >

static cancellation_token_source Concurrency::cancellation_token_source::create_linked_source ( _Iter  _Begin, _Iter  _End  )

inlinestatic

Creates a cancellation_token_source which is canceled when one of a series of tokens represented by an STL iterator pair is canceled.

Parameters

_Begin	The STL iterator corresponding to the beginning of the range of tokens to listen for cancellation of.
_End	The STL iterator corresponding to the ending of the range of tokens to listen for cancellation of.

Returns

A cancellation_token_source which is canceled when any of the tokens provided by the range described by the STL iterators contained in the _Begin and _End parameters is canceled.

    {
        cancellation_token_source _NewSource;
        for (_Iter _It = _Begin; _It != _End; ++_It)
        {
            _It->register_callback( [_NewSource](){ _NewSource.cancel(); } );
        }
        return _NewSource;
    }

cancellation_token Concurrency::cancellation_token_source::get_token ( ) const

inline

Returns a cancellation token associated with this source. The returned token can be polled for cancellation or provide a callback if and when cancellation occurs.

Returns

A cancellation token associated with this source.

    {
        return cancellation_token(_M_Impl);
    }

bool Concurrency::cancellation_token_source::operator!= ( const cancellation_token_source &  _Src ) const

inline

    {
        return !(operator==(_Src));
    }

cancellation_token_source& Concurrency::cancellation_token_source::operator= ( const cancellation_token_source &  _Src )

inline

    {
        if (this != &_Src)
        {
            _Clear();
            _Assign(_Src._M_Impl);
        }
        return *this;
    }

cancellation_token_source& Concurrency::cancellation_token_source::operator= ( cancellation_token_source &&  _Src )

inline

    {
        if (this != &_Src)
        {
            _Clear();
            _Move(_Src._M_Impl);
        }
        return *this;
    }

bool Concurrency::cancellation_token_source::operator== ( const cancellation_token_source &  _Src ) const

inline

    {
        return _M_Impl == _Src._M_Impl;
    }

Member Data Documentation

_ImplType Concurrency::cancellation_token_source::_M_Impl

private

---

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

• VS2015/inc/pplcancellation_token.h