.. index:: pair: class; EE::detail::CancellationState
.. _doxid-class_e_e_1_1detail_1_1_cancellation_state:

class EE::detail::CancellationState
===================================

.. toctree::
	:hidden:

	struct_EE_detail_CancellationState_Entry.rst

Overview
~~~~~~~~

Shared cancellation state. :ref:`More...<details-class_e_e_1_1detail_1_1_cancellation_state>`


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

	#include <cancellationtoken.hpp>
	
	class CancellationState {
	public:
		// typedefs
	
		typedef :ref:`SmallUniqueFunction<doxid-class_e_e_1_1_small_unique_function>`<void(), 64> :target:`Callback<doxid-class_e_e_1_1detail_1_1_cancellation_state_1a43e90476db38a1e33d2c00d75e716abf>`;

		// structs
	
		struct :ref:`Entry<doxid-struct_e_e_1_1detail_1_1_cancellation_state_1_1_entry>`;

		// methods
	
		bool :target:`isCancellationRequested<doxid-class_e_e_1_1detail_1_1_cancellation_state_1abb0313619d6d537d13eba1c6feb9eca7>`() const;
		bool :target:`cancel<doxid-class_e_e_1_1detail_1_1_cancellation_state_1aa429b5d45f955a8a53c4c63966e821f3>`();
		:ref:`Uint64<doxid-namespace_e_e_1ae05f59b032c290566852fe63cb26135c>` :ref:`add<doxid-class_e_e_1_1detail_1_1_cancellation_state_1a52467089edf9998510875902055edce3>`(:ref:`Callback<doxid-class_e_e_1_1detail_1_1_cancellation_state_1a43e90476db38a1e33d2c00d75e716abf>`& callback);
		void :ref:`remove<doxid-class_e_e_1_1detail_1_1_cancellation_state_1a44c2fd61b7d4038f27ebe09c0d4f13cf>`(:ref:`Uint64<doxid-namespace_e_e_1ae05f59b032c290566852fe63cb26135c>` id);
	};
.. _details-class_e_e_1_1detail_1_1_cancellation_state:

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

Shared cancellation state. Owned jointly by the source, tokens and live registrations.

Methods
-------

.. index:: pair: function; add
.. _doxid-class_e_e_1_1detail_1_1_cancellation_state_1a52467089edf9998510875902055edce3:

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

	:ref:`Uint64<doxid-namespace_e_e_1ae05f59b032c290566852fe63cb26135c>` add(:ref:`Callback<doxid-class_e_e_1_1detail_1_1_cancellation_state_1a43e90476db38a1e33d2c00d75e716abf>`& callback)



.. rubric:: Returns:

Registration id, or 0 when cancellation already happened (callback not stored).

.. index:: pair: function; remove
.. _doxid-class_e_e_1_1detail_1_1_cancellation_state_1a44c2fd61b7d4038f27ebe09c0d4f13cf:

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

	void remove(:ref:`Uint64<doxid-namespace_e_e_1ae05f59b032c290566852fe63cb26135c>` id)

Removes the registration. Blocks while its callback is running on another thread.