OSTaskDel()
void OSTaskDel (OS_TCB *p_tcb,
OS_ERR *p_err)
File |
Called from |
Code enabled by |
os_task.c |
Task only |
OS_CFG_TASK_DEL_EN |
When a task is no longer needed, it can be deleted. Deleting a task does not mean that the code is removed, but that the task code is no longer managed by µC/OS-III. OSTaskDel() can be used when creating a task that will only run once. In this case, the task must not return but instead call OSTaskDel((OS_TCB *)0, &err) which specifies to µC/OS-III to delete the currently running task.
A task may also delete another task by specifying to OSTaskDel() the address of the OS_TCB of the task to delete.
Once a task is deleted, its OS_TCB and stack may be reused to create another task. This assumes that the task’s stack requirement of the new task is satisfied by the stack size of the deleted task.
Even though µC/OS-III allows the user to delete tasks at run time, it is recommend that such actions be avoided. Why? Because a task can “own” resources that are shared with other tasks. Deleting the task that owns resource(s) without first relinquishing the resources could lead to strange behaviors and possible deadlocks.
Arguments
p_tcb
is a pointer to the TCB of the task to delete or, you can pass a NULL pointer to specify that the calling task delete itself. If deleting the calling task, the scheduler will be invoked so that the next highest-priority task is executed.
p_err
is a pointer to a variable that will receive an error code:
Returned Value
None
Notes/Warnings
OSTaskDel() verifies that the user is not attempting to delete the µC/OS-III idle task and the ISR handler task.
Be careful when deleting a task that owns resources.
Example
OS_TCB MyTaskTCB;
void TaskX (void *p_arg) { OS_ERR err;
while (DEF_ON) { : : OSTaskDel(&MyTaskTCB, &err); /* Check “err” */ : : } } |