Update source headers for 2008. Omit CVS ID keyword subst.
[yaz-moved-to-github.git] / include / yaz / mutex.h
1 /* This file is part of the YAZ toolkit.
2  * Copyright (C) 1995-2008 Index Data.
3  * All rights reserved.
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  *     * Redistributions of source code must retain the above copyright
8  *       notice, this list of conditions and the following disclaimer.
9  *     * Redistributions in binary form must reproduce the above copyright
10  *       notice, this list of conditions and the following disclaimer in the
11  *       documentation and/or other materials provided with the distribution.
12  *     * Neither the name of Index Data nor the names of its contributors
13  *       may be used to endorse or promote products derived from this
14  *       software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 /* $Id: mutex.h,v 1.1 2007-04-17 20:26:18 adam Exp $ */
28
29 /**
30  * \file mutex.h
31  * \brief Header for Mutex functions
32  */
33 #ifndef YAZ_MUTEX_H
34 #define YAZ_MUTEX_H
35
36 #include <stddef.h>
37 #include <yaz/yconfig.h>
38
39 YAZ_BEGIN_CDECL
40
41 /** \brief NMEM/YAZ MUTEX opaque pointer */
42 typedef struct yaz_mutex *YAZ_MUTEX;
43 /** \brief create Mutex */
44 YAZ_EXPORT void yaz_mutex_create(YAZ_MUTEX *);
45 /** \brief enter critical section / AKA lock */
46 YAZ_EXPORT void yaz_mutex_enter(YAZ_MUTEX);
47 /** \brief leave critical section / AKA unlock */
48 YAZ_EXPORT void yaz_mutex_leave(YAZ_MUTEX);
49 /** \brief destroy MUTEX */
50 YAZ_EXPORT void yaz_mutex_destroy(YAZ_MUTEX *);
51
52 YAZ_END_CDECL
53
54 #endif
55 /*
56  * Local variables:
57  * c-basic-offset: 4
58  * indent-tabs-mode: nil
59  * End:
60  * vim: shiftwidth=4 tabstop=8 expandtab
61  */
62