← Back to branch summary

~ubuntu-branches/ubuntu/trusty/gcr/trusty-proposed

« back to all changes in this revision

Viewing changes to docs/reference/gck/html/GckObjectCache.html

  • Committer: Package Import Robot
  • Author(s): Jordi Mallach
  • Date: 2012-05-03 10:18:39 UTC
  • Revision ID: package-import@ubuntu.com-20120503101839-wuvloldm7gmdsnij
Tags: upstream-3.4.1
Import upstream version 3.4.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gck/html/GckObjectCache.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>GckObjectCache</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
7
<link rel="home" href="index.html" title="Gck Library Reference Manual">
 
8
<link rel="up" href="reference.html" title="PKCS#11 GObject Bindings">
 
9
<link rel="prev" href="GckAttributes.html" title="GckAttributes">
 
10
<link rel="next" href="GckEnumerator.html" title="GckEnumerator">
 
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="GckAttributes.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="reference.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">Gck Library Reference Manual</th>
 
21
<td><a accesskey="n" href="GckEnumerator.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#GckObjectCache.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#GckObjectCache.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#GckObjectCache.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
                   | 
 
30
                  <a href="#GckObjectCache.prerequisites" class="shortcut">Prerequisites</a>
 
31
                   | 
 
32
                  <a href="#GckObjectCache.properties" class="shortcut">Properties</a>
 
33
</td></tr>
 
34
</table>
 
35
<div class="refentry">
 
36
<a name="GckObjectCache"></a><div class="titlepage"></div>
 
37
<div class="refnamediv"><table width="100%"><tr>
 
38
<td valign="top">
 
39
<h2><span class="refentrytitle"><a name="GckObjectCache.top_of_page"></a>GckObjectCache</span></h2>
 
40
<p>GckObjectCache — An interface which holds attributes for a PKCS#11 object</p>
 
41
</td>
 
42
<td valign="top" align="right"></td>
 
43
</tr></table></div>
 
44
<div class="refsynopsisdiv">
 
45
<a name="GckObjectCache.synopsis"></a><h2>Synopsis</h2>
 
46
<pre class="synopsis">                    <a class="link" href="GckObjectCache.html#GckObjectCache-struct" title="GckObjectCache">GckObjectCache</a>;
 
47
struct              <a class="link" href="GckObjectCache.html#GckObjectCacheIface" title="struct GckObjectCacheIface">GckObjectCacheIface</a>;
 
48
<a class="link" href="GckAttributes.html" title="GckAttributes"><span class="returnvalue">GckAttributes</span></a> *     <a class="link" href="GckObjectCache.html#gck-object-cache-get-attributes" title="gck_object_cache_get_attributes ()">gck_object_cache_get_attributes</a>     (<em class="parameter"><code><a class="link" href="GckObjectCache.html" title="GckObjectCache"><span class="type">GckObjectCache</span></a> *object</code></em>);
 
49
<span class="returnvalue">void</span>                <a class="link" href="GckObjectCache.html#gck-object-cache-set-attributes" title="gck_object_cache_set_attributes ()">gck_object_cache_set_attributes</a>     (<em class="parameter"><code><a class="link" href="GckObjectCache.html" title="GckObjectCache"><span class="type">GckObjectCache</span></a> *object</code></em>,
 
50
                                                         <em class="parameter"><code><a class="link" href="GckAttributes.html" title="GckAttributes"><span class="type">GckAttributes</span></a> *attrs</code></em>);
 
51
<span class="returnvalue">void</span>                <a class="link" href="GckObjectCache.html#gck-object-cache-fill" title="gck_object_cache_fill ()">gck_object_cache_fill</a>               (<em class="parameter"><code><a class="link" href="GckObjectCache.html" title="GckObjectCache"><span class="type">GckObjectCache</span></a> *object</code></em>,
 
52
                                                         <em class="parameter"><code><a class="link" href="GckAttributes.html" title="GckAttributes"><span class="type">GckAttributes</span></a> *attrs</code></em>);
 
53
<a class="link" href="GckAttributes.html" title="GckAttributes"><span class="returnvalue">GckAttributes</span></a> *     <a class="link" href="GckObjectCache.html#gck-object-cache-lookup" title="gck_object_cache_lookup ()">gck_object_cache_lookup</a>             (<em class="parameter"><code><a class="link" href="GckObject.html" title="GckObject"><span class="type">GckObject</span></a> *object</code></em>,
 
54
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> *attr_types</code></em>,
 
55
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_attr_types</code></em>,
 
56
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
57
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
58
<span class="returnvalue">void</span>                <a class="link" href="GckObjectCache.html#gck-object-cache-lookup-async" title="gck_object_cache_lookup_async ()">gck_object_cache_lookup_async</a>       (<em class="parameter"><code><a class="link" href="GckObject.html" title="GckObject"><span class="type">GckObject</span></a> *object</code></em>,
 
59
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> *attr_types</code></em>,
 
60
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_attr_types</code></em>,
 
61
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
62
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
 
63
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
 
64
<a class="link" href="GckAttributes.html" title="GckAttributes"><span class="returnvalue">GckAttributes</span></a> *     <a class="link" href="GckObjectCache.html#gck-object-cache-lookup-finish" title="gck_object_cache_lookup_finish ()">gck_object_cache_lookup_finish</a>      (<em class="parameter"><code><a class="link" href="GckObject.html" title="GckObject"><span class="type">GckObject</span></a> *object</code></em>,
 
65
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
 
66
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
67
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GckObjectCache.html#gck-object-cache-update" title="gck_object_cache_update ()">gck_object_cache_update</a>             (<em class="parameter"><code><a class="link" href="GckObjectCache.html" title="GckObjectCache"><span class="type">GckObjectCache</span></a> *object</code></em>,
 
68
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> *attr_types</code></em>,
 
69
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_attr_types</code></em>,
 
70
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
71
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
72
<span class="returnvalue">void</span>                <a class="link" href="GckObjectCache.html#gck-object-cache-update-async" title="gck_object_cache_update_async ()">gck_object_cache_update_async</a>       (<em class="parameter"><code><a class="link" href="GckObjectCache.html" title="GckObjectCache"><span class="type">GckObjectCache</span></a> *object</code></em>,
 
73
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> *attr_types</code></em>,
 
74
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_attr_types</code></em>,
 
75
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
76
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
 
77
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
 
78
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GckObjectCache.html#gck-object-cache-update-finish" title="gck_object_cache_update_finish ()">gck_object_cache_update_finish</a>      (<em class="parameter"><code><a class="link" href="GckObjectCache.html" title="GckObjectCache"><span class="type">GckObjectCache</span></a> *object</code></em>,
 
79
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
 
80
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
 
81
</pre>
 
82
</div>
 
83
<div class="refsect1">
 
84
<a name="GckObjectCache.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
85
<pre class="synopsis">
 
86
  GInterface
 
87
   +----GckObjectCache
 
88
</pre>
 
89
</div>
 
90
<div class="refsect1">
 
91
<a name="GckObjectCache.prerequisites"></a><h2>Prerequisites</h2>
 
92
<p>
 
93
GckObjectCache requires
 
94
 <a class="link" href="GckObject.html" title="GckObject">GckObject</a>.</p>
 
95
</div>
 
96
<div class="refsect1">
 
97
<a name="GckObjectCache.properties"></a><h2>Properties</h2>
 
98
<pre class="synopsis">
 
99
  "<a class="link" href="GckObjectCache.html#GckObjectCache--attributes" title='The "attributes" property'>attributes</a>"               <a class="link" href="GckAttributes.html" title="GckAttributes"><span class="type">GckAttributes</span></a>*        : Read / Write
 
100
</pre>
 
101
</div>
 
102
<div class="refsect1">
 
103
<a name="GckObjectCache.description"></a><h2>Description</h2>
 
104
<p>
 
105
<a class="link" href="GckObjectCache.html" title="GckObjectCache"><span class="type">GckObjectCache</span></a> is an interface implemented by derived classes of
 
106
<a class="link" href="GckObject.html" title="GckObject"><span class="type">GckObject</span></a> to indicate which attributes they'd like an enumerator to retrieve.
 
107
These attributes are then cached on the object and can be retrieved through
 
108
the <a class="link" href="GckObjectCache.html#GckObjectCache--attributes" title='The "attributes" property'><span class="type">"attributes"</span></a> property.
 
109
</p>
 
110
</div>
 
111
<div class="refsect1">
 
112
<a name="GckObjectCache.details"></a><h2>Details</h2>
 
113
<div class="refsect2">
 
114
<a name="GckObjectCache-struct"></a><h3>GckObjectCache</h3>
 
115
<pre class="programlisting">typedef struct _GckObjectCache GckObjectCache;</pre>
 
116
<p>
 
117
An interface implemented on an <a class="link" href="GckObject.html" title="GckObject"><span class="type">GckObject</span></a> which contains a cache of attributes.
 
118
</p>
 
119
</div>
 
120
<hr>
 
121
<div class="refsect2">
 
122
<a name="GckObjectCacheIface"></a><h3>struct GckObjectCacheIface</h3>
 
123
<pre class="programlisting">struct GckObjectCacheIface {
 
124
        GTypeInterface interface;
 
125
 
 
126
        const gulong *  default_types;
 
127
        gint            n_default_types;
 
128
 
 
129
        void         (* fill)                              (GckObjectCache *object,
 
130
                                                            GckAttributes *attrs);
 
131
};
 
132
</pre>
 
133
<p>
 
134
Interface for <a class="link" href="GckObjectCache.html" title="GckObjectCache"><span class="type">GckObjectCache</span></a>. If the <em class="parameter"><code>default_types</code></em> field is set by
 
135
a implementing class, then the a <a class="link" href="GckEnumerator.html" title="GckEnumerator"><span class="type">GckEnumerator</span></a> which has been setup using
 
136
<a class="link" href="GckEnumerator.html#gck-enumerator-set-object-type" title="gck_enumerator_set_object_type ()"><code class="function">gck_enumerator_set_object_type()</code></a>
 
137
</p>
 
138
<p>
 
139
The implementation for <em class="parameter"><code>populate</code></em> should add the attributes to the
 
140
cache. It must be thread safe.
 
141
</p>
 
142
<div class="variablelist"><table border="0">
 
143
<col align="left" valign="top">
 
144
<tbody>
 
145
<tr>
 
146
<td><p><span class="term"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="GckObjectCacheIface.interface"></a>interface</code></em>;</span></p></td>
 
147
<td>parent interface</td>
 
148
</tr>
 
149
<tr>
 
150
<td><p><span class="term">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> *<em class="structfield"><code><a name="GckObjectCacheIface.default-types"></a>default_types</code></em>;</span></p></td>
 
151
<td>attribute types that an
 
152
enumerator should retrieve. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_default_types]</span>
 
153
</td>
 
154
</tr>
 
155
<tr>
 
156
<td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> <em class="structfield"><code><a name="GckObjectCacheIface.n-default-types"></a>n_default_types</code></em>;</span></p></td>
 
157
<td>number of attribute types to be retrieved</td>
 
158
</tr>
 
159
<tr>
 
160
<td><p><span class="term"><em class="structfield"><code><a name="GckObjectCacheIface.fill"></a>fill</code></em> ()</span></p></td>
 
161
<td>virtual method to add attributes to the cache</td>
 
162
</tr>
 
163
</tbody>
 
164
</table></div>
 
165
</div>
 
166
<hr>
 
167
<div class="refsect2">
 
168
<a name="gck-object-cache-get-attributes"></a><h3>gck_object_cache_get_attributes ()</h3>
 
169
<pre class="programlisting"><a class="link" href="GckAttributes.html" title="GckAttributes"><span class="returnvalue">GckAttributes</span></a> *     gck_object_cache_get_attributes     (<em class="parameter"><code><a class="link" href="GckObjectCache.html" title="GckObjectCache"><span class="type">GckObjectCache</span></a> *object</code></em>);</pre>
 
170
<p>
 
171
Gets the attributes cached on this object.
 
172
</p>
 
173
<div class="variablelist"><table border="0">
 
174
<col align="left" valign="top">
 
175
<tbody>
 
176
<tr>
 
177
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
 
178
<td>an object with an attribute cache</td>
 
179
</tr>
 
180
<tr>
 
181
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
182
<td>the attributes. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
183
</td>
 
184
</tr>
 
185
</tbody>
 
186
</table></div>
 
187
</div>
 
188
<hr>
 
189
<div class="refsect2">
 
190
<a name="gck-object-cache-set-attributes"></a><h3>gck_object_cache_set_attributes ()</h3>
 
191
<pre class="programlisting"><span class="returnvalue">void</span>                gck_object_cache_set_attributes     (<em class="parameter"><code><a class="link" href="GckObjectCache.html" title="GckObjectCache"><span class="type">GckObjectCache</span></a> *object</code></em>,
 
192
                                                         <em class="parameter"><code><a class="link" href="GckAttributes.html" title="GckAttributes"><span class="type">GckAttributes</span></a> *attrs</code></em>);</pre>
 
193
<p>
 
194
Sets the attributes cached on this object.
 
195
</p>
 
196
<p>
 
197
If the <em class="parameter"><code>attrs</code></em> <a class="link" href="GckAttributes.html" title="GckAttributes"><span class="type">GckAttributes</span></a> is floating, it is consumed.
 
198
</p>
 
199
<div class="variablelist"><table border="0">
 
200
<col align="left" valign="top">
 
201
<tbody>
 
202
<tr>
 
203
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
 
204
<td>an object with an attribute cache</td>
 
205
</tr>
 
206
<tr>
 
207
<td><p><span class="term"><em class="parameter"><code>attrs</code></em> :</span></p></td>
 
208
<td>the attributes to set. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
209
</td>
 
210
</tr>
 
211
</tbody>
 
212
</table></div>
 
213
</div>
 
214
<hr>
 
215
<div class="refsect2">
 
216
<a name="gck-object-cache-fill"></a><h3>gck_object_cache_fill ()</h3>
 
217
<pre class="programlisting"><span class="returnvalue">void</span>                gck_object_cache_fill               (<em class="parameter"><code><a class="link" href="GckObjectCache.html" title="GckObjectCache"><span class="type">GckObjectCache</span></a> *object</code></em>,
 
218
                                                         <em class="parameter"><code><a class="link" href="GckAttributes.html" title="GckAttributes"><span class="type">GckAttributes</span></a> *attrs</code></em>);</pre>
 
219
<p>
 
220
Adds the attributes to the set cached on this object. If an attribute is
 
221
already present in the cache it will be overridden by this value.
 
222
</p>
 
223
<p>
 
224
This will be done in a thread-safe manner.
 
225
</p>
 
226
<p>
 
227
If the <em class="parameter"><code>attrs</code></em> <a class="link" href="GckAttributes.html" title="GckAttributes"><span class="type">GckAttributes</span></a> is floating, it is consumed.
 
228
</p>
 
229
<div class="variablelist"><table border="0">
 
230
<col align="left" valign="top">
 
231
<tbody>
 
232
<tr>
 
233
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
 
234
<td>an object with the cache</td>
 
235
</tr>
 
236
<tr>
 
237
<td><p><span class="term"><em class="parameter"><code>attrs</code></em> :</span></p></td>
 
238
<td>the attributes to cache</td>
 
239
</tr>
 
240
</tbody>
 
241
</table></div>
 
242
</div>
 
243
<hr>
 
244
<div class="refsect2">
 
245
<a name="gck-object-cache-lookup"></a><h3>gck_object_cache_lookup ()</h3>
 
246
<pre class="programlisting"><a class="link" href="GckAttributes.html" title="GckAttributes"><span class="returnvalue">GckAttributes</span></a> *     gck_object_cache_lookup             (<em class="parameter"><code><a class="link" href="GckObject.html" title="GckObject"><span class="type">GckObject</span></a> *object</code></em>,
 
247
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> *attr_types</code></em>,
 
248
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_attr_types</code></em>,
 
249
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
250
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
251
<p>
 
252
Lookup attributes in the cache, or retrieve them from the object if necessary.
 
253
</p>
 
254
<p>
 
255
If <em class="parameter"><code>object</code></em> is a <a class="link" href="GckObjectCache.html" title="GckObjectCache"><span class="type">GckObjectCache</span></a> then this will lookup the attributes there
 
256
first if available, otherwise will read them from the object and update
 
257
the cache.
 
258
</p>
 
259
<p>
 
260
If <em class="parameter"><code>object</code></em> is not a <a class="link" href="GckObjectCache.html" title="GckObjectCache"><span class="type">GckObjectCache</span></a>, then the attributes will simply be
 
261
read from the object.
 
262
</p>
 
263
<p>
 
264
This may block, use the asynchronous version when this is not desirable
 
265
</p>
 
266
<div class="variablelist"><table border="0">
 
267
<col align="left" valign="top">
 
268
<tbody>
 
269
<tr>
 
270
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
 
271
<td>the object</td>
 
272
</tr>
 
273
<tr>
 
274
<td><p><span class="term"><em class="parameter"><code>attr_types</code></em> :</span></p></td>
 
275
<td>the types of attributes to update. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_attr_types]</span>
 
276
</td>
 
277
</tr>
 
278
<tr>
 
279
<td><p><span class="term"><em class="parameter"><code>n_attr_types</code></em> :</span></p></td>
 
280
<td>the number of attribute types</td>
 
281
</tr>
 
282
<tr>
 
283
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
284
<td>optional cancellation object</td>
 
285
</tr>
 
286
<tr>
 
287
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
288
<td>location to place an error</td>
 
289
</tr>
 
290
<tr>
 
291
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
292
<td>the attributes retrieved or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on failure. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
293
</td>
 
294
</tr>
 
295
</tbody>
 
296
</table></div>
 
297
</div>
 
298
<hr>
 
299
<div class="refsect2">
 
300
<a name="gck-object-cache-lookup-async"></a><h3>gck_object_cache_lookup_async ()</h3>
 
301
<pre class="programlisting"><span class="returnvalue">void</span>                gck_object_cache_lookup_async       (<em class="parameter"><code><a class="link" href="GckObject.html" title="GckObject"><span class="type">GckObject</span></a> *object</code></em>,
 
302
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> *attr_types</code></em>,
 
303
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_attr_types</code></em>,
 
304
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
305
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
 
306
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
 
307
<p>
 
308
Lookup attributes in the cache, or retrieve them from the object if necessary.
 
309
</p>
 
310
<p>
 
311
If <em class="parameter"><code>object</code></em> is a <a class="link" href="GckObjectCache.html" title="GckObjectCache"><span class="type">GckObjectCache</span></a> then this will lookup the attributes there
 
312
first if available, otherwise will read them from the object and update
 
313
the cache.
 
314
</p>
 
315
<p>
 
316
If <em class="parameter"><code>object</code></em> is not a <a class="link" href="GckObjectCache.html" title="GckObjectCache"><span class="type">GckObjectCache</span></a>, then the attributes will simply be
 
317
read from the object.
 
318
</p>
 
319
<p>
 
320
This will return immediately and complete asynchronously
 
321
</p>
 
322
<div class="variablelist"><table border="0">
 
323
<col align="left" valign="top">
 
324
<tbody>
 
325
<tr>
 
326
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
 
327
<td>the object</td>
 
328
</tr>
 
329
<tr>
 
330
<td><p><span class="term"><em class="parameter"><code>attr_types</code></em> :</span></p></td>
 
331
<td>the types of attributes to update. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_attr_types]</span>
 
332
</td>
 
333
</tr>
 
334
<tr>
 
335
<td><p><span class="term"><em class="parameter"><code>n_attr_types</code></em> :</span></p></td>
 
336
<td>the number of attribute types</td>
 
337
</tr>
 
338
<tr>
 
339
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
340
<td>optional cancellation object</td>
 
341
</tr>
 
342
<tr>
 
343
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
 
344
<td>called when the operation completes</td>
 
345
</tr>
 
346
<tr>
 
347
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
348
<td>data to pass to the callback</td>
 
349
</tr>
 
350
</tbody>
 
351
</table></div>
 
352
</div>
 
353
<hr>
 
354
<div class="refsect2">
 
355
<a name="gck-object-cache-lookup-finish"></a><h3>gck_object_cache_lookup_finish ()</h3>
 
356
<pre class="programlisting"><a class="link" href="GckAttributes.html" title="GckAttributes"><span class="returnvalue">GckAttributes</span></a> *     gck_object_cache_lookup_finish      (<em class="parameter"><code><a class="link" href="GckObject.html" title="GckObject"><span class="type">GckObject</span></a> *object</code></em>,
 
357
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
 
358
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
359
<p>
 
360
Complete an operation to lookup attributes in the cache or retrieve them
 
361
from the object if necessary.
 
362
</p>
 
363
<div class="variablelist"><table border="0">
 
364
<col align="left" valign="top">
 
365
<tbody>
 
366
<tr>
 
367
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
 
368
<td>the object</td>
 
369
</tr>
 
370
<tr>
 
371
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
 
372
<td>the asynchrounous result passed to the callback</td>
 
373
</tr>
 
374
<tr>
 
375
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
376
<td>location to place an error</td>
 
377
</tr>
 
378
<tr>
 
379
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
380
<td>the attributes retrieved or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on failure. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
381
</td>
 
382
</tr>
 
383
</tbody>
 
384
</table></div>
 
385
</div>
 
386
<hr>
 
387
<div class="refsect2">
 
388
<a name="gck-object-cache-update"></a><h3>gck_object_cache_update ()</h3>
 
389
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gck_object_cache_update             (<em class="parameter"><code><a class="link" href="GckObjectCache.html" title="GckObjectCache"><span class="type">GckObjectCache</span></a> *object</code></em>,
 
390
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> *attr_types</code></em>,
 
391
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_attr_types</code></em>,
 
392
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
393
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
394
<p>
 
395
Update the object cache with given attributes. If an attribute already
 
396
exists in the cache, it will be updated, and if it doesn't it will be added.
 
397
</p>
 
398
<p>
 
399
This may block, use the asynchronous version when this is not desirable
 
400
</p>
 
401
<div class="variablelist"><table border="0">
 
402
<col align="left" valign="top">
 
403
<tbody>
 
404
<tr>
 
405
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
 
406
<td>the object with the cache</td>
 
407
</tr>
 
408
<tr>
 
409
<td><p><span class="term"><em class="parameter"><code>attr_types</code></em> :</span></p></td>
 
410
<td>the types of attributes to update. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_attr_types]</span>
 
411
</td>
 
412
</tr>
 
413
<tr>
 
414
<td><p><span class="term"><em class="parameter"><code>n_attr_types</code></em> :</span></p></td>
 
415
<td>the number of attribute types</td>
 
416
</tr>
 
417
<tr>
 
418
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
419
<td>optional cancellation object</td>
 
420
</tr>
 
421
<tr>
 
422
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
423
<td>location to place an error</td>
 
424
</tr>
 
425
<tr>
 
426
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
427
<td>whether the cache update was successful</td>
 
428
</tr>
 
429
</tbody>
 
430
</table></div>
 
431
</div>
 
432
<hr>
 
433
<div class="refsect2">
 
434
<a name="gck-object-cache-update-async"></a><h3>gck_object_cache_update_async ()</h3>
 
435
<pre class="programlisting"><span class="returnvalue">void</span>                gck_object_cache_update_async       (<em class="parameter"><code><a class="link" href="GckObjectCache.html" title="GckObjectCache"><span class="type">GckObjectCache</span></a> *object</code></em>,
 
436
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gulong"><span class="type">gulong</span></a> *attr_types</code></em>,
 
437
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> n_attr_types</code></em>,
 
438
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
 
439
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
 
440
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
 
441
<p>
 
442
Update the object cache with given attributes. If an attribute already
 
443
exists in the cache, it will be updated, and if it doesn't it will be added.
 
444
</p>
 
445
<p>
 
446
This call will return immediately and complete asynchronously.
 
447
</p>
 
448
<div class="variablelist"><table border="0">
 
449
<col align="left" valign="top">
 
450
<tbody>
 
451
<tr>
 
452
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
 
453
<td>the object with the cache</td>
 
454
</tr>
 
455
<tr>
 
456
<td><p><span class="term"><em class="parameter"><code>attr_types</code></em> :</span></p></td>
 
457
<td>the types of attributes to update. <span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=n_attr_types]</span>
 
458
</td>
 
459
</tr>
 
460
<tr>
 
461
<td><p><span class="term"><em class="parameter"><code>n_attr_types</code></em> :</span></p></td>
 
462
<td>the number of attribute types</td>
 
463
</tr>
 
464
<tr>
 
465
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
466
<td>optional cancellation object</td>
 
467
</tr>
 
468
<tr>
 
469
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
 
470
<td>called when the operation completes</td>
 
471
</tr>
 
472
<tr>
 
473
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
474
<td>data to be passed to the callback</td>
 
475
</tr>
 
476
</tbody>
 
477
</table></div>
 
478
</div>
 
479
<hr>
 
480
<div class="refsect2">
 
481
<a name="gck-object-cache-update-finish"></a><h3>gck_object_cache_update_finish ()</h3>
 
482
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            gck_object_cache_update_finish      (<em class="parameter"><code><a class="link" href="GckObjectCache.html" title="GckObjectCache"><span class="type">GckObjectCache</span></a> *object</code></em>,
 
483
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gio/unstable/GAsyncResult.html"><span class="type">GAsyncResult</span></a> *result</code></em>,
 
484
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
485
<p>
 
486
Complete an asynchronous operation to update the object cache with given
 
487
attributes.
 
488
</p>
 
489
<div class="variablelist"><table border="0">
 
490
<col align="left" valign="top">
 
491
<tbody>
 
492
<tr>
 
493
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
 
494
<td>the object with the cache</td>
 
495
</tr>
 
496
<tr>
 
497
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
 
498
<td>the asynchronous result passed to the callback</td>
 
499
</tr>
 
500
<tr>
 
501
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
502
<td>location to place an error</td>
 
503
</tr>
 
504
<tr>
 
505
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
506
<td>whether the cache update was successful</td>
 
507
</tr>
 
508
</tbody>
 
509
</table></div>
 
510
</div>
 
511
</div>
 
512
<div class="refsect1">
 
513
<a name="GckObjectCache.property-details"></a><h2>Property Details</h2>
 
514
<div class="refsect2">
 
515
<a name="GckObjectCache--attributes"></a><h3>The <code class="literal">"attributes"</code> property</h3>
 
516
<pre class="programlisting">  "attributes"               <a class="link" href="GckAttributes.html" title="GckAttributes"><span class="type">GckAttributes</span></a>*        : Read / Write</pre>
 
517
<p>
 
518
The attributes cached on this object.
 
519
</p>
 
520
</div>
 
521
</div>
 
522
</div>
 
523
<div class="footer">
 
524
<hr>
 
525
          Generated by GTK-Doc V1.18</div>
 
526
</body>
 
527
</html>
 
 
b'\\ No newline at end of file'