libamxc  1.10.3
C Generic Data Containers
amxc_aqueue.h File Reference

Ambiorix array based queue API header file. More...

#include <amxc/amxc_common.h>
#include <amxc/amxc_array.h>

Go to the source code of this file.

Typedefs

typedef amxc_array_t amxc_aqueue_t
 The array queue structure. More...
 
typedef amxc_array_it_t amxc_aqueue_it_t
 The array queue iterator structure. More...
 
typedef amxc_array_it_delete_t amxc_aqueue_it_delete_t
 Definition of the item delete function. More...
 

Functions

AMXC_INLINE int amxc_aqueue_new (amxc_aqueue_t **aqueue)
 Allocates an array queue. More...
 
AMXC_INLINE void amxc_aqueue_delete (amxc_aqueue_t **aqueue, amxc_aqueue_it_delete_t func)
 Frees the previously allocated array queue. More...
 
AMXC_INLINE int amxc_aqueue_init (amxc_aqueue_t *const aqueue)
 Initializes an array queue. More...
 
AMXC_INLINE void amxc_aqueue_clean (amxc_aqueue_t *const aqueue, amxc_aqueue_it_delete_t func)
 Removes all items from the array queue. More...
 
AMXC_INLINE amxc_aqueue_it_tamxc_aqueue_add (amxc_aqueue_t *const aqueue, void *data)
 Adds data to the array queue. More...
 
AMXC_INLINE void * amxc_aqueue_remove (amxc_aqueue_t *const aqueue)
 Removes the first added data from the queue. More...
 
AMXC_INLINE size_t amxc_aqueue_size (const amxc_aqueue_t *const aqueue)
 Calculates the number of items in the queue. More...
 
AMXC_INLINE size_t amxc_aqueue_is_empty (const amxc_aqueue_t *const aqueue)
 Checks that the array queue is empty. More...
 

Detailed Description

Ambiorix array based queue API header file.

Definition in file amxc_aqueue.h.