Homepage  

xTaskCallApplicationTaskHook
[Task Control]

task. h

	portBASE_TYPE xTaskCallApplicationTaskHook( xTaskHandle xTask, void *pvParameter );

configUSE_APPLICATION_TASK_TAG must be defined as 1 for this function to be available. See the configuration section for more information.

A 'tag' value can be assigned to each task. Normally this value is for the use of the application only and the kernel does not access it. However, it is possible to use the tag to assign a hook (or callback) function to a task - the hook function being executed by calling xTaskCallApplicationTaskHook(). Each task can define its own callback, or simply not define a callback at all.

Although it is possible to use the first function parameter to call the hook function of any task, the most common use of task hook function is with the trace hook macros, as per the example given below.

Task hook functions must have type pdTASK_HOOK_CODE, that is take a void * parameter, and return a value of type portBASE_TYPE. The void * parameter can be used to pass any information into the hook function.

Parameters:

xTask	The handle of the task whose hook function is being called. Passing NULL as xTask will call the hook function assocaited with the currently executing task.
pvParameter	The value to pass to the hook function. This can be a pointer to a structure, or simply a numeric value.

Example usage:

    /* In this example a callback function is being assigned as the task tag.
    First define the callback function - this must have type pdTASK_HOOK_CODE
    as per this example. */
    static portBASE_TYPE prvExampleTaskHook( void * pvParameter )
    {
        /* Perform some action - this could be anything from logging a value,
        updating the task state, outputting a value, etc. */

        return 0;
    }

    /* Now define the task that sets prvExampleTaskHook as its hook/tag value.
    This is in fact registering the task callback, as described on the 
    xTaskCallApplicationTaskHook() documentation page. */
    void vAnotherTask( void *pvParameters )
    {
        /* Register our callback function. */
        vTaskSetApplicationTaskTag( NULL, prvExampleTaskHook );

        for( ;; )
        {
            /* Rest of task code goes here. */
        }
    }

    /* As an example use of the hook (callback) we can get the kernel to call the
    hook function of each task that is being switched out during a reschedule. */
    #define traceTASK_SWITCHED_OUT() xTaskCallApplicationTaskHook( pxCurrentTCB, 0 )
  

Copyright (C) 2003 - 2008 Richard Barry
Any and all data, files, source code, html content and documentation included in the FreeRTOS distribution or available on this site are the exclusive property of Richard Barry. See the files license.txt (included in the distribution) and this copyright notice for more information. FreeRTOS^TM and FreeRTOS.org^TM are trade marks of Richard Barry.