Inheritance diagram for Task< R()>:

Public Member Functions
void	set (TaskQueue *q)
	Set the queue of this task. More...

void	cancel ()
	Cancel the execution of this task. More...

bool	ready ()
	Return true if this task is ready to be posted. More...

void	wait ()
	Wait for this task to finish execution. More...

bool	finished ()
	Check if the callback has run to completion or been fully canceled. More...

Protected Member Functions
virtual uint32_t	size ()
	Size of buffer required for TaskBase::start. More...

virtual run_callback_t	start (void *data, uint32_t max_size)
	Copy any callback data and return a callback to run. More...

virtual void	finish ()
	Inform this task that execution has finished. More...

void	post ()
	Post this task to the set TaskQueue for execution. More...

Detailed Description

template<typename R>
class events::Task< R()>

Definition at line 509 of file Task.h.

Member Function Documentation

void cancel ( )

inherited

Cancel the execution of this task.

Once cancelled the task can be posted again. Previous calls to post may still run. If you need to ensure the callback has finished the function wait() can be used.

Note: This function is interrupt safe

virtual void finish ( )

protectedvirtualinherited

Inform this task that execution has finished.

bool finished ( )

inherited

Check if the callback has run to completion or been fully canceled.

When an task is finished the queue is completely done with it and the callback is either fully complete or has been canceled and will not run.

Returns: true if this task has been flushed from the queue, false otherwise

void post ( )

protectedinherited

Post this task to the set TaskQueue for execution.

bool ready ( )

inherited

Return true if this task is ready to be posted.

Check if this task is on a queue waiting to be run.

Returns: true if it is safe to call post

void set ( TaskQueue * q )

inherited

Set the queue of this task.

Parameters

q	TaskQueue to post to

virtual uint32_t size ( )

protectedvirtual

Size of buffer required for TaskBase::start.

Returns: requested buffer size

Implements TaskBase.

Definition at line 530 of file Task.h.

virtual run_callback_t start	(	void *	data,
		uint32_t	size
	)

protectedvirtual

Copy any callback data and return a callback to run.

Parameters

data	Buffer to copy data to. Do not copy more than TaskBase::size() data.
size	Maximum size to copy

Implements TaskBase.

Definition at line 535 of file Task.h.

void wait ( )

inherited

Wait for this task to finish execution.

When this function returns then this task is in the finished state.

Public Member Functions

Protected Member Functions

Detailed Description

template<typename R> class events::Task< R()>

Member Function Documentation

Important Information for this Arm website

template<typename R>
class events::Task< R()>