godot.mutex source code

1 /**
2 A synchronization mutex (mutual exclusion).
3 
4 Copyright:
5 Copyright (c) 2007-2018 Juan Linietsky, Ariel Manzur.  
6 Copyright (c) 2014-2018 Godot Engine contributors (cf. AUTHORS.md)  
7 Copyright (c) 2017-2018 Godot-D contributors  
8 
9 License: $(LINK2 https://opensource.org/licenses/MIT, MIT License)
10 
11 
12 */
13 module godot.mutex;
14 import std.meta : AliasSeq, staticIndexOf;
15 import std.traits : Unqual;
16 import godot.d.traits;
17 import godot.core;
18 import godot.c;
19 import godot.d.bind;
20 import godot.d.reference;
21 import godot.globalenums;
22 import godot.object;
23 import godot.classdb;
24 import godot.reference;
25 /**
26 A synchronization mutex (mutual exclusion).
27 
28 This is used to synchronize multiple $(D Thread)s, and is equivalent to a binary $(D Semaphore). It guarantees that only one thread can ever acquire the lock at a time. A mutex can be used to protect a critical section; however, be careful to avoid deadlocks.
29 */
30 @GodotBaseClass struct Mutex
31 {
32 	package(godot) enum string _GODOT_internal_name = "_Mutex";
33 public:
34 @nogc nothrow:
35 	union { /** */ godot_object _godot_object; /** */ Reference _GODOT_base; }
36 	alias _GODOT_base this;
37 	alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);
38 	package(godot) __gshared bool _classBindingInitialized = false;
39 	package(godot) static struct GDNativeClassBinding
40 	{
41 		__gshared:
42 		@GodotName("lock") GodotMethod!(void) lock;
43 		@GodotName("try_lock") GodotMethod!(GodotError) tryLock;
44 		@GodotName("unlock") GodotMethod!(void) unlock;
45 	}
46 	/// 
47 	pragma(inline, true) bool opEquals(in Mutex other) const
48 	{ return _godot_object.ptr is other._godot_object.ptr; }
49 	/// 
50 	pragma(inline, true) typeof(null) opAssign(typeof(null) n)
51 	{ _godot_object.ptr = n; return null; }
52 	/// 
53 	pragma(inline, true) bool opEquals(typeof(null) n) const
54 	{ return _godot_object.ptr is n; }
55 	/// 
56 	size_t toHash() const @trusted { return cast(size_t)_godot_object.ptr; }
57 	mixin baseCasts;
58 	/// Construct a new instance of Mutex.
59 	/// Note: use `memnew!Mutex` instead.
60 	static Mutex _new()
61 	{
62 		static godot_class_constructor constructor;
63 		if(constructor is null) constructor = _godot_api.godot_get_class_constructor("_Mutex");
64 		if(constructor is null) return typeof(this).init;
65 		return cast(Mutex)(constructor());
66 	}
67 	@disable new(size_t s);
68 	/**
69 	Locks this $(D Mutex), blocks until it is unlocked by the current owner.
70 	*/
71 	void lock()
72 	{
73 		checkClassBinding!(typeof(this))();
74 		ptrcall!(void)(GDNativeClassBinding.lock, _godot_object);
75 	}
76 	/**
77 	Tries locking this $(D Mutex), but does not block. Returns $(D constant OK) on success, $(D constant ERR_BUSY) otherwise.
78 	*/
79 	GodotError tryLock()
80 	{
81 		checkClassBinding!(typeof(this))();
82 		return ptrcall!(GodotError)(GDNativeClassBinding.tryLock, _godot_object);
83 	}
84 	/**
85 	Unlocks this $(D Mutex), leaving it to other threads.
86 	*/
87 	void unlock()
88 	{
89 		checkClassBinding!(typeof(this))();
90 		ptrcall!(void)(GDNativeClassBinding.unlock, _godot_object);
91 	}
92 }