include/yaz/mutex.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2010 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
  28 /**
  29  * \file mutex.h
  30  * \brief Header for Mutex functions
  31  */
  32 #ifndef YAZ_MUTEX_H
  33 #define YAZ_MUTEX_H
  34
  35 #include <stddef.h>
  36 #include <yaz/yconfig.h>
  37
  38 YAZ_BEGIN_CDECL
  39
  40 /** \brief YAZ MUTEX opaque pointer */
  41 typedef struct yaz_mutex *YAZ_MUTEX;
  42
  43 /** \brief create MUTEX
  44     \param mutexp is pointer to MUTEX handle (*mutexp must be NULL)
  45
  46     It is important that *mutexp is NULL. If not, yaz_mutex_create will
  47     not modify the handle (assumes it is already created!)
  48  */
  49 YAZ_EXPORT void yaz_mutex_create(YAZ_MUTEX *mutexp);
  50
  51 /** \brief enter critical section / AKA lock
  52     \param mutex MUTEX handle
  53  */
  54 YAZ_EXPORT void yaz_mutex_enter(YAZ_MUTEX mutex);
  55
  56
  57 /** \brief leave critical section / AKA unlock
  58     \param mutex MUTEX handle
  59  */
  60 YAZ_EXPORT void yaz_mutex_leave(YAZ_MUTEX mutex);
  61
  62
  63 /** \brief destroy MUTEX
  64     \param mutexp pointer to MUTEX handle
  65
  66     If *mutexp is NULL, then this function does nothing.
  67  */
  68 YAZ_EXPORT void yaz_mutex_destroy(YAZ_MUTEX *mutexp);
  69
  70
  71 /** \brief sets name of MUTEX for debugging purposes
  72     \param mutex MUTEX handle
  73     \param log_level YAZ log level
  74     \param name user-given name associated with MUTEX
  75
  76     If log_level != 0 and name != 0 this function will make yaz_mutex_enter
  77     and yaz_mutex_leave print information for each invocation using yaz_log
  78     with the level given. In particular when YAZ is compiled with pthreads,
  79     yaz_mutex_enter will inform if a lock is not immediately acquired.
  80     This function should be called after a MUTEX is created but before
  81     it is used for locking.
  82  */
  83 void yaz_mutex_set_name(YAZ_MUTEX mutex, int log_level, const char *name);
  84
  85 YAZ_END_CDECL
  86
  87 #endif
  88 /*
  89  * Local variables:
  90  * c-basic-offset: 4
  91  * c-file-style: "Stroustrup"
  92  * indent-tabs-mode: nil
  93  * End:
  94  * vim: shiftwidth=4 tabstop=8 expandtab
  95  */
  96