|
libtasks Documentation
1.6
|
#include <cleanup_task.h>


Public Member Functions | |
| cleanup_task (disposable *d) | |
| bool | handle_event (worker *worker, int) |
Public Member Functions inherited from tasks::timer_task | |
| 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 () |
| worker * | assigned_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_exception & | exception () 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 | |
| disposable * | m_disposable |
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 |
Definition at line 18 of file cleanup_task.h.
|
inline |
Definition at line 20 of file cleanup_task.h.
|
inlinevirtual |
Will be called for each I/O or timer event.
Each task needs to implement the handle_event method. Returns true if the task stays active and false otherwise. The task will be deleted if false is returned and auto_delete() returns true.
| worker | The worker thread executing the task. |
| events | The events bitmask. |
Implements tasks::event_task.
Definition at line 22 of file cleanup_task.h.

|
private |
Definition at line 33 of file cleanup_task.h.