/usr/share/gtk-doc/html/eds/EBackendFactory.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 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EBackendFactory: 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="eds-e-backend-enums.html" title="e-backend-enums">
<link rel="next" href="EDataFactory.html" title="EDataFactory">
<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="#EBackendFactory.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#EBackendFactory.object-hierarchy" class="shortcut">Object Hierarchy</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="eds-e-backend-enums.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="EDataFactory.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="EBackendFactory"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="EBackendFactory.top_of_page"></a>EBackendFactory</span></h2>
<p>EBackendFactory — An abstract base class for backend factories</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="EBackendFactory.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">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="EBackendFactory.html#e-backend-factory-get-hash-key" title="e_backend_factory_get_hash_key ()">e_backend_factory_get_hash_key</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="EBackend.html" title="EBackend"><span class="returnvalue">EBackend</span></a> *
</td>
<td class="function_name">
<a class="link" href="EBackendFactory.html#e-backend-factory-new-backend" title="e_backend_factory_new_backend ()">e_backend_factory_new_backend</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="EBackendFactory.html#e-backend-factory-get-module-filename" title="e_backend_factory_get_module_filename ()">e_backend_factory_get_module_filename</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="EBackendFactory.html#e-backend-factory-share-subprocess" title="e_backend_factory_share_subprocess ()">e_backend_factory_share_subprocess</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="EBackendFactory.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="EBackendFactory.html#EBackendFactory-struct" title="struct EBackendFactory">EBackendFactory</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="EBackendFactory.html#EBackendFactoryClass" title="struct EBackendFactoryClass">EBackendFactoryClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="EBackendFactory.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> <a class="link" href="EExtension.html" title="EExtension">EExtension</a>
<span class="lineart">╰──</span> EBackendFactory
<span class="lineart">├──</span> <a class="link" href="EBookBackendFactory.html" title="EBookBackendFactory">EBookBackendFactory</a>
<span class="lineart">├──</span> <a class="link" href="ECalBackendFactory.html" title="ECalBackendFactory">ECalBackendFactory</a>
<span class="lineart">╰──</span> <a class="link" href="ECollectionBackendFactory.html" title="ECollectionBackendFactory">ECollectionBackendFactory</a>
</pre>
</div>
<div class="refsect1">
<a name="EBackendFactory.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libebackend/libebackend.h>
</pre>
</div>
<div class="refsect1">
<a name="EBackendFactory.description"></a><h2>Description</h2>
<p>An <a class="link" href="EBackendFactory.html" title="EBackendFactory"><span class="type">EBackendFactory</span></a>'s job is to create an <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> instance for a
given <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a>. <a class="link" href="EBackendFactory.html" title="EBackendFactory"><span class="type">EBackendFactory</span></a> and <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> should be subclassed
together, so that each type of <a class="link" href="EBackendFactory.html" title="EBackendFactory"><span class="type">EBackendFactory</span></a> creates a unique type
of <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a>.</p>
<p>Each <a class="link" href="EBackendFactory.html" title="EBackendFactory"><span class="type">EBackendFactory</span></a> subclass must define a hash key to uniquely
identify itself among other <a class="link" href="EBackendFactory.html" title="EBackendFactory"><span class="type">EBackendFactory</span></a> subclasses. <a class="link" href="EDataFactory.html" title="EDataFactory"><span class="type">EDataFactory</span></a>
then services incoming connection requests by deriving a hash key from
the requested <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a>, using the dervied hash key to find an appropriate
<a class="link" href="EBackendFactory.html" title="EBackendFactory"><span class="type">EBackendFactory</span></a>, and creating an <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> instance from that factory
to pair with the requested <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a>.</p>
</div>
<div class="refsect1">
<a name="EBackendFactory.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-backend-factory-get-hash-key"></a><h3>e_backend_factory_get_hash_key ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
e_backend_factory_get_hash_key (<em class="parameter"><code><a class="link" href="EBackendFactory.html" title="EBackendFactory"><span class="type">EBackendFactory</span></a> *factory</code></em>);</pre>
<p>Returns a hash key which uniquely identifies <em class="parameter"><code>factory</code></em>
.</p>
<p>Since only one instance of each <a class="link" href="EBackendFactory.html" title="EBackendFactory"><span class="type">EBackendFactory</span></a> subclass is ever created,
the hash key need only be unique among subclasses, not among instances of
each subclass.</p>
<div class="refsect3">
<a name="e-backend-factory-get-hash-key.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>factory</p></td>
<td class="parameter_description"><p>an <a class="link" href="EBackendFactory.html" title="EBackendFactory"><span class="type">EBackendFactory</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-backend-factory-get-hash-key.returns"></a><h4>Returns</h4>
<p> a hash key which uniquely identifies <em class="parameter"><code>factory</code></em>
</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-backend-factory-new-backend"></a><h3>e_backend_factory_new_backend ()</h3>
<pre class="programlisting"><a class="link" href="EBackend.html" title="EBackend"><span class="returnvalue">EBackend</span></a> *
e_backend_factory_new_backend (<em class="parameter"><code><a class="link" href="EBackendFactory.html" title="EBackendFactory"><span class="type">EBackendFactory</span></a> *factory</code></em>,
<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>);</pre>
<p>Returns a new <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> instance for <em class="parameter"><code>source</code></em>
.</p>
<div class="refsect3">
<a name="e-backend-factory-new-backend.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>factory</p></td>
<td class="parameter_description"><p>an <a class="link" href="EBackendFactory.html" title="EBackendFactory"><span class="type">EBackendFactory</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-backend-factory-new-backend.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> instance for <em class="parameter"><code>source</code></em>
</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-backend-factory-get-module-filename"></a><h3>e_backend_factory_get_module_filename ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
e_backend_factory_get_module_filename (<em class="parameter"><code><a class="link" href="EBackendFactory.html" title="EBackendFactory"><span class="type">EBackendFactory</span></a> *factory</code></em>);</pre>
<p>Returns the filename of the shared library for the module used
to load the backends provided by <em class="parameter"><code>factory</code></em>
.</p>
<div class="refsect3">
<a name="e-backend-factory-get-module-filename.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>factory</p></td>
<td class="parameter_description"><p>an <a class="link" href="EBackendFactory.html" title="EBackendFactory"><span class="type">EBackendFactory</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-backend-factory-get-module-filename.returns"></a><h4>Returns</h4>
<p> the filename for the module associated to the <em class="parameter"><code>factory</code></em>
</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.16.html" title="Index of new symbols in 3.16">3.16</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-backend-factory-share-subprocess"></a><h3>e_backend_factory_share_subprocess ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_backend_factory_share_subprocess (<em class="parameter"><code><a class="link" href="EBackendFactory.html" title="EBackendFactory"><span class="type">EBackendFactory</span></a> *factory</code></em>);</pre>
<p>Returns TRUE if the <em class="parameter"><code>factory</code></em>
wants to share the subprocess
for all backends provided by itself. Otherwise, returns FALSE.</p>
<div class="refsect3">
<a name="e-backend-factory-share-subprocess.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>factory</p></td>
<td class="parameter_description"><p>an <a class="link" href="EBackendFactory.html" title="EBackendFactory"><span class="type">EBackendFactory</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-backend-factory-share-subprocess.returns"></a><h4>Returns</h4>
<p> TRUE if the <em class="parameter"><code>factory</code></em>
shares the subprocess for all its
backends. Otherwise, FALSE.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.16.html" title="Index of new symbols in 3.16">3.16</a></p>
</div>
</div>
<div class="refsect1">
<a name="EBackendFactory.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="EBackendFactory-struct"></a><h3>struct EBackendFactory</h3>
<pre class="programlisting">struct EBackendFactory;</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>
<hr>
<div class="refsect2">
<a name="EBackendFactoryClass"></a><h3>struct EBackendFactoryClass</h3>
<pre class="programlisting">struct EBackendFactoryClass {
/* Methods */
const gchar * (*get_hash_key) (EBackendFactory *factory);
EBackend * (*new_backend) (EBackendFactory *factory,
ESource *source);
struct _EModule *e_module;
gboolean share_subprocess;
};
</pre>
<p>Base class structure for the <a class="link" href="EBackendFactory.html" title="EBackendFactory"><span class="type">EBackendFactory</span></a> class</p>
<div class="refsect3">
<a name="EBackendFactoryClass.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="EBackendFactoryClass.get-hash-key"></a>get_hash_key</code></em> ()</p></td>
<td class="struct_member_description"><p>Get the hash key for this factory</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="EBackendFactoryClass.new-backend"></a>new_backend</code></em> ()</p></td>
<td class="struct_member_description"><p>Create a new <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> of the appropriate type for the passed <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a></p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p>struct <a class="link" href="EModule.html" title="EModule"><span class="type">_EModule</span></a> *<em class="structfield"><code><a name="EBackendFactoryClass.e-module"></a>e_module</code></em>;</p></td>
<td class="struct_member_description"><p>An <a class="link" href="EModule.html" title="EModule"><span class="type">EModule</span></a> associated with this backend factory</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> <em class="structfield"><code><a name="EBackendFactoryClass.share-subprocess"></a>share_subprocess</code></em>;</p></td>
<td class="struct_member_description"><p>Whether subporcesses for this backend factory should share one process</p></td>
<td class="struct_member_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>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|