WorkSingularTask Class Reference

A WorkSingularTask runs a task in a WorkDispatcher, but never concurrently with itself. More...

Public Member Functions
	WorkSingularTask (WorkSingularTask const &)=delete
WorkSingularTask &	operator= (WorkSingularTask const &)=delete
template<class Callable , class A1 , class A2 , ...class AN>
	WorkSingularTask (WorkDispatcher &dispatcher, Callable &&c, A1 &&a1, A2 &&a2,...AN &&aN)
	Create a singular task to be run in dispatcher. More...
void	Wake ()
	Ensure that this task runs at least once after this call. More...

Detailed Description

A WorkSingularTask runs a task in a WorkDispatcher, but never concurrently with itself.

That is, the function provided to the WorkSingularTask runs concurrently with other tasks in the WorkDispatcher, but never with another invocation of itself.

This is useful if there is single-threaded work to do that can be overlapped with other parallel tasks in a dispatcher. For example, a multiple-producer, single-consumer problem can be tackled this way. Run the producer tasks as usual in a WorkDispatcher and create a WorkSingularTask for the consumer. When a producer task has generated a result to consume, it invokes Wake() on the consumer task. This ensures that the consumer runs only when there are results to consume, and it lets the consumer operate single-threaded. For example, the consumer could populate stl containers without locking.

Definition at line 56 of file singularTask.h.

Constructor & Destructor Documentation

WorkSingularTask	(	WorkDispatcher &	dispatcher,
		Callable &&	c,
		A1 &&	a1,
		A2 &&	a2,
		...AN &&	aN
	)

Create a singular task to be run in dispatcher.

Callers must ensure that dispatcher lives at least as long as this WorkSingularTask.

A singular task is one that will not run concurrently with itself. See the WorkSingularTask doc for more details.

After constructing a WorkSingularTask, call Wake() to ensure that the task runs at least once.

Member Function Documentation

void Wake ( )

inline

Ensure that this task runs at least once after this call.

The task is not guaranteed to run as many times as Wake() is invoked, only that it run at least once after a call to Wake().

Definition at line 90 of file singularTask.h.

---

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

• pxr/base/work/singularTask.h