Task Handles & Enumerations

Group that contains definitions for task handles. More...

Collaboration diagram for Task Handles & Enumerations:

Data Structures
struct	xTIME_OUT
struct	xMEMORY_REGION
struct	xTASK_PARAMETERS
struct	xTASK_STATUS

Typedefs
typedef void *	TaskHandle_t
	Type by which tasks are referenced. More...
typedef BaseType_t(*	TaskHookFunction_t) (void *)
	Defines the prototype to which the application task hook function must conform.
typedef struct xTIME_OUT	TimeOut_t
typedef struct xMEMORY_REGION	MemoryRegion_t
typedef struct xTASK_PARAMETERS	TaskParameters_t
typedef struct xTASK_STATUS	TaskStatus_t

Enumerations
enum	eTaskState {   eRunning = 0, eReady, eBlocked, eSuspended,   eDeleted, eInvalid }
	Task states returned by eTaskGetState. More...
enum	eNotifyAction {   eNoAction = 0, eSetBits, eIncrement, eSetValueWithOverwrite,   eSetValueWithoutOverwrite }
	Actions that can be performed when vTaskNotify() is called. More...
enum	eSleepModeStatus { eAbortSleep, eStandardSleep, eNoTasksWaitingTimeout }

Detailed Description

Group that contains definitions for task handles.

Typedef Documentation

MemoryRegion_t

typedef struct xMEMORY_REGION MemoryRegion_t

#include <task.h>

Defines the memory ranges allocated to the task when an MPU is used.

TaskHandle_t

typedef void* TaskHandle_t

#include <task.h>

Type by which tasks are referenced.

For example, a call to xTaskCreate() returns (via a pointer parameter) a TaskHandle_t variable that can then be used as a parameter to vTaskDelete() to delete the task.

TaskParameters_t

typedef struct xTASK_PARAMETERS TaskParameters_t

#include <task.h>

Parameters required to create an MPU protected task.

TaskStatus_t

typedef struct xTASK_STATUS TaskStatus_t

#include <task.h>

Used with the uxTaskGetSystemState() function to return the state of each task in the system.

TimeOut_t

typedef struct xTIME_OUT TimeOut_t

#include <task.h>

Used internally only.

Enumeration Type Documentation

eNotifyAction

enum eNotifyAction

#include <task.h>

Actions that can be performed when vTaskNotify() is called.

Enumerator
eNoAction	Notify the task without updating its notify value.
eSetBits	Set bits in the task's notification value.
eIncrement	Increment the task's notification value.
eSetValueWithOverwrite	Set the task's notification value to a specific value even if the previous value has not yet been read by the task.
eSetValueWithoutOverwrite	Set the task's notification value if the previous value has been read by the task.

eSleepModeStatus

enum eSleepModeStatus

#include <task.h>

Possible return values for eTaskConfirmSleepModeStatus().

Enumerator
eAbortSleep	A task has been made ready or a context switch pended since portSUPPORESS_TICKS_AND_SLEEP() was called - abort entering a sleep mode.
eStandardSleep	Enter a sleep mode that will not last any longer than the expected idle time.
eNoTasksWaitingTimeout	No tasks are waiting for a timeout so it is safe to enter a sleep mode that can only be exited by an external interrupt.

eTaskState

enum eTaskState

#include <task.h>

Task states returned by eTaskGetState.

Enumerator
eRunning	A task is querying the state of itself, so must be running.
eReady	The task being queried is in a read or pending ready list.
eBlocked	The task being queried is in the Blocked state.
eSuspended	The task being queried is in the Suspended state, or is in the Blocked state with an infinite time out.
eDeleted	The task being queried has been deleted, but its TCB has not yet been freed.
eInvalid	Used as an 'invalid state' value.