libchamplain-doc 0.12.2-1 / usr / share / gtk-doc / html / libchamplain / ChamplainFileCache.html

This file is indexed.

/usr/share/gtk-doc/html/libchamplain/ChamplainFileCache.html is in libchamplain-doc 0.12.2-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ChamplainFileCache</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="libchamplain Reference Manual">
<link rel="up" href="ch05.html" title="Tile Caches">
<link rel="prev" href="ChamplainTileCache.html" title="ChamplainTileCache">
<link rel="next" href="ChamplainMemoryCache.html" title="ChamplainMemoryCache">
<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="ChamplainTileCache.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch05.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">libchamplain Reference Manual</th>
<td><a accesskey="n" href="ChamplainMemoryCache.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#ChamplainFileCache.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#ChamplainFileCache.description" class="shortcut">Description</a>
                   | 
                  <a href="#ChamplainFileCache.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#ChamplainFileCache.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="ChamplainFileCache"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ChamplainFileCache.top_of_page"></a>ChamplainFileCache</span></h2>
<p>ChamplainFileCache — Stores and loads cached tiles from the file system</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="ChamplainFileCache.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct              <a class="link" href="ChamplainFileCache.html#ChamplainFileCache-struct" title="struct ChamplainFileCache">ChamplainFileCache</a>;
<a class="link" href="ChamplainFileCache.html" title="ChamplainFileCache"><span class="returnvalue">ChamplainFileCache</span></a> * <a class="link" href="ChamplainFileCache.html#champlain-file-cache-new-full" title="champlain_file_cache_new_full ()">champlain_file_cache_new_full</a>      (<em class="parameter"><code><span class="type">guint</span> size_limit</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *cache_dir</code></em>,
                                                         <em class="parameter"><code><a class="link" href="ChamplainRenderer.html" title="ChamplainRenderer"><span class="type">ChamplainRenderer</span></a> *renderer</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="ChamplainFileCache.html#champlain-file-cache-set-size-limit" title="champlain_file_cache_set_size_limit ()">champlain_file_cache_set_size_limit</a> (<em class="parameter"><code><a class="link" href="ChamplainFileCache.html" title="ChamplainFileCache"><span class="type">ChamplainFileCache</span></a> *file_cache</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> size_limit</code></em>);
<span class="returnvalue">guint</span>               <a class="link" href="ChamplainFileCache.html#champlain-file-cache-get-size-limit" title="champlain_file_cache_get_size_limit ()">champlain_file_cache_get_size_limit</a> (<em class="parameter"><code><a class="link" href="ChamplainFileCache.html" title="ChamplainFileCache"><span class="type">ChamplainFileCache</span></a> *file_cache</code></em>);
const <span class="returnvalue">gchar</span> *       <a class="link" href="ChamplainFileCache.html#champlain-file-cache-get-cache-dir" title="champlain_file_cache_get_cache_dir ()">champlain_file_cache_get_cache_dir</a>  (<em class="parameter"><code><a class="link" href="ChamplainFileCache.html" title="ChamplainFileCache"><span class="type">ChamplainFileCache</span></a> *file_cache</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="ChamplainFileCache.html#champlain-file-cache-purge" title="champlain_file_cache_purge ()">champlain_file_cache_purge</a>          (<em class="parameter"><code><a class="link" href="ChamplainFileCache.html" title="ChamplainFileCache"><span class="type">ChamplainFileCache</span></a> *file_cache</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="ChamplainFileCache.html#champlain-file-cache-purge-on-idle" title="champlain_file_cache_purge_on_idle ()">champlain_file_cache_purge_on_idle</a>  (<em class="parameter"><code><a class="link" href="ChamplainFileCache.html" title="ChamplainFileCache"><span class="type">ChamplainFileCache</span></a> *file_cache</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="ChamplainFileCache.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GObject
   +----GInitiallyUnowned
         +----<a class="link" href="ChamplainMapSource.html" title="ChamplainMapSource">ChamplainMapSource</a>
               +----<a class="link" href="ChamplainTileCache.html" title="ChamplainTileCache">ChamplainTileCache</a>
                     +----ChamplainFileCache
</pre>
</div>
<div class="refsect1">
<a name="ChamplainFileCache.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="ChamplainFileCache.html#ChamplainFileCache--cache-dir" title='The "cache-dir" property'>cache-dir</a>"                <span class="type">gchar</span>*                : Read / Write / Construct Only
  "<a class="link" href="ChamplainFileCache.html#ChamplainFileCache--size-limit" title='The "size-limit" property'>size-limit</a>"               <span class="type">guint</span>                 : Read / Write / Construct
</pre>
</div>
<div class="refsect1">
<a name="ChamplainFileCache.description"></a><h2>Description</h2>
<p>
<a class="link" href="ChamplainFileCache.html" title="ChamplainFileCache"><span class="type">ChamplainFileCache</span></a> is a cache that stores and retrieves tiles from the
file system. Tiles most frequently loaded gain in "popularity". This popularity
is taken into account when purging the cache.
</p>
</div>
<div class="refsect1">
<a name="ChamplainFileCache.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="ChamplainFileCache-struct"></a><h3>struct ChamplainFileCache</h3>
<pre class="programlisting">struct ChamplainFileCache;</pre>
<p>
The <a class="link" href="ChamplainFileCache.html" title="ChamplainFileCache"><span class="type">ChamplainFileCache</span></a> structure contains only private data
and should be accessed using the provided API
</p>
<p class="since">Since 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-file-cache-new-full"></a><h3>champlain_file_cache_new_full ()</h3>
<pre class="programlisting"><a class="link" href="ChamplainFileCache.html" title="ChamplainFileCache"><span class="returnvalue">ChamplainFileCache</span></a> * champlain_file_cache_new_full      (<em class="parameter"><code><span class="type">guint</span> size_limit</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *cache_dir</code></em>,
                                                         <em class="parameter"><code><a class="link" href="ChamplainRenderer.html" title="ChamplainRenderer"><span class="type">ChamplainRenderer</span></a> *renderer</code></em>);</pre>
<p>
Constructor of <a class="link" href="ChamplainFileCache.html" title="ChamplainFileCache"><span class="type">ChamplainFileCache</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>size_limit</code></em> :</span></p></td>
<td>maximal size of the cache in bytes</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cache_dir</code></em> :</span></p></td>
<td>the directory where the cache is created. When cache_dir == NULL,
a cache in ~/.cache/champlain is used. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>renderer</code></em> :</span></p></td>
<td>the <a class="link" href="ChamplainRenderer.html" title="ChamplainRenderer"><span class="type">ChamplainRenderer</span></a> used for tiles rendering</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a constructed <a class="link" href="ChamplainFileCache.html" title="ChamplainFileCache"><span class="type">ChamplainFileCache</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.8</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-file-cache-set-size-limit"></a><h3>champlain_file_cache_set_size_limit ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                champlain_file_cache_set_size_limit (<em class="parameter"><code><a class="link" href="ChamplainFileCache.html" title="ChamplainFileCache"><span class="type">ChamplainFileCache</span></a> *file_cache</code></em>,
                                                         <em class="parameter"><code><span class="type">guint</span> size_limit</code></em>);</pre>
<p>
Sets the cache size limit in bytes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>file_cache</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainFileCache.html" title="ChamplainFileCache"><span class="type">ChamplainFileCache</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>size_limit</code></em> :</span></p></td>
<td>the cache limit in bytes</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.4</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-file-cache-get-size-limit"></a><h3>champlain_file_cache_get_size_limit ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>               champlain_file_cache_get_size_limit (<em class="parameter"><code><a class="link" href="ChamplainFileCache.html" title="ChamplainFileCache"><span class="type">ChamplainFileCache</span></a> *file_cache</code></em>);</pre>
<p>
Gets the cache size limit in bytes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>file_cache</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainFileCache.html" title="ChamplainFileCache"><span class="type">ChamplainFileCache</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>size limit</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.4</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-file-cache-get-cache-dir"></a><h3>champlain_file_cache_get_cache_dir ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       champlain_file_cache_get_cache_dir  (<em class="parameter"><code><a class="link" href="ChamplainFileCache.html" title="ChamplainFileCache"><span class="type">ChamplainFileCache</span></a> *file_cache</code></em>);</pre>
<p>
Gets the directory where the cache database is stored.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>file_cache</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainFileCache.html" title="ChamplainFileCache"><span class="type">ChamplainFileCache</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the directory</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-file-cache-purge"></a><h3>champlain_file_cache_purge ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                champlain_file_cache_purge          (<em class="parameter"><code><a class="link" href="ChamplainFileCache.html" title="ChamplainFileCache"><span class="type">ChamplainFileCache</span></a> *file_cache</code></em>);</pre>
<p>
Purge the cache from the less popular tiles until cache's size limit is reached.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>file_cache</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainFileCache.html" title="ChamplainFileCache"><span class="type">ChamplainFileCache</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 0.4</p>
</div>
<hr>
<div class="refsect2">
<a name="champlain-file-cache-purge-on-idle"></a><h3>champlain_file_cache_purge_on_idle ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                champlain_file_cache_purge_on_idle  (<em class="parameter"><code><a class="link" href="ChamplainFileCache.html" title="ChamplainFileCache"><span class="type">ChamplainFileCache</span></a> *file_cache</code></em>);</pre>
<p>
Purge the cache from the less popular tiles until cache's size limit is reached.
This is a non blocking call as the purge will happen when the application is idle
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>file_cache</code></em> :</span></p></td>
<td>a <a class="link" href="ChamplainFileCache.html" title="ChamplainFileCache"><span class="type">ChamplainFileCache</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 0.4</p>
</div>
</div>
<div class="refsect1">
<a name="ChamplainFileCache.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="ChamplainFileCache--cache-dir"></a><h3>The <code class="literal">"cache-dir"</code> property</h3>
<pre class="programlisting">  "cache-dir"                <span class="type">gchar</span>*                : Read / Write / Construct Only</pre>
<p>
The directory where the tile database is stored.
</p>
<p>Default value: NULL</p>
<p class="since">Since 0.6</p>
</div>
<hr>
<div class="refsect2">
<a name="ChamplainFileCache--size-limit"></a><h3>The <code class="literal">"size-limit"</code> property</h3>
<pre class="programlisting">  "size-limit"               <span class="type">guint</span>                 : Read / Write / Construct</pre>
<p>
The cache size limit in bytes.
</p>
<p>
Note: this new value will not be applied until you call <span class="type">champlain_cache_purge</span>
</p>
<p>Allowed values: [1,G_MAXLONG]</p>
<p>Default value: 100000000</p>
<p class="since">Since 0.4</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.