RW_comdefs.h File Reference

Resource Wait, data structures and typedefs common to RW.h and RW.ih. More...

#include <PBS/RW_type.h>

Typedefs
typedef struct _RW_ctl	RW_ctl
	Typedef for the struct _RW_tmr.
typedef struct _RW_tmr	RW_tmr
	Typedef for the struct _RW_tmr.
typedef void *(*	RW_get_cb )(void *hndl, void *prm)
	Function signature for the get callback routine. Used by RW_getW() and RW_getW_toc().
typedef int(*	RW_free_cb )(void *ctx, void *resource, void *prm)
	Function signature for the free callback routine. Used by RW_free().
typedef int	RW_key
	The typedef for a RW key, returned by the RW_lock() routine and used by the RW_unlock() routine.
typedef int	RW_keys
	The typedef for RW keys, returned by the RW_lock2() routine and used by the RW_unlock2() routine.
typedef int	RW_state
	Typedef for the RW state, used the RW routines to key track of the current state, (timers running, not running, need to be started, locked, unlocked) etc.

---

Detailed Description

Resource Wait, data structures and typedefs common to RW.h and RW.ih.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: RW_comdefs.h,v 1.3 2011/03/24 23:05:44 apw Exp $

Warning:

The user should rarely have to directly include this file. It is included automatically by either RW_pubdefs.h or RW_protos.h.

---

Typedef Documentation

RW_ctl

Typedef for the struct _RW_tmr.

Typedef for the struct _RW_ctl.

This data structure provides supports both locking and blocking of a resource. On the VxWorks platforms, interrupt locking is used to lock the resource. This is fairly heavy handed, but the usual case is that very few instructions actually are executed during the locked period. This make the interrupt locking a good candidate because of its low overhead. The blocking is implemented with a standard semaphore.