.. index:: pair: class; EE::CancellationSource
.. _doxid-class_e_e_1_1_cancellation_source:

class EE::CancellationSource
============================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Producer side of a cancellation request. :ref:`More...<details-class_e_e_1_1_cancellation_source>`


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

	#include <cancellationtoken.hpp>
	
	class CancellationSource {
	public:
		// construction
	
		:target:`CancellationSource<doxid-class_e_e_1_1_cancellation_source_1a62090ee8487713e308f65db65b96cd51>`();
		:target:`CancellationSource<doxid-class_e_e_1_1_cancellation_source_1a3ee1c64bec966d2f984700f0b6830bad>`(CancellationSource&&);
		:target:`CancellationSource<doxid-class_e_e_1_1_cancellation_source_1a1f53d01d3834211c8ef0ccfbc31416d3>`(const CancellationSource&);

		// methods
	
		CancellationSource& :target:`operator=<doxid-class_e_e_1_1_cancellation_source_1ab870615f2c44fac762f239c9f229ca44>`(CancellationSource&&);
		CancellationSource& :target:`operator=<doxid-class_e_e_1_1_cancellation_source_1a31a34fe6db88cf4aff7fad18213d4871>`(const CancellationSource&);
		:ref:`CancellationToken<doxid-class_e_e_1_1_cancellation_token>` :target:`token<doxid-class_e_e_1_1_cancellation_source_1a7ad1bf994c293ec4ebfe9d72f0cb43e9>`() const;
		bool :ref:`cancel<doxid-class_e_e_1_1_cancellation_source_1a83ff4c1999bf4a9cc0dd2d93b899c11f>`();
		bool :target:`isCancellationRequested<doxid-class_e_e_1_1_cancellation_source_1abb3430154cec78008955fc8877f6f245>`() const;
	};
.. _details-class_e_e_1_1_cancellation_source:

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

Producer side of a cancellation request.

Move-only. Destroying the source does not cancel its tokens.

Methods
-------

.. index:: pair: function; cancel
.. _doxid-class_e_e_1_1_cancellation_source_1a83ff4c1999bf4a9cc0dd2d93b899c11f:

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

	bool cancel()

Requests cancellation and runs every registered callback on this thread.



.. rubric:: Returns:

True only for the call that performed the cancellation.