libtasks Documentation  1.6
tasks::timer_task Class Reference

#include <timer_task.h>

Inheritance diagram for tasks::timer_task:
Collaboration diagram for tasks::timer_task:

Public Member Functions

 timer_task (double after, double repeat)
 
virtual ~timer_task ()
 
std::string get_string () const
 
ev_timer * watcher () const
 
double after () const
 
double repeat () const
 
void init_watcher ()
 Initialize the underlying watcher object. More...
 
void start_watcher (worker *worker)
 Activate the underlying watcher to listen for I/O or timer events. More...
 
void stop_watcher (worker *worker)
 Deactivate the underlying watcher. More...
 
- Public Member Functions inherited from tasks::event_task
virtual ~event_task ()
 
virtual bool handle_event (worker *worker, int events)=0
 
workerassigned_worker () const
 Returns a pointer to the assigned worker. More...
 
void assign_worker (worker *worker)
 
void notify_error (worker *worker=nullptr)
 
void on_error (error_func_worker_t f)
 
void on_error (error_func_void_t f)
 Install an error callback. More...
 
- Public Member Functions inherited from tasks::task
virtual ~task ()
 
bool auto_delete () const
 Returns true if auto deletion is active. More...
 
void disable_auto_delete ()
 Call this to deactivate auto deletion. More...
 
void finish (worker *worker=nullptr)
 Called by a worker when a task has auto_deletion enabled. More...
 
void on_finish (finish_func_worker_t f)
 
void on_finish (finish_func_void_t f)
 
- Public Member Functions inherited from tasks::error_base
 error_base ()
 
virtual ~error_base ()
 
bool error () const
 Return true if an error occured. More...
 
tasks_error error_code () const
 Return the error code. More...
 
const std::string & error_message () const
 Return the error message. More...
 
int sys_errno () const
 Return the errno if available. More...
 
std::string sys_errno_str () const
 Return the errno description if available. More...
 
const tasks_exceptionexception () const
 Return the underlying exception object. More...
 
void set_exception (tasks_exception &e)
 Set an exception to report an error. More...
 
void reset_error ()
 Reset the error state. More...
 

Private Attributes

std::unique_ptr< ev_timer > m_timer
 
double m_after = 0
 
double m_repeat = 0.
 

Additional Inherited Members

- Public Types inherited from tasks::event_task
typedef std::function< void(worker
*worker, const tasks_exception
&e)> 
error_func_worker_t
 
typedef std::function< void(const
tasks_exception &e)> 
error_func_void_t
 
- Public Types inherited from tasks::task
typedef std::function< void(worker
*worker)> 
finish_func_worker_t
 
typedef std::function< void()> finish_func_void_t
 

Detailed Description

Definition at line 20 of file timer_task.h.

Constructor & Destructor Documentation

tasks::timer_task::timer_task ( double  after,
double  repeat 
)

Definition at line 15 of file timer_task.cpp.

Here is the call graph for this function:

tasks::timer_task::~timer_task ( )
virtual

Definition at line 23 of file timer_task.cpp.

Here is the call graph for this function:

Member Function Documentation

double tasks::timer_task::after ( ) const
inline

Definition at line 33 of file timer_task.h.

Here is the caller graph for this function:

std::string tasks::timer_task::get_string ( ) const
inline

Definition at line 25 of file timer_task.h.

Here is the caller graph for this function:

void tasks::timer_task::init_watcher ( )
inlinevirtual

Initialize the underlying watcher object.

Implements tasks::event_task.

Definition at line 37 of file timer_task.h.

Here is the caller graph for this function:

double tasks::timer_task::repeat ( ) const
inline

Definition at line 35 of file timer_task.h.

Here is the caller graph for this function:

void tasks::timer_task::start_watcher ( worker worker)
virtual

Activate the underlying watcher to listen for I/O or timer events.

Implements tasks::event_task.

Definition at line 25 of file timer_task.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

void tasks::timer_task::stop_watcher ( worker worker)
virtual

Deactivate the underlying watcher.

Implements tasks::event_task.

Definition at line 34 of file timer_task.cpp.

Here is the call graph for this function:

ev_timer* tasks::timer_task::watcher ( ) const
inline

Definition at line 31 of file timer_task.h.

Member Data Documentation

double tasks::timer_task::m_after = 0
private

Definition at line 43 of file timer_task.h.

double tasks::timer_task::m_repeat = 0.
private

Definition at line 44 of file timer_task.h.

std::unique_ptr<ev_timer> tasks::timer_task::m_timer
private

Definition at line 42 of file timer_task.h.


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