1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2010 Index Data.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
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.
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.
30 * \brief Header for Mutex functions
37 #include <yaz/yconfig.h>
41 /** \brief YAZ MUTEX opaque pointer */
42 typedef struct yaz_mutex *YAZ_MUTEX;
44 /** \brief YAZ condition opaque pointer */
45 typedef struct yaz_cond *YAZ_COND;
47 /** \brief create MUTEX
48 \param mutexp is pointer to MUTEX handle (*mutexp must be NULL)
50 It is important that *mutexp is NULL. If not, yaz_mutex_create will
51 not modify the handle (assumes it is already created!)
53 YAZ_EXPORT void yaz_mutex_create(YAZ_MUTEX *mutexp);
55 /** \brief enter critical section / AKA lock
56 \param mutex MUTEX handle
58 YAZ_EXPORT void yaz_mutex_enter(YAZ_MUTEX mutex);
61 /** \brief leave critical section / AKA unlock
62 \param mutex MUTEX handle
64 YAZ_EXPORT void yaz_mutex_leave(YAZ_MUTEX mutex);
67 /** \brief destroy MUTEX
68 \param mutexp pointer to MUTEX handle
70 If *mutexp is NULL, then this function does nothing.
72 YAZ_EXPORT void yaz_mutex_destroy(YAZ_MUTEX *mutexp);
75 /** \brief sets name of MUTEX for debugging purposes
76 \param mutex MUTEX handle
77 \param log_level YAZ log level
78 \param name user-given name associated with MUTEX
80 If log_level != 0 and name != 0 this function will make yaz_mutex_enter
81 and yaz_mutex_leave print information for each invocation using yaz_log
82 with the level given. In particular when YAZ is compiled with pthreads,
83 yaz_mutex_enter will inform if a lock is not immediately acquired.
84 This function should be called after a MUTEX is created but before
85 it is used for locking.
88 void yaz_mutex_set_name(YAZ_MUTEX mutex, int log_level, const char *name);
90 /** \brief creates condition variable
91 \param p reference to condition handle
93 Upon successful completion *p holds the condition handle; *p = 0
96 YAZ_EXPORT void yaz_cond_create(YAZ_COND *p);
98 /** \brief destroys condition variable
99 \param p reference to condition handle
101 Upon completion *p holds 0.
104 void yaz_cond_destroy(YAZ_COND *p);
106 YAZ_EXPORT struct timeval;
108 /** \brief waits for condition
109 \param p condition variable handle
111 \param abstime wait until this time; 0 for indefinite wait
113 Semantics like pthread_cond_wait.
116 int yaz_cond_wait(YAZ_COND p, YAZ_MUTEX m, const struct timeval *abstime);
118 /** \brief unblock one thread waiting for block
119 \param p condition variable handle
122 int yaz_cond_signal(YAZ_COND p);
124 /** \brief unblock all threads waiting for block
125 \param p condition variable handle
128 int yaz_cond_broadcast(YAZ_COND p);
136 * c-file-style: "Stroustrup"
137 * indent-tabs-mode: nil
139 * vim: shiftwidth=4 tabstop=8 expandtab