This file is indexed.

/usr/share/gtk-doc/html/libsoup-2.4/SoupCache.html is in libsoup2.4-doc 2.38.1-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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SoupCache</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="libsoup Reference Manual">
<link rel="up" href="ch07.html" title="Experimental streaming API">
<link rel="prev" href="SoupRequestData.html" title="SoupRequestData">
<link rel="next" href="ix01.html" title="Index">
<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="SoupRequestData.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch07.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">libsoup Reference Manual</th>
<td><a accesskey="n" href="ix01.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#SoupCache.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#SoupCache.description" class="shortcut">Description</a>
                   | 
                  <a href="#SoupCache.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#SoupCache.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
                   | 
                  <a href="#SoupCache.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="SoupCache"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="SoupCache.top_of_page"></a>SoupCache</span></h2>
<p>SoupCache</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="SoupCache.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libsoup/soup.h&gt;

struct              <a class="link" href="SoupCache.html#SoupCache-struct" title="struct SoupCache">SoupCache</a>;
enum                <a class="link" href="SoupCache.html#SoupCacheType" title="enum SoupCacheType">SoupCacheType</a>;
<a class="link" href="SoupCache.html" title="SoupCache"><span class="returnvalue">SoupCache</span></a> *         <a class="link" href="SoupCache.html#soup-cache-new" title="soup_cache_new ()">soup_cache_new</a>                      (<em class="parameter"><code>const <span class="type">char</span> *cache_dir</code></em>,
                                                         <em class="parameter"><code><a class="link" href="SoupCache.html#SoupCacheType" title="enum SoupCacheType"><span class="type">SoupCacheType</span></a> cache_type</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="SoupCache.html#soup-cache-flush" title="soup_cache_flush ()">soup_cache_flush</a>                    (<em class="parameter"><code><a class="link" href="SoupCache.html" title="SoupCache"><span class="type">SoupCache</span></a> *cache</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="SoupCache.html#soup-cache-clear" title="soup_cache_clear ()">soup_cache_clear</a>                    (<em class="parameter"><code><a class="link" href="SoupCache.html" title="SoupCache"><span class="type">SoupCache</span></a> *cache</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="SoupCache.html#soup-cache-dump" title="soup_cache_dump ()">soup_cache_dump</a>                     (<em class="parameter"><code><a class="link" href="SoupCache.html" title="SoupCache"><span class="type">SoupCache</span></a> *cache</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="SoupCache.html#soup-cache-load" title="soup_cache_load ()">soup_cache_load</a>                     (<em class="parameter"><code><a class="link" href="SoupCache.html" title="SoupCache"><span class="type">SoupCache</span></a> *cache</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="SoupCache.html#soup-cache-get-max-size" title="soup_cache_get_max_size ()">soup_cache_get_max_size</a>             (<em class="parameter"><code><a class="link" href="SoupCache.html" title="SoupCache"><span class="type">SoupCache</span></a> *cache</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="SoupCache.html#soup-cache-set-max-size" title="soup_cache_set_max_size ()">soup_cache_set_max_size</a>             (<em class="parameter"><code><a class="link" href="SoupCache.html" title="SoupCache"><span class="type">SoupCache</span></a> *cache</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> max_size</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="SoupCache.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----SoupCache
</pre>
</div>
<div class="refsect1">
<a name="SoupCache.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
SoupCache implements
 <a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature">SoupSessionFeature</a>.</p>
</div>
<div class="refsect1">
<a name="SoupCache.properties"></a><h2>Properties</h2>
<pre class="synopsis">
  "<a class="link" href="SoupCache.html#SoupCache--cache-dir" title='The "cache-dir" property'>cache-dir</a>"                <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only
  "<a class="link" href="SoupCache.html#SoupCache--cache-type" title='The "cache-type" property'>cache-type</a>"               <a class="link" href="SoupCache.html#SoupCacheType" title="enum SoupCacheType"><span class="type">SoupCacheType</span></a>         : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1">
<a name="SoupCache.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="SoupCache.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="SoupCache-struct"></a><h3>struct SoupCache</h3>
<pre class="programlisting">struct SoupCache;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="SoupCacheType"></a><h3>enum SoupCacheType</h3>
<pre class="programlisting">typedef enum {
	SOUP_CACHE_SINGLE_USER,
	SOUP_CACHE_SHARED
} SoupCacheType;
</pre>
<p>
The type of cache; this affects what kinds of responses will be
saved.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="SOUP-CACHE-SINGLE-USER:CAPS"></a><span class="term"><code class="literal">SOUP_CACHE_SINGLE_USER</code></span></p></td>
<td>a single-user cache
</td>
</tr>
<tr>
<td><p><a name="SOUP-CACHE-SHARED:CAPS"></a><span class="term"><code class="literal">SOUP_CACHE_SHARED</code></span></p></td>
<td>a shared cache
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.34</p>
</div>
<hr>
<div class="refsect2">
<a name="soup-cache-new"></a><h3>soup_cache_new ()</h3>
<pre class="programlisting"><a class="link" href="SoupCache.html" title="SoupCache"><span class="returnvalue">SoupCache</span></a> *         soup_cache_new                      (<em class="parameter"><code>const <span class="type">char</span> *cache_dir</code></em>,
                                                         <em class="parameter"><code><a class="link" href="SoupCache.html#SoupCacheType" title="enum SoupCacheType"><span class="type">SoupCacheType</span></a> cache_type</code></em>);</pre>
<p>
Creates a new <a class="link" href="SoupCache.html" title="SoupCache"><span class="type">SoupCache</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>cache_dir</code></em> :</span></p></td>
<td>the directory to store the cached data, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to use the default one</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cache_type</code></em> :</span></p></td>
<td>the <a class="link" href="SoupCache.html#SoupCacheType" title="enum SoupCacheType"><span class="type">SoupCacheType</span></a> of the cache</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="SoupCache.html" title="SoupCache"><span class="type">SoupCache</span></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.34</p>
</div>
<hr>
<div class="refsect2">
<a name="soup-cache-flush"></a><h3>soup_cache_flush ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                soup_cache_flush                    (<em class="parameter"><code><a class="link" href="SoupCache.html" title="SoupCache"><span class="type">SoupCache</span></a> *cache</code></em>);</pre>
<p>
This function will force all pending writes in the <em class="parameter"><code>cache</code></em> to be
committed to disk. For doing so it will iterate the <a href="/usr/share/gtk-doc/html/glib/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a>
associated with <em class="parameter"><code>cache</code></em>'s session as long as needed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>cache</code></em> :</span></p></td>
<td>a <a class="link" href="SoupCache.html" title="SoupCache"><span class="type">SoupCache</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.34</p>
</div>
<hr>
<div class="refsect2">
<a name="soup-cache-clear"></a><h3>soup_cache_clear ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                soup_cache_clear                    (<em class="parameter"><code><a class="link" href="SoupCache.html" title="SoupCache"><span class="type">SoupCache</span></a> *cache</code></em>);</pre>
<p>
Will remove all entries in the <em class="parameter"><code>cache</code></em> plus all the cache files
associated with them.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>cache</code></em> :</span></p></td>
<td>a <a class="link" href="SoupCache.html" title="SoupCache"><span class="type">SoupCache</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.34</p>
</div>
<hr>
<div class="refsect2">
<a name="soup-cache-dump"></a><h3>soup_cache_dump ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                soup_cache_dump                     (<em class="parameter"><code><a class="link" href="SoupCache.html" title="SoupCache"><span class="type">SoupCache</span></a> *cache</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="soup-cache-load"></a><h3>soup_cache_load ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                soup_cache_load                     (<em class="parameter"><code><a class="link" href="SoupCache.html" title="SoupCache"><span class="type">SoupCache</span></a> *cache</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="soup-cache-get-max-size"></a><h3>soup_cache_get_max_size ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               soup_cache_get_max_size             (<em class="parameter"><code><a class="link" href="SoupCache.html" title="SoupCache"><span class="type">SoupCache</span></a> *cache</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="soup-cache-set-max-size"></a><h3>soup_cache_set_max_size ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                soup_cache_set_max_size             (<em class="parameter"><code><a class="link" href="SoupCache.html" title="SoupCache"><span class="type">SoupCache</span></a> *cache</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> max_size</code></em>);</pre>
<p>
</p>
</div>
</div>
<div class="refsect1">
<a name="SoupCache.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="SoupCache--cache-dir"></a><h3>The <code class="literal">"cache-dir"</code> property</h3>
<pre class="programlisting">  "cache-dir"                <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct Only</pre>
<p>The directory to store the cache files.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="SoupCache--cache-type"></a><h3>The <code class="literal">"cache-type"</code> property</h3>
<pre class="programlisting">  "cache-type"               <a class="link" href="SoupCache.html#SoupCacheType" title="enum SoupCacheType"><span class="type">SoupCacheType</span></a>         : Read / Write / Construct Only</pre>
<p>Whether the cache is private or shared.</p>
<p>Default value: SOUP_CACHE_SINGLE_USER</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>