gate_task_t Interface Reference

Interface to cover asynchronous task execution. More...

#include <runnables.h>

Inheritance diagram for gate_task_t:

Public Member Functions
gate_result_t	run ()
	Executes code covered by this interface, wakes up waiters on exit.
gate_result_t	cancel ()
	Cancels a prepared or running task, wakes up all waiting functions.
gate_enumint_t	get_status ()
	Returns the current GATE_TASK_STATUS_* value describing the task's state.
gate_bool_t	completed ()
	Returns true if the task was executed or canceled.
gate_result_t	get_result (gate_result_t *ptr_task_result, void const **ptr_task_data)
	Returns the result state of the task and optionally a pointer to the task's result data.
gate_result_t	wait ()
	Waits until the task switches into completed state (done or canceled)
gate_result_t	timed_wait (gate_uint32_t timeout_ms)
	Waits until the task switches into completed state (done or canceled) or a timeout occured.
Public Member Functions inherited from gate_runnable_t
Public Member Functions inherited from gate_object_t
char const *	get_interface_name ()
	Returns on object's interface path name.
void	release ()
	Decrease object's reference counter, releases the object when count reaches zero.
int	retain ()
	Increase object's reference counter.

Detailed Description

Interface to cover asynchronous task execution.

---

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

• runnables.h