← Back to branch summary

~ubuntu-branches/ubuntu/natty/evolution-data-server/natty

« back to all changes in this revision

Viewing changes to docs/reference/libedataserver/xml/e-flag.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-01 22:47:15 UTC
  • mfrom: (1.1.77 upstream)
  • Revision ID: james.westby@ubuntu.com-20100301224715-drsxc2y3t8anz3c0
Tags: 2.28.3-0ubuntu1
https://launchpad.net/bugs/455020
https://launchpad.net/bugs/475147
https://launchpad.net/bugs/305428
https://launchpad.net/bugs/341909
https://launchpad.net/bugs/444177
* New upstream version:
  Bug Fixes:
  - #602723 - Contact list name doesn't get displayed in 'To' dialog 
  - #600322 - assertion failed: (reply == msg) in cs_waitinfo()
              (lp: #455020, #475147)
  - #564727 - Few memory leaks (lp: #305428)
  - #574940 - Always ref returned info from message_info_from_uid 
              (lp: #341909)
  - #429317 - Use the relative URI returned if the server 
              re-directs a request
  - #602820 - Test validity of a book_view before using it in LDAP 
  - #590762 - Recurring google calendar items are not changeable
  - #604236 - Slow GPG processing 
  - #597816 - Do not crash on incorrect parameters used in sexp to SQL 
              (lp: #444177)
  - #604544 - Try Exchange fallback authentication only once 
  - #600778 - Fix --enable-e2k-debug configure option resolution 
  - #260407 - 'endswith' address book search doesn't work 
  - #549221 - (bnc) delete, sync flags immediately
* debian/patches/99_reconfigure.patch:
  - new version update

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libedataserver/xml/e-flag.xml
5
5
<refmeta>
6
6
<refentrytitle role="top_of_page" id="libedataserver-EFlag.top_of_page">EFlag</refentrytitle>
7
7
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>LIBEDATASERVER Library</refmiscinfo>
 
8
<refmiscinfo>
 
9
  LIBEDATASERVER Library
 
10
</refmiscinfo>
9
11
</refmeta>
10
 
 
11
12
<refnamediv>
12
13
<refname>EFlag</refname>
13
14
<refpurpose>Simple thread synchronization</refpurpose>
16
17
<refsynopsisdiv id="libedataserver-EFlag.synopsis" role="synopsis">
17
18
<title role="synopsis.title">Synopsis</title>
18
19
 
19
 
<synopsis>
20
 
                    <link linkend="EFlag">EFlag</link>;
21
 
<link linkend="EFlag">EFlag</link> *             <link linkend="e-flag-new">e_flag_new</link>                          (void);
22
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-flag-is-set">e_flag_is_set</link>                       (<link linkend="EFlag">EFlag</link> *flag);
23
 
<link linkend="void">void</link>                <link linkend="e-flag-set">e_flag_set</link>                          (<link linkend="EFlag">EFlag</link> *flag);
24
 
<link linkend="void">void</link>                <link linkend="e-flag-clear">e_flag_clear</link>                        (<link linkend="EFlag">EFlag</link> *flag);
25
 
<link linkend="void">void</link>                <link linkend="e-flag-wait">e_flag_wait</link>                         (<link linkend="EFlag">EFlag</link> *flag);
26
 
<link linkend="gboolean">gboolean</link>            <link linkend="e-flag-timed-wait">e_flag_timed_wait</link>                   (<link linkend="EFlag">EFlag</link> *flag,
27
 
                                                         <link linkend="GTimeVal">GTimeVal</link> *abs_time);
28
 
<link linkend="void">void</link>                <link linkend="e-flag-free">e_flag_free</link>                         (<link linkend="EFlag">EFlag</link> *flag);
 
20
<synopsis>                    <link linkend="EFlag">EFlag</link>;
 
21
<link linkend="EFlag"><returnvalue>EFlag</returnvalue></link> *             <link linkend="e-flag-new">e_flag_new</link>                          (<parameter><type>void</type></parameter>);
 
22
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-flag-is-set">e_flag_is_set</link>                       (<parameter><link linkend="EFlag"><type>EFlag</type></link> *flag</parameter>);
 
23
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-flag-set">e_flag_set</link>                          (<parameter><link linkend="EFlag"><type>EFlag</type></link> *flag</parameter>);
 
24
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-flag-clear">e_flag_clear</link>                        (<parameter><link linkend="EFlag"><type>EFlag</type></link> *flag</parameter>);
 
25
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-flag-wait">e_flag_wait</link>                         (<parameter><link linkend="EFlag"><type>EFlag</type></link> *flag</parameter>);
 
26
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-flag-timed-wait">e_flag_timed_wait</link>                   (<parameter><link linkend="EFlag"><type>EFlag</type></link> *flag</parameter>,
 
27
                                                         <parameter><link linkend="GTimeVal"><type>GTimeVal</type></link> *abs_time</parameter>);
 
28
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="e-flag-free">e_flag_free</link>                         (<parameter><link linkend="EFlag"><type>EFlag</type></link> *flag</parameter>);
29
29
</synopsis>
30
30
</refsynopsisdiv>
31
31
 
32
 
 
33
 
 
34
 
 
35
 
 
36
 
 
37
 
 
38
 
 
39
 
 
40
32
<refsect1 id="libedataserver-EFlag.description" role="desc">
41
33
<title role="desc.title">Description</title>
42
34
<para>
44
36
thread-safe flag that can be blocked on.
45
37
</para>
46
38
</refsect1>
47
 
 
48
39
<refsect1 id="libedataserver-EFlag.details" role="details">
49
40
<title role="details.title">Details</title>
50
41
<refsect2 id="EFlag" role="struct">
51
42
<title>EFlag</title>
52
 
<indexterm zone="EFlag"><primary sortas="EFlag">EFlag</primary></indexterm><programlisting>typedef struct _EFlag EFlag;</programlisting>
 
43
<indexterm zone="EFlag"><primary>EFlag</primary></indexterm>
 
44
<programlisting>typedef struct _EFlag EFlag;</programlisting>
53
45
<para>
54
46
The <structname>EFlag</structname> struct is an opaque data structure
55
47
representing a thread-safe flag.  It should be accessed only by using
57
49
</para></refsect2>
58
50
<refsect2 id="e-flag-new" role="function">
59
51
<title>e_flag_new ()</title>
60
 
<indexterm zone="e-flag-new"><primary sortas="e_flag_new">e_flag_new</primary></indexterm><programlisting><link linkend="EFlag">EFlag</link> *             e_flag_new                          (void);</programlisting>
 
52
<indexterm zone="e-flag-new"><primary>e_flag_new</primary></indexterm>
 
53
<programlisting><link linkend="EFlag"><returnvalue>EFlag</returnvalue></link> *             e_flag_new                          (<parameter><type>void</type></parameter>);</programlisting>
61
54
<para>
62
55
Creates a new <link linkend="EFlag"><type>EFlag</type></link> object.  It is initially unset.</para>
63
 
<para>
64
 
</para><variablelist role="params">
 
56
<variablelist role="params">
65
57
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="EFlag"><type>EFlag</type></link>
66
58
</simpara></listitem></varlistentry>
67
59
</variablelist></refsect2>
68
60
<refsect2 id="e-flag-is-set" role="function">
69
61
<title>e_flag_is_set ()</title>
70
 
<indexterm zone="e-flag-is-set"><primary sortas="e_flag_is_set">e_flag_is_set</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_flag_is_set                       (<link linkend="EFlag">EFlag</link> *flag);</programlisting>
 
62
<indexterm zone="e-flag-is-set"><primary>e_flag_is_set</primary></indexterm>
 
63
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_flag_is_set                       (<parameter><link linkend="EFlag"><type>EFlag</type></link> *flag</parameter>);</programlisting>
71
64
<para>
72
65
Returns the state of <parameter>flag</parameter>.</para>
73
 
<para>
74
 
</para><variablelist role="params">
 
66
<variablelist role="params">
75
67
<varlistentry><term><parameter>flag</parameter>&#160;:</term>
76
 
<listitem><simpara> an <link linkend="EFlag"><type>EFlag</type></link>
 
68
<listitem><simpara>an <link linkend="EFlag"><type>EFlag</type></link>
77
69
</simpara></listitem></varlistentry>
78
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>flag</parameter> is set
 
70
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>flag</parameter> is set
79
71
</simpara></listitem></varlistentry>
80
72
</variablelist></refsect2>
81
73
<refsect2 id="e-flag-set" role="function">
82
74
<title>e_flag_set ()</title>
83
 
<indexterm zone="e-flag-set"><primary sortas="e_flag_set">e_flag_set</primary></indexterm><programlisting><link linkend="void">void</link>                e_flag_set                          (<link linkend="EFlag">EFlag</link> *flag);</programlisting>
 
75
<indexterm zone="e-flag-set"><primary>e_flag_set</primary></indexterm>
 
76
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_flag_set                          (<parameter><link linkend="EFlag"><type>EFlag</type></link> *flag</parameter>);</programlisting>
84
77
<para>
85
78
Sets <parameter>flag</parameter>.  All threads waiting on <parameter>flag</parameter> are woken up.  Threads that
86
79
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
87
80
block at all.</para>
88
 
<para>
89
 
</para><variablelist role="params">
 
81
<variablelist role="params">
90
82
<varlistentry><term><parameter>flag</parameter>&#160;:</term>
91
 
<listitem><simpara> an <link linkend="EFlag"><type>EFlag</type></link>
 
83
<listitem><simpara>an <link linkend="EFlag"><type>EFlag</type></link>
92
84
</simpara></listitem></varlistentry>
93
85
</variablelist></refsect2>
94
86
<refsect2 id="e-flag-clear" role="function">
95
87
<title>e_flag_clear ()</title>
96
 
<indexterm zone="e-flag-clear"><primary sortas="e_flag_clear">e_flag_clear</primary></indexterm><programlisting><link linkend="void">void</link>                e_flag_clear                        (<link linkend="EFlag">EFlag</link> *flag);</programlisting>
 
88
<indexterm zone="e-flag-clear"><primary>e_flag_clear</primary></indexterm>
 
89
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_flag_clear                        (<parameter><link linkend="EFlag"><type>EFlag</type></link> *flag</parameter>);</programlisting>
97
90
<para>
98
91
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>
99
92
will block until <parameter>flag</parameter> is set.</para>
100
 
<para>
101
 
</para><variablelist role="params">
 
93
<variablelist role="params">
102
94
<varlistentry><term><parameter>flag</parameter>&#160;:</term>
103
 
<listitem><simpara> an <link linkend="EFlag"><type>EFlag</type></link>
 
95
<listitem><simpara>an <link linkend="EFlag"><type>EFlag</type></link>
104
96
</simpara></listitem></varlistentry>
105
97
</variablelist></refsect2>
106
98
<refsect2 id="e-flag-wait" role="function">
107
99
<title>e_flag_wait ()</title>
108
 
<indexterm zone="e-flag-wait"><primary sortas="e_flag_wait">e_flag_wait</primary></indexterm><programlisting><link linkend="void">void</link>                e_flag_wait                         (<link linkend="EFlag">EFlag</link> *flag);</programlisting>
 
100
<indexterm zone="e-flag-wait"><primary>e_flag_wait</primary></indexterm>
 
101
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_flag_wait                         (<parameter><link linkend="EFlag"><type>EFlag</type></link> *flag</parameter>);</programlisting>
109
102
<para>
110
103
Blocks until <parameter>flag</parameter> is set.  If <parameter>flag</parameter> is already set, the function returns
111
104
immediately.</para>
112
 
<para>
113
 
</para><variablelist role="params">
 
105
<variablelist role="params">
114
106
<varlistentry><term><parameter>flag</parameter>&#160;:</term>
115
 
<listitem><simpara> an <link linkend="EFlag"><type>EFlag</type></link>
 
107
<listitem><simpara>an <link linkend="EFlag"><type>EFlag</type></link>
116
108
</simpara></listitem></varlistentry>
117
109
</variablelist></refsect2>
118
110
<refsect2 id="e-flag-timed-wait" role="function">
119
111
<title>e_flag_timed_wait ()</title>
120
 
<indexterm zone="e-flag-timed-wait"><primary sortas="e_flag_timed_wait">e_flag_timed_wait</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_flag_timed_wait                   (<link linkend="EFlag">EFlag</link> *flag,
121
 
                                                         <link linkend="GTimeVal">GTimeVal</link> *abs_time);</programlisting>
 
112
<indexterm zone="e-flag-timed-wait"><primary>e_flag_timed_wait</primary></indexterm>
 
113
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_flag_timed_wait                   (<parameter><link linkend="EFlag"><type>EFlag</type></link> *flag</parameter>,
 
114
                                                         <parameter><link linkend="GTimeVal"><type>GTimeVal</type></link> *abs_time</parameter>);</programlisting>
122
115
<para>
123
116
Blocks until <parameter>flag</parameter> is set, or until the time specified by <parameter>abs_time</parameter>.
124
117
If <parameter>flag</parameter> is already set, the function returns immediately.  The return
125
118
value indicates the state of <parameter>flag</parameter> after waiting.
126
119
</para>
127
120
<para>
128
 
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>.
 
121
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>.
129
122
</para>
130
123
<para>
131
124
To easily calculate <parameter>abs_time</parameter>, a combination of <link linkend="g-get-current-time"><function>g_get_current_time()</function></link> and
132
125
<link linkend="g-time-val-add"><function>g_time_val_add()</function></link> can be used.</para>
133
 
<para>
134
 
</para><variablelist role="params">
 
126
<variablelist role="params">
135
127
<varlistentry><term><parameter>flag</parameter>&#160;:</term>
136
 
<listitem><simpara> an <link linkend="EFlag"><type>EFlag</type></link>
 
128
<listitem><simpara>an <link linkend="EFlag"><type>EFlag</type></link>
137
129
</simpara></listitem></varlistentry>
138
130
<varlistentry><term><parameter>abs_time</parameter>&#160;:</term>
139
 
<listitem><simpara> a <link linkend="GTimeVal"><type>GTimeVal</type></link>, determining the final time
 
131
<listitem><simpara>a <link linkend="GTimeVal"><type>GTimeVal</type></link>, determining the final time
140
132
</simpara></listitem></varlistentry>
141
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>flag</parameter> is now set
 
133
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>flag</parameter> is now set
142
134
</simpara></listitem></varlistentry>
143
135
</variablelist></refsect2>
144
136
<refsect2 id="e-flag-free" role="function">
145
137
<title>e_flag_free ()</title>
146
 
<indexterm zone="e-flag-free"><primary sortas="e_flag_free">e_flag_free</primary></indexterm><programlisting><link linkend="void">void</link>                e_flag_free                         (<link linkend="EFlag">EFlag</link> *flag);</programlisting>
 
138
<indexterm zone="e-flag-free"><primary>e_flag_free</primary></indexterm>
 
139
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link>                e_flag_free                         (<parameter><link linkend="EFlag"><type>EFlag</type></link> *flag</parameter>);</programlisting>
147
140
<para>
148
141
Destroys <parameter>flag</parameter>.</para>
149
 
<para>
150
 
</para><variablelist role="params">
 
142
<variablelist role="params">
151
143
<varlistentry><term><parameter>flag</parameter>&#160;:</term>
152
 
<listitem><simpara> an <link linkend="EFlag"><type>EFlag</type></link>
 
144
<listitem><simpara>an <link linkend="EFlag"><type>EFlag</type></link>
153
145
</simpara></listitem></varlistentry>
154
146
</variablelist></refsect2>
155
147
 
156
148
</refsect1>
157
149
 
158
 
 
159
 
 
160
 
 
161
150
</refentry>