source: mainline/uspace/lib/c/include/adt/dynamic_fifo.h@ 7093a32

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 7093a32 was 7093a32, checked in by Jakub Jermar <jakub@…>, 15 years ago

Cleanup of dynamic FIFO.

  • Property mode set to 100644
File size: 2.5 KB
Line 
1/*
2 * Copyright (c) 2009 Lukas Mejdrech
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** @addtogroup libc
30 * @{
31 */
32
33/** @file
34 * Dynamic first in first out positive integer queue.
35 * Possitive integer values only.
36 */
37
38#ifndef LIBC_DYNAMIC_FIFO_H_
39#define LIBC_DYNAMIC_FIFO_H_
40
41/** Type definition of the dynamic fifo queue.
42 * @see dyn_fifo
43 */
44typedef struct dyn_fifo dyn_fifo_t;
45
46/** Type definition of the dynamic fifo queue pointer.
47 * @see dyn_fifo
48 */
49typedef dyn_fifo_t *dyn_fifo_ref;
50
51/** Dynamic first in first out positive integer queue.
52 * Possitive integer values only.
53 * The queue automatically resizes if needed.
54 */
55struct dyn_fifo {
56 /** Stored item field. */
57 int *items;
58 /** Actual field size. */
59 int size;
60 /** First item in the queue index. */
61 int head;
62 /** Last item in the queue index. */
63 int tail;
64 /** Consistency check magic value. */
65 int magic_value;
66};
67
68extern int dyn_fifo_initialize(dyn_fifo_ref, int);
69extern int dyn_fifo_destroy(dyn_fifo_ref);
70extern int dyn_fifo_push(dyn_fifo_ref, int, int);
71extern int dyn_fifo_pop(dyn_fifo_ref);
72extern int dyn_fifo_value(dyn_fifo_ref);
73
74#endif
75
76/** @}
77 */
Note: See TracBrowser for help on using the repository browser.