mutex.h
1 /*************************************************************************/
2 /* mutex.h */
3 /*************************************************************************/
4 /* This file is part of: */
5 /* GODOT ENGINE */
6 /* http://www.godotengine.org */
7 /*************************************************************************/
8 /* Copyright (c) 2007-2016 Juan Linietsky, Ariel Manzur. */
9 /* */
10 /* Permission is hereby granted, free of charge, to any person obtaining */
11 /* a copy of this software and associated documentation files (the */
12 /* "Software"), to deal in the Software without restriction, including */
13 /* without limitation the rights to use, copy, modify, merge, publish, */
14 /* distribute, sublicense, and/or sell copies of the Software, and to */
15 /* permit persons to whom the Software is furnished to do so, subject to */
16 /* the following conditions: */
17 /* */
18 /* The above copyright notice and this permission notice shall be */
19 /* included in all copies or substantial portions of the Software. */
20 /* */
21 /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
22 /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
23 /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
24 /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
25 /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
26 /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
27 /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
28 /*************************************************************************/
29 #ifndef MUTEX_H
30 #define MUTEX_H
31 
32 #include "error_list.h"
33 
34 
45 class Mutex {
46 protected:
47  static Mutex* (*create_func)(bool);
48 
49 public:
50 
51  virtual void lock()=0;
52  virtual void unlock()=0;
53  virtual Error try_lock()=0;
54 
55  static Mutex * create(bool p_recursive=true);
56 
57  virtual ~Mutex();
58 };
59 
60 class MutexLock {
61 
62  Mutex *mutex;
63 public:
64 
65  MutexLock(Mutex* p_mutex) { mutex=p_mutex; if (mutex) mutex->lock(); }
66  ~MutexLock() { if (mutex) mutex->unlock(); }
67 
68 };
69 
70 #endif
Definition: mutex.h:45
virtual void unlock()=0
Unlock the mutex, let other threads continue.
virtual void lock()=0
Lock the mutex, block if locked by someone else.
Definition: mutex.h:60
virtual Error try_lock()=0
Attempt to lock the mutex, OK on success, ERROR means it can't lock.
static Mutex * create(bool p_recursive=true)
Create a mutex.
Definition: mutex.cpp:37