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

Constituent: pbs     Tag: linux-gcc


Interface   Data Structures   File List   Data Fields   Globals  

RW.ih.px-xxx-xxx File Reference

Defines the POSIX platform dependent inline Resource Wait (RW) routines. More...

#include <pthread.h>
#include "PBS/BUG.h"

Include dependency graph for RW.ih.px-xxx-xxx:


Functions

RW__EXP_FNC RW_key RW__lock (RW_ctl *rw)
 Locks a resource so it can be manipulated in an interlocked fashion.
RW__EXP_FNC RW_keys RW__lock2 (RW_ctl *rw_0, RW_ctl *rw_1)
 Locks two resource so they can be manipulated in an interlocked fashion.
RW__EXP_FNC int RW__unlock (RW_ctl *rw, RW_key key)
 This routine unlocks a previously locked resource.
RW__EXP_FNC int RW__unlock2 (RW_ctl *rw_0, RW_ctl *rw_1, RW_keys keys)
 This routine unlocks a previously locked resource.
RW__EXP_FNC int RW__wait (RW_ctl *rw, RW_key key)
 Blocks a task/thread until there is a reasonable chance that a resource is available.
RW__EXP_FNC RW_key RW__wake (RW_ctl *rw, RW_key key)
 This provides the signaling mechanism to wake up a thread of code which is waiting for a resource.

Detailed Description

Defines the POSIX platform dependent inline Resource Wait (RW) routines.

Author:
JJRussell - russell@slac.stanford.edu
   CVS $Id: RW.ih.px-xxx-xxx,v 1.3 2004/10/20 14:36:52 russell Exp $
  

Function Documentation

RW_key RW__lock RW_ctl rw  ) 
 

Locks a resource so it can be manipulated in an interlocked fashion.

Returns:
A key to be passed to the RW__unlock routine.
Parameters:
rw The RW handle

RW_keys RW__lock2 RW_ctl rw_0,
RW_ctl rw_1
 

Locks two resource so they can be manipulated in an interlocked fashion.

Returns:
A set of keys to be passed to the RW__unlock2 routine
Parameters:
rw_0 The RW handle of the first resource to be locked
rw_1 The RW handle of the second resource to be locked

int RW__unlock RW_ctl rw,
RW_key  key
 

This routine unlocks a previously locked resource.

Parameters:
rw The RW handle
key The key used to lock the resource, returned from RW__lock

int RW__unlock2 RW_ctl rw_0,
RW_ctl rw_1,
RW_keys  keys
 

This routine unlocks a previously locked resource.

Parameters:
rw_0 The RW handle of the first resource to be unlocked
rw_1 The RW handle of the second resource to be unlocked
keys The keys used to lock the resources, returned from RW_lock2

int RW__wait RW_ctl rw,
RW_key  key
 

Blocks a task/thread until there is a reasonable chance that a resource is available.

Parameters:
rw The RW handle
key The key used to unlock the interrupts
Returns:
Status

int RW__wake RW_ctl rw,
RW_key  key
 

This provides the signaling mechanism to wake up a thread of code which is waiting for a resource.

Parameters:
rw The RW handle
key The key used to unlock the resource.
Return values:
Status This routine checks if any thread is waiting for a resource, and if so wakes that thread. The resource should be locked on entry to this routine. This routine always exits with the resource still locked.


Generated on Fri Feb 2 06:11:58 2007 by  doxygen 1.4.4