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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libedataserver-EFlag">
<refmeta>
<refentrytitle role="top_of_page" id="libedataserver-EFlag.top_of_page">EFlag</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBEDATASERVER Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>EFlag</refname>
<refpurpose>Simple thread synchronization</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="libedataserver-EFlag.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="EFlag">EFlag</link>;
<link linkend="EFlag">EFlag</link>* <link linkend="e-flag-new">e_flag_new</link> (void);
<link linkend="gboolean">gboolean</link> <link linkend="e-flag-is-set">e_flag_is_set</link> (<link linkend="EFlag">EFlag</link> *flag);
<link linkend="void">void</link> <link linkend="e-flag-set">e_flag_set</link> (<link linkend="EFlag">EFlag</link> *flag);
<link linkend="void">void</link> <link linkend="e-flag-clear">e_flag_clear</link> (<link linkend="EFlag">EFlag</link> *flag);
<link linkend="void">void</link> <link linkend="e-flag-wait">e_flag_wait</link> (<link linkend="EFlag">EFlag</link> *flag);
<link linkend="gboolean">gboolean</link> <link linkend="e-flag-timed-wait">e_flag_timed_wait</link> (<link linkend="EFlag">EFlag</link> *flag,
<link linkend="GTimeVal">GTimeVal</link> *abs_time);
<link linkend="void">void</link> <link linkend="e-flag-free">e_flag_free</link> (<link linkend="EFlag">EFlag</link> *flag);
</synopsis>
</refsynopsisdiv>
<refsect1 id="libedataserver-EFlag.description" role="desc">
<title role="desc.title">Description</title>
<para>
An <link linkend="EFlag"><type>EFlag</type></link> is a simple thread synchronization mechanism. It implements a
thread-safe flag that can be blocked on.
</para>
</refsect1>
<refsect1 id="libedataserver-EFlag.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="EFlag" role="struct">
<title>EFlag</title>
<indexterm zone="EFlag"><primary>EFlag</primary></indexterm><programlisting>typedef struct _EFlag EFlag;</programlisting>
<para>
The <structname>EFlag</structname> struct is an opaque data structure
representing a thread-safe flag. It should be accessed only by using
the following functions.
</para></refsect2>
<refsect2 id="e-flag-new" role="function">
<title>e_flag_new ()</title>
<indexterm zone="e-flag-new"><primary>e_flag_new</primary></indexterm><programlisting><link linkend="EFlag">EFlag</link>* e_flag_new (void);</programlisting>
<para>
Creates a new <link linkend="EFlag"><type>EFlag</type></link> object. It is initially unset.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="EFlag"><type>EFlag</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-flag-is-set" role="function">
<title>e_flag_is_set ()</title>
<indexterm zone="e-flag-is-set"><primary>e_flag_is_set</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> e_flag_is_set (<link linkend="EFlag">EFlag</link> *flag);</programlisting>
<para>
Returns the state of <parameter>flag</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>flag</parameter> :</term>
<listitem><simpara> an <link linkend="EFlag"><type>EFlag</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>flag</parameter> is set
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-flag-set" role="function">
<title>e_flag_set ()</title>
<indexterm zone="e-flag-set"><primary>e_flag_set</primary></indexterm><programlisting><link linkend="void">void</link> e_flag_set (<link linkend="EFlag">EFlag</link> *flag);</programlisting>
<para>
Sets <parameter>flag</parameter>. All threads waiting on <parameter>flag</parameter> are woken up. Threads that
call <link linkend="e-flag-wait"><function>e_flag_wait()</function></link> or <link linkend="e-flag-timed-wait"><function>e_flag_timed_wait()</function></link> once <parameter>flag</parameter> is set will not
block at all.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>flag</parameter> :</term>
<listitem><simpara> an <link linkend="EFlag"><type>EFlag</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-flag-clear" role="function">
<title>e_flag_clear ()</title>
<indexterm zone="e-flag-clear"><primary>e_flag_clear</primary></indexterm><programlisting><link linkend="void">void</link> e_flag_clear (<link linkend="EFlag">EFlag</link> *flag);</programlisting>
<para>
Unsets <parameter>flag</parameter>. Subsequent calls to <link linkend="e-flag-wait"><function>e_flag_wait()</function></link> or <link linkend="e-flag-timed-wait"><function>e_flag_timed_wait()</function></link>
will block until <parameter>flag</parameter> is set.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>flag</parameter> :</term>
<listitem><simpara> an <link linkend="EFlag"><type>EFlag</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-flag-wait" role="function">
<title>e_flag_wait ()</title>
<indexterm zone="e-flag-wait"><primary>e_flag_wait</primary></indexterm><programlisting><link linkend="void">void</link> e_flag_wait (<link linkend="EFlag">EFlag</link> *flag);</programlisting>
<para>
Blocks until <parameter>flag</parameter> is set. If <parameter>flag</parameter> is already set, the function returns
immediately.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>flag</parameter> :</term>
<listitem><simpara> an <link linkend="EFlag"><type>EFlag</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-flag-timed-wait" role="function">
<title>e_flag_timed_wait ()</title>
<indexterm zone="e-flag-timed-wait"><primary>e_flag_timed_wait</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> e_flag_timed_wait (<link linkend="EFlag">EFlag</link> *flag,
<link linkend="GTimeVal">GTimeVal</link> *abs_time);</programlisting>
<para>
Blocks until <parameter>flag</parameter> is set, or until the time specified by <parameter>abs_time</parameter>.
If <parameter>flag</parameter> is already set, the function returns immediately. The return
value indicates the state of <parameter>flag</parameter> after waiting.
</para>
<para>
If <parameter>abs_time</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>, <link linkend="e-flag-timed-wait"><function>e_flag_timed_wait()</function></link> acts like <link linkend="e-flag-wait"><function>e_flag_wait()</function></link>.
</para>
<para>
To easily calculate <parameter>abs_time</parameter>, a combination of <link linkend="g-get-current-time"><function>g_get_current_time()</function></link> and
<link linkend="g-time-val-add"><function>g_time_val_add()</function></link> can be used.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>flag</parameter> :</term>
<listitem><simpara> an <link linkend="EFlag"><type>EFlag</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>abs_time</parameter> :</term>
<listitem><simpara> a <link linkend="GTimeVal"><type>GTimeVal</type></link>, determining the final time
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>flag</parameter> is now set
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-flag-free" role="function">
<title>e_flag_free ()</title>
<indexterm zone="e-flag-free"><primary>e_flag_free</primary></indexterm><programlisting><link linkend="void">void</link> e_flag_free (<link linkend="EFlag">EFlag</link> *flag);</programlisting>
<para>
Destroys <parameter>flag</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>flag</parameter> :</term>
<listitem><simpara> an <link linkend="EFlag"><type>EFlag</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
