summaryrefslogtreecommitdiff
path: root/core/os/mutex.h
diff options
context:
space:
mode:
authorJuan Linietsky <reduzio@gmail.com>2014-02-09 22:10:30 -0300
committerJuan Linietsky <reduzio@gmail.com>2014-02-09 22:10:30 -0300
commit0b806ee0fc9097fa7bda7ac0109191c9c5e0a1ac (patch)
tree276c4d099e178eb67fbd14f61d77b05e3808e9e3 /core/os/mutex.h
parent0e49da1687bc8192ed210947da52c9e5c5f301bb (diff)
GODOT IS OPEN SOURCE
Diffstat (limited to 'core/os/mutex.h')
-rw-r--r--core/os/mutex.h70
1 files changed, 70 insertions, 0 deletions
diff --git a/core/os/mutex.h b/core/os/mutex.h
new file mode 100644
index 0000000000..512180d6c7
--- /dev/null
+++ b/core/os/mutex.h
@@ -0,0 +1,70 @@
+/*************************************************************************/
+/* mutex.h */
+/*************************************************************************/
+/* This file is part of: */
+/* GODOT ENGINE */
+/* http://www.godotengine.org */
+/*************************************************************************/
+/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
+/* */
+/* Permission is hereby granted, free of charge, to any person obtaining */
+/* a copy of this software and associated documentation files (the */
+/* "Software"), to deal in the Software without restriction, including */
+/* without limitation the rights to use, copy, modify, merge, publish, */
+/* distribute, sublicense, and/or sell copies of the Software, and to */
+/* permit persons to whom the Software is furnished to do so, subject to */
+/* the following conditions: */
+/* */
+/* The above copyright notice and this permission notice shall be */
+/* included in all copies or substantial portions of the Software. */
+/* */
+/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
+/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
+/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
+/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
+/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
+/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
+/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
+/*************************************************************************/
+#ifndef MUTEX_H
+#define MUTEX_H
+
+#include "error_list.h"
+
+
+/**
+ * @class Mutex
+ * @author Juan Linietsky
+ * Portable Mutex (thread-safe locking) implementation.
+ * Mutexes are always recursive ( they don't self-lock in a single thread ).
+ * Mutexes can be used with a Lockp object like this, to avoid having to worry about unlocking:
+ * Lockp( mutex );
+ */
+
+
+class Mutex {
+protected:
+ static Mutex* (*create_func)(bool);
+
+public:
+
+ virtual void lock()=0; ///< Lock the mutex, block if locked by someone else
+ virtual void unlock()=0; ///< Unlock the mutex, let other threads continue
+ virtual Error try_lock()=0; ///< Attempt to lock the mutex, true on success, false means it can't lock.
+
+ static Mutex * create(bool p_recursive=true); ///< Create a mutex
+
+ virtual ~Mutex();
+};
+
+class MutexLock {
+
+ Mutex *mutex;
+public:
+
+ MutexLock(Mutex* p_mutex) { mutex=p_mutex; if (mutex) mutex->lock(); }
+ ~MutexLock() { if (mutex) mutex->unlock(); }
+
+};
+
+#endif