---

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

Constituent: pbs     Tag: linux-gcc

---

         

---

RW_tmr.ih File Reference

Defines platform independent inline Resource Wait timer (RW_tmr) routines. More...

#include "PBS/RW_pubdefs.h"
#include "PBS/RW.h"
#include "PBS/RW.ih"
#include "RW_tmr.h"

Include dependency graph for RW_tmr.ih:

This graph shows which files directly or indirectly include this file:

Defines
#define	_OK   ATTR_UNUSED_OK
	Abbrev for ATTR_UNUSED_OK, undef'd in this file.
Functions
RW__EXP_PROTO RW_state	RW__tmr_init (RW_tmr *tmr, RW_ctl *rw, const TOC *toc) _OK
	Initializes a Resource Wait timer based on the toc. If TOC is TOC_NOWAIT or TOV_FOREVER, no timer is initialized.
RW__EXP_PROTO RW_state	RW__tmr_lock (RW_tmr *tmr, RW_state state) _OK
	Locks the resource.
RW__EXP_PROTO RW_state	RW__tmr_wait (RW_tmr *tmr, RW_state state) _OK
	Waits until the timer expires or another task calls RW__tmr_wake indicating that another attempt be made to allocate the resource.
RW__EXP_PROTO RW_state	RW__tmr_unlock (RW_tmr *tmr, RW_state state) _OK
	Unlocks the resource.
RW__EXP_PROTO RW_state	RW__tmr_destroy (RW_tmr *tmr, RW_state state) _OK
	Destroys the tmr RW handle. This should be called before exiting the routine doing the allocation, since it will cleanup any outstanding timers among other things.

---

Detailed Description

Defines platform independent inline Resource Wait timer (RW_tmr) routines.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: RW_tmr.ih,v 1.4 2005/10/01 01:00:13 russell Exp $

---

Function Documentation

RW__EXP_PROTO RW_state RW__tmr_destroy (  RW_tmr *  tmr, RW_state  state )

Destroys the tmr RW handle. This should be called before exiting the routine doing the allocation, since it will cleanup any outstanding timers among other things. Parameters: tmr  The RW timer handle state  The current state Returns: The updated state. Warning: Failure to call this routine if a timer is still on the WUT que is fatal.

RW__EXP_FNC RW_state RW__tmr_init (  RW_tmr *  tmr, RW_ctl *  rw, const TOC *  toc )

Initializes a Resource Wait timer based on the toc. If TOC is TOC_NOWAIT or TOV_FOREVER, no timer is initialized. Parameters: tmr  The Resource Wait Timer to initialize rw  The underlying resource wait control structure. toc  The TimeOut control block. Two special values are recognized TOC_NOWAIT and TOC_FOREVER. Returns: A state variable which should be passed to RW_tmr_block.

RW__EXP_PROTO RW_state RW__tmr_lock (  RW_tmr *  tmr, RW_state  state )

Locks the resource. Parameters: tmr  The RW timer handle state  The current RW state Returns: The update RW state.

RW__EXP_PROTO RW_state RW__tmr_unlock (  RW_tmr *  tmr, RW_state  state )

Unlocks the resource. Parameters: tmr  The RW timer handle state  The current RW state Returns: The update RW state.

RW__EXP_PROTO RW_state RW__tmr_wait (  RW_tmr *  tmr, RW_state  state )

Waits until the timer expires or another task calls RW__tmr_wake indicating that another attempt be made to allocate the resource. Parameters: tmr  A previously initialized timer resource handle state  The current RW state Returns: The updated RW state.

---