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
|
<!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</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="EBackend.html" title="EBackend">
<link rel="next" href="EDataFactory.html" title="EDataFactory">
<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="EBackend.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="EDataFactory.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#EBackendFactory.synopsis" class="shortcut">Top</a>
|
<a href="#EBackendFactory.description" class="shortcut">Description</a>
|
<a href="#EBackendFactory.object-hierarchy" class="shortcut">Object Hierarchy</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 valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="EBackendFactory.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libebackend/e-backend-factory.h>
struct <a class="link" href="EBackendFactory.html#EBackendFactory-struct" title="struct EBackendFactory">EBackendFactory</a>;
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <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> (<em class="parameter"><code><a class="link" href="EBackendFactory.html" title="EBackendFactory"><span class="type">EBackendFactory</span></a> *factory</code></em>);
<a class="link" href="EBackend.html" title="EBackend"><span class="returnvalue">EBackend</span></a> * <a class="link" href="EBackendFactory.html#e-backend-factory-new-backend" title="e_backend_factory_new_backend ()">e_backend_factory_new_backend</a> (<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 href="../libedataserver/ESource.html"><span class="type">ESource</span></a> *source</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="EBackendFactory.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>
+----<a class="link" href="EExtension.html" title="EExtension">EExtension</a>
+----EBackendFactory
</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 href="../libedataserver/ESource.html"><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 href="../libedataserver/ESource.html"><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 href="../libedataserver/ESource.html"><span class="type">ESource</span></a>.
</p>
</div>
<div class="refsect1">
<a name="EBackendFactory.details"></a><h2>Details</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 3.4</p>
</div>
<hr>
<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="http://library.gnome.org/devel/glib/unstable/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>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>factory</code></em> :</span></p></td>
<td>an <a class="link" href="EBackendFactory.html" title="EBackendFactory"><span class="type">EBackendFactory</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a hash key which uniquely identifies <em class="parameter"><code>factory</code></em>.
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.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.4</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 href="../libedataserver/ESource.html"><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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>factory</code></em> :</span></p></td>
<td>an <a class="link" href="EBackendFactory.html" title="EBackendFactory"><span class="type">EBackendFactory</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
<td>an <a href="../libedataserver/ESource.html"><span class="type">ESource</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>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>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.4</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|
