stapl::detail::edge_local_notifier_base Struct Reference

Represents the primary interface through which users of the edge_container or edge_view (i.e., task_graph) are informed of data flow events triggered by the completion of predecessor tasks.Instances of this class are heap allocated and passed to the edge_container when successor tasks create an edge via edge_view::setup_flow. When data flow is available for a successor, the edge_container will invoke this object's function operator, once per specified predecessor. When all notifications have been received, this object passes the successor task to the PARAGRAPH's executor, making it eligible for execution. More...

Public Member Functions
	edge_local_notifier_base (bool persistent)
virtual void	operator() (executor_base &)=0
	Invoked by each predecessor edge which this notifier was registered with, signifying that the value is now available for consumption. When the operator() has been called by all predecessors, the task associated with the notifier (m_task_ptr) is released to the executor as runnable.
virtual void	set_task_ptr (task_base *t, executor_base &executor)=0
	Set the internal pointer to the task associated with this notifier so that it can be passed to the executor when all edge trigger events (i.e., operator() calls) have occurred. More...
virtual void	intrusive_ptr_add_ref_impl (void) const =0
	Pure virtual method that defines interface for implementation of counter increment called by freestanding intrusive_ptr_add_ref. Implemented in edge_local_notifier.
virtual void	intrusive_ptr_release_impl (void) const =0
	Pure virtual method that defines interface for implementation of counter decrement called by freestanding intrusive_ptr_release. Implemented in edge_local_notifier.

Public Types
typedef void	result_type

Protected Attributes
const bool	m_b_persistent
	Denotes whether PARAGRAPH this edge notifier is a part of is persistent.

Friends
void	intrusive_ptr_add_ref (edge_local_notifier_base const *ptr)
	Freestanding function required for boost::intrusive_ptr, which is used to implement reference counting on this object, as needed for persistent PARAGRAPH usage. More...
void	intrusive_ptr_release (edge_local_notifier_base const *ptr)
	Freestanding function required for boost::intrusive_ptr, which is used to implement reference counting on this object, as needed for persistent PARAGRAPH usage. More...

Detailed Description

Represents the primary interface through which users of the edge_container or edge_view (i.e., task_graph) are informed of data flow events triggered by the completion of predecessor tasks.

Instances of this class are heap allocated and passed to the edge_container when successor tasks create an edge via edge_view::setup_flow. When data flow is available for a successor, the edge_container will invoke this object's function operator, once per specified predecessor. When all notifications have been received, this object passes the successor task to the PARAGRAPH's executor, making it eligible for execution.

Note that the interface to access the value facilitated through a different interface, namely edge_view::operator[].

See also

edge_view::setup_flow

edge_view::operator[]

aggregated_edge_view::setup_flow

aggregated_edge_view::operator[]

executor_base

Member Function Documentation

set_task_ptr()

virtual void stapl::detail::edge_local_notifier_base::set_task_ptr ( task_base *  t, executor_base &  executor  )

pure virtual

Set the internal pointer to the task associated with this notifier so that it can be passed to the executor when all edge trigger events (i.e., operator() calls) have occurred.

Parameters

t	Pointer to task associated with this predecessor notifier.
executor	The executor associated with the PARAGRAPH for this notifier.

Initialization of the task happens concurrently with the construction of this object and the edge creations it participates in. When task_graph_impl::add_task finishes creating the task, it calls this method.

See also

task_graph_impl::add_task

Implemented in stapl::detail::edge_local_notifier.

Friends And Related Function Documentation

intrusive_ptr_add_ref

void intrusive_ptr_add_ref ( edge_local_notifier_base const *  ptr )

friend

Freestanding function required for boost::intrusive_ptr, which is used to implement reference counting on this object, as needed for persistent PARAGRAPH usage.

Parameters

ptr	An instance of edge_local_notifier_base who reference count is to be incremented.

intrusive_ptr_release

void intrusive_ptr_release ( edge_local_notifier_base const *  ptr )

friend

Freestanding function required for boost::intrusive_ptr, which is used to implement reference counting on this object, as needed for persistent PARAGRAPH usage.

Parameters

ptr	An instance of edge_local_notifier_base who reference count is to be decremented.

---

The documentation for this struct was generated from the following file:

• edge_local_notifier.hpp