Skip to main content
Header: ar_util/api/ar_util_list.h

Structures

ar_list_node_t

Members
ar_list_t *
Indicates the last known list for which this node belonged.
ar_list_node_t *
The next node.
ar_list_node_t *

ar_list_t

Members
ar_list_node_t
A special dummy node to implement the NULL object pattern.
uint32_t
Optional, the user supplied lock implementation function.
ar_list_lock_enter_fn_t
optional, the user supplied unlock implementation function.
ar_list_lock_leave_fn_t
Enable secure linked list flag.
bool_t

Functions

ar_list_init

ar_list_init: initialize a list to itself.
Parameters
ar_list_t *
pointer to ar_list_t.
lock_fn: lock function pointer.
unlock_fn: unlock function pointer.
Returns 0 Success Nonzero Failure

ar_list_init_node

ar_list_init_node
Parameters
ar_list_node_t *
pointer to ar_list_node_t.
Returns 0 Success Nonzero Failure

ar_list_add_tail

ar_list_add_tail
Parameters
ar_list_t *
pointer to ar_list_t.
ar_list_node_t *
node to be added to the list.
Returns 0 Success Nonzero Failure

ar_list_remove_head

ar_list_remove_head
Parameters
ar_list_t *
pointer to ar_list_t.
Returns 0 Success Nonzero Failure

ar_list_delete

ar_list_delete
Parameters
ar_list_t *
pointer to ar_list_t.
ar_list_node_t *
pointer to node to be deleted.
Returns 0 Success Nonzero Failure

ar_list_clear

ar_list_clear
Parameters
ar_list_t *
pointer to ar_list_t.
Returns 0 Success Nonzero Failure

ar_list_is_empty

ar_list_is_empty: check if the list is empty.
Parameters
ar_list_t *
pointer to ar_list_t.
Returns 1 if the list is empty 0 otherwise

ar_list_get_head

ar_list_get_head: return the head node from list.
Parameters
ar_list_t *
pointer to ar_list_t.
Returns address of head node

ar_list_get_tail

ar_list_get_tail: return the tail node from list.
Parameters
ar_list_t *
pointer to ar_list_t.
Returns address of tail node

Type Definitions

ar_list_node_t

ar_list_t

ar_list_lock_enter_fn_t

ar_list_lock_leave_fn_t

Macros

ar_list_for_each_entry

ar_list_for_each_entry: iterate over list