vtkThreadedTaskQueue< void, Args... > Class Template Reference

#include <vtkThreadedTaskQueue.h>

Inheritance diagram for vtkThreadedTaskQueue< void, Args... >:

Collaboration diagram for vtkThreadedTaskQueue< void, Args... >:

Public Member Functions
	vtkThreadedTaskQueue (std::function< void(Args...)> worker, bool strict_ordering=true, int buffer_size=-1, int max_concurrent_tasks=-1)
	~vtkThreadedTaskQueue ()
void	Push (Args &&... args)
	Push arguments for the work.
bool	IsEmpty () const
	Returns false if there's some result that may be popped right now or in the future.
void	Flush ()
	Blocks till the queue becomes empty.
	vtkThreadedTaskQueue (std::function< void(Args...)> worker, bool strict_ordering=true, int buffer_size=-1, int max_concurrent_tasks=-1)
	~vtkThreadedTaskQueue ()
void	Push (Args &&... args)
	Push arguments for the work.
bool	Pop (void &result)
	Pop the last result.
bool	TryPop (void &result)
	Attempt to pop without waiting.
bool	IsEmpty () const
	Returns false if there's some result that may be popped right now or in the future.
void	Flush ()
	Blocks till the queue becomes empty.

Detailed Description

template<typename... Args>
class vtkThreadedTaskQueue< void, Args... >

Definition at line 118 of file vtkThreadedTaskQueue.h.

Constructor & Destructor Documentation

vtkThreadedTaskQueue() [1/2]

template<typename... Args>

vtkThreadedTaskQueue< void, Args... >::vtkThreadedTaskQueue	(	std::function< void(Args...)>	worker,
		bool	strict_ordering = true,
		int	buffer_size = -1,
		int	max_concurrent_tasks = -1 )

~vtkThreadedTaskQueue() [1/2]

template<typename... Args>

vtkThreadedTaskQueue< void, Args... >::~vtkThreadedTaskQueue

(

)

vtkThreadedTaskQueue() [2/2]

vtkThreadedTaskQueue< void, Args >::vtkThreadedTaskQueue	(	std::function< void(Args...)>	worker,
		bool	strict_ordering = true,
		int	buffer_size = -1,
		int	max_concurrent_tasks = -1 )

~vtkThreadedTaskQueue() [2/2]

vtkThreadedTaskQueue< void, Args >::~vtkThreadedTaskQueue

(

)

Member Function Documentation

Push() [1/2]

template<typename... Args>

void vtkThreadedTaskQueue< void, Args... >::Push

(

Args &&...

args

)

Push arguments for the work.

IsEmpty() [1/2]

template<typename... Args>

bool vtkThreadedTaskQueue< void, Args... >::IsEmpty

(

)

const

Returns false if there's some result that may be popped right now or in the future.

Flush() [1/2]

template<typename... Args>

void vtkThreadedTaskQueue< void, Args... >::Flush

(

)

Blocks till the queue becomes empty.

Push() [2/2]

void vtkThreadedTaskQueue< void, Args >::Push

(

Args &&...

args

)

Push arguments for the work.

Pop()

bool vtkThreadedTaskQueue< void, Args >::Pop

(

void &

result

)

Pop the last result.

Returns true on success. May fail if called on an empty queue. This will wait for result to be available.

TryPop()

bool vtkThreadedTaskQueue< void, Args >::TryPop

(

void &

result

)

Attempt to pop without waiting.

If not results are available, returns false.

IsEmpty() [2/2]

bool vtkThreadedTaskQueue< void, Args >::IsEmpty

(

)

const

Returns false if there's some result that may be popped right now or in the future.

Flush() [2/2]

void vtkThreadedTaskQueue< void, Args >::Flush

(

)

Blocks till the queue becomes empty.

---

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

• Common/Core/vtkThreadedTaskQueue.h