5 Author: Pekka Riikonen <priikone@silcnet.org>
7 Copyright (C) 2001 - 2005 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; version 2 of the License.
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.
20 /****h* silcutil/SILC Mutex Interface
24 * Interface for the SILC Mutex locking implementation. This is platform
25 * independent mutual exclusion interface for applications that need
26 * concurrency control.
33 /****s* silcutil/SilcMutexAPI/SilcMutex
37 * typedef struct SilcMutexStruct *SilcMutex;
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.
46 typedef struct SilcMutexStruct *SilcMutex;
48 /****d* silcutil/SilcMutexAPI/SILC_MUTEX_DEFINE
52 * #define SILC_MUTEX_DEFINE(name) ...
56 * This macro is used to define new mutex. Use this macro in an
57 * environment that can be compiled with or without the SILC Mutex
58 * API. This is equivalent to defining SilcMutex `name'; directly.
62 #define SILC_MUTEX_DEFINE(name) SilcMutex name
65 /****f* silcutil/SilcMutexAPI/silc_mutex_alloc
69 * SilcBool silc_mutex_alloc(SilcMutex *mutex);
73 * Allocates SILC Mutex object. The mutex object must be allocated
74 * before it can be used. It is freed by the silc_mutex_free function.
75 * This returns TRUE and allocated mutex in to the `mutex' and FALSE
79 SilcBool silc_mutex_alloc(SilcMutex *mutex);
81 /****f* silcutil/SilcMutexAPI/silc_mutex_free
85 * void silc_mutex_free(SilcMutex mutex);
89 * Free SILC Mutex object and frees all allocated memory. If `mutex'
90 * is NULL this function has no effect.
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. If `mutex' is NULL this function
110 * The caller must not call silc_mutex_lock for mutex that has been
111 * already locked in the current thread. In this case deadlock will
115 void silc_mutex_lock(SilcMutex mutex);
117 /****f* silcutil/SilcMutexAPI/silc_mutex_unlock
121 * void silc_mutex_unlock(SilcMutex mutex);
125 * Unlocks the mutex and thus releases it for another thread that
126 * may be waiting for the lock. If `mutex' is NULL this function
131 * The caller must not call the silc_mutex_unlock for an unlocked
132 * mutex or mutex not locked by the current thread. It is fatal
133 * error if this occurs.
136 void silc_mutex_unlock(SilcMutex mutex);