mem_util_task.h File Reference

Interface to the functions found in mem_util_task.c. More...

#include <ITC/ITC_drvdefs.h>
#include <ITC/ITC_pubdefs.h>
#include <mem_unit_test.h>

Functions
int	TASK_init (test_Test_Descriptor *td_p, ITC_Task **task_pp, ITC_TaskID tid)
	Create a task.
int	TASK_add_queue (test_Test_Descriptor *td_p, ITC_Task *task_p, ITC_QueueID queue_id, ITC_cb_Dispatch *dispatch_p)
	Add a queue to a task.
int	TASK_start (test_Test_Descriptor *td_p, ITC_Task *task_p, char *name, int priority)
	Start a task.
int	TASK_stop (test_Test_Descriptor *td_p, ITC_Task *task_p)
	Stop a task.
int	TASK_remove_queue (test_Test_Descriptor *td_p, ITC_Task *task_p, ITC_QueueID queue_id)
	Remove a queue from a task.
int	TASK_shutdown (test_Test_Descriptor *td_p, ITC_Task *task_p)
	Shutdown a task.

---

Detailed Description

Interface to the functions found in mem_util_task.c.

**  CVS $Id: mem_util_task.h,v 1.2 2011/03/29 01:58:52 apw Exp $
**  

---

Function Documentation

int TASK_add_queue	(	test_Test_Descriptor *	td_p,
		ITC_Task *	task_p,
		ITC_QueueID	queue_id,
		ITC_cb_Dispatch *	dispatch_p
	)

Add a queue to a task.

Parameters:

	td_p	Pointer to test descriptor.
	task_p	Pointer to task control block.
	queue_id	ID of the queue to add.
	dispatch_p	Pointer to dispatch function for the queue.

Returns:

MSG code.

References POOL_alloc(), test_Pop_State(), test_Push_State(), and test_Status_Success().

Referenced by TASK_init(), and TLM_init().

int TASK_init	(	test_Test_Descriptor *	td_p,
		ITC_Task **	task_pp,
		ITC_TaskID	tid
	)

Create a task.

Parameters:

	td_p	Pointer to test descriptor.
	task_pp	Location to return pointer to task control block.
	tid	Task ID.

Return values:

	0	Success.
	-1	Failure.

References POOL_alloc(), TASK_add_queue(), test_NULL_Compare(), test_Pop_State(), test_Push_State(), and test_Status_Success().

Referenced by CMD_init(), and TLM_init().

int TASK_remove_queue	(	test_Test_Descriptor *	td_p,
		ITC_Task *	task_p,
		ITC_QueueID	queue_id
	)

Remove a queue from a task.

Parameters:

	td_p	Pointer to test descriptor.
	task_p	Pointer to task control block.
	queue_id	ID of the queue to remove.

Returns:

MSG code.

References test_Pop_State(), test_Push_State(), and test_Status_Success().

Referenced by TASK_shutdown(), and TLM_shutdown().

int TASK_shutdown	(	test_Test_Descriptor *	td_p,
		ITC_Task *	task_p
	)

Shutdown a task.

Parameters:

	td_p	Pointer to test descriptor.
	task_p	Pointer to task control block.

Return values:

	0	Success.
	-1	Failure.

References TASK_remove_queue(), test_Pop_State(), test_Push_State(), and test_Status_Success().

Referenced by CMD_shutdown(), and TLM_shutdown().

int TASK_start	(	test_Test_Descriptor *	td_p,
		ITC_Task *	task_p,
		char *	name,
		int	priority
	)

Start a task.

Parameters:

	td_p	Pointer to test descriptor.
	task_p	Pointer to task control block.
	name	Name string for the task.
	priority	Priority of the task.

Returns:

MSG code.

References test_Pop_State(), test_Push_State(), and test_Status_Success().

Referenced by CMD_start(), and TLM_start().

int TASK_stop	(	test_Test_Descriptor *	td_p,
		ITC_Task *	task_p
	)

Stop a task.

Parameters:

	td_p	Pointer to test descriptor.
	task_p	Pointer to task control block.

Returns:

MSG code.

References test_Delay(), test_Pop_State(), test_Push_State(), and test_Status_Success().

Referenced by CMD_stop(), and TLM_stop().