threadutil: Doxygenation and compiler warnings.
This commit is contained in:
@@ -29,118 +29,99 @@
|
||||
*
|
||||
******************************************************************************/
|
||||
|
||||
|
||||
#ifndef FREE_LIST_H
|
||||
#define FREE_LIST_H
|
||||
|
||||
|
||||
/*!
|
||||
* \file
|
||||
*/
|
||||
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
|
||||
#include "ithread.h"
|
||||
|
||||
|
||||
#include <errno.h>
|
||||
|
||||
/****************************************************************************
|
||||
* Name: FreeListNode
|
||||
*
|
||||
* Description:
|
||||
* free list node. points to next free item.
|
||||
* memory for node is borrowed from allocated items.
|
||||
* Internal Use Only.
|
||||
*****************************************************************************/
|
||||
/*!
|
||||
* Free list node. points to next free item.
|
||||
* Memory for node is borrowed from allocated items.
|
||||
* \internal
|
||||
*/
|
||||
typedef struct FREELISTNODE
|
||||
{
|
||||
struct FREELISTNODE *next;
|
||||
} FreeListNode;
|
||||
|
||||
|
||||
/****************************************************************************
|
||||
* Name: FreeList
|
||||
*
|
||||
* Description:
|
||||
* Stores head and size of free list, as well as mutex for protection.
|
||||
* Internal Use Only.
|
||||
*****************************************************************************/
|
||||
/*!
|
||||
* Stores head and size of free list, as well as mutex for protection.
|
||||
* \internal
|
||||
*/
|
||||
typedef struct FREELIST
|
||||
{
|
||||
FreeListNode *head;
|
||||
size_t element_size;
|
||||
int maxFreeListLength;
|
||||
int freeListLength;
|
||||
|
||||
}FreeList;
|
||||
} FreeList;
|
||||
|
||||
/****************************************************************************
|
||||
* Function: FreeListInit
|
||||
/*!
|
||||
* \brief Initializes Free List.
|
||||
*
|
||||
* Description:
|
||||
* Initializes Free List. Must be called first.
|
||||
* And only once for FreeList.
|
||||
* Parameters:
|
||||
* free_list - must be valid, non null, pointer to a linked list.
|
||||
* size_t - size of elements to store in free list
|
||||
* maxFreeListSize - max size that the free list can grow to
|
||||
* before returning memory to O.S.
|
||||
* Returns:
|
||||
* 0 on success. Nonzero on failure.
|
||||
* Always returns 0.
|
||||
*****************************************************************************/
|
||||
int FreeListInit(FreeList *free_list,
|
||||
size_t elementSize,
|
||||
int maxFreeListSize);
|
||||
|
||||
/****************************************************************************
|
||||
* Function: FreeListAlloc
|
||||
* Must be called first and only once for FreeList.
|
||||
*
|
||||
* Description:
|
||||
* Allocates chunk of set size.
|
||||
* If a free item is available in the list, returnes the stored item.
|
||||
* Otherwise calls the O.S. to allocate memory.
|
||||
* Parameters:
|
||||
* free_list - must be valid, non null, pointer to a linked list.
|
||||
* Returns:
|
||||
* Non NULL on success. NULL on failure.
|
||||
*****************************************************************************/
|
||||
void * FreeListAlloc (FreeList *free_list);
|
||||
* \return:
|
||||
* \li \c 0 on success.
|
||||
* \li \c EINVAL on failure.
|
||||
*/
|
||||
int FreeListInit(
|
||||
/*! Must be valid, non null, pointer to a linked list. */
|
||||
FreeList *free_list,
|
||||
/*! Size of elements to store in free list. */
|
||||
size_t elementSize,
|
||||
/*! Max size that the free list can grow to before returning
|
||||
* memory to O.S. */
|
||||
int maxFreeListLength);
|
||||
|
||||
/****************************************************************************
|
||||
* Function: FreeListFree
|
||||
/*!
|
||||
* \brief Allocates chunk of set size.
|
||||
*
|
||||
* Description:
|
||||
* Returns an item to the Free List.
|
||||
* If the free list is smaller than the max size than
|
||||
* adds the item to the free list.
|
||||
* Otherwise returns the item to the O.S.
|
||||
* Parameters:
|
||||
* free_list - must be valid, non null, pointer to a linked list.
|
||||
* Returns:
|
||||
* 0 on success. Nonzero on failure.
|
||||
* Always returns 0.
|
||||
*****************************************************************************/
|
||||
int FreeListFree (FreeList *free_list,void * element);
|
||||
|
||||
/****************************************************************************
|
||||
* Function: FreeListDestroy
|
||||
* If a free item is available in the list, returnes the stored item,
|
||||
* otherwise calls the O.S. to allocate memory.
|
||||
*
|
||||
* Description:
|
||||
* Releases the resources stored with the free list.
|
||||
* Parameters:
|
||||
* free_list - must be valid, non null, pointer to a linked list.
|
||||
* Returns:
|
||||
* 0 on success. Nonzero on failure.
|
||||
* Always returns 0.
|
||||
*****************************************************************************/
|
||||
int FreeListDestroy (FreeList *free_list);
|
||||
* \return Non NULL on success. NULL on failure.
|
||||
*/
|
||||
void *FreeListAlloc(
|
||||
/*! Must be valid, non null, pointer to a linked list. */
|
||||
FreeList *free_list);
|
||||
|
||||
/*!
|
||||
* \brief Returns an item to the Free List.
|
||||
*
|
||||
* If the free list is smaller than the max size then adds the item to the
|
||||
* free list, otherwise returns the item to the O.S.
|
||||
*
|
||||
* \return:
|
||||
* \li \c 0 on success.
|
||||
* \li \c EINVAL on failure.
|
||||
*/
|
||||
int FreeListFree(
|
||||
/*! Must be valid, non null, pointer to a free list. */
|
||||
FreeList *free_list,
|
||||
/*! Must be a pointer allocated by FreeListAlloc. */
|
||||
void *element);
|
||||
|
||||
/*!
|
||||
* \brief Releases the resources stored with the free list.
|
||||
*
|
||||
* \return:
|
||||
* \li \c 0 on success.
|
||||
* \li \c EINVAL on failure.
|
||||
*/
|
||||
int FreeListDestroy(
|
||||
/*! Must be valid, non null, pointer to a linked list. */
|
||||
FreeList *free_list);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
|
Reference in New Issue
Block a user