GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > PBS / V2-10-5

Constituent: pbs     Tag: rad750


Interface   Data Structures   File List   Data Fields   Globals  

TBD.c.vx-xxx-xxx File Reference

Task Block of Data manager, callable implementation, VXWORKS platform. More...

#include <taskLib.h>
#include <taskVarLib.h>

Include dependency graph for TBD.c.vx-xxx-xxx:

Include dependency graph

Functions

int TBD_initialize (void)
 One time TBD system initialization call.

int TBD_add (TBD_ctl *tbd)
 Estblishes a pointer to the task specific TBD control structure.

int TBD_delete (void)
 Deletes the association a pointer to the task specific TBD control structure.

int TBD_destroy (void)
 Shutdown the TBD facility.


Detailed Description

Task Block of Data manager, callable implementation, VXWORKS platform.

Author:
JJRussell - russell@slac.stanford.edu

    CVS $Id: TBD.c.vx-xxx-xxx,v 1.3 2004/12/07 16:13:13 russell Exp $

Function Documentation

int TBD_add TBD_ctl *  tbd  ) 
 

Estblishes a pointer to the task specific TBD control structure.

Parameters:
tbd Pointer to the TBD control structure for this TASK.
Returns:
Status
This routine is generally called once at task initialization time to establish a pointer to the TBD control structure for the calling task. When using tasks created by the TASK facility in PBS, this call is made automatically.

int TBD_delete void   ) 
 

Deletes the association a pointer to the task specific TBD control structure.

Returns:
Status
This routine is generally called once at task exit time to dissolve the association of the pointer to the TBD control structure with the calling task. Note that freeing the memory of the managed area is the user's responsibility.

When using tasks created by the TASK facility in PBS, this call is made automatically at task exit. The memory of the managed area is also freed.

int TBD_destroy void   ) 
 

Shutdown the TBD facility.

Returns:
Status
This routine is generally called once at system exit time to remove the global pointer (key).

int TBD_initialize void   ) 
 

One time TBD system initialization call.

Returns:
Status
This is not part of the runtime interface, but the documentation is provided for completeness. While the implementation of this routine is platform dependent, generally speaking, this routine establishes the address of the TBD maintained data structure as a task specific piece of data. The underlying OS then ensures that a pointer to the calling task's TBD data structure is made available.


Generated on Tue Sep 13 21:46:53 2005 by doxygen 1.3.3