5 Author: Pekka Riikonen <priikone@silcnet.org>
7 Copyright (C) 2001 Pekka Riikonen
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.
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.
21 /****h* silcutil/SILC Mutex Interface
25 * Interface for the SILC Mutex locking implementation. This is platform
26 * independent mutual exclusion interface for applications that need
27 * concurrency control.
34 /****s* silcutil/SilcMutexAPI/SilcMutex
38 * typedef struct SilcMutexStruct *SilcMutex;
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.
47 typedef struct SilcMutexStruct *SilcMutex;
49 /****d* silcutil/SilcMutexAPI/SILC_MUTEX_DEFINE
53 * #define SILC_MUTEX_DEFINE(name) ...
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.
63 #define SILC_MUTEX_DEFINE(name) SilcMutex name
66 /****f* silcutil/SilcMutexAPI/silc_mutex_alloc
70 * bool silc_mutex_alloc(SilcMutex *mutex);
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
80 bool silc_mutex_alloc(SilcMutex *mutex);
82 /****f* silcutil/SilcMutexAPI/silc_mutex_free
86 * void silc_mutex_free(SilcMutex mutex);
90 * Free SILC Mutex object and frees all allocated memory.
93 void silc_mutex_free(SilcMutex mutex);
95 /****f* silcutil/SilcMutexAPI/silc_mutex_lock
99 * void silc_mutex_lock(SilcMutex mutex);
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.
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
114 void silc_mutex_lock(SilcMutex mutex);
116 /****f* silcutil/SilcMutexAPI/silc_mutex_unlock
120 * void silc_mutex_unlock(SilcMutex mutex);
124 * Unlocks the mutex and thus releases it for another thread that
125 * may be waiting for the lock.
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.
134 void silc_mutex_unlock(SilcMutex mutex);