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 NMEM/YAZ MUTEX opaque pointer */
  41 typedef struct yaz_mutex *YAZ_MUTEX;
  42 /** \brief create Mutex */
  43 YAZ_EXPORT void yaz_mutex_create(YAZ_MUTEX *);
  44 /** \brief enter critical section / AKA lock */
  45 YAZ_EXPORT void yaz_mutex_enter(YAZ_MUTEX);
  46 /** \brief leave critical section / AKA unlock */
  47 YAZ_EXPORT void yaz_mutex_leave(YAZ_MUTEX);
  48 /** \brief destroy MUTEX */
  49 YAZ_EXPORT void yaz_mutex_destroy(YAZ_MUTEX *);
  50 /** \brief sets name of MUTEX for debugging purposes */
  51 void yaz_mutex_set_name(YAZ_MUTEX p, int log_level, const char *name);
  52
  53 YAZ_END_CDECL
  54
  55 #endif
  56 /*
  57  * Local variables:
  58  * c-basic-offset: 4
  59  * c-file-style: "Stroustrup"
  60  * indent-tabs-mode: nil
  61  * End:
  62  * vim: shiftwidth=4 tabstop=8 expandtab
  63  */
  64