osip_mt.h
3.81 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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
/*
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 _OSIP_MT_H_
#define _OSIP_MT_H_
#ifndef OSIP_MONOTHREAD
#include <stdio.h>
/**
* @file osip_mt.h
* @brief oSIP Thread, Mutex and Semaphore definitions
*
* Those methods are only available if the library is compile
* in multi threaded mode. This is the default for oSIP.
*/
/**
* @defgroup oSIP_THREAD oSIP Thread Routines
* @ingroup osip2_port
* @{
*/
#ifdef __cplusplus
extern "C" {
#endif
/**
* Structure for referencing a thread
* @struct osip_thread
*/
struct osip_thread;
/**
* Allocate (or initialise if a thread address is given)
* @param stacksize The stack size of the thread. (20000 is a good value)
* @param func The method where the thread start.
* @param arg A pointer on the argument given to the method 'func'.
*/
struct osip_thread *osip_thread_create(int stacksize, void *(*func)(void *), void *arg);
/**
* Join a thread.
* @param thread The thread to join.
*/
int osip_thread_join(struct osip_thread *thread);
/**
* Set the priority of a thread. (NOT IMPLEMENTED ON ALL SYSTEMS)
* @param thread The thread to work on.
* @param priority The priority value to set.
*/
int osip_thread_set_priority(struct osip_thread *thread, int priority);
/**
* Exit from a thread.
*/
void osip_thread_exit(void);
#ifdef __cplusplus
}
#endif
/** @}
* @defgroup oSIP_SEMA oSIP semaphore definitions
* @ingroup osip2_port
* @{
*/
#ifdef __cplusplus
extern "C" {
#endif
/**
* Structure for referencing a semaphore element.
* @struct osip_sem
*/
struct osip_sem;
/**
* Allocate and Initialise a semaphore.
* @param value The initial value for the semaphore.
*/
struct osip_sem *osip_sem_init(unsigned int value);
/**
* Destroy a semaphore.
* @param sem The semaphore to destroy.
*/
int osip_sem_destroy(struct osip_sem *sem);
/**
* Post operation on a semaphore.
* @param sem The semaphore to destroy.
*/
int osip_sem_post(struct osip_sem *sem);
/**
* Wait operation on a semaphore.
* NOTE: this call will block if the semaphore is at 0.
* @param sem The semaphore to destroy.
*/
int osip_sem_wait(struct osip_sem *sem);
/**
* Wait operation on a semaphore.
* NOTE: if the semaphore is at 0, this call won't block.
* @param sem The semaphore to destroy.
*/
int osip_sem_trywait(struct osip_sem *sem);
#ifdef __cplusplus
}
#endif
/** @}
* @defgroup oSIP_MUTEX oSIP mutex definitions
* @ingroup osip2_port
* @{
*/
#ifdef __cplusplus
extern "C" {
#endif
/**
* Structure for referencing a mutex element.
* @struct osip_mutex
*/
struct osip_mutex;
/**
* Allocate and Initialise a mutex.
*/
struct osip_mutex *osip_mutex_init(void);
/**
* Destroy the mutex.
* @param mut The mutex to destroy.
*/
void osip_mutex_destroy(struct osip_mutex *mut);
/**
* Lock the mutex.
* @param mut The mutex to lock.
*/
int osip_mutex_lock(struct osip_mutex *mut);
/**
* Unlock the mutex.
* @param mut The mutex to unlock.
*/
int osip_mutex_unlock(struct osip_mutex *mut);
#ifdef __cplusplus
}
#endif
/** @} */
#endif /* OSIP_MONOTHREAD */
#endif /* end of _THREAD_H_ */