.. index:: pair: class; EE::CancellationRegistration
.. _doxid-class_e_e_1_1_cancellation_registration:

class EE::CancellationRegistration
==================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

RAII handle for a callback registered on a :ref:`CancellationToken <doxid-class_e_e_1_1_cancellation_token>`. :ref:`More...<details-class_e_e_1_1_cancellation_registration>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <cancellationtoken.hpp>
	
	class CancellationRegistration {
	public:
		// construction
	
		:target:`CancellationRegistration<doxid-class_e_e_1_1_cancellation_registration_1a206a97f2e8acd4d8bde93463a4e53442>`();
		:target:`CancellationRegistration<doxid-class_e_e_1_1_cancellation_registration_1ae46b6481d0fb198131389d230dc8eec1>`(CancellationRegistration&& other);
		:target:`CancellationRegistration<doxid-class_e_e_1_1_cancellation_registration_1a996e0d415aa4a3eb2c44f23b75e69f15>`(const CancellationRegistration&);
		:target:`~CancellationRegistration<doxid-class_e_e_1_1_cancellation_registration_1aa9c9af543b9473027d72f4b9dba2a0d8>`();

		// methods
	
		CancellationRegistration& :target:`operator=<doxid-class_e_e_1_1_cancellation_registration_1ae51ecfa0ac8e161876969d05c1d124f3>`(CancellationRegistration&& other);
		CancellationRegistration& :target:`operator=<doxid-class_e_e_1_1_cancellation_registration_1af02cfde07a96dbbe0ad21c035bbf6b5a>`(const CancellationRegistration&);
		void :ref:`reset<doxid-class_e_e_1_1_cancellation_registration_1ab1d93c6432ef1d9bb96afb70d53e75ef>`();
		:ref:`operator bool<doxid-class_e_e_1_1_cancellation_registration_1aa72ac300e3614bc17c9b42ace38e8498>`() const;
	};
.. _details-class_e_e_1_1_cancellation_registration:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

RAII handle for a callback registered on a :ref:`CancellationToken <doxid-class_e_e_1_1_cancellation_token>`.

Destroying (or :ref:`reset() <doxid-class_e_e_1_1_cancellation_registration_1ab1d93c6432ef1d9bb96afb70d53e75ef>` -ing) the registration unregisters the callback if it has not fired. If the callback is running concurrently on the cancelling thread, destruction waits for it to finish, so state captured by the callback may be released right after the registration dies. A callback may destroy its own registration without deadlocking.

Methods
-------

.. index:: pair: function; reset
.. _doxid-class_e_e_1_1_cancellation_registration_1ab1d93c6432ef1d9bb96afb70d53e75ef:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void reset()

Unregisters the callback now.

.. index:: pair: function; operator bool
.. _doxid-class_e_e_1_1_cancellation_registration_1aa72ac300e3614bc17c9b42ace38e8498:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	operator bool() const



.. rubric:: Returns:

True while the callback is registered and has not been invoked.