.. index:: pair: class; EE::detail::TaskSharedState
.. _doxid-class_e_e_1_1detail_1_1_task_shared_state:

template class EE::detail::TaskSharedState
==========================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

State shared by one Task<T> and the copies of its TaskResolver<T>. :ref:`More...<details-class_e_e_1_1detail_1_1_task_shared_state>`


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

	#include <task.hpp>
	
	template <typename T>
	class TaskSharedState {
	public:
		// typedefs
	
		typedef std::conditional_t<std::is_void_v<T>, :ref:`TaskVoidValue<doxid-struct_e_e_1_1detail_1_1_task_void_value>`, T> :target:`Value<doxid-class_e_e_1_1detail_1_1_task_shared_state_1a71a22b726ac27d362f8d0edc6e5bf2a9>`;
		typedef :ref:`SmallUniqueFunction<doxid-class_e_e_1_1_small_unique_function>`<void(TaskSharedState&), 64> :target:`Continuation<doxid-class_e_e_1_1detail_1_1_task_shared_state_1a905478ba391a97683359bf5525969ce4>`;

		// methods
	
		void :target:`retain<doxid-class_e_e_1_1detail_1_1_task_shared_state_1a2b530af49145853793b5e9d9450b5c3a>`();
		void :target:`release<doxid-class_e_e_1_1detail_1_1_task_shared_state_1aa363a290e0f02468c43889bd4ed8f7ff>`();
		void :target:`retainResolver<doxid-class_e_e_1_1detail_1_1_task_shared_state_1a2c1f6812ac83b4cad225e1e5a53ca8e1>`();
		bool :ref:`releaseResolver<doxid-class_e_e_1_1detail_1_1_task_shared_state_1a4ba19defb8668c9696b6db60bd4516db>`();
		:ref:`TaskState<doxid-namespace_e_e_1ac2db4385f16b83a7a553865c98c38128>` :target:`state<doxid-class_e_e_1_1detail_1_1_task_shared_state_1a147bcab9a36012ff7db1fa5a7de0ee58>`() const;
	
		template <typename... Args>
		bool :target:`resolve<doxid-class_e_e_1_1detail_1_1_task_shared_state_1a3375a5b3379da10e283de97f3678c70b>`(Args&&... args);
	
		bool :ref:`abandon<doxid-class_e_e_1_1detail_1_1_task_shared_state_1a132ffb468eb0e52b844440d69fd97ae6>`();
		void :ref:`attach<doxid-class_e_e_1_1detail_1_1_task_shared_state_1a7a32976a5f357a6ffa88a0202af61249>`(:ref:`Continuation<doxid-class_e_e_1_1detail_1_1_task_shared_state_1a905478ba391a97683359bf5525969ce4>` continuation);
		:ref:`TaskState<doxid-namespace_e_e_1ac2db4385f16b83a7a553865c98c38128>` :target:`wait<doxid-class_e_e_1_1detail_1_1_task_shared_state_1a2985442e9c8ccb28be09938ce965c349>`();
	
		template <typename Rep, typename Period>
		:ref:`TaskState<doxid-namespace_e_e_1ac2db4385f16b83a7a553865c98c38128>` :target:`waitFor<doxid-class_e_e_1_1detail_1_1_task_shared_state_1a1ffdfe5757627ba3a97b74c32ffa922b>`(const std::chrono::duration<Rep, Period>& timeout);
	
		:ref:`Value<doxid-class_e_e_1_1detail_1_1_task_shared_state_1a71a22b726ac27d362f8d0edc6e5bf2a9>`& :ref:`value<doxid-class_e_e_1_1detail_1_1_task_shared_state_1a78fff8ecec39e5623b16187de4aa55f4>`();
	};
.. _details-class_e_e_1_1detail_1_1_task_shared_state:

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

State shared by one Task<T> and the copies of its TaskResolver<T>.

Reference counting is intrusive so that continuations can re-acquire ownership from the plain reference they receive (needed to keep the value alive while a continuation is queued on an executor) and so that every task costs exactly one allocation. Resolver copies are counted apart, so the task is abandoned when the last resolver goes away, whoever else still holds the state.

Methods
-------

.. index:: pair: function; releaseResolver
.. _doxid-class_e_e_1_1detail_1_1_task_shared_state_1a4ba19defb8668c9696b6db60bd4516db:

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

	bool releaseResolver()



.. rubric:: Returns:

True if the last resolver was released.

.. index:: pair: function; abandon
.. _doxid-class_e_e_1_1detail_1_1_task_shared_state_1a132ffb468eb0e52b844440d69fd97ae6:

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

	bool abandon()



.. rubric:: Returns:

True if this call moved the state from Pending to Abandoned.

.. index:: pair: function; attach
.. _doxid-class_e_e_1_1detail_1_1_task_shared_state_1a7a32976a5f357a6ffa88a0202af61249:

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

	void attach(:ref:`Continuation<doxid-class_e_e_1_1detail_1_1_task_shared_state_1a905478ba391a97683359bf5525969ce4>` continuation)

Stores the continuation, or runs it immediately if the state is already terminal. Never invokes user code while holding the mutex.

.. index:: pair: function; value
.. _doxid-class_e_e_1_1detail_1_1_task_shared_state_1a78fff8ecec39e5623b16187de4aa55f4:

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

	:ref:`Value<doxid-class_e_e_1_1detail_1_1_task_shared_state_1a71a22b726ac27d362f8d0edc6e5bf2a9>`& value()

Only valid once Ready, and only from the single consumer.