Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

Anchor10046431004643A task may also delete another task by specifying to OSTaskDel() the address of the OS_TCB of the task to delete. Anchor10046441004644

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.

Anchor10046451004645Even 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. Anchor10046461004646

Arguments

...

1004647p_tcb Anchor10046481004648

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.

...

10046491004649p_err Anchor10046501004650

is a pointer to a variable that will receive an error code:

...

classWebWorks_Indent_1

...

OS_ERR_NONE

...

classWebWorks_Indent_2

...

...

'p_err' gets set to OS_ERR_NONE before OSSched() to allow the returned error code to be monitored (by another task) even for a task that is deleting itself. In this case, p_err must point to a global variable that can be accessed by that other task and, you should initialize that variable to OS_ERR_TASK_RUNNING prior to deleting the task.

...

classWebWorks_Indent_1

...

OS_ERR_TASK_DEL_IDLE

...

classWebWorks_Indent_2

...

If attempting to delete the idle task.

...

classWebWorks_Indent_1

...

...

OS_ERR_TASK_DEL_ISR

...

classWebWorks_Indent_2

...

If OS_CFG_CALLED_FROM_ISR_CHK_EN set to 1 in os_cfg.h: if you called OSTaskDel() from an ISR.

...

...

OS_ERR_TASK_DEL_INVALID

...

classWebWorks_Indent_2

...

If attempting to delete the ISR Handler task while OS_CFG_ISR_POST_DEFERRED_EN is set to 1.

...

Returned Value

...

None Anchor10504261050426

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

...

rowspan14

...