godot.semaphore source code

1 /**
2 A synchronization Semaphore.
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.semaphore;
14 import std.meta : AliasSeq, staticIndexOf;
15 import std.traits : Unqual;
16 import godot.d.meta;
17 import godot.core;
18 import godot.c;
19 import godot.d.bind;
20 import godot.d.reference;
21 import godot.object;
22 import godot.classdb;
23 import godot.reference;
24 /**
25 A synchronization Semaphore.
26 
27 Element used to synchronize multiple $(D Thread)s. Initialized to zero on creation. Be careful to avoid deadlocks. For a binary version, see $(D Mutex).
28 */
29 @GodotBaseClass struct Semaphore
30 {
31 	enum string _GODOT_internal_name = "_Semaphore";
32 public:
33 @nogc nothrow:
34 	union { godot_object _godot_object; Reference _GODOT_base; }
35 	alias _GODOT_base this;
36 	alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);
37 	package(godot) __gshared bool _classBindingInitialized = false;
38 	package(godot) static struct _classBinding
39 	{
40 		__gshared:
41 		@GodotName("wait") GodotMethod!(GodotError) wait;
42 		@GodotName("post") GodotMethod!(GodotError) post;
43 	}
44 	bool opEquals(in Semaphore other) const { return _godot_object.ptr is other._godot_object.ptr; }
45 	Semaphore opAssign(T : typeof(null))(T n) { _godot_object.ptr = null; }
46 	bool opEquals(typeof(null) n) const { return _godot_object.ptr is null; }
47 	mixin baseCasts;
48 	static Semaphore _new()
49 	{
50 		static godot_class_constructor constructor;
51 		if(constructor is null) constructor = _godot_api.godot_get_class_constructor("_Semaphore");
52 		if(constructor is null) return typeof(this).init;
53 		return cast(Semaphore)(constructor());
54 	}
55 	@disable new(size_t s);
56 	/**
57 	Tries to wait for the `Semaphore`, if its value is zero, blocks until non-zero. Returns $(D OK) on success, $(D ERR_BUSY) otherwise.
58 	*/
59 	GodotError wait()
60 	{
61 		checkClassBinding!(typeof(this))();
62 		return ptrcall!(GodotError)(_classBinding.wait, _godot_object);
63 	}
64 	/**
65 	Lowers the `Semaphore`, allowing one more thread in. Returns $(D OK) on success, $(D ERR_BUSY) otherwise.
66 	*/
67 	GodotError post()
68 	{
69 		checkClassBinding!(typeof(this))();
70 		return ptrcall!(GodotError)(_classBinding.post, _godot_object);
71 	}
72 }