Colony

/**

 * @file queue.h

 * @brief A queue implementation

 * 

 * Implements a queue, a first in, first out data structure.

 *

 * @author Brian Coltin, Colony Project

 **/

#ifndef WIRELESS_QUEUE_H

#define WIRELESS_QUEUE_H

struct node_def;

/**

 * @defgroup queue Queue

 * @brief A queue implementation

 * 

 * A queue implementation.

 *

 * @{

 **/

/**

 * @struct Queue

 * Represents a queue, a first in, first out data structure.

 **/

typedef struct

{

        /**

         * The head of the queue, the next item to be removed.

         **/

        struct node_def* head;

        /**

         * The tail of the queue, the last item added.

         **/

        struct node_def* tail;

        /**

         * The number of elements in the queue.

         **/

        int size;

} Queue;

/** @brief Create a new queue **/

Queue* queue_create(void);

/** @brief Destroy a queue **/

void queue_destroy(Queue* q);

/** @brief Add an element to a queue **/

void queue_add(Queue* q, void* item);

/** @brief Remove an element from a queue **/

void* queue_remove(Queue* q);

/** @brief Remove all instances of a given element from a queue **/

void queue_remove_all(Queue* q, void* item);

/** @brief Get the size of a queue **/

int queue_size(Queue* q);

/** @brief Check if the queue is empty **/

int queue_is_empty(Queue* q);

/** @} **/

#endif