<!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.28.1 (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">
<span class="returnvalue">gsize</span>
</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"> GObject
<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><span class="type">GHashTable</span> **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 <code class="literal">NULL</code>. </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 <code class="literal">NULL</code>,
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"><span class="returnvalue">gsize</span>
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>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.28.1</div>
</body>
</html>