compo_pool.h

COMPO source code for reference

/*******************************************************************************

File name   : compo_pool.h

Description : pool manager interface

COPYRIGHT (C) STMicroelectronics 2000.

Date               Modification                               Name
----               ------------                               ----
05 April 2004        Creation                                   TM

*******************************************************************************/

/* Define to prevent recursive inclusion */

#ifndef __COMPO_POOL_H
#define __COMPO_POOL_H


/* Includes ----------------------------------------------------------------- */
#include "stddefs.h"

/* C++ support */
#ifdef __cplusplus
extern "C" {
#endif

/* Exported Types ----------------------------------------------------------- */
typedef struct
{
  U32                   NbFreeElem;           /* Number of Free elements in Data Pool */
  U32                   NbElem;               /* Number of elements */
  U32                   ElemSize;             /* Size of an element in Byte */
  void*                 ElemArray_p;          /* Array of elements */
  void**                HandleArray_p;        /* Array of handle (i.e array of pointers to elements)*/
} stcompo_DataPoolDesc_t;


/* Exported Functions ------------------------------------------------------- */

void stcompo_InitDataPool(
  stcompo_DataPoolDesc_t*    DataPool_p,
  U32                       NbElem,
  U32                       ElemSize,
  void*                     ElemArray_p,
  void**                    HandleArray_p
);

ST_ErrorCode_t stcompo_GetElement(
  stcompo_DataPoolDesc_t* DataPool_p,
  void**                 Handle_p
);

ST_ErrorCode_t stcompo_ReleaseElement(
  stcompo_DataPoolDesc_t*  DataPool_p,
  void*                   Handle_p
);


/* C++ support */
#ifdef __cplusplus
}
#endif

#endif /* #ifndef __COMPO_POOL_H */

/* End of blt_pool.h */