1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-01-18 12:52:44 +01:00
RIOT/core/include/queue.h
2014-07-30 21:10:22 +02:00

86 lines
1.8 KiB
C

/*
* Copyright (C) 2013 Freie Universität Berlin
*
* This file subject to the terms and conditions of the GNU Lesser General
* Public License. See the file LICENSE in the top level directory for more
* details.
*/
/**
* @addtogroup core_util
* @{
*
* @file queue.h
* @brief A simple queue implementation
*
* @author Kaspar Schleiser <kaspar@schleiser.de>
*/
#ifndef __QUEUE_H
#define __QUEUE_H
#include <stddef.h>
#include <stdint.h>
/**
* data type for priority queue nodes
*/
typedef struct queue_node_t {
struct queue_node_t *next; /**< next queue node */
unsigned int data; /**< queue node data */
uint32_t priority; /**< queue node priority */
} queue_node_t;
/**
* data type for priority queues
*/
typedef struct queue {
queue_node_t *first; /**< first queue node */
} queue_t;
/**
* @brief Static initializer for queue_node_t.
*/
#define QUEUE_NODE_INIT { NULL, 0, 0 }
/**
* @brief Static initializer for queue_t.
*/
#define QUEUE_INIT { NULL }
/**
* @brief remove the queue's head
*
* @param[out] root the queue's root
*
* @return the old head
*/
queue_node_t *queue_remove_head(queue_t *root);
/**
* @brief insert `new_obj` into `root` based on its priority
*
* @details
* The new object will be appended after objects with the same priority.
*
* @param[in,out] root the queue's root
* @param[in] new_obj the object to prepend
*/
void queue_priority_add(queue_t *root, queue_node_t *new_obj);
/**
* @brief remove `node` from `root`
*
* @param[in,out] root the queue's root
* @param[in] node the node to remove
*/
void queue_remove(queue_t *root, queue_node_t *node);
#if ENABLE_DEBUG
void queue_print(queue_t *root);
void queue_print_node(queue_t *root);
#endif
/** @} */
#endif /* __QUEUE_H */