---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > MEM / V5-7-1

Constituent: mem_unit_test     Tag: sun-gcc

---

         

---

mem_util_pool.h File Reference

Interface to the functions found in mem_util_pool.c. More...

#include "ITC/ITC_pubdefs.h"
#include "mem_unit_test.h"

Include dependency graph for mem_util_pool.h:

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

Functions
void *	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 the memory pool.
int	POOL_init (test_Test_Descriptor *td_p, unsigned int num_pkts, unsigned int pkt_bytes)
	Create the memory pool for packets.
int	POOL_shutdown (test_Test_Descriptor *td_p)
	Shutdown the memory pool.

---

Detailed Description

Interface to the functions found in mem_util_pool.c.

**  CVS $Id: mem_util_pool.h,v 1.1 2005/10/25 21:53:19 dmay Exp $
**  

---

Function Documentation

void* 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 the memory pool. Parameters: prm  Context parm (pointer to test descriptor). 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.

int POOL_init (  test_Test_Descriptor *  td_p, unsigned int  num_pkts, unsigned int  pkt_bytes )

Create the memory pool for packets. Parameters: td_p  Pointer to test descriptor. num_pkts  Number of packets to include in the pool. pkt_bytes  Size of each packet in the pool, in bytes. Return values: 0  Success. -1  Failure.

int POOL_shutdown (  test_Test_Descriptor *  td_p  )

Shutdown the memory pool. Parameters: td_p  Pointer to test descriptor. Return values: 0  Success. -1  Failure.

---