GATE
Public Member Functions | Protected Member Functions | List of all members
gate::ITaskBase Class Reference
Inheritance diagram for gate::ITaskBase:
gate::ITaskBuilder gate::IRunnable gate::ICancelable gate::IObjectBuilder< gate_task_t, GATE_INTERFACE_VTBL(gate_task) > gate::IObject gate::TaskDispatcher0< OUTARG > gate::TaskDispatcher1< A1, OUTARG > gate::TaskDispatcher2< A1, A2, OUTARG > gate::TaskDispatcher3< A1, A2, A3, OUTARG > gate::TaskDispatcher4< A1, A2, A3, A4, OUTARG > gate::TaskRunnableDispatcher

Public Member Functions

virtual void run ()
 
virtual void cancel ()
 
virtual Task::StatusEnum status ()
 
virtual bool_t completed ()
 
virtual void const * getResult ()
 
virtual void wait ()
 
virtual bool waitFor (uint32_t timeoutMs)
 
- Public Member Functions inherited from gate::IObjectBuilder< gate_task_t, GATE_INTERFACE_VTBL(gate_task) >
virtual void release () noexcept
 
virtual int retain () noexcept
 
virtual String getInterfaceName () noexcept
 
virtual gate_task_t * c_impl ()
 

Protected Member Functions

virtual void runImpl ()
 To be overwritten by derived implementation class.
 
virtual void cancelImpl ()
 To be overwritten by derived implementation class.
 
virtual void setTaskData (void const *data=NULL)
 
- Protected Member Functions inherited from gate::ITaskBuilder
 ITaskBuilder (obj_vtbl_t const *vtbl_ptr, char const *name)
 
- Protected Member Functions inherited from gate::IObjectBuilder< gate_task_t, GATE_INTERFACE_VTBL(gate_task) >
 IObjectBuilder (obj_vtbl_t const *vtbl_ptr, char const *name)
 

Additional Inherited Members

- Public Types inherited from gate::ITaskBuilder
typedef IObjectBuilder< gate_task_t, GATE_INTERFACE_VTBL(gate_task) > object_builder_t
 
- Public Types inherited from gate::IObjectBuilder< gate_task_t, GATE_INTERFACE_VTBL(gate_task) >
typedef gate_task_t obj_struct_t
 
typedef GATE_INTERFACE_VTBL(gate_task) obj_vtbl_t
 
typedef IObjectBuilder< obj_struct_t, obj_vtbl_t > ObjectBuilder
 
- Static Protected Member Functions inherited from gate::ITaskBuilder
static result_t task_run (void *this_ptr)
 
static result_t task_cancel (void *this_ptr)
 
static int task_get_status (void *this_ptr)
 
static gate_bool_t task_completed (void *this_ptr)
 
static gate_result_t task_get_result (void *this_ptr, gate_result_t *ptr_task_result, void const **ptr_task_data)
 
static gate_result_t task_wait (void *this_ptr)
 
static gate_result_t task_timed_wait (void *this_ptr, gate_uint32_t timeout_ms)
 
- Static Protected Member Functions inherited from gate::IObjectBuilder< gate_task_t, GATE_INTERFACE_VTBL(gate_task) >
static void object_release (void *obj_ptr) noexcept
 
static int object_retain (void *obj_ptr) noexcept
 
static char const * object_get_interface_name (void *obj_ptr) noexcept
 
static T * getInterface (cpp_object *obj)
 
- Static Protected Attributes inherited from gate::ITaskBuilder
static VtblTask cpp_vtbl_task
 

Member Function Documentation

◆ cancel()

void gate::ITaskBase::cancel ( )
virtual

Implements gate::ITaskBuilder.

◆ completed()

bool_t gate::ITaskBase::completed ( )
virtual

Implements gate::ITaskBuilder.

◆ getResult()

void const * gate::ITaskBase::getResult ( )
virtual

Implements gate::ITaskBuilder.

◆ run()

void gate::ITaskBase::run ( )
virtual

Implements gate::ITaskBuilder.

◆ runImpl()

void gate::ITaskBase::runImpl ( )
protectedvirtual

To be overwritten by derived implementation class.

Reimplemented in gate::TaskRunnableDispatcher, gate::TaskDispatcher0< OUTARG >, gate::TaskDispatcher1< A1, OUTARG >, gate::TaskDispatcher2< A1, A2, OUTARG >, gate::TaskDispatcher3< A1, A2, A3, OUTARG >, and gate::TaskDispatcher4< A1, A2, A3, A4, OUTARG >.

◆ status()

Task::StatusEnum gate::ITaskBase::status ( )
virtual

Implements gate::ITaskBuilder.

◆ wait()

void gate::ITaskBase::wait ( )
virtual

Implements gate::ITaskBuilder.

◆ waitFor()

bool gate::ITaskBase::waitFor ( uint32_t timeoutMs)
virtual

Implements gate::ITaskBuilder.

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