TaskBase Class Reference

TaskBase. More...

#include <TaskBase.h>

Inheritance diagram for TaskBase:

Public Member Functions
	TaskBase (TaskQueue *q)
	Construct a new TaskBase object. More...
virtual	~TaskBase ()
	Destroy this TaskBase. More...
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 ()=0
	Size of buffer required for TaskBase::start. More...
virtual run_callback_t	start (void *data, uint32_t size)=0
	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

TaskBase.

Representation of a caller allocated task

Definition at line 43 of file TaskBase.h.

Constructor & Destructor Documentation

TaskBase()

TaskBase

(

TaskQueue *

q

)

Construct a new TaskBase object.

Parameters

q	Queue for posting to

~TaskBase()

virtual ~TaskBase ( )

virtual

Destroy this TaskBase.

Member Function Documentation

set()

void set

(

TaskQueue *

q

)

Set the queue of this task.

Parameters

q	TaskQueue to post to

cancel()

void cancel

(

)

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

ready()

bool ready

(

)

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

wait()

void wait

(

)

Wait for this task to finish execution.

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

finished()

bool finished

(

)

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

size()

virtual uint32_t size ( )

protectedpure virtual

Size of buffer required for TaskBase::start.

Returns

requested buffer size

Implemented in Task< R()>, Task< R(ARG0)>, and Task< R(ARG0, ARG1)>.

start()

virtual run_callback_t start ( void *  data, uint32_t  size  )

protectedpure virtual

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

Implemented in Task< R()>, Task< R(ARG0)>, and Task< R(ARG0, ARG1)>.

finish()

virtual void finish ( )

protectedvirtual

Inform this task that execution has finished.

post()

void post ( )

protected

Post this task to the set TaskQueue for execution.