evolution-data-server-doc 3.22.7-1 / usr / share / gtk-doc / html / eds / EDBusServer.html

This file is indexed.

/usr/share/gtk-doc/html/eds/EDBusServer.html is in evolution-data-server-doc 3.22.7-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EDBusServer: Evolution-Data-Server Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Reference Manual">
<link rel="up" href="ch06.html" title="Abstract Classes for Backends">
<link rel="prev" href="EDataFactory.html" title="EDataFactory">
<link rel="next" href="EExtensible.html" title="EExtensible">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#EDBusServer.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#EDBusServer.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#EDBusServer.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch06.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="EDataFactory.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="EExtensible.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="EDBusServer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="EDBusServer.top_of_page"></a>EDBusServer</span></h2>
<p>EDBusServer — An abstract base class for a D-Bus server</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="EDBusServer.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="eds-e-backend-enums.html#EDBusServerExitCode" title="enum EDBusServerExitCode"><span class="returnvalue">EDBusServerExitCode</span></a>
</td>
<td class="function_name">
<a class="link" href="EDBusServer.html#e-dbus-server-run" title="e_dbus_server_run ()">e_dbus_server_run</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="EDBusServer.html#e-dbus-server-quit" title="e_dbus_server_quit ()">e_dbus_server_quit</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="EDBusServer.html#e-dbus-server-hold" title="e_dbus_server_hold ()">e_dbus_server_hold</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="EDBusServer.html#e-dbus-server-release" title="e_dbus_server_release ()">e_dbus_server_release</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="EDBusServer.html#e-dbus-server-load-modules" title="e_dbus_server_load_modules ()">e_dbus_server_load_modules</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="EDBusServer.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="EDBusServer.html#EDBusServer-struct" title="struct EDBusServer">EDBusServer</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="EDBusServer.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> EDBusServer
        <span class="lineart">├──</span> <a class="link" href="EDataFactory.html" title="EDataFactory">EDataFactory</a>
        <span class="lineart">╰──</span> <a class="link" href="EUserPrompterServer.html" title="EUserPrompterServer">EUserPrompterServer</a>
</pre>
</div>
<div class="refsect1">
<a name="EDBusServer.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
EDBusServer implements
</p>
</div>
<div class="refsect1">
<a name="EDBusServer.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libebackend/libebackend.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="EDBusServer.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="EDBusServer.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-dbus-server-run"></a><h3>e_dbus_server_run ()</h3>
<pre class="programlisting"><a class="link" href="eds-e-backend-enums.html#EDBusServerExitCode" title="enum EDBusServerExitCode"><span class="returnvalue">EDBusServerExitCode</span></a>
e_dbus_server_run (<em class="parameter"><code><a class="link" href="EDBusServer.html" title="EDBusServer"><span class="type">EDBusServer</span></a> *server</code></em>,
                   <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> wait_for_client</code></em>);</pre>
<p>Emits the <span class="type">“run”</span> signal.</p>
<p>By default the <em class="parameter"><code>server</code></em>
 will start its main loop and attempt to acquire
its well-known session bus name.  If the <em class="parameter"><code>server</code></em>
's main loop is already
running, the function will immediately return <a class="link" href="eds-e-backend-enums.html#E-DBUS-SERVER-EXIT-NONE:CAPS"><span class="type">E_DBUS_SERVER_EXIT_NONE</span></a>.
Otherwise the function blocks until <a class="link" href="EDBusServer.html#e-dbus-server-quit" title="e_dbus_server_quit ()"><code class="function">e_dbus_server_quit()</code></a> is called.</p>
<p>If <em class="parameter"><code>wait_for_client</code></em>
 is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the <em class="parameter"><code>server</code></em>
 will continue running until
the first client connection is made instead of quitting on its own if
no client connection is made within the first few seconds.</p>
<div class="refsect3">
<a name="e-dbus-server-run.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>server</p></td>
<td class="parameter_description"><p>an <a class="link" href="EDBusServer.html" title="EDBusServer"><span class="type">EDBusServer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>wait_for_client</p></td>
<td class="parameter_description"><p>continue running until a client connects</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-dbus-server-run.returns"></a><h4>Returns</h4>
<p> the exit code passed to <a class="link" href="EDBusServer.html#e-dbus-server-quit" title="e_dbus_server_quit ()"><code class="function">e_dbus_server_quit()</code></a></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.4.html" title="Index of new symbols in 3.4">3.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-dbus-server-quit"></a><h3>e_dbus_server_quit ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_dbus_server_quit (<em class="parameter"><code><a class="link" href="EDBusServer.html" title="EDBusServer"><span class="type">EDBusServer</span></a> *server</code></em>,
                    <em class="parameter"><code><a class="link" href="eds-e-backend-enums.html#EDBusServerExitCode" title="enum EDBusServerExitCode"><span class="type">EDBusServerExitCode</span></a> code</code></em>);</pre>
<p>Emits the <span class="type">“quit”</span> signal with the given <em class="parameter"><code>code</code></em>
.</p>
<p>By default the <em class="parameter"><code>server</code></em>
 will quit its main loop and cause
<a class="link" href="EDBusServer.html#e-dbus-server-run" title="e_dbus_server_run ()"><code class="function">e_dbus_server_run()</code></a> to return <em class="parameter"><code>code</code></em>
.</p>
<div class="refsect3">
<a name="e-dbus-server-quit.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>server</p></td>
<td class="parameter_description"><p>an <a class="link" href="EDBusServer.html" title="EDBusServer"><span class="type">EDBusServer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>code</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-e-backend-enums.html#EDBusServerExitCode" title="enum EDBusServerExitCode"><span class="type">EDBusServerExitCode</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.4.html" title="Index of new symbols in 3.4">3.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-dbus-server-hold"></a><h3>e_dbus_server_hold ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_dbus_server_hold (<em class="parameter"><code><a class="link" href="EDBusServer.html" title="EDBusServer"><span class="type">EDBusServer</span></a> *server</code></em>);</pre>
<p>Increases the use count of <em class="parameter"><code>server</code></em>
.</p>
<p>Use this function to indicate that the server has a reason to continue
to run.  To cancel the hold, call <a class="link" href="EDBusServer.html#e-dbus-server-release" title="e_dbus_server_release ()"><code class="function">e_dbus_server_release()</code></a>.</p>
<div class="refsect3">
<a name="e-dbus-server-hold.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>server</p></td>
<td class="parameter_description"><p>an <a class="link" href="EDBusServer.html" title="EDBusServer"><span class="type">EDBusServer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.4.html" title="Index of new symbols in 3.4">3.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-dbus-server-release"></a><h3>e_dbus_server_release ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_dbus_server_release (<em class="parameter"><code><a class="link" href="EDBusServer.html" title="EDBusServer"><span class="type">EDBusServer</span></a> *server</code></em>);</pre>
<p>Decreates the use count of <em class="parameter"><code>server</code></em>
.</p>
<p>When the use count reaches zero, the server will stop running.</p>
<p>Never call this function except to cancel the effect of a previous call
to <a class="link" href="EDBusServer.html#e-dbus-server-hold" title="e_dbus_server_hold ()"><code class="function">e_dbus_server_hold()</code></a>.</p>
<div class="refsect3">
<a name="e-dbus-server-release.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>server</p></td>
<td class="parameter_description"><p>an <a class="link" href="EDBusServer.html" title="EDBusServer"><span class="type">EDBusServer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.4.html" title="Index of new symbols in 3.4">3.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-dbus-server-load-modules"></a><h3>e_dbus_server_load_modules ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_dbus_server_load_modules (<em class="parameter"><code><a class="link" href="EDBusServer.html" title="EDBusServer"><span class="type">EDBusServer</span></a> *server</code></em>);</pre>
<p>This function should be called once during <em class="parameter"><code>server</code></em>
 initialization to
load all available library modules to extend the <em class="parameter"><code>server</code></em>
's functionality.</p>
<div class="refsect3">
<a name="e-dbus-server-load-modules.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>server</p></td>
<td class="parameter_description"><p>an <a class="link" href="EDBusServer.html" title="EDBusServer"><span class="type">EDBusServer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.4.html" title="Index of new symbols in 3.4">3.4</a></p>
</div>
</div>
<div class="refsect1">
<a name="EDBusServer.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="EDBusServer-struct"></a><h3>struct EDBusServer</h3>
<pre class="programlisting">struct EDBusServer;</pre>
<p>Contains only private data that should be read and manipulated using the
functions below.</p>
<p class="since">Since: <a class="link" href="api-index-3.4.html" title="Index of new symbols in 3.4">3.4</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.