/usr/share/gtk-doc/html/libsoup-2.4/SoupContentSniffer.html is in libsoup2.4-doc 2.52.2-1ubuntu0.3.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SoupContentSniffer: libsoup Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libsoup Reference Manual">
<link rel="up" href="ch03.html" title="Additional Features">
<link rel="prev" href="SoupContentDecoder.html" title="SoupContentDecoder">
<link rel="next" href="SoupCookieJar.html" title="SoupCookieJar">
<meta name="generator" content="GTK-Doc V1.25 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#SoupContentSniffer.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#SoupContentSniffer.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#SoupContentSniffer.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="SoupContentDecoder.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="SoupCookieJar.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="SoupContentSniffer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="SoupContentSniffer.top_of_page"></a>SoupContentSniffer</span></h2>
<p>SoupContentSniffer — Content sniffing for SoupSession</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="SoupContentSniffer.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="SoupContentSniffer.html" title="SoupContentSniffer"><span class="returnvalue">SoupContentSniffer</span></a> *
</td>
<td class="function_name">
<a class="link" href="SoupContentSniffer.html#soup-content-sniffer-new" title="soup_content_sniffer_new ()">soup_content_sniffer_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="SoupContentSniffer.html#soup-content-sniffer-sniff" title="soup_content_sniffer_sniff ()">soup_content_sniffer_sniff</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"><span class="returnvalue">gsize</span></a>
</td>
<td class="function_name">
<a class="link" href="SoupContentSniffer.html#soup-content-sniffer-get-buffer-size" title="soup_content_sniffer_get_buffer_size ()">soup_content_sniffer_get_buffer_size</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="SoupContentSniffer.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="SoupContentSniffer.html#SoupContentSniffer-struct" title="SoupContentSniffer">SoupContentSniffer</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="SoupContentSniffer.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> SoupContentSniffer
</pre>
</div>
<div class="refsect1">
<a name="SoupContentSniffer.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
SoupContentSniffer implements
<a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature">SoupSessionFeature</a> and SoupContentProcessor.</p>
</div>
<div class="refsect1">
<a name="SoupContentSniffer.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libsoup/soup.h>
</pre>
</div>
<div class="refsect1">
<a name="SoupContentSniffer.description"></a><h2>Description</h2>
<p>A <a class="link" href="SoupContentSniffer.html" title="SoupContentSniffer"><span class="type">SoupContentSniffer</span></a> tries to detect the actual content type of
the files that are being downloaded by looking at some of the data
before the <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> emits its <a class="link" href="SoupMessage.html#SoupMessage-got-headers" title="The “got-headers” signal"><span class="type">“got-headers”</span></a> signal.
<a class="link" href="SoupContentSniffer.html" title="SoupContentSniffer"><span class="type">SoupContentSniffer</span></a> implements <a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature"><span class="type">SoupSessionFeature</span></a>, so you can add
content sniffing to a session with <a class="link" href="SoupSession.html#soup-session-add-feature" title="soup_session_add_feature ()"><code class="function">soup_session_add_feature()</code></a> or
<a class="link" href="SoupSession.html#soup-session-add-feature-by-type" title="soup_session_add_feature_by_type ()"><code class="function">soup_session_add_feature_by_type()</code></a>.</p>
</div>
<div class="refsect1">
<a name="SoupContentSniffer.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="soup-content-sniffer-new"></a><h3>soup_content_sniffer_new ()</h3>
<pre class="programlisting"><a class="link" href="SoupContentSniffer.html" title="SoupContentSniffer"><span class="returnvalue">SoupContentSniffer</span></a> *
soup_content_sniffer_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="SoupContentSniffer.html" title="SoupContentSniffer"><span class="type">SoupContentSniffer</span></a>.</p>
<div class="refsect3">
<a name="soup-content-sniffer-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="SoupContentSniffer.html" title="SoupContentSniffer"><span class="type">SoupContentSniffer</span></a></p>
</div>
<p class="since">Since: 2.28</p>
</div>
<hr>
<div class="refsect2">
<a name="soup-content-sniffer-sniff"></a><h3>soup_content_sniffer_sniff ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> *
soup_content_sniffer_sniff (<em class="parameter"><code><a class="link" href="SoupContentSniffer.html" title="SoupContentSniffer"><span class="type">SoupContentSniffer</span></a> *sniffer</code></em>,
<em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>,
<em class="parameter"><code><a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> *buffer</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> **params</code></em>);</pre>
<p>Sniffs <em class="parameter"><code>buffer</code></em>
to determine its Content-Type. The result may also
be influenced by the Content-Type declared in <em class="parameter"><code>msg</code></em>
's response
headers.</p>
<div class="refsect3">
<a name="soup-content-sniffer-sniff.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>sniffer</p></td>
<td class="parameter_description"><p>a <a class="link" href="SoupContentSniffer.html" title="SoupContentSniffer"><span class="type">SoupContentSniffer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>msg</p></td>
<td class="parameter_description"><p>the message to sniff</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>buffer</p></td>
<td class="parameter_description"><p>a buffer containing the start of <em class="parameter"><code>msg</code></em>
's response body</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>params</p></td>
<td class="parameter_description"><p> return
location for Content-Type parameters (eg, "charset"), or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 utf8][<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<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></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="soup-content-sniffer-sniff.returns"></a><h4>Returns</h4>
<p> the sniffed Content-Type of <em class="parameter"><code>buffer</code></em>
; this will never be <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>,
but may be "application/octet-stream".</p>
</div>
<p class="since">Since: 2.28</p>
</div>
<hr>
<div class="refsect2">
<a name="soup-content-sniffer-get-buffer-size"></a><h3>soup_content_sniffer_get_buffer_size ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"><span class="returnvalue">gsize</span></a>
soup_content_sniffer_get_buffer_size (<em class="parameter"><code><a class="link" href="SoupContentSniffer.html" title="SoupContentSniffer"><span class="type">SoupContentSniffer</span></a> *sniffer</code></em>);</pre>
<p>Gets the number of bytes <em class="parameter"><code>sniffer</code></em>
needs in order to properly sniff
a buffer.</p>
<div class="refsect3">
<a name="soup-content-sniffer-get-buffer-size.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>sniffer</p></td>
<td class="parameter_description"><p>a <a class="link" href="SoupContentSniffer.html" title="SoupContentSniffer"><span class="type">SoupContentSniffer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="soup-content-sniffer-get-buffer-size.returns"></a><h4>Returns</h4>
<p> the number of bytes to sniff</p>
</div>
<p class="since">Since: 2.28</p>
</div>
</div>
<div class="refsect1">
<a name="SoupContentSniffer.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="SoupContentSniffer-struct"></a><h3>SoupContentSniffer</h3>
<pre class="programlisting">typedef struct _SoupContentSniffer SoupContentSniffer;</pre>
<p>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|