LIM_pool.h File Reference

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

#include <ITC/ITC_pubdefs.h>
#include <PBS/FPA.h>

Typedefs
typedef struct _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.4 2011/03/29 21:20:29 apw 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.

Referenced by lim_alloc_wrap(), sim_init_task(), sim_shutdown_task(), sim_start_timer(), TLM_init(), TLM_shutdown(), and WRAP_send_cmd().

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.

Referenced by CMD_init(), lim_init_wrap(), SIM_init_tasks(), and TLM_init().

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.

Referenced by CMD_shutdown(), lim_shutdown_wrap(), SIM_shutdown_tasks(), and TLM_shutdown().