YAZ  5.23.1
mutex.h
Go to the documentation of this file.
1 /* This file is part of the YAZ toolkit.
2  * Copyright (C) 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 
32 #ifndef YAZ_MUTEX_H
33 #define YAZ_MUTEX_H
34 
35 #include <stddef.h>
36 #include <time.h>
37 #include <yaz/yconfig.h>
38 
40 
42 typedef struct yaz_mutex *YAZ_MUTEX;
43 
45 typedef struct yaz_cond *YAZ_COND;
46 
53 YAZ_EXPORT void yaz_mutex_create(YAZ_MUTEX *mutexp);
54 
58 YAZ_EXPORT void yaz_mutex_enter(YAZ_MUTEX mutex);
59 
60 
64 YAZ_EXPORT void yaz_mutex_leave(YAZ_MUTEX mutex);
65 
66 
72 YAZ_EXPORT void yaz_mutex_destroy(YAZ_MUTEX *mutexp);
73 
74 
87 YAZ_EXPORT
88 void yaz_mutex_set_name(YAZ_MUTEX mutex, int log_level, const char *name);
89 
96 YAZ_EXPORT void yaz_cond_create(YAZ_COND *p);
97 
103 YAZ_EXPORT
104 void yaz_cond_destroy(YAZ_COND *p);
105 
106 struct timeval;
107 
115 YAZ_EXPORT
116 int yaz_cond_wait(YAZ_COND p, YAZ_MUTEX m, const struct timeval *abstime);
117 
121 YAZ_EXPORT
122 int yaz_cond_signal(YAZ_COND p);
123 
127 YAZ_EXPORT
128 int yaz_cond_broadcast(YAZ_COND p);
129 
131 
132 #endif
133 /*
134  * Local variables:
135  * c-basic-offset: 4
136  * c-file-style: "Stroustrup"
137  * indent-tabs-mode: nil
138  * End:
139  * vim: shiftwidth=4 tabstop=8 expandtab
140  */
141 
void yaz_cond_destroy(YAZ_COND *p)
destroys condition variable
Definition: condvar.c:62
int yaz_cond_broadcast(YAZ_COND p)
unblock all threads waiting for block
Definition: condvar.c:120
#define YAZ_END_CDECL
Definition: yconfig.h:57
void yaz_mutex_set_name(YAZ_MUTEX mutex, int log_level, const char *name)
sets name of MUTEX for debugging purposes
Definition: mutex.c:56
char * name
Definition: initopt.c:18
static int log_level
Definition: eventl.c:39
Header with fundamental macros.
void yaz_cond_create(YAZ_COND *p)
creates condition variable
Definition: condvar.c:49
void yaz_mutex_leave(YAZ_MUTEX mutex)
leave critical section / AKA unlock
Definition: mutex.c:120
struct yaz_mutex * YAZ_MUTEX
YAZ MUTEX opaque pointer.
Definition: mutex.h:42
void yaz_mutex_enter(YAZ_MUTEX mutex)
enter critical section / AKA lock
Definition: mutex.c:69
void yaz_mutex_create(YAZ_MUTEX *mutexp)
create MUTEX
Definition: mutex.c:41
void yaz_mutex_destroy(YAZ_MUTEX *mutexp)
destroy MUTEX
Definition: mutex.c:138
int yaz_cond_wait(YAZ_COND p, YAZ_MUTEX m, const struct timeval *abstime)
waits for condition
Definition: condvar.c:75
int yaz_cond_signal(YAZ_COND p)
unblock one thread waiting for block
Definition: condvar.c:108
struct yaz_cond * YAZ_COND
YAZ condition opaque pointer.
Definition: mutex.h:45
#define YAZ_BEGIN_CDECL
Definition: yconfig.h:56