lib/silcutil/silcmutex.h

   1 /*
   2
   3   silcmutex.h
   4
   5   Author: Pekka Riikonen <priikone@silcnet.org>
   6
   7   Copyright (C) 2001 Pekka Riikonen
   8
   9   This program is free software; you can redistribute it and/or modify
  10   it under the terms of the GNU General Public License as published by
  11   the Free Software Foundation; either version 2 of the License, or
  12   (at your option) any later version.
  13
  14   This program is distributed in the hope that it will be useful,
  15   but WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17   GNU General Public License for more details.
  18
  19 */
  20
  21 /****h* silcutil/SILC Mutex Interface
  22  *
  23  * DESCRIPTION
  24  *
  25  * Interface for the SILC Mutex locking implementation. This is platform
  26  * independent mutual exclusion interface for applications that need
  27  * concurrency control.
  28  *
  29  ***/
  30
  31 #ifndef SILCMUTEX_H
  32 #define SILCMUTEX_H
  33
  34 /****s* silcutil/SilcMutexAPI/SilcMutex
  35  *
  36  * NAME
  37  *
  38  *    typedef struct SilcMutexStruct *SilcMutex;
  39  *
  40  * DESCRIPTION
  41  *
  42  *    This context is the actual SILC Mutex and is allocated
  43  *    by silc_mutex_alloc and given as argument to all silc_mutex_*
  44  *    functions.  It is freed by the silc_mutex_free function.
  45  *
  46  ***/
  47 typedef struct SilcMutexStruct *SilcMutex;
  48
  49 /****d* silcutil/SilcMutexAPI/SILC_MUTEX_DEFINE
  50  *
  51  * NAME
  52  *
  53  *    #define SILC_MUTEX_DEFINE(name) ...
  54  *
  55  * DESCRIPTION
  56  *
  57  *    This macro is used to define new mutex.  Use this macro in an
  58  *    environment that can be compiled with or without the SILC Mutex
  59  *    API. This is equivalent to defining SilcMutex `name'; directly.
  60  *
  61  * SOURCE
  62  */
  63 #define SILC_MUTEX_DEFINE(name) SilcMutex name
  64 /***/
  65
  66 /****f* silcutil/SilcMutexAPI/silc_mutex_alloc
  67  *
  68  * SYNOPSIS
  69  *
  70  *    bool silc_mutex_alloc(SilcMutex *mutex);
  71  *
  72  * DESCRIPTION
  73  *
  74  *    Allocates SILC Mutex object.  The mutex object must be allocated
  75  *    before it can be used.  It is freed by the silc_mutex_free function.
  76  *    This returns TRUE and allocated mutex in to the `mutex' and FALSE
  77  *    on error.
  78  *
  79  ***/
  80 bool silc_mutex_alloc(SilcMutex *mutex);
  81
  82 /****f* silcutil/SilcMutexAPI/silc_mutex_free
  83  *
  84  * SYNOPSIS
  85  *
  86  *    void silc_mutex_free(SilcMutex mutex);
  87  *
  88  * DESCRIPTION
  89  *
  90  *    Free SILC Mutex object and frees all allocated memory.
  91  *
  92  ***/
  93 void silc_mutex_free(SilcMutex mutex);
  94
  95 /****f* silcutil/SilcMutexAPI/silc_mutex_lock
  96  *
  97  * SYNOPSIS
  98  *
  99  *    void silc_mutex_lock(SilcMutex mutex);
 100  *
 101  * DESCRIPTION
 102  *
 103  *    Locks the mutex. If the mutex is locked by another thread the
 104  *    current thread will block until the other thread has issued
 105  *    silc_mutex_unlock for the mutex.
 106  *
 107  * NOTES
 108  *
 109  *    The caller must not call silc_mutex_lock for mutex that has been
 110  *    already locked in the current thread.  In this case deadlock will
 111  *    occur.
 112  *
 113  ***/
 114 void silc_mutex_lock(SilcMutex mutex);
 115
 116 /****f* silcutil/SilcMutexAPI/silc_mutex_unlock
 117  *
 118  * SYNOPSIS
 119  *
 120  *    void silc_mutex_unlock(SilcMutex mutex);
 121  *
 122  * DESCRIPTION
 123  *
 124  *    Unlocks the mutex and thus releases it for another thread that
 125  *    may be waiting for the lock.
 126  *
 127  * NOTES
 128  *
 129  *    The caller must not call the silc_mutex_unlock for an unlocked
 130  *    mutex or mutex not locked by the current thread.  It is fatal
 131  *    error if this occurs.
 132  *
 133  ***/
 134 void silc_mutex_unlock(SilcMutex mutex);
 135
 136 #endif