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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EBackend</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="ch01.html" title="Evolution-Data-Server Manual: Backend Utilities (libebackend)">
<link rel="next" href="EBackendFactory.html" title="EBackendFactory">
<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="ch01.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="EBackendFactory.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#EBackend.synopsis" class="shortcut">Top</a>
|
<a href="#EBackend.description" class="shortcut">Description</a>
|
<a href="#EBackend.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#EBackend.properties" class="shortcut">Properties</a>
|
<a href="#EBackend.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="EBackend"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="EBackend.top_of_page"></a>EBackend</span></h2>
<p>EBackend — an abstract base class for backends</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="EBackend.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libebackend/e-backend.h>
struct <a class="link" href="EBackend.html#EBackend-struct" title="struct EBackend">EBackend</a>;
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="EBackend.html#e-backend-get-online" title="e_backend_get_online ()">e_backend_get_online</a> (<em class="parameter"><code><a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> *backend</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EBackend.html#e-backend-set-online" title="e_backend_set_online ()">e_backend_set_online</a> (<em class="parameter"><code><a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> *backend</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> online</code></em>);
<a href="../libedataserver/ESource.html"><span class="returnvalue">ESource</span></a> * <a class="link" href="EBackend.html#e-backend-get-source" title="e_backend_get_source ()">e_backend_get_source</a> (<em class="parameter"><code><a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> *backend</code></em>);
<span class="returnvalue">void</span> <a class="link" href="EBackend.html#e-backend-last-client-gone" title="e_backend_last_client_gone ()">e_backend_last_client_gone</a> (<em class="parameter"><code><a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> *backend</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="EBackend.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>
+----EBackend
</pre>
</div>
<div class="refsect1">
<a name="EBackend.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="EBackend.html#EBackend--online" title='The "online" property'>online</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct
"<a class="link" href="EBackend.html#EBackend--source" title='The "source" property'>source</a>" <a href="../libedataserver/ESource.html"><span class="type">ESource</span></a>* : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1">
<a name="EBackend.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="EBackend.html#EBackend-last-client-gone" title='The "last-client-gone" signal'>last-client-gone</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="EBackend.description"></a><h2>Description</h2>
<p>
An <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> is paired with an <a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> to facilitate performing
actions on the local or remote resource described by the <a href="../libedataserver/ESource.html"><span class="type">ESource</span></a>.
</p>
<p>
In other words, whereas a certain backend type knows how to talk to a
certain type of server or data store, the <a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> fills in configuration
details such as host name, user name, resource path, etc.
</p>
<p>
All <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> instances are created by an <a class="link" href="EBackendFactory.html" title="EBackendFactory"><span class="type">EBackendFactory</span></a>.
</p>
</div>
<div class="refsect1">
<a name="EBackend.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="EBackend-struct"></a><h3>struct EBackend</h3>
<pre class="programlisting">struct EBackend;</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-backend-get-online"></a><h3>e_backend_get_online ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> e_backend_get_online (<em class="parameter"><code><a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> *backend</code></em>);</pre>
<p>
Returns the online state of <em class="parameter"><code>backend</code></em>: <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>backend</code></em> is online,
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if offline. The online state of each backend is bound to the
online state of the <a class="link" href="EDataFactory.html" title="EDataFactory"><span class="type">EDataFactory</span></a> that created it.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
<td>an <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the online state</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.4</p>
</div>
<hr>
<div class="refsect2">
<a name="e-backend-set-online"></a><h3>e_backend_set_online ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_backend_set_online (<em class="parameter"><code><a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> *backend</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> online</code></em>);</pre>
<p>
Sets the online state of <em class="parameter"><code>backend</code></em>: <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>backend</code></em> is online,
<em class="parameter"><code>FALSE</code></em> if offline. The online state of each backend is bound to
the online state of the <a class="link" href="EDataFactory.html" title="EDataFactory"><span class="type">EDataFactory</span></a> that created it.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
<td>an <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>online</code></em> :</span></p></td>
<td>the online state</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.4</p>
</div>
<hr>
<div class="refsect2">
<a name="e-backend-get-source"></a><h3>e_backend_get_source ()</h3>
<pre class="programlisting"><a href="../libedataserver/ESource.html"><span class="returnvalue">ESource</span></a> * e_backend_get_source (<em class="parameter"><code><a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> *backend</code></em>);</pre>
<p>
Returns the <a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> to which <em class="parameter"><code>backend</code></em> is paired.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
<td>an <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> to which <em class="parameter"><code>backend</code></em> is paired</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.4</p>
</div>
<hr>
<div class="refsect2">
<a name="e-backend-last-client-gone"></a><h3>e_backend_last_client_gone ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_backend_last_client_gone (<em class="parameter"><code><a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> *backend</code></em>);</pre>
<p>
Emits the <a class="link" href="EBackend.html#EBackend-last-client-gone" title='The "last-client-gone" signal'><span class="type">"last-client-gone"</span></a> signal to indicate the last
client connection to <em class="parameter"><code>backend</code></em> has been closed. The <em class="parameter"><code>backend</code></em> may be
finalized after a short period to reclaim resources if no new client
connections are established.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
<td>an <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.4</p>
</div>
</div>
<div class="refsect1">
<a name="EBackend.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="EBackend--online"></a><h3>The <code class="literal">"online"</code> property</h3>
<pre class="programlisting"> "online" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct</pre>
<p>Whether the backend is online.</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="EBackend--source"></a><h3>The <code class="literal">"source"</code> property</h3>
<pre class="programlisting"> "source" <a href="../libedataserver/ESource.html"><span class="type">ESource</span></a>* : Read / Write / Construct Only</pre>
<p>The data source being acted upon.</p>
</div>
</div>
<div class="refsect1">
<a name="EBackend.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="EBackend-last-client-gone"></a><h3>The <code class="literal">"last-client-gone"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> *ebackend,
<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>
|
