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
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libedataserver-EFileCache">
<refmeta>
<refentrytitle role="top_of_page">EFileCache</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBEDATASERVER Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>EFileCache</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="EFileCachePrivate">EFileCachePrivate</link>;
<link linkend="EFileCache">EFileCache</link>* <link linkend="e-file-cache-new">e_file_cache_new</link> (const <link linkend="char">char</link> *filename);
<link linkend="gboolean">gboolean</link> <link linkend="e-file-cache-remove">e_file_cache_remove</link> (<link linkend="EFileCache">EFileCache</link> *cache);
<link linkend="gboolean">gboolean</link> <link linkend="e-file-cache-clean">e_file_cache_clean</link> (<link linkend="EFileCache">EFileCache</link> *cache);
const <link linkend="char">char</link>* <link linkend="e-file-cache-get-object">e_file_cache_get_object</link> (<link linkend="EFileCache">EFileCache</link> *cache,
const <link linkend="char">char</link> *key);
<link linkend="GSList">GSList</link>* <link linkend="e-file-cache-get-objects">e_file_cache_get_objects</link> (<link linkend="EFileCache">EFileCache</link> *cache);
<link linkend="GSList">GSList</link>* <link linkend="e-file-cache-get-keys">e_file_cache_get_keys</link> (<link linkend="EFileCache">EFileCache</link> *cache);
<link linkend="gboolean">gboolean</link> <link linkend="e-file-cache-add-object">e_file_cache_add_object</link> (<link linkend="EFileCache">EFileCache</link> *cache,
const <link linkend="char">char</link> *key,
const <link linkend="char">char</link> *value);
<link linkend="gboolean">gboolean</link> <link linkend="e-file-cache-replace-object">e_file_cache_replace_object</link> (<link linkend="EFileCache">EFileCache</link> *cache,
const <link linkend="char">char</link> *key,
const <link linkend="char">char</link> *new_value);
<link linkend="gboolean">gboolean</link> <link linkend="e-file-cache-remove-object">e_file_cache_remove_object</link> (<link linkend="EFileCache">EFileCache</link> *cache,
const <link linkend="char">char</link> *key);
<link linkend="void">void</link> <link linkend="e-file-cache-freeze-changes">e_file_cache_freeze_changes</link> (<link linkend="EFileCache">EFileCache</link> *cache);
<link linkend="void">void</link> <link linkend="e-file-cache-thaw-changes">e_file_cache_thaw_changes</link> (<link linkend="EFileCache">EFileCache</link> *cache);
const <link linkend="char">char</link>* <link linkend="e-file-cache-get-filename">e_file_cache_get_filename</link> (<link linkend="EFileCache">EFileCache</link> *cache);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="EFileCachePrivate" role="struct"/>EFileCachePrivate</title>
<indexterm><primary>EFileCachePrivate</primary></indexterm><programlisting>typedef struct _EFileCachePrivate EFileCachePrivate;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="e-file-cache-new" role="function"/>e_file_cache_new ()</title>
<indexterm><primary>e_file_cache_new</primary></indexterm><programlisting><link linkend="EFileCache">EFileCache</link>* e_file_cache_new (const <link linkend="char">char</link> *filename);</programlisting>
<para>
Creates a new <link linkend="EFileCache"><type>EFileCache</type></link> object, which implements a cache of
objects, very useful for remote backends.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>filename</parameter> :</term>
<listitem><simpara> filename where the cache is kept.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly created object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-file-cache-remove" role="function"/>e_file_cache_remove ()</title>
<indexterm><primary>e_file_cache_remove</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> e_file_cache_remove (<link linkend="EFileCache">EFileCache</link> *cache);</programlisting>
<para>
Remove the cache from disk.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>cache</parameter> :</term>
<listitem><simpara> A <link linkend="EFileCache"><type>EFileCache</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if successful, FALSE otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-file-cache-clean" role="function"/>e_file_cache_clean ()</title>
<indexterm><primary>e_file_cache_clean</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> e_file_cache_clean (<link linkend="EFileCache">EFileCache</link> *cache);</programlisting>
<para>
Clean up the cache's contents.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>cache</parameter> :</term>
<listitem><simpara> A <link linkend="EFileCache"><type>EFileCache</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if successful, FALSE otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-file-cache-get-object" role="function"/>e_file_cache_get_object ()</title>
<indexterm><primary>e_file_cache_get_object</primary></indexterm><programlisting>const <link linkend="char">char</link>* e_file_cache_get_object (<link linkend="EFileCache">EFileCache</link> *cache,
const <link linkend="char">char</link> *key);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>cache</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>key</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-file-cache-get-objects" role="function"/>e_file_cache_get_objects ()</title>
<indexterm><primary>e_file_cache_get_objects</primary></indexterm><programlisting><link linkend="GSList">GSList</link>* e_file_cache_get_objects (<link linkend="EFileCache">EFileCache</link> *cache);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>cache</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-file-cache-get-keys" role="function"/>e_file_cache_get_keys ()</title>
<indexterm><primary>e_file_cache_get_keys</primary></indexterm><programlisting><link linkend="GSList">GSList</link>* e_file_cache_get_keys (<link linkend="EFileCache">EFileCache</link> *cache);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>cache</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-file-cache-add-object" role="function"/>e_file_cache_add_object ()</title>
<indexterm><primary>e_file_cache_add_object</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> e_file_cache_add_object (<link linkend="EFileCache">EFileCache</link> *cache,
const <link linkend="char">char</link> *key,
const <link linkend="char">char</link> *value);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>cache</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>key</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-file-cache-replace-object" role="function"/>e_file_cache_replace_object ()</title>
<indexterm><primary>e_file_cache_replace_object</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> e_file_cache_replace_object (<link linkend="EFileCache">EFileCache</link> *cache,
const <link linkend="char">char</link> *key,
const <link linkend="char">char</link> *new_value);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>cache</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>key</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>new_value</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-file-cache-remove-object" role="function"/>e_file_cache_remove_object ()</title>
<indexterm><primary>e_file_cache_remove_object</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> e_file_cache_remove_object (<link linkend="EFileCache">EFileCache</link> *cache,
const <link linkend="char">char</link> *key);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>cache</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>key</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-file-cache-freeze-changes" role="function"/>e_file_cache_freeze_changes ()</title>
<indexterm><primary>e_file_cache_freeze_changes</primary></indexterm><programlisting><link linkend="void">void</link> e_file_cache_freeze_changes (<link linkend="EFileCache">EFileCache</link> *cache);</programlisting>
<para>
Disables temporarily all writes to disk for the given cache object.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>cache</parameter> :</term>
<listitem><simpara> An <link linkend="EFileCache"><type>EFileCache</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-file-cache-thaw-changes" role="function"/>e_file_cache_thaw_changes ()</title>
<indexterm><primary>e_file_cache_thaw_changes</primary></indexterm><programlisting><link linkend="void">void</link> e_file_cache_thaw_changes (<link linkend="EFileCache">EFileCache</link> *cache);</programlisting>
<para>
Enables again writes to disk on every change.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>cache</parameter> :</term>
<listitem><simpara> An <link linkend="EFileCache"><type>EFileCache</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="e-file-cache-get-filename" role="function"/>e_file_cache_get_filename ()</title>
<indexterm><primary>e_file_cache_get_filename</primary></indexterm><programlisting>const <link linkend="char">char</link>* e_file_cache_get_filename (<link linkend="EFileCache">EFileCache</link> *cache);</programlisting>
<para>
Gets the name of the file where the cache is being stored.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>cache</parameter> :</term>
<listitem><simpara> A <link linkend="EFileCache"><literal>EFileCache</literal></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The name of the cache.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
