Detailed Description

Creates a doubly linked list. It works as utils for other modules.

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

Data Structures
struct	List_Elem_tag
	Structure defining object for the list element. More...
struct	List_Object_tag
	Structure defining object for the list. More...
struct	List_Params_tag
	Structure defining params for the list. More...

Macros
#define	List_traverse(x, y)
	Traverse the full list till the last element.

Typedefs
typedef struct List_Elem_tag	List_Elem
	Structure defining object for the list element.
typedef struct List_Object_tag	List_Object
	Structure defining object for the list.
typedef List_Object *	List_Handle
	Defines List handle type.
typedef struct List_Params_tag	List_Params
	Structure defining params for the list.

Functions
Void	List_Params_init (List_Params *params)
	Initialize this config-params structure with supplier-specified defaults before instance creation.
List_Handle	List_create (List_Params params, Error_Block eb)
	Function to create a list object.
Void	List_delete (List_Handle *handlePtr)
	Function to delete a list object.
Void	List_construct (List_Object obj, List_Params params)
	Function to construct a list object. This function is used when memory for the list object is not to be allocated by the List API.
Void	List_destruct (List_Object *obj)
	Function to destruct a list object.
Void	List_elemClear (List_Elem *elem)
	Function to clear element contents.
Bool	List_empty (List_Handle handle)
	Function to check if list is empty.
Ptr	List_get (List_Handle handle)
	Function to get first element of List.
Void	List_put (List_Handle handle, List_Elem *elem)
	Function to insert element at the end of List.
Ptr	List_next (List_Handle handle, List_Elem *elem)
	Function to traverse to the next element in the list (non atomic)
Ptr	List_prev (List_Handle handle, List_Elem *elem)
	Function to traverse to the previous element in the list (non atomic)
Void	List_insert (List_Handle handle, List_Elem newElem, List_Elem curElem)
	Function to insert element before the existing element in the list.
Void	List_remove (List_Handle handle, List_Elem *elem)
	Function to removes element from the List.
Void	List_putHead (List_Handle handle, List_Elem *elem)
	Function to put the element before head.
Ptr	List_dequeue (List_Handle handle)
	Get element from front of List (non-atomic)
Void	List_enqueue (List_Handle handle, List_Elem *elem)
	Put element at end of List (non-atomic)
Void	List_enqueueHead (List_Handle handle, List_Elem *elem)
	Put element at head of List (non-atomic)

Macro Definition Documentation

#define List_traverse	(	x,
		y
	)

Value:

for(x = (List_Elem *)((List_Object *)y)->elem.next; \
                               (UInt32) x != (UInt32)&((List_Object *)y)->elem;\
                                x = x->next)

Traverse the full list till the last element.

Typedef Documentation

typedef struct List_Elem_tag List_Elem

Structure defining object for the list element.

typedef struct List_Object_tag List_Object

Structure defining object for the list.

typedef List_Object* List_Handle

Defines List handle type.

typedef struct List_Params_tag List_Params

Structure defining params for the list.

Function Documentation

Void List_Params_init ( List_Params * params )

Initialize this config-params structure with supplier-specified defaults before instance creation.

Parameters:

params Instance config-params structure.

See also:: List_create

List_Handle List_create	(	List_Params *	params,
		Error_Block *	eb
	)

Function to create a list object.

Parameters:

params	Pointer to list creation parameters. If NULL is passed, default parameters are used.
eb	Unused

Return values:

List-handle Handle to the list object

See also:: List_delete

Void List_delete ( List_Handle * handlePtr )

Function to delete a list object.

Parameters:

handlePtr Pointer to the list handle

See also:: List_delete

Void List_construct	(	List_Object *	obj,
		List_Params *	params
	)

Function to construct a list object. This function is used when memory for the list object is not to be allocated by the List API.

Parameters:

obj	Pointer to the list object to be constructed
params	Pointer to list construction parameters. If NULL is passed, default parameters are used.

See also:: List_destruct

Void List_destruct ( List_Object * obj )

Function to destruct a list object.

Parameters:

obj	Pointer to the list object to be destructed

See also:: List_construct

Void List_elemClear ( List_Elem * elem )

Function to clear element contents.

Parameters:

elem	Element to be cleared

See also:

Bool List_empty ( List_Handle handle )

Function to check if list is empty.

Parameters:

handle Pointer to the list

Return values:

TRUE	List is empty
FALSE	List is not empty

See also:

Ptr List_get ( List_Handle handle )

Function to get first element of List.

Parameters:

handle Pointer to the list

Return values:

NULL	Operation failed
Valid-pointer	Pointer to first element

See also:: List_put

Void List_put	(	List_Handle	handle,
		List_Elem *	elem
	)

Function to insert element at the end of List.

Parameters:

handle	Pointer to the list
elem	Element to be inserted

See also:: List_get

Ptr List_next	(	List_Handle	handle,
		List_Elem *	elem
	)

Function to traverse to the next element in the list (non atomic)

Parameters:

handle	Pointer to the list
elem	Pointer to the current element

Return values:

NULL	Operation failed
Valid-pointer	Pointer to next element

See also:: List_prev

Ptr List_prev	(	List_Handle	handle,
		List_Elem *	elem
	)

Function to traverse to the previous element in the list (non atomic)

Parameters:

handle	Pointer to the list
elem	Pointer to the current element

Return values:

NULL	Operation failed
Valid-pointer	Pointer to previous element

See also:: List_next

Void List_insert	(	List_Handle	handle,
		List_Elem *	newElem,
		List_Elem *	curElem
	)

Function to insert element before the existing element in the list.

Parameters:

handle	Pointer to the list
newElem	Element to be inserted
curElem	Existing element before which new one is to be inserted

See also:: List_remove

Void List_remove	(	List_Handle	handle,
		List_Elem *	elem
	)

Function to removes element from the List.

Parameters:

handle	Pointer to the list
elem	Element to be removed

See also:: List_insert

Void List_putHead	(	List_Handle	handle,
		List_Elem *	elem
	)

Function to put the element before head.

Parameters:

handle	Pointer to the list
elem	Element to be added at the head

See also:: List_put

Ptr List_dequeue ( List_Handle handle )

Get element from front of List (non-atomic)

Parameters:

handle Pointer to the list

Return values:

NULL	Operation failed
Valid-pointer	Pointer to removed element

See also:: List_enqueue, List_enqueueHead

Void List_enqueue	(	List_Handle	handle,
		List_Elem *	elem
	)

Put element at end of List (non-atomic)

Parameters:

handle	Pointer to the list
elem	Element to be put

See also:: List_dequeue

Void List_enqueueHead	(	List_Handle	handle,
		List_Elem *	elem
	)

Put element at head of List (non-atomic)

Parameters:

handle	Pointer to the list
elem	Element to be added

See also:: List_dequeue

Detailed Description

Data Structures

Macros

Typedefs

Functions

Macro Definition Documentation

Typedef Documentation

Function Documentation