summaryrefslogtreecommitdiff
path: root/doc/classes/Semaphore.xml
blob: 0aeb6472af2e8d96c5781e5e8406c29fb82f51a9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Semaphore" inherits="Reference" category="Core" version="3.0.alpha.custom_build">
	<brief_description>
		A synchronization Semaphore.
	</brief_description>
	<description>
		A synchronization Semaphore. Element used in multi-threadding. Initialized to zero on creation.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="post">
			<return type="int" enum="Error">
			</return>
			<description>
				Lowers the [Semaphore], allowing one more thread in.
			</description>
		</method>
		<method name="wait">
			<return type="int" enum="Error">
			</return>
			<description>
				Tries to wait for the [Semaphore], if its value is zero, blocks until non-zero.
			</description>
		</method>
	</methods>
	<constants>
	</constants>
</class>