| 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 | * Packet map and queue.
|
|---|
| 35 | */
|
|---|
| 36 |
|
|---|
| 37 | #ifndef LIBC_PACKET_H_
|
|---|
| 38 | #define LIBC_PACKET_H_
|
|---|
| 39 |
|
|---|
| 40 | /** Packet identifier type.
|
|---|
| 41 | * Value zero is used as an invalid identifier.
|
|---|
| 42 | */
|
|---|
| 43 | typedef int packet_id_t;
|
|---|
| 44 |
|
|---|
| 45 | /** Type definition of the packet.
|
|---|
| 46 | * @see packet
|
|---|
| 47 | */
|
|---|
| 48 | typedef struct packet * packet_t;
|
|---|
| 49 |
|
|---|
| 50 | /** Type definition of the packet pointer.
|
|---|
| 51 | * @see packet
|
|---|
| 52 | */
|
|---|
| 53 | typedef packet_t * packet_ref;
|
|---|
| 54 |
|
|---|
| 55 | /** Type definition of the packet dimension.
|
|---|
| 56 | * @see packet_dimension
|
|---|
| 57 | */
|
|---|
| 58 | typedef struct packet_dimension packet_dimension_t;
|
|---|
| 59 |
|
|---|
| 60 | /** Type definition of the packet dimension pointer.
|
|---|
| 61 | * @see packet_dimension
|
|---|
| 62 | */
|
|---|
| 63 | typedef packet_dimension_t * packet_dimension_ref;
|
|---|
| 64 |
|
|---|
| 65 | /** Packet dimension. */
|
|---|
| 66 | struct packet_dimension {
|
|---|
| 67 | /** Reserved packet prefix length. */
|
|---|
| 68 | size_t prefix;
|
|---|
| 69 | /** Maximal packet content length. */
|
|---|
| 70 | size_t content;
|
|---|
| 71 | /** Reserved packet suffix length. */
|
|---|
| 72 | size_t suffix;
|
|---|
| 73 | /** Maximal packet address length. */
|
|---|
| 74 | size_t addr_len;
|
|---|
| 75 | };
|
|---|
| 76 |
|
|---|
| 77 | /** @name Packet management system interface
|
|---|
| 78 | */
|
|---|
| 79 | /*@{*/
|
|---|
| 80 |
|
|---|
| 81 | extern packet_t pm_find(packet_id_t);
|
|---|
| 82 | extern int pm_add(packet_t);
|
|---|
| 83 | extern int pm_init(void);
|
|---|
| 84 | extern void pm_destroy(void);
|
|---|
| 85 |
|
|---|
| 86 | extern int pq_add(packet_t *, packet_t, size_t, size_t);
|
|---|
| 87 | extern packet_t pq_find(packet_t, size_t);
|
|---|
| 88 | extern int pq_insert_after(packet_t, packet_t);
|
|---|
| 89 | extern packet_t pq_detach(packet_t);
|
|---|
| 90 | extern int pq_set_order(packet_t, size_t, size_t);
|
|---|
| 91 | extern int pq_get_order(packet_t, size_t *, size_t *);
|
|---|
| 92 | extern void pq_destroy(packet_t, void (*)(packet_t));
|
|---|
| 93 | extern packet_t pq_next(packet_t);
|
|---|
| 94 | extern packet_t pq_previous(packet_t);
|
|---|
| 95 |
|
|---|
| 96 | /*@}*/
|
|---|
| 97 |
|
|---|
| 98 | #endif
|
|---|
| 99 |
|
|---|
| 100 | /** @}
|
|---|
| 101 | */
|
|---|
