.. index:: pair: class; EE::UI::UIThreadObservation
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_thread_observation:

template class EE::UI::UIThreadObservation
==========================================

.. toctree::
	:hidden:

	struct_EE_UI_UIThreadObservation_SourceConnection.rst
	struct_EE_UI_UIThreadObservation_SourceConnectionBase.rst
	struct_EE_UI_UIThreadObservation_State.rst

Overview
~~~~~~~~

Scoped non-blocking delivery of observable changes to the :ref:`UI <doxid-namespace_e_e_1_1_u_i>` thread. :ref:`More...<details-class_e_e_1_1_u_i_1_1_u_i_thread_observation>`


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

	#include <uiobservedelivery.hpp>
	
	template <typename T>
	class UIThreadObservation {
	public:
		// typedefs
	
		typedef std::function<void(:ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`&, const T&)> :target:`Callback<doxid-class_e_e_1_1_u_i_1_1_u_i_thread_observation_1aff3f38a12d32e233650c3fc965e0eb48>`;

		// structs
	
		template <typename Connection>
		struct :ref:`SourceConnection<doxid-struct_e_e_1_1_u_i_1_1_u_i_thread_observation_1_1_source_connection>`;
	
		struct :ref:`SourceConnectionBase<doxid-struct_e_e_1_1_u_i_1_1_u_i_thread_observation_1_1_source_connection_base>`;
		struct :ref:`State<doxid-struct_e_e_1_1_u_i_1_1_u_i_thread_observation_1_1_state>`;

		// construction
	
		:target:`UIThreadObservation<doxid-class_e_e_1_1_u_i_1_1_u_i_thread_observation_1a77c2a9ce2bdd2ad43d08a60dee310d0b>`();
		:target:`UIThreadObservation<doxid-class_e_e_1_1_u_i_1_1_u_i_thread_observation_1a23b1c8e91f733e9804bb71a33d02d102>`(const UIThreadObservation&);
		:target:`UIThreadObservation<doxid-class_e_e_1_1_u_i_1_1_u_i_thread_observation_1a63de78c05fd2d1a6b33f0e5a5b622d9a>`(UIThreadObservation&&);
	
		template <typename Source>
		:ref:`UIThreadObservation<doxid-class_e_e_1_1_u_i_1_1_u_i_thread_observation_1a21bcb2da7a9632aef4ead718b78a38ae>`(Source& source, :ref:`Node<doxid-class_e_e_1_1_scene_1_1_node>`& scheduler, :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`& endpoint, :ref:`Callback<doxid-class_e_e_1_1_u_i_1_1_u_i_thread_observation_1aff3f38a12d32e233650c3fc965e0eb48>` callback);

		// methods
	
		UIThreadObservation& :target:`operator=<doxid-class_e_e_1_1_u_i_1_1_u_i_thread_observation_1a32a3e88a05cf705cfab3b865d377f0fa>`(const UIThreadObservation&);
		UIThreadObservation& :target:`operator=<doxid-class_e_e_1_1_u_i_1_1_u_i_thread_observation_1a7b65de94c0dcafe7300bce7de513415f>`(UIThreadObservation&&);
		void :ref:`disconnect<doxid-class_e_e_1_1_u_i_1_1_u_i_thread_observation_1ad6e1048bbf38fc87d2fbedf76da856b7>`();
		:ref:`operator bool<doxid-class_e_e_1_1_u_i_1_1_u_i_thread_observation_1a57a899aa2745e8fdae0ef6b5a773126c>`() const;
	};
.. _details-class_e_e_1_1_u_i_1_1_u_i_thread_observation:

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

Scoped non-blocking delivery of observable changes to the :ref:`UI <doxid-namespace_e_e_1_1_u_i>` thread.

The scheduler must outlive this connection and is normally the owning :ref:`UISceneNode <doxid-class_e_e_1_1_u_i_1_1_u_i_scene_node>`. The endpoint widget is not retained; queued work becomes a no-op after it closes. Source mutation remains the producer's synchronization responsibility because :ref:`ObservableValue <doxid-class_e_e_1_1_observable_value>` itself is single-threaded. In particular, construct and disconnect this observation only while the producer is stopped or otherwise synchronized; observer registration and removal must not race source mutation.

Construction
------------

.. index:: pair: function; UIThreadObservation
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_thread_observation_1a21bcb2da7a9632aef4ead718b78a38ae:

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

	template <typename Source>
	UIThreadObservation(Source& source, :ref:`Node<doxid-class_e_e_1_1_scene_1_1_node>`& scheduler, :ref:`UIWidget<doxid-class_e_e_1_1_u_i_1_1_u_i_widget>`& endpoint, :ref:`Callback<doxid-class_e_e_1_1_u_i_1_1_u_i_thread_observation_1aff3f38a12d32e233650c3fc965e0eb48>` callback)

Observes ``source`` and queues ``callback`` on ``scheduler's`` :ref:`UI <doxid-namespace_e_e_1_1_u_i>` thread.

Delivery preserves source notification order. The callback receives the endpoint only while it remains alive. Keep the returned observation alive and ensure the scheduler outlives it.

Methods
-------

.. index:: pair: function; disconnect
.. _doxid-class_e_e_1_1_u_i_1_1_u_i_thread_observation_1ad6e1048bbf38fc87d2fbedf76da856b7:

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

	void disconnect()

Stops future delivery and invalidates already queued callbacks.

Synchronize with the source producer before calling this; see the class thread-safety notes.

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

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

	operator bool() const



.. rubric:: Returns:

Whether the source is connected and the endpoint remains alive.