GLAST/LAT >
DAQ and FSW >
FSW >
Doxygen Index >
LIM / V1-19-1
Constituent: lim_unit_test     Tag: rad750
Interface Data Structures File List Data Fields Globals
LIM_pool.h File Reference
Interface to the functions found in LIM_pool.c. More...
#include "ITC/ITC_pubdefs.h"
#include "PBS/FPA.h"
Include dependency graph for LIM_pool.h:
This graph shows which files directly or indirectly include this file:
|
Typedefs |
typedef _LIM_Pool | LIM_Pool |
| Typedef for opaque _LIM_Pool structure.
|
Functions |
unsigned int | LIM_pool_init (LIM_Pool **pool_pp, unsigned int num_pkts, unsigned int pkt_bytes) |
| Initialize a memory pool.
|
unsigned int | LIM_pool_shutdown (LIM_Pool *pool_p) |
| Shutdown a memory pool by freeing its memory.
|
void * | LIM_pool_alloc (void *prm, unsigned int size, ITC_cb_Completion **free_cb, void **cb_parm_0, void **cb_parm_1, void **cb_parm_2) |
| Allocate a packet from a memory pool.
|
Detailed Description
Interface to the functions found in LIM_pool.c.
** CVS $Id: LIM_pool.h,v 1.3 2005/12/23 18:35:18 dmay Exp $
**
Function Documentation
void * LIM_pool_alloc |
( |
void * |
prm, |
|
|
unsigned int |
size, |
|
|
ITC_cb_Completion ** |
free_cb, |
|
|
void ** |
cb_parm_0, |
|
|
void ** |
cb_parm_1, |
|
|
void ** |
cb_parm_2 |
|
) |
|
|
|
Allocate a packet from a memory pool.
- Parameters:
-
| prm | Context parm (pointer to pool control info). |
| size | Size of allocation request, in bytes. |
| free_cb | Location to store pointer to 'free' callback function. |
| cb_parm_0 | Location to store callback parameter 0. |
| cb_parm_1 | Location to store callback parameter 1. |
| cb_parm_2 | Location to store callback parameter 2. |
- Returns:
- Pointer to allocated packet.
|
unsigned int LIM_pool_init |
( |
LIM_Pool ** |
pool_pp, |
|
|
unsigned int |
num_pkts, |
|
|
unsigned int |
pkt_bytes |
|
) |
|
|
|
Initialize a memory pool.
- Parameters:
-
| pool_pp | Location to return pool control info pointer. |
| num_pkts | Number of packets to include in the pool. |
| pkt_bytes | Size of each packet, in bytes. |
- Returns:
- MSG code.
|
unsigned int LIM_pool_shutdown |
( |
LIM_Pool * |
pool_p |
) |
|
|
|
Shutdown a memory pool by freeing its memory.
- Parameters:
-
| pool_p | Pointer to pool control information. |
- Returns:
- MSG code.
|
Generated on Mon Jan 14 12:12:19 2008 by
1.4.4