blob: 646d7adc9d51df3aa40a85d908fa3c079d3cf12d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
/**
* @file send_queue.h
*
* @brief Interface of send_queue_t.
*
*/
/*
* Copyright (C) 2005 Jan Hutter, Martin Willi
* Hochschule fuer Technik Rapperswil
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*/
#ifndef SEND_QUEUE_H_
#define SEND_QUEUE_H_
#include <types.h>
#include <network/packet.h>
typedef struct send_queue_t send_queue_t;
/**
* @brief Send-Queue
*
* Although the send-queue is based on a linked_list_t
* all access functions are thread-save implemented.
*
* @ingroup queues
*/
struct send_queue_t {
/**
* @brief returns number of packets in queue
*
* @param send_queue_t calling object
* @param[out] count integer pointer to store the count in
* @returns number of items in queue
*/
int (*get_count) (send_queue_t *send_queue);
/**
* @brief get the next packet from the queue.
*
* If the queue is empty, this function blocks until a packet can be returned.
*
* After using, the returned packet has to get destroyed by the caller.
*
* @param send_queue_t calling object
* @return next packet from the queue
*/
packet_t *(*get) (send_queue_t *send_queue);
/**
* @brief adds a packet to the queue.
*
* This function is non blocking and adds a packet_t to the list.
* The specific packet object has to get destroyed by the thread which
* removes the packet.
*
* @param send_queue_t calling object
* @param packet packet_t to add to the queue (packet is not copied)
*/
void (*add) (send_queue_t *send_queue, packet_t *packet);
/**
* @brief destroys a send_queue object.
*
* @warning The caller of this function has to make sure
* that no thread is going to add or get a packet from the send_queue
* after calling this function.
*
* @param send_queue_t calling object
*/
void (*destroy) (send_queue_t *send_queue);
};
/**
* @brief Creates an empty send_queue_t.
*
* @return send_queue_t empty send_queue_t
*
* @ingroup queues
*/
send_queue_t *send_queue_create();
#endif /*SEND_QUEUE_H_*/
|
