summaryrefslogtreecommitdiff
path: root/src/common/mutex.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/common/mutex.h')
-rw-r--r--src/common/mutex.h79
1 files changed, 40 insertions, 39 deletions
diff --git a/src/common/mutex.h b/src/common/mutex.h
index 1999627cd..d298c05af 100644
--- a/src/common/mutex.h
+++ b/src/common/mutex.h
@@ -1,92 +1,93 @@
// Copyright (c) rAthena Project (www.rathena.org) - Licensed under GNU GPL
-// For more information, see LICENCE in the main folder
+// For more information, see LICENCE in the main folder
-#ifndef _rA_MUTEX_H_
-#define _rA_MUTEX_H_
+#ifndef COMMON_MUTEX_H
+#define COMMON_MUTEX_H
+#include "../common/cbasetypes.h"
-typedef struct ramutex *ramutex; // Mutex
-typedef struct racond *racond; // Condition Var
+typedef struct ramutex ramutex; // Mutex
+typedef struct racond racond; // Condition Var
/**
- * Creates a Mutex
+ * Creates a Mutex
*
* @return not NULL
*/
-ramutex ramutex_create();
+ramutex *ramutex_create();
-/**
+/**
* Destroys a Mutex
- *
+ *
* @param m - the mutex to destroy
*/
-void ramutex_destroy( ramutex m );
+void ramutex_destroy(ramutex *m);
-/**
+/**
* Gets a lock
*
* @param m - the mutex to lock
*/
-void ramutex_lock( ramutex m);
+void ramutex_lock(ramutex *m);
-/**
+/**
* Trys to get the Lock
- *
+ *
* @param m - the mutex try to lock
- *
+ *
* @return boolean (true = got the lock)
*/
-bool ramutex_trylock( ramutex m );
+bool ramutex_trylock(ramutex *m);
-/**
+/**
* Unlocks a mutex
*
* @param m - the mutex to unlock
*/
-void ramutex_unlock( ramutex m);
+void ramutex_unlock(ramutex *m);
-/**
+/**
* Creates a Condition variable
*
* @return not NULL
*/
-racond racond_create();
+racond *racond_create();
-/**
+/**
* Destroy a Condition variable
*
- * @param c - the condition varaible to destroy
+ * @param c - the condition variable to destroy
*/
-void racond_destroy( racond c );
+void racond_destroy(racond *c);
/**
- * Waits Until state is signalled
- *
- * @param c - the condition var to wait for signalled state
- * @param m - the mutex used for syncronization
+ * Waits Until state is signaled
+ *
+ * @param c - the condition var to wait for signaled state
+ * @param m - the mutex used for synchronization
* @param timeout_ticks - timeout in ticks ( -1 = INFINITE )
*/
-void racond_wait( racond c, ramutex m, sysint timeout_ticks);
+void racond_wait(racond *c, ramutex *m, sysint timeout_ticks);
-/**
- * Sets the given condition var to signalled state
+/**
+ * Sets the given condition var to signaled state
*
- * @param c - condition var to set in signalled state.
+ * @param c - condition var to set in signaled state.
*
* @note:
* Only one waiter gets notified.
*/
-void racond_signal( racond c );
+void racond_signal(racond *c);
-/**
- * Sets notifys all waiting threads thats signalled.
- * @param c - condition var to set in signalled state
- *
+/**
+ * Sets notifies all waiting threads thats signaled.
+ * @param c - condition var to set in signaled state
+ *
* @note:
* All Waiters getting notified.
- */
-void racond_broadcast( racond c );
+ */
+void racond_broadcast(racond *c);
-#endif
+#endif /* COMMON_MUTEX_H */