boost::threadpool::looped_task_func Class Reference

List of all members.

Public Types
typedef void	result_type
Public Member Functions
	looped_task_func (function0< bool > const &function, unsigned int const interval=0)
void	operator() (void) const

---

Detailed Description

Looped task function object.

This function object wraps a boolean thread function object. The wrapped task function is invoked by calling the operator () and it is executed in regular time intervals until false is returned. The interval length may be zero. Please note that a pool's thread is engaged as long as the task is looped.

Definition at line 107 of file task_adaptors.hpp.

---

Member Typedef Documentation

typedef void boost::threadpool::looped_task_func::result_type

Indicates the functor's result type.

Definition at line 115 of file task_adaptors.hpp.

---

Constructor & Destructor Documentation

boost::threadpool::looped_task_func::looped_task_func	(	function0< bool > const &	function,
		unsigned int const	interval = 0
	)

Constructor.

Parameters:

function	The task's function object which is looped until false is returned.
interval	The minimum break time in milli seconds before the first execution of the task function and between the following ones.

Definition at line 122 of file task_adaptors.hpp.

---

Member Function Documentation

void boost::threadpool::looped_task_func::operator()

(

void

)

const

Executes the task function.

Definition at line 131 of file task_adaptors.hpp.