← Back to branch summary

~ubuntu-branches/ubuntu/raring/evolution-data-server/raring-proposed 

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

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EDataFactory</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="Base Classes for Backends">
<link rel="prev" href="EBackendFactory.html" title="EBackendFactory">
<link rel="next" href="EDBusServer.html" title="EDBusServer">
<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="EBackendFactory.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="EDBusServer.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#EDataFactory.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#EDataFactory.description" class="shortcut">Description</a>
                   | 
                  <a href="#EDataFactory.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#EDataFactory.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
</td></tr>
</table>
<div class="refentry">
<a name="EDataFactory"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="EDataFactory.top_of_page"></a>EDataFactory</span></h2>
<p>EDataFactory — An abstract base class for a backend-based server</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="EDataFactory.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libebackend/libebackend.h&gt;

struct              <a class="link" href="EDataFactory.html#EDataFactory-struct" title="struct EDataFactory">EDataFactory</a>;
<a class="link" href="EBackend.html" title="EBackend"><span class="returnvalue">EBackend</span></a> *          <a class="link" href="EDataFactory.html#e-data-factory-ref-backend" title="e_data_factory_ref_backend ()">e_data_factory_ref_backend</a>          (<em class="parameter"><code><a class="link" href="EDataFactory.html" title="EDataFactory"><span class="type">EDataFactory</span></a> *data_factory</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *hash_key</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/libedataserver/ESource.html"><span class="type">ESource</span></a> *source</code></em>);
<a class="link" href="EBackendFactory.html" title="EBackendFactory"><span class="returnvalue">EBackendFactory</span></a> *   <a class="link" href="EDataFactory.html#e-data-factory-ref-backend-factory" title="e_data_factory_ref_backend_factory ()">e_data_factory_ref_backend_factory</a>  (<em class="parameter"><code><a class="link" href="EDataFactory.html" title="EDataFactory"><span class="type">EDataFactory</span></a> *data_factory</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *hash_key</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="EDataFactory.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="EDBusServer.html" title="EDBusServer">EDBusServer</a>
         +----EDataFactory
               +----<a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer">ESourceRegistryServer</a>
</pre>
</div>
<div class="refsect1">
<a name="EDataFactory.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
EDataFactory implements
 <a class="link" href="EExtensible.html" title="EExtensible">EExtensible</a>.</p>
</div>
<div class="refsect1">
<a name="EDataFactory.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="EDataFactory.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="EDataFactory-struct"></a><h3>struct EDataFactory</h3>
<pre class="programlisting">struct EDataFactory;</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-data-factory-ref-backend"></a><h3>e_data_factory_ref_backend ()</h3>
<pre class="programlisting"><a class="link" href="EBackend.html" title="EBackend"><span class="returnvalue">EBackend</span></a> *          e_data_factory_ref_backend          (<em class="parameter"><code><a class="link" href="EDataFactory.html" title="EDataFactory"><span class="type">EDataFactory</span></a> *data_factory</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *hash_key</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/libedataserver/ESource.html"><span class="type">ESource</span></a> *source</code></em>);</pre>
<p>
Returns either a newly-created or existing <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> for <a href="/usr/share/gtk-doc/html/libedataserver/ESource.html"><span class="type">ESource</span></a>.
The returned <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> is referenced for thread-safety and must be
unreferenced with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with it.
</p>
<p>
The <em class="parameter"><code>data_factory</code></em> retains a weak reference to <em class="parameter"><code>backend</code></em> so it can return
the same instance while <em class="parameter"><code>backend</code></em> is in use.  When the last strong reference
to <em class="parameter"><code>backend</code></em> is dropped, <em class="parameter"><code>data_factory</code></em> will lose its weak reference and will
have to create a new <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> instance the next time the same <em class="parameter"><code>hash_key</code></em>
and <em class="parameter"><code>source</code></em> are requested.
</p>
<p>
If no suitable <a class="link" href="EBackendFactory.html" title="EBackendFactory"><span class="type">EBackendFactory</span></a> exists, the function returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</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>data_factory</code></em> :</span></p></td>
<td>an <a class="link" href="EDataFactory.html" title="EDataFactory"><span class="type">EDataFactory</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>hash_key</code></em> :</span></p></td>
<td>hash key for 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="/usr/share/gtk-doc/html/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>an <a class="link" href="EBackend.html" title="EBackend"><span class="type">EBackend</span></a> for <em class="parameter"><code>source</code></em>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="e-data-factory-ref-backend-factory"></a><h3>e_data_factory_ref_backend_factory ()</h3>
<pre class="programlisting"><a class="link" href="EBackendFactory.html" title="EBackendFactory"><span class="returnvalue">EBackendFactory</span></a> *   e_data_factory_ref_backend_factory  (<em class="parameter"><code><a class="link" href="EDataFactory.html" title="EDataFactory"><span class="type">EDataFactory</span></a> *data_factory</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *hash_key</code></em>);</pre>
<p>
Returns the <a class="link" href="EBackendFactory.html" title="EBackendFactory"><span class="type">EBackendFactory</span></a> for <em class="parameter"><code>hash_key</code></em>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no such factory
is registered.
</p>
<p>
The returned <a class="link" href="EBackendFactory.html" title="EBackendFactory"><span class="type">EBackendFactory</span></a> is referenced for thread-safety.
Unreference the <a class="link" href="EBackendFactory.html" title="EBackendFactory"><span class="type">EBackendFactory</span></a> with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished
with it.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_factory</code></em> :</span></p></td>
<td>an <a class="link" href="EDataFactory.html" title="EDataFactory"><span class="type">EDataFactory</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>hash_key</code></em> :</span></p></td>
<td>hash key for 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>the <a class="link" href="EBackendFactory.html" title="EBackendFactory"><span class="type">EBackendFactory</span></a> for <em class="parameter"><code>hash_key</code></em>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>