libspopc/mutex.h

/* this is mutex.h file, part of the libspopc library sources
 * copyright © 2002- Benoit Rouits <brouits@free.fr>
 * released under the terms of the GNU Lesser General Public Licence.
 *
 * libspopc offers simple API for a pop3 client.
 * See RFC 1725 for pop3 specifications.
 * more information on http://herewe.servebeer.com/libspopc/
 *
 *  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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

#ifndef MUTEX_H
#define MUTEX_H

#include <semaphore.h>

typedef sem_t mutex;

/* initializes a thread-wide mutex */
int mutex_init(mutex* id);

/* acquire the given mutex to enter in a critical section */
int mutex_in (mutex* id);

/* quit the critical section, by releasing the given mutex */
int mutex_out (mutex* id);

/* clean the mutex, thus re-initable by mutex_init() */
int mutex_clean(mutex* id);

#endif
1	/* this is mutex.h file, part of the libspopc library sources
2	* copyright © 2002- Benoit Rouits <brouits@free.fr>
3	* released under the terms of the GNU Lesser General Public Licence.
4	*
5	* libspopc offers simple API for a pop3 client.
6	* See RFC 1725 for pop3 specifications.
7	* more information on http://herewe.servebeer.com/libspopc/
8	*
9	* This library is free software; you can redistribute it and/or
10	* modify it under the terms of the GNU Lesser General Public
11	* License as published by the Free Software Foundation; either
12	* version 2.1 of the License, or (at your option) any later version.
13	*
14	* This library is distributed in the hope that it will be useful,
15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17	* Lesser General Public License for more details.
18	*
19	* You should have received a copy of the GNU Lesser General Public
20	* License along with this library; if not, write to the Free Software
21	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22	*/
23
24	#ifndef MUTEX_H
25	#define MUTEX_H
26
27	#include <semaphore.h>
28
29	typedef sem_t mutex;
30
31	/* initializes a thread-wide mutex */
32	int mutex_init(mutex* id);
33
34	/* acquire the given mutex to enter in a critical section */
35	int mutex_in (mutex* id);
36
37	/* quit the critical section, by releasing the given mutex */
38	int mutex_out (mutex* id);
39
40	/* clean the mutex, thus re-initable by mutex_init() */
41	int mutex_clean(mutex* id);
42
43	#endif