qi::Task Class Reference

#include <task.hpp>

Inheritance diagram for qi::Task:

Public Member Functions
virtual bool	interrupt ()=0
	Task ()
virtual	~Task ()

Public Attributes
Property< std::string >	error
Property< bool >	running
	RO, Indicates if the task is currently running. More...

Detailed Description

Definition at line 15 of file task.hpp.

Constructor & Destructor Documentation

Task()

qi::Task::Task ( )

inline

Definition at line 18 of file task.hpp.

~Task()

virtual qi::Task::~Task ( )

inlinevirtual

Definition at line 19 of file task.hpp.

Member Function Documentation

interrupt()

virtual bool qi::Task::interrupt ( )

pure virtual

Ask the task to interrupt itself.

Returns

true if the request was successful. Does not imply that the Task is effectively stopped, but that it will eventually stop.

Implemented in qi::TaskCall< Future< T > >, and qi::TaskCall< T >.

Member Data Documentation

error

Property<std::string> qi::Task::error

RO, Indicates if the task encountered an error. Empty for no error. Should be set to "interrupted" If interrupt() was called successfuly and the normal Task output will not trigger.

Definition at line 35 of file task.hpp.

running

Property<bool> qi::Task::running

RO, Indicates if the task is currently running.

Definition at line 29 of file task.hpp.

---

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

• task.hpp