Concurrency::cancellation_token_registration Class Reference

The cancellation_token_registration class represents a callback notification from a cancellation_token. When the register method on a cancellation_token is used to receive notification of when cancellation occurs, a cancellation_token_registration object is returned as a handle to the callback so that the caller can request a specific callback no longer be made through use of the deregister method. More...

#include <pplcancellation_token.h>

Public Member Functions
	cancellation_token_registration ()
	~cancellation_token_registration ()
	cancellation_token_registration (const cancellation_token_registration &_Src)
	cancellation_token_registration (cancellation_token_registration &&_Src)
cancellation_token_registration &	operator= (const cancellation_token_registration &_Src)
cancellation_token_registration &	operator= (cancellation_token_registration &&_Src)
bool	operator== (const cancellation_token_registration &_Rhs) const
bool	operator!= (const cancellation_token_registration &_Rhs) const

Private Member Functions
	cancellation_token_registration (_In_ details::_CancellationTokenRegistration *_PRegistration)
void	_Clear ()
void	_Assign (_In_ details::_CancellationTokenRegistration *_PRegistration)
void	_Move (_In_ details::_CancellationTokenRegistration *&_PRegistration)

Private Attributes
details::_CancellationTokenRegistration *	_M_pRegistration

Friends
class	cancellation_token

Detailed Description

The cancellation_token_registration class represents a callback notification from a cancellation_token. When the register method on a cancellation_token is used to receive notification of when cancellation occurs, a cancellation_token_registration object is returned as a handle to the callback so that the caller can request a specific callback no longer be made through use of the deregister method.

Constructor & Destructor Documentation

Concurrency::cancellation_token_registration::cancellation_token_registration ( )

inline

                                      :
        _M_pRegistration(NULL)
    {
    }

Concurrency::cancellation_token_registration::~cancellation_token_registration ( )

inline

    {
        _Clear();
    }

Concurrency::cancellation_token_registration::cancellation_token_registration ( const cancellation_token_registration &  _Src )

inline

    {
        _Assign(_Src._M_pRegistration);
    }

Concurrency::cancellation_token_registration::cancellation_token_registration ( cancellation_token_registration &&  _Src )

inline

    {
        _Move(_Src._M_pRegistration);
    }

Concurrency::cancellation_token_registration::cancellation_token_registration ( _In_ details::_CancellationTokenRegistration *  _PRegistration )

inlineprivate

                                                                                                :
        _M_pRegistration(_PRegistration)
    {
    }

Member Function Documentation

void Concurrency::cancellation_token_registration::_Assign ( _In_ details::_CancellationTokenRegistration *  _PRegistration )

inlineprivate

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

void Concurrency::cancellation_token_registration::_Clear ( )

inlineprivate

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

void Concurrency::cancellation_token_registration::_Move ( _In_ details::_CancellationTokenRegistration *&  _PRegistration )

inlineprivate

    {
        _M_pRegistration = _PRegistration;
        _PRegistration = NULL;
    }

bool Concurrency::cancellation_token_registration::operator!= ( const cancellation_token_registration &  _Rhs ) const

inline

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

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

inline

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

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

inline

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

bool Concurrency::cancellation_token_registration::operator== ( const cancellation_token_registration &  _Rhs ) const

inline

    {
        return _M_pRegistration == _Rhs._M_pRegistration;
    }

Friends And Related Function Documentation

friend class cancellation_token

friend

Member Data Documentation

details::_CancellationTokenRegistration* Concurrency::cancellation_token_registration::_M_pRegistration

private

---

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

• VS2017/inc/pplcancellation_token.h