lib/silcutil/silcmutex.h

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