← Back to branch summary

~ubuntu-branches/ubuntu/natty/evolution-data-server/natty

« back to all changes in this revision

Viewing changes to docs/reference/camel/xml/camel-uid-cache.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-01 22:47:15 UTC
  • mfrom: (1.1.77 upstream)
  • Revision ID: james.westby@ubuntu.com-20100301224715-drsxc2y3t8anz3c0
Tags: 2.28.3-0ubuntu1
https://launchpad.net/bugs/455020
https://launchpad.net/bugs/475147
https://launchpad.net/bugs/305428
https://launchpad.net/bugs/341909
https://launchpad.net/bugs/444177
* New upstream version:
  Bug Fixes:
  - #602723 - Contact list name doesn't get displayed in 'To' dialog 
  - #600322 - assertion failed: (reply == msg) in cs_waitinfo()
              (lp: #455020, #475147)
  - #564727 - Few memory leaks (lp: #305428)
  - #574940 - Always ref returned info from message_info_from_uid 
              (lp: #341909)
  - #429317 - Use the relative URI returned if the server 
              re-directs a request
  - #602820 - Test validity of a book_view before using it in LDAP 
  - #590762 - Recurring google calendar items are not changeable
  - #604236 - Slow GPG processing 
  - #597816 - Do not crash on incorrect parameters used in sexp to SQL 
              (lp: #444177)
  - #604544 - Try Exchange fallback authentication only once 
  - #600778 - Fix --enable-e2k-debug configure option resolution 
  - #260407 - 'endswith' address book search doesn't work 
  - #549221 - (bnc) delete, sync flags immediately
* debian/patches/99_reconfigure.patch:
  - new version update

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/camel/xml/camel-uid-cache.xml
1
 
<refentry id="camel-camel-uid-cache">
2
 
<refmeta>
3
 
<refentrytitle role="top_of_page" id="camel-camel-uid-cache.top_of_page">camel-uid-cache</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>CAMEL Library</refmiscinfo>
6
 
</refmeta>
7
 
 
8
 
<refnamediv>
9
 
<refname>camel-uid-cache</refname>
10
 
<refpurpose></refpurpose>
11
 
</refnamediv>
12
 
 
13
 
<refsynopsisdiv id="camel-camel-uid-cache.synopsis" role="synopsis">
14
 
<title role="synopsis.title">Synopsis</title>
15
 
 
16
 
<synopsis>
17
 
                    <link linkend="CamelUIDCache">CamelUIDCache</link>;
18
 
<link linkend="CamelUIDCache">CamelUIDCache</link> *     <link linkend="camel-uid-cache-new">camel_uid_cache_new</link>                 (const <link linkend="gchar">gchar</link> *filename);
19
 
<link linkend="gboolean">gboolean</link>            <link linkend="camel-uid-cache-save">camel_uid_cache_save</link>                (<link linkend="CamelUIDCache">CamelUIDCache</link> *cache);
20
 
<link linkend="void">void</link>                <link linkend="camel-uid-cache-destroy">camel_uid_cache_destroy</link>             (<link linkend="CamelUIDCache">CamelUIDCache</link> *cache);
21
 
<link linkend="GPtrArray">GPtrArray</link> *         <link linkend="camel-uid-cache-get-new-uids">camel_uid_cache_get_new_uids</link>        (<link linkend="CamelUIDCache">CamelUIDCache</link> *cache,
22
 
                                                         <link linkend="GPtrArray">GPtrArray</link> *uids);
23
 
<link linkend="void">void</link>                <link linkend="camel-uid-cache-save-uid">camel_uid_cache_save_uid</link>            (<link linkend="CamelUIDCache">CamelUIDCache</link> *cache,
24
 
                                                         const <link linkend="gchar">gchar</link> *uid);
25
 
<link linkend="void">void</link>                <link linkend="camel-uid-cache-free-uids">camel_uid_cache_free_uids</link>           (<link linkend="GPtrArray">GPtrArray</link> *uids);
26
 
</synopsis>
27
 
</refsynopsisdiv>
28
 
 
29
 
 
30
 
 
31
 
 
32
 
 
33
 
 
34
 
 
35
 
 
36
 
 
37
 
<refsect1 id="camel-camel-uid-cache.description" role="desc">
38
 
<title role="desc.title">Description</title>
39
 
<para>
40
 
</para>
41
 
</refsect1>
42
 
 
43
 
<refsect1 id="camel-camel-uid-cache.details" role="details">
44
 
<title role="details.title">Details</title>
45
 
<refsect2 id="CamelUIDCache" role="struct">
46
 
<title>CamelUIDCache</title>
47
 
<indexterm zone="CamelUIDCache"><primary sortas="CamelUIDCache">CamelUIDCache</primary></indexterm><programlisting>typedef struct {
48
 
        gchar *filename;
49
 
        GHashTable *uids;
50
 
        guint level;
51
 
        gsize expired;
52
 
        gsize size;
53
 
        gint fd;
54
 
} CamelUIDCache;
55
 
</programlisting>
56
 
<para>
57
 
</para></refsect2>
58
 
<refsect2 id="camel-uid-cache-new" role="function">
59
 
<title>camel_uid_cache_new ()</title>
60
 
<indexterm zone="camel-uid-cache-new"><primary sortas="camel_uid_cache_new">camel_uid_cache_new</primary></indexterm><programlisting><link linkend="CamelUIDCache">CamelUIDCache</link> *     camel_uid_cache_new                 (const <link linkend="gchar">gchar</link> *filename);</programlisting>
61
 
<para>
62
 
Creates a new UID cache, initialized from <parameter>filename</parameter>. If <parameter>filename</parameter>
63
 
doesn't already exist, the UID cache will be empty. Otherwise, if
64
 
it does exist but can't be read, the function will return <link linkend="NULL--CAPS"><literal>NULL</literal></link>.</para>
65
 
<para>
66
 
</para><variablelist role="params">
67
 
<varlistentry><term><parameter>filename</parameter>&#160;:</term>
68
 
<listitem><simpara> path to load the cache from
69
 
</simpara></listitem></varlistentry>
70
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new UID cache, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
71
 
</simpara></listitem></varlistentry>
72
 
</variablelist></refsect2>
73
 
<refsect2 id="camel-uid-cache-save" role="function">
74
 
<title>camel_uid_cache_save ()</title>
75
 
<indexterm zone="camel-uid-cache-save"><primary sortas="camel_uid_cache_save">camel_uid_cache_save</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            camel_uid_cache_save                (<link linkend="CamelUIDCache">CamelUIDCache</link> *cache);</programlisting>
76
 
<para>
77
 
Attempts to save <parameter>cache</parameter> back to disk.</para>
78
 
<para>
79
 
</para><variablelist role="params">
80
 
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
81
 
<listitem><simpara> a CamelUIDCache
82
 
</simpara></listitem></varlistentry>
83
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> success or failure
84
 
</simpara></listitem></varlistentry>
85
 
</variablelist></refsect2>
86
 
<refsect2 id="camel-uid-cache-destroy" role="function">
87
 
<title>camel_uid_cache_destroy ()</title>
88
 
<indexterm zone="camel-uid-cache-destroy"><primary sortas="camel_uid_cache_destroy">camel_uid_cache_destroy</primary></indexterm><programlisting><link linkend="void">void</link>                camel_uid_cache_destroy             (<link linkend="CamelUIDCache">CamelUIDCache</link> *cache);</programlisting>
89
 
<para>
90
 
Destroys <parameter>cache</parameter> and frees its data.</para>
91
 
<para>
92
 
</para><variablelist role="params">
93
 
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
94
 
<listitem><simpara> a CamelUIDCache
95
 
</simpara></listitem></varlistentry>
96
 
</variablelist></refsect2>
97
 
<refsect2 id="camel-uid-cache-get-new-uids" role="function">
98
 
<title>camel_uid_cache_get_new_uids ()</title>
99
 
<indexterm zone="camel-uid-cache-get-new-uids"><primary sortas="camel_uid_cache_get_new_uids">camel_uid_cache_get_new_uids</primary></indexterm><programlisting><link linkend="GPtrArray">GPtrArray</link> *         camel_uid_cache_get_new_uids        (<link linkend="CamelUIDCache">CamelUIDCache</link> *cache,
100
 
                                                         <link linkend="GPtrArray">GPtrArray</link> *uids);</programlisting>
101
 
<para>
102
 
Returns an array of UIDs from <parameter>uids</parameter> that are not in <parameter>cache</parameter>, and
103
 
removes UIDs from <parameter>cache</parameter> that aren't in <parameter>uids</parameter>.</para>
104
 
<para>
105
 
</para><variablelist role="params">
106
 
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
107
 
<listitem><simpara> a CamelUIDCache
108
 
</simpara></listitem></varlistentry>
109
 
<varlistentry><term><parameter>uids</parameter>&#160;:</term>
110
 
<listitem><simpara> an array of UIDs
111
 
</simpara></listitem></varlistentry>
112
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> an array of new UIDs, which must be freed with
113
 
<link linkend="camel-uid-cache-free-uids"><function>camel_uid_cache_free_uids()</function></link>.
114
 
</simpara></listitem></varlistentry>
115
 
</variablelist></refsect2>
116
 
<refsect2 id="camel-uid-cache-save-uid" role="function">
117
 
<title>camel_uid_cache_save_uid ()</title>
118
 
<indexterm zone="camel-uid-cache-save-uid"><primary sortas="camel_uid_cache_save_uid">camel_uid_cache_save_uid</primary></indexterm><programlisting><link linkend="void">void</link>                camel_uid_cache_save_uid            (<link linkend="CamelUIDCache">CamelUIDCache</link> *cache,
119
 
                                                         const <link linkend="gchar">gchar</link> *uid);</programlisting>
120
 
<para>
121
 
Marks a uid for saving.</para>
122
 
<para>
123
 
</para><variablelist role="params">
124
 
<varlistentry><term><parameter>cache</parameter>&#160;:</term>
125
 
<listitem><simpara> a CamelUIDCache
126
 
</simpara></listitem></varlistentry>
127
 
<varlistentry><term><parameter>uid</parameter>&#160;:</term>
128
 
<listitem><simpara> a uid to save
129
 
</simpara></listitem></varlistentry>
130
 
</variablelist></refsect2>
131
 
<refsect2 id="camel-uid-cache-free-uids" role="function">
132
 
<title>camel_uid_cache_free_uids ()</title>
133
 
<indexterm zone="camel-uid-cache-free-uids"><primary sortas="camel_uid_cache_free_uids">camel_uid_cache_free_uids</primary></indexterm><programlisting><link linkend="void">void</link>                camel_uid_cache_free_uids           (<link linkend="GPtrArray">GPtrArray</link> *uids);</programlisting>
134
 
<para>
135
 
Frees the array of UIDs.</para>
136
 
<para>
137
 
</para><variablelist role="params">
138
 
<varlistentry><term><parameter>uids</parameter>&#160;:</term>
139
 
<listitem><simpara> an array returned from <link linkend="camel-uid-cache-get-new-uids"><function>camel_uid_cache_get_new_uids()</function></link>
140
 
</simpara></listitem></varlistentry>
141
 
</variablelist></refsect2>
142
 
 
143
 
</refsect1>
144
 
 
145
 
 
146
 
 
147
 
 
148
 
</refentry>