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
|
<!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</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Backend Utilities (libebackend)">
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Backend Utilities (libebackend)">
<link rel="prev" href="EDataFactory.html" title="EDataFactory">
<link rel="next" href="EExtensible.html" title="EExtensible">
<meta name="generator" content="GTK-Doc V1.18 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="EDataFactory.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Evolution-Data-Server Manual: Backend Utilities (libebackend)</th>
<td><a accesskey="n" href="EExtensible.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#EDBusServer.synopsis" class="shortcut">Top</a>
|
<a href="#EDBusServer.description" class="shortcut">Description</a>
|
<a href="#EDBusServer.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#EDBusServer.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#EDBusServer.signals" class="shortcut">Signals</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 valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="EDBusServer.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libebackend/e-dbus-server>
struct <a class="link" href="EDBusServer.html#EDBusServer-struct" title="struct EDBusServer">EDBusServer</a>;
<span class="returnvalue">void</span> <a class="link" href="EDBusServer.html#e-dbus-server-run" title="e_dbus_server_run ()">e_dbus_server_run</a> (<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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> wait_for_client</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EDBusServer.html#e-dbus-server-quit" title="e_dbus_server_quit ()">e_dbus_server_quit</a> (<em class="parameter"><code><a class="link" href="EDBusServer.html" title="EDBusServer"><span class="type">EDBusServer</span></a> *server</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EDBusServer.html#e-dbus-server-hold" title="e_dbus_server_hold ()">e_dbus_server_hold</a> (<em class="parameter"><code><a class="link" href="EDBusServer.html" title="EDBusServer"><span class="type">EDBusServer</span></a> *server</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EDBusServer.html#e-dbus-server-release" title="e_dbus_server_release ()">e_dbus_server_release</a> (<em class="parameter"><code><a class="link" href="EDBusServer.html" title="EDBusServer"><span class="type">EDBusServer</span></a> *server</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EDBusServer.html#e-dbus-server-load-modules" title="e_dbus_server_load_modules ()">e_dbus_server_load_modules</a> (<em class="parameter"><code><a class="link" href="EDBusServer.html" title="EDBusServer"><span class="type">EDBusServer</span></a> *server</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="EDBusServer.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----EDBusServer
+----<a class="link" href="EDataFactory.html" title="EDataFactory">EDataFactory</a>
</pre>
</div>
<div class="refsect1">
<a name="EDBusServer.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
EDBusServer implements
<a class="link" href="EExtensible.html" title="EExtensible">EExtensible</a>.</p>
</div>
<div class="refsect1">
<a name="EDBusServer.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="EDBusServer.html#EDBusServer-bus-acquired" title='The "bus-acquired" signal'>bus-acquired</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
"<a class="link" href="EDBusServer.html#EDBusServer-bus-name-acquired" title='The "bus-name-acquired" signal'>bus-name-acquired</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
"<a class="link" href="EDBusServer.html#EDBusServer-bus-name-lost" title='The "bus-name-lost" signal'>bus-name-lost</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
</pre>
</div>
<div class="refsect1">
<a name="EDBusServer.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="EDBusServer.details"></a><h2>Details</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 3.4</p>
</div>
<hr>
<div class="refsect2">
<a name="e-dbus-server-run"></a><h3>e_dbus_server_run ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> 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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> wait_for_client</code></em>);</pre>
</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>);</pre>
</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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>server</code></em> :</span></p></td>
<td>an <a class="link" href="EDBusServer.html" title="EDBusServer"><span class="type">EDBusServer</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.4</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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>server</code></em> :</span></p></td>
<td>an <a class="link" href="EDBusServer.html" title="EDBusServer"><span class="type">EDBusServer</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.4</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>
</div>
</div>
<div class="refsect1">
<a name="EDBusServer.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="EDBusServer-bus-acquired"></a><h3>The <code class="literal">"bus-acquired"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="EDBusServer.html" title="EDBusServer"><span class="type">EDBusServer</span></a> *edbusserver,
<a href="http://library.gnome.org/devel/gio/unstable/GDBusConnection.html"><span class="type">GDBusConnection</span></a> *arg1,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
</div>
<hr>
<div class="refsect2">
<a name="EDBusServer-bus-name-acquired"></a><h3>The <code class="literal">"bus-name-acquired"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="EDBusServer.html" title="EDBusServer"><span class="type">EDBusServer</span></a> *edbusserver,
<a href="http://library.gnome.org/devel/gio/unstable/GDBusConnection.html"><span class="type">GDBusConnection</span></a> *arg1,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
</div>
<hr>
<div class="refsect2">
<a name="EDBusServer-bus-name-lost"></a><h3>The <code class="literal">"bus-name-lost"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="EDBusServer.html" title="EDBusServer"><span class="type">EDBusServer</span></a> *edbusserver,
<a href="http://library.gnome.org/devel/gio/unstable/GDBusConnection.html"><span class="type">GDBusConnection</span></a> *arg1,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|
