osip_fifo.h
3.17 KB
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
/*
The oSIP library implements the Session Initiation Protocol (SIP -rfc3261-)
Copyright (C) 2001-2020 Aymeric MOIZARD amoizard@antisip.com
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef _FIFO_H_
#define _FIFO_H_
#ifndef OSIP_MONOTHREAD
#include <osip2/osip_mt.h>
#endif
#include <osipparser2/osip_list.h>
/**
* @file osip_fifo.h
* @brief oSIP fifo Routines
*
* This is a very simple implementation of a fifo.
* <BR>There is not much to say about it...
*/
/**
* @defgroup oSIP_FIFO oSIP fifo Handling
* @ingroup osip2_port
* @{
*/
#ifdef __cplusplus
extern "C" {
#endif
#ifndef DOXYGEN
typedef enum { osip_ok, osip_empty } osip_fifo_state;
#endif
/**
* Structure for referencing a fifo.
* @var osip_fifo_t
*/
typedef struct osip_fifo osip_fifo_t;
/**
* Structure for referencing a fifo.
* @struct osip_fifo
*/
struct osip_fifo {
#ifndef OSIP_MONOTHREAD
struct osip_mutex *qislocked; /**< mutex for fifo */
struct osip_sem *qisempty; /**< semaphore for fifo */
#endif
osip_list_t queue; /**< list of nodes containing elements */
int nb_elt; /**< nb of elements */
osip_fifo_state state; /**< state of the fifo */
};
/**
* Initialise a osip_fifo_t element.
* NOTE: this element MUST be previously allocated with
* osip_malloc(). The osip_free() call on the fifo is
* still automatically done by osip_fifo_free(). This
* also means you can't use a static osip_fifo_t variable
* if you want to use osip_fifo_free().
* @param ff The element to initialise.
*/
void osip_fifo_init(osip_fifo_t *ff);
/**
* Free a fifo element.
* @param ff The element to work on.
*/
void osip_fifo_free(osip_fifo_t *ff);
/**
* Insert an element in a fifo (at the beginning).
* @param ff The element to work on.
* @param element The pointer on the element to insert.
*/
int osip_fifo_insert(osip_fifo_t *ff, void *element);
/**
* Add an element in a fifo.
* @param ff The element to work on.
* @param element The pointer on the element to add.
*/
int osip_fifo_add(osip_fifo_t *ff, void *element);
/**
* Get the number of element in a fifo.
* @param ff The element to work on.
*/
int osip_fifo_size(osip_fifo_t *ff);
#ifndef OSIP_MONOTHREAD
/**
* Get an element from a fifo or block until one is added.
* @param ff The element to work on.
*/
void *osip_fifo_get(osip_fifo_t *ff);
#endif
/**
* Try to get an element from a fifo, but do not block if there is no element.
* @param ff The element to work on.
*/
void *osip_fifo_tryget(osip_fifo_t *ff);
/** @} */
#ifdef __cplusplus
}
#endif
#endif