common/include/lac_list.h

11  * List structure and list functions.
36  *      Add a structure to tail of a list.
39  *      Adds pObj to the tail of  list (if it exists). Allocates and sets a
42  * @param[in] list                      Pointer to the head pointer of the list.
43  *                                      Can be NULL if no elements yet in list.
44  * @param[in/out] tail                  Pointer to tail pointer of the list.
45  *                                      Can be NULL if no elements yet in list.
48  *                                      of list if pObj has been successfully
51  *                                      the list.
55 CpaStatus SalList_add(sal_list_t **list, sal_list_t **tail, void *pObj);
60  *      Delete an element from the list.
63  *      Delete an element from the list.
65  * @param[in/out] head_list             Pointer to the head pointer of the list.
66  *                                      Can be NULL if no elements yet in list.
68  *                                      to point to list->next if head_list is
69 *list.
71 *list.
72  *                                      Can be NULL if no elements yet in list.
74  *                                      by the function to point to list->next
75  * @param[in] list                      Pointer to list.
79 SalList_del(sal_list_t **head_list, sal_list_t **pre_list, sal_list_t *list);
84  *      Returns pObj element in list structure.
89  * @param[in] list                      Pointer to list element.
90  * @retval void*                        pObj member of list structure.
93 void *SalList_getObject(sal_list_t *list);
98  *      Set pObj to be NULL in the list.
101  *      Set pObj of a element in the list to be NULL.
103  * @param[in] list                      Pointer to list element.
106 void SalList_delObject(sal_list_t **list);
111  *      Returns next element in list structure.
116  * @param[in] list                      Pointer to list element.
117  * @retval void*                        next member of list structure.
125  *      Frees memory associated with list structure.
128  *      Frees memory associated with list structure and the Obj pointed to by
129  *      the list.
131  * @param[in] list                      Pointer to list.