---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > IMM / V0-0-2

Constituent: imm     Tag: linux-gcc

---

         

---

RBM_prvdefs.h File Reference

Private definitions for the RBM package. More...

#include "PBS/MTX.h"
#include "PBS/RNG.h"
#include "PBS/RW.ih"
#include "IMM/RBM_pubdefs.h"

Include dependency graph for RBM_prvdefs.h:

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

Data Structures
struct	_RBM_Control
	Structure to hold the RBM control block. More...
struct	_RBM_Ring
	Structure to store a ring buffer controller. More...
Defines
#define	RBM_L_MEM_STATES   (4)
	Number of control states.
Typedefs
typedef enum _RBM_RingState	RBM_RingState
	Typedef for enum _RBM_RingState.
typedef _RBM_Control	RBM_Control
	Typedef for struct _RBM_Control.
Enumerations
enum	_RBM_RingState {   RBM_MEM_UNINITIALIZED = 0,   RBM_MEM_INITIALIZED = 1,   RBM_MEM_STARTED = 2,   RBM_MEM_STOPPING = 3 }
	Enumeration of states a ring buffer can be in. More...
Functions
void	RBM_stopCheck (RBM_Ring *rcb)
	Check if ring buffer is drained (if it is, complete stop processing).
Variables
RBM_Control *	RBM_rcb
	Control block for the memory pool management system.
const char *	RBM_mem_states [RBM_L_MEM_STATES]
	String constants for RBM ring buffer memory states.

---

Detailed Description

Private definitions for the RBM package.

CVS $Id: RBM_prvdefs.h,v 1.1.1.1 2005/03/18 02:22:08 apw Exp $

Author:

A.P.Waite

---

Enumeration Type Documentation

enum _RBM_RingState

Enumeration of states a ring buffer can be in. Enumeration values: RBM_MEM_UNINITIALIZED  Uninitialized RBM_MEM_INITIALIZED  Initialized (cannot allocate pkts) RBM_MEM_STARTED  Started (can allocate pkts) RBM_MEM_STOPPING  Stopping (won't allocate pkts)

---

Function Documentation

void RBM_stopCheck (  RBM_Ring *  rcb  )

Check if ring buffer is drained (if it is, complete stop processing). Parameters: rcb  (in) Ring buffer manager control block RBM_stopCheck() checks a ring to see if all the memory hass been freed, and if so, completes the process of stopping the ring.

---

Variable Documentation

RBM_Control* RBM_rcb (   )

Control block for the memory pool management system. Control block for the memory pool management system. This is global, so care must be taken when writing elements of this block that the code is properly protected.

---