boost::threadpool::looped_task_func Class Reference

Looped task function object. More...

#include <src/threadpool/boost/threadpool/task_adaptors.hpp>

Public Types
typedef void	result_type
	Indicates the functor's result type. More...

Public Member Functions
	looped_task_func (function0< bool > const &function, unsigned int const interval=0)
	Constructor. More...
void	operator() (void) const
	Executes the task function. More...

Private Attributes
function0< bool >	m_function
	The task's function. More...
unsigned int	m_break_s
	Duration of breaks in seconds. More...
unsigned int	m_break_ns
	Duration of breaks in nano seconds. More...

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 118 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  )

inline

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 125 of file task_adaptors.hpp.

      : m_function(function)
#if BOOST_VERSION >= 15000
      , m_break(interval)
#endif
    {
#if BOOST_VERSION < 15000
      m_break_s  = interval / 1000;
      m_break_ns = (interval - m_break_s * 1000) * 1000 * 1000;
#endif
    }

Member Function Documentation

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

inline

Executes the task function.

Definition at line 139 of file task_adaptors.hpp.

    {
      if(m_function)
      {
#if BOOST_VERSION >= 15000
        if(m_break > boost::chrono::milliseconds(0))
          boost::this_thread::sleep_for(m_break);
#else
        if(m_break_s > 0 || m_break_ns > 0)
        {
          // Sleep some time before first execution
          xtime xt;
          xtime_get(&xt, TIME_UTC);
          xt.nsec += m_break_ns;
          xt.sec += m_break_s;
          thread::sleep(xt);
        }
#endif
        while(m_function())
        {
#if BOOST_VERSION >= 15000
          if(m_break > boost::chrono::milliseconds(0))
            boost::this_thread::sleep_for(m_break);
#else
          if(m_break_s > 0 || m_break_ns > 0)
          {
            xtime xt;
            xtime_get(&xt, TIME_UTC);
            xt.nsec += m_break_ns;
            xt.sec += m_break_s;
            thread::sleep(xt);
          }
#endif
          else
          {
            thread::yield(); // Be fair to other threads
          }
        }
      }
    }

Member Data Documentation

unsigned int boost::threadpool::looped_task_func::m_break_ns

private

Duration of breaks in nano seconds.

Definition at line 115 of file task_adaptors.hpp.

unsigned int boost::threadpool::looped_task_func::m_break_s

private

Duration of breaks in seconds.

Definition at line 114 of file task_adaptors.hpp.

function0<bool> boost::threadpool::looped_task_func::m_function

private

The task's function.

Definition at line 110 of file task_adaptors.hpp.

---

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

• GaudiMTTools/src/threadpool/boost/threadpool/task_adaptors.hpp