stapl::detail::remote_edge_version_entry< T, Notifier, Hook > Class Template Reference

Maintains list of edge notifications for locations with remote consumers. More...

Public Member Functions
template<typename FullValueAccess >
void	add_notifier (Notifier const &notifier, std::size_t tid, edge_container &ct, FullValueAccess const &full_value, const bool b_full_flow, const bool b_persistent, const bool b_upgrade, const bool b_moveable, const bool b_consumers_before_producer)
	Add a new remote notifier, invoking it if flow has previously been set. More...
template<typename FullValueAccess >
void	set_value (edge_container &ct, std::size_t tid, FullValueAccess const &full_value, bool b_persistent, bool b_moveable)
	This method is called by the corresponding edge_entry to notify this edge version of the produced value so that it can flush its notification list. More...
notifier_list_t &	notifications (void)
	Enable access to notification list. More...
bool	empty_notifications (void) const
	Return true if there are no notifiers in list. False otherwise.
void	cleanup_notifications (void)
	Called by edge_entry destructor to explicit delete notifiers when they have been kept for PARAGRAPH persistency support. For incrementally destroyed PARAGRAPHs, this is a noop. More...
void	clear_flow (void)
bool	test_flow (void) const
bool	test_flushing (void) const

Public Types
using	entry_t = typename base_t::notifier_entry_t
using	notifier_list_t = typename base_t::notifier_list_t

Protected Member Functions
template<typename NotifierInvoker >
void	flush_notifications (NotifierInvoker const &invoker, const bool b_persistent)
	Invoke all notifier in the list, deleting them afterwords as part of incremental PARAGRAPH destruction, unless persistency is enabled. More...
template<typename NotifierInvoker >
void	add_notifier_impl (NotifierInvoker const &invoker, Notifier const &notifier, const bool b_persistent)
	Add a new notifier to the list, possibly invoking it immediately if the associated data flow was previously triggered. More...
void	set_flow (void)
void	clear_flushing (void)
void	set_flushing (void)

Protected Types
typedef notifier_entry< Notifier, boost::intrusive::slist_base_hook<> >	notifier_entry_t

Protected Attributes
notifier_list_t	m_notifications

Detailed Description

template<typename T, typename Notifier, typename Hook>
class stapl::detail::remote_edge_version_entry< T, Notifier, Hook >

Maintains list of edge notifications for locations with remote consumers.

Template Parameters

T	The value type produced by the producer task.
Notifier	Edge notifiers for remote consumers locations registered with the producer. Currently, an instantiation of class template edge_notifier_wrapper.
Hook	The Boost.Intrusive container entry hook type used to place this version to store this version and notifiers in a list with other versions held by the edge_entry.

See also

edge_notifier_wrapper

Currently, objects from this class template are only stored on the producer location. Unlike local notifications (i.e., signal, filtered, or full), no value data member is held. The produced value is always available on producer location after producer task execution until all successors have been notified and local successors have finished execution. Hence, the edge_entry just passes a reference to this value when calling add_notifier and set_value.

Member Function Documentation

add_notifier()

template<typename T , typename Notifier , typename Hook >

template<typename FullValueAccess >

void stapl::detail::remote_edge_version_entry< T, Notifier, Hook >::add_notifier	(	Notifier const &	notifier,
		std::size_t	tid,
		edge_container &	ct,
		FullValueAccess const &	full_value,
		const bool	b_full_flow,
		const bool	b_persistent,
		const bool	b_upgrade,
		const bool	b_moveable,
		const bool	b_consumers_before_producer
	)

Add a new remote notifier, invoking it if flow has previously been set.

Parameters

notifier	New remote notifier to add to list.
tid	The task identifier of the associated edge_entry.
ct	The edge_container associated with notifier.
full_value	The task identifier of the associated edge_entry.
b_full_flow	The current flow state of the value produced by tid (i.e., is full_value valid?).
b_persistent	True if corresponding PARAGRAPH is persistent. False otherwise.
b_upgrade	Is this new notifier an upgrade of a previous request (i.e., a FULL after a previous SIGNAL request).
b_moveable	Whether function allowed to move out the value to service a single remote consumer.
b_consumers_before_producer	True if consumers were registered on this location (creating an edge_entry) prior to the initialization of the producer. This parameter is only passed in debug mode to allow an assert to be properly guarded by a corner case caused by unconditional insertion of a remote notifier on the initial execution location (this simplifies the migration protocol). Discussed in more detail in edge_container::setup_flow.

Invokes base member notifier_list::add_notifier_impl after constructing a notifier invoker lambda using the input parameters.

set_value()

template<typename T , typename Notifier , typename Hook >

template<typename FullValueAccess >

void stapl::detail::remote_edge_version_entry< T, Notifier, Hook >::set_value	(	edge_container &	ct,
		std::size_t	tid,
		FullValueAccess const &	full_value,
		bool	b_persistent,
		bool	b_moveable
	)

This method is called by the corresponding edge_entry to notify this edge version of the produced value so that it can flush its notification list.

Parameters

ct	The edge container holding the entry this list of remote notifications refers to.
tid	The task identifier of the associated edge_entry.
full_value	The value produced by task tid.
b_persistent	True if corresponding PARAGARAPH is persistent. False otherwise.
b_moveable	Whether function allowed to move out the value to service a single remote consumer.

Invokes base member notifier_list::add_notifier_impl after constructing a notifier invoker lambda using the input parameters.

See also

notifier_list::flush_notifications

notifications()

template<typename T , typename Notifier , typename Hook >

notifier_list_t& stapl::detail::remote_edge_version_entry< T, Notifier, Hook >::notifications

(

void

)

Enable access to notification list.

This method exists solely to support migration. The associated edge_entry performs a swap on with this list and returns the elements to edge_container::migrate_entry so that these notifiers can be forwarded to the task's new execution location.

flush_notifications()

template<typename Notifier>

template<typename NotifierInvoker >

void stapl::detail::notifier_list< Notifier >::flush_notifications ( NotifierInvoker const &  invoker, const bool  b_persistent  )

protectedinherited

Invoke all notifier in the list, deleting them afterwords as part of incremental PARAGRAPH destruction, unless persistency is enabled.

Parameters

invoker	Higher order function object which is responsible for calling the notifier with whatever arguments are necessary.
b_persistent	Denotes whether persistency is enabled in the associated PARAGRAPH. Guards the deletion of a notifier after it is invoked.

This protected method is used by derived classes to implement their set_value methods (which are called by the edge_entry when the corresponding data flow is locally triggered.

add_notifier_impl()

template<typename Notifier>

template<typename NotifierInvoker >

void stapl::detail::notifier_list< Notifier >::add_notifier_impl ( NotifierInvoker const &  invoker, Notifier const &  notifier, const bool  b_persistent  )

protectedinherited

Add a new notifier to the list, possibly invoking it immediately if the associated data flow was previously triggered.

Parameters

invoker	Higher order function object which is responsible for calling the notifier with whatever arguments are necessary.
notifier	The edge notifier that tied to the data flow this notifier list is a part of.
b_persistent	Denotes whether persistency is enabled in the associated PARAGRAPH.

This protected method is used by derived classes to implement their add_notifier methods. The derived classes construct the appropriate invoker.

Note that even if flow is previously set, an entry may be created to either (a) allow subsequent persistent PARAGRAPH invocations or (b) maintain notifier ordering if a notifier flush is in progress.

cleanup_notifications()

template<typename Notifier>

void stapl::detail::notifier_list< Notifier >::cleanup_notifications ( void  )

inherited

Called by edge_entry destructor to explicit delete notifiers when they have been kept for PARAGRAPH persistency support. For incrementally destroyed PARAGRAPHs, this is a noop.

See also

edge_entry::~edge_entry

---

The documentation for this class was generated from the following files:

• notifier_list.hpp
• remote_edge_version_entry.hpp