diff options
Diffstat (limited to 'docs/reference/html')
62 files changed, 0 insertions, 37819 deletions
diff --git a/docs/reference/html/SoupAddress.html b/docs/reference/html/SoupAddress.html deleted file mode 100644 index 1a8f8ae8..00000000 --- a/docs/reference/html/SoupAddress.html +++ /dev/null @@ -1,1079 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SoupAddress: 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="ch05.html" title="Low-level Networking API"> -<link rel="prev" href="ch05.html" title="Low-level Networking API"> -<link rel="next" href="SoupSocket.html" title="SoupSocket"> -<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="#SoupAddress.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupAddress.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> - <a href="#SoupAddress.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> - <a href="#SoupAddress.properties" class="shortcut">Properties</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="ch05.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="ch05.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="SoupSocket.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="SoupAddress"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="SoupAddress.top_of_page"></a>SoupAddress</span></h2> -<p>SoupAddress — DNS support</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="SoupAddress.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="SoupAddress.html" title="SoupAddress"><span class="returnvalue">SoupAddress</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupAddress.html#soup-address-new" title="soup_address_new ()">soup_address_new</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupAddress.html" title="SoupAddress"><span class="returnvalue">SoupAddress</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupAddress.html#soup-address-new-from-sockaddr" title="soup_address_new_from_sockaddr ()">soup_address_new_from_sockaddr</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupAddress.html" title="SoupAddress"><span class="returnvalue">SoupAddress</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupAddress.html#soup-address-new-any" title="soup_address_new_any ()">soup_address_new_any</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<span class="c_punctuation">(</span><a class="link" href="SoupAddress.html#SoupAddressCallback" title="SoupAddressCallback ()">*SoupAddressCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupAddress.html#soup-address-resolve-async" title="soup_address_resolve_async ()">soup_address_resolve_async</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">guint</span> -</td> -<td class="function_name"> -<a class="link" href="SoupAddress.html#soup-address-resolve-sync" title="soup_address_resolve_sync ()">soup_address_resolve_sync</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupAddress.html#soup-address-is-resolved" title="soup_address_is_resolved ()">soup_address_is_resolved</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupAddress.html#soup-address-get-name" title="soup_address_get_name ()">soup_address_get_name</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">struct <span class="returnvalue">sockaddr</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupAddress.html#soup-address-get-sockaddr" title="soup_address_get_sockaddr ()">soup_address_get_sockaddr</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GSocketAddress</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupAddress.html#soup-address-get-gsockaddr" title="soup_address_get_gsockaddr ()">soup_address_get_gsockaddr</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupAddress.html#soup-address-get-physical" title="soup_address_get_physical ()">soup_address_get_physical</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">guint</span> -</td> -<td class="function_name"> -<a class="link" href="SoupAddress.html#soup-address-get-port" title="soup_address_get_port ()">soup_address_get_port</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupAddress.html#soup-address-equal-by-name" title="soup_address_equal_by_name ()">soup_address_equal_by_name</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">guint</span> -</td> -<td class="function_name"> -<a class="link" href="SoupAddress.html#soup-address-hash-by-name" title="soup_address_hash_by_name ()">soup_address_hash_by_name</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupAddress.html#soup-address-equal-by-ip" title="soup_address_equal_by_ip ()">soup_address_equal_by_ip</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">guint</span> -</td> -<td class="function_name"> -<a class="link" href="SoupAddress.html#soup-address-hash-by-ip" title="soup_address_hash_by_ip ()">soup_address_hash_by_ip</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupAddress.properties"></a><h2>Properties</h2> -<div class="informaltable"><table class="informaltable" border="0"> -<colgroup> -<col width="150px" class="properties_type"> -<col width="300px" class="properties_name"> -<col width="200px" class="properties_flags"> -</colgroup> -<tbody> -<tr> -<td class="property_type"><a class="link" href="SoupAddress.html#SoupAddressFamily" title="enum SoupAddressFamily"><span class="type">SoupAddressFamily</span></a></td> -<td class="property_name"><a class="link" href="SoupAddress.html#SoupAddress--family" title="The “family” property">family</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">gchar</span> *</td> -<td class="property_name"><a class="link" href="SoupAddress.html#SoupAddress--name" title="The “name” property">name</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">gchar</span> *</td> -<td class="property_name"><a class="link" href="SoupAddress.html#SoupAddress--physical" title="The “physical” property">physical</a></td> -<td class="property_flags">Read</td> -</tr> -<tr> -<td class="property_type"><span class="type">gint</span></td> -<td class="property_name"><a class="link" href="SoupAddress.html#SoupAddress--port" title="The “port” property">port</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">gchar</span> *</td> -<td class="property_name"><a class="link" href="SoupAddress.html#SoupAddress--protocol" title="The “protocol” property">protocol</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -<tr> -<td class="property_type"><span class="type">gpointer</span></td> -<td class="property_name"><a class="link" href="SoupAddress.html#SoupAddress--sockaddr" title="The “sockaddr” property">sockaddr</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupAddress.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="SoupAddress.html#SoupAddress-struct" title="SoupAddress">SoupAddress</a></td> -</tr> -<tr> -<td class="datatype_keyword">enum</td> -<td class="function_name"><a class="link" href="SoupAddress.html#SoupAddressFamily" title="enum SoupAddressFamily">SoupAddressFamily</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupAddress.html#SOUP-ADDRESS-ANY-PORT:CAPS" title="SOUP_ADDRESS_ANY_PORT">SOUP_ADDRESS_ANY_PORT</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupAddress.html#SOUP-ADDRESS-FAMILY:CAPS" title="SOUP_ADDRESS_FAMILY">SOUP_ADDRESS_FAMILY</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupAddress.html#SOUP-ADDRESS-NAME:CAPS" title="SOUP_ADDRESS_NAME">SOUP_ADDRESS_NAME</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupAddress.html#SOUP-ADDRESS-PHYSICAL:CAPS" title="SOUP_ADDRESS_PHYSICAL">SOUP_ADDRESS_PHYSICAL</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupAddress.html#SOUP-ADDRESS-PORT:CAPS" title="SOUP_ADDRESS_PORT">SOUP_ADDRESS_PORT</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupAddress.html#SOUP-ADDRESS-SOCKADDR:CAPS" title="SOUP_ADDRESS_SOCKADDR">SOUP_ADDRESS_SOCKADDR</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupAddress.html#SOUP-ADDRESS-PROTOCOL:CAPS" title="SOUP_ADDRESS_PROTOCOL">SOUP_ADDRESS_PROTOCOL</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupAddress.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> GObject - <span class="lineart">╰──</span> SoupAddress -</pre> -</div> -<div class="refsect1"> -<a name="SoupAddress.implemented-interfaces"></a><h2>Implemented Interfaces</h2> -<p> -SoupAddress implements - GSocketConnectable.</p> -</div> -<div class="refsect1"> -<a name="SoupAddress.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="SoupAddress.description"></a><h2>Description</h2> -<p><a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> represents the address of a TCP connection endpoint: -both the IP address and the port. (It is somewhat like an -object-oriented version of struct sockaddr.)</p> -<p>Although <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> is still used in some libsoup API's, it -should not be used in new code; use GLib's <span class="type">GNetworkAddress</span> or -<span class="type">GSocketAddress</span> instead.</p> -</div> -<div class="refsect1"> -<a name="SoupAddress.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="soup-address-new"></a><h3>soup_address_new ()</h3> -<pre class="programlisting"><a class="link" href="SoupAddress.html" title="SoupAddress"><span class="returnvalue">SoupAddress</span></a> * -soup_address_new (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>, - <em class="parameter"><code><span class="type">guint</span> port</code></em>);</pre> -<p>Creates a <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> from <em class="parameter"><code>name</code></em> - and <em class="parameter"><code>port</code></em> -. The <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a>'s IP -address may not be available right away; the caller can call -<a class="link" href="SoupAddress.html#soup-address-resolve-async" title="soup_address_resolve_async ()"><code class="function">soup_address_resolve_async()</code></a> or <a class="link" href="SoupAddress.html#soup-address-resolve-sync" title="soup_address_resolve_sync ()"><code class="function">soup_address_resolve_sync()</code></a> to -force a DNS resolution.</p> -<div class="refsect3"> -<a name="soup-address-new.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>name</p></td> -<td class="parameter_description"><p>a hostname or physical address</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>port</p></td> -<td class="parameter_description"><p>a port number</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-address-new.returns"></a><h4>Returns</h4> -<p> a <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-address-new-from-sockaddr"></a><h3>soup_address_new_from_sockaddr ()</h3> -<pre class="programlisting"><a class="link" href="SoupAddress.html" title="SoupAddress"><span class="returnvalue">SoupAddress</span></a> * -soup_address_new_from_sockaddr (<em class="parameter"><code><span class="type">struct sockaddr</span> *sa</code></em>, - <em class="parameter"><code><span class="type">int</span> len</code></em>);</pre> -<p>Returns a <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> equivalent to <em class="parameter"><code>sa</code></em> - (or <code class="literal">NULL</code> if <em class="parameter"><code>sa</code></em> -'s -address family isn't supported)</p> -<div class="refsect3"> -<a name="soup-address-new-from-sockaddr.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>sa</p></td> -<td class="parameter_description"><p>a pointer to a sockaddr</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>len</p></td> -<td class="parameter_description"><p>size of <em class="parameter"><code>sa</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-address-new-from-sockaddr.returns"></a><h4>Returns</h4> -<p>the new <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a>. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-address-new-any"></a><h3>soup_address_new_any ()</h3> -<pre class="programlisting"><a class="link" href="SoupAddress.html" title="SoupAddress"><span class="returnvalue">SoupAddress</span></a> * -soup_address_new_any (<em class="parameter"><code><a class="link" href="SoupAddress.html#SoupAddressFamily" title="enum SoupAddressFamily"><span class="type">SoupAddressFamily</span></a> family</code></em>, - <em class="parameter"><code><span class="type">guint</span> port</code></em>);</pre> -<p>Returns a <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> corresponding to the "any" address -for <em class="parameter"><code>family</code></em> - (or <code class="literal">NULL</code> if <em class="parameter"><code>family</code></em> - isn't supported), suitable for -using as a listening <a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a>.</p> -<div class="refsect3"> -<a name="soup-address-new-any.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>family</p></td> -<td class="parameter_description"><p>the address family</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>port</p></td> -<td class="parameter_description"><p>the port number (usually <a class="link" href="SoupAddress.html#SOUP-ADDRESS-ANY-PORT:CAPS" title="SOUP_ADDRESS_ANY_PORT"><code class="literal">SOUP_ADDRESS_ANY_PORT</code></a>)</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-address-new-any.returns"></a><h4>Returns</h4> -<p>the new <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a>. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SoupAddressCallback"></a><h3>SoupAddressCallback ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -<span class="c_punctuation">(</span>*SoupAddressCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> *addr</code></em>, - <em class="parameter"><code><span class="type">guint</span> status</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> -<p>The callback function passed to <a class="link" href="SoupAddress.html#soup-address-resolve-async" title="soup_address_resolve_async ()"><code class="function">soup_address_resolve_async()</code></a>.</p> -<div class="refsect3"> -<a name="SoupAddressCallback.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>addr</p></td> -<td class="parameter_description"><p>the <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> that was resolved</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>status</p></td> -<td class="parameter_description"><p><a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-OK:CAPS"><code class="literal">SOUP_STATUS_OK</code></a>, <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-CANT-RESOLVE:CAPS"><code class="literal">SOUP_STATUS_CANT_RESOLVE</code></a>, or -<a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-CANCELLED:CAPS"><code class="literal">SOUP_STATUS_CANCELLED</code></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>the user data that was passed to -<a class="link" href="SoupAddress.html#soup-address-resolve-async" title="soup_address_resolve_async ()"><code class="function">soup_address_resolve_async()</code></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-address-resolve-async"></a><h3>soup_address_resolve_async ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_address_resolve_async (<em class="parameter"><code><a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> *addr</code></em>, - <em class="parameter"><code><span class="type">GMainContext</span> *async_context</code></em>, - <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>, - <em class="parameter"><code><a class="link" href="SoupAddress.html#SoupAddressCallback" title="SoupAddressCallback ()"><span class="type">SoupAddressCallback</span></a> callback</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> -<p>Asynchronously resolves the missing half of <em class="parameter"><code>addr</code></em> - (its IP address -if it was created with <a class="link" href="SoupAddress.html#soup-address-new" title="soup_address_new ()"><code class="function">soup_address_new()</code></a>, or its hostname if it -was created with <a class="link" href="SoupAddress.html#soup-address-new-from-sockaddr" title="soup_address_new_from_sockaddr ()"><code class="function">soup_address_new_from_sockaddr()</code></a> or -<a class="link" href="SoupAddress.html#soup-address-new-any" title="soup_address_new_any ()"><code class="function">soup_address_new_any()</code></a>.)</p> -<p>If <em class="parameter"><code>cancellable</code></em> - is non-<code class="literal">NULL</code>, it can be used to cancel the -resolution. <em class="parameter"><code>callback</code></em> - will still be invoked in this case, with a -status of <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-CANCELLED:CAPS"><code class="literal">SOUP_STATUS_CANCELLED</code></a>.</p> -<p>It is safe to call this more than once on a given address, from the -same thread, with the same <em class="parameter"><code>async_context</code></em> - (and doing so will not -result in redundant DNS queries being made). But it is not safe to -call from multiple threads, or with different <em class="parameter"><code>async_contexts</code></em> -, or -mixed with calls to <a class="link" href="SoupAddress.html#soup-address-resolve-sync" title="soup_address_resolve_sync ()"><code class="function">soup_address_resolve_sync()</code></a>.</p> -<div class="refsect3"> -<a name="soup-address-resolve-async.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>addr</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>async_context</p></td> -<td class="parameter_description"><p>the <span class="type">GMainContext</span> to call <em class="parameter"><code>callback</code></em> -from. </p></td> -<td class="parameter_annotations"><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 class="parameter_name"><p>cancellable</p></td> -<td class="parameter_description"><p>a <span class="type">GCancellable</span> object, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>callback</p></td> -<td class="parameter_description"><p>callback to call with the result. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>data for <em class="parameter"><code>callback</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-address-resolve-sync"></a><h3>soup_address_resolve_sync ()</h3> -<pre class="programlisting"><span class="returnvalue">guint</span> -soup_address_resolve_sync (<em class="parameter"><code><a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> *addr</code></em>, - <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>);</pre> -<p>Synchronously resolves the missing half of <em class="parameter"><code>addr</code></em> -, as with -<a class="link" href="SoupAddress.html#soup-address-resolve-async" title="soup_address_resolve_async ()"><code class="function">soup_address_resolve_async()</code></a>.</p> -<p>If <em class="parameter"><code>cancellable</code></em> - is non-<code class="literal">NULL</code>, it can be used to cancel the -resolution. <a class="link" href="SoupAddress.html#soup-address-resolve-sync" title="soup_address_resolve_sync ()"><code class="function">soup_address_resolve_sync()</code></a> will then return a status -of <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-CANCELLED:CAPS"><code class="literal">SOUP_STATUS_CANCELLED</code></a>.</p> -<p>It is safe to call this more than once, even from different -threads, but it is not safe to mix calls to -<a class="link" href="SoupAddress.html#soup-address-resolve-sync" title="soup_address_resolve_sync ()"><code class="function">soup_address_resolve_sync()</code></a> with calls to -<a class="link" href="SoupAddress.html#soup-address-resolve-async" title="soup_address_resolve_async ()"><code class="function">soup_address_resolve_async()</code></a> on the same address.</p> -<div class="refsect3"> -<a name="soup-address-resolve-sync.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>addr</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>cancellable</p></td> -<td class="parameter_description"><p>a <span class="type">GCancellable</span> object, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-address-resolve-sync.returns"></a><h4>Returns</h4> -<p> <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-OK:CAPS"><code class="literal">SOUP_STATUS_OK</code></a>, <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-CANT-RESOLVE:CAPS"><code class="literal">SOUP_STATUS_CANT_RESOLVE</code></a>, or -<a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-CANCELLED:CAPS"><code class="literal">SOUP_STATUS_CANCELLED</code></a>.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-address-is-resolved"></a><h3>soup_address_is_resolved ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_address_is_resolved (<em class="parameter"><code><a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> *addr</code></em>);</pre> -<p>Tests if <em class="parameter"><code>addr</code></em> - has already been resolved. Unlike the other -<a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> "get" methods, this is safe to call when <em class="parameter"><code>addr</code></em> - might -be being resolved in another thread.</p> -<div class="refsect3"> -<a name="soup-address-is-resolved.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>addr</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-address-is-resolved.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if <em class="parameter"><code>addr</code></em> -has been resolved.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-address-get-name"></a><h3>soup_address_get_name ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -soup_address_get_name (<em class="parameter"><code><a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> *addr</code></em>);</pre> -<p>Returns the hostname associated with <em class="parameter"><code>addr</code></em> -.</p> -<p>This method is not thread-safe; if you call it while <em class="parameter"><code>addr</code></em> - is being -resolved in another thread, it may return garbage. You can use -<a class="link" href="SoupAddress.html#soup-address-is-resolved" title="soup_address_is_resolved ()"><code class="function">soup_address_is_resolved()</code></a> to safely test whether or not an address -is resolved before fetching its name or address.</p> -<div class="refsect3"> -<a name="soup-address-get-name.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>addr</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-address-get-name.returns"></a><h4>Returns</h4> -<p>the hostname, or <code class="literal">NULL</code> if it is not known. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-address-get-sockaddr"></a><h3>soup_address_get_sockaddr ()</h3> -<pre class="programlisting">struct <span class="returnvalue">sockaddr</span> * -soup_address_get_sockaddr (<em class="parameter"><code><a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> *addr</code></em>, - <em class="parameter"><code><span class="type">int</span> *len</code></em>);</pre> -<p>Returns the sockaddr associated with <em class="parameter"><code>addr</code></em> -, with its length in -*<em class="parameter"><code>len</code></em> -. If the sockaddr is not yet known, returns <code class="literal">NULL</code>.</p> -<p>This method is not thread-safe; if you call it while <em class="parameter"><code>addr</code></em> - is being -resolved in another thread, it may return garbage. You can use -<a class="link" href="SoupAddress.html#soup-address-is-resolved" title="soup_address_is_resolved ()"><code class="function">soup_address_is_resolved()</code></a> to safely test whether or not an address -is resolved before fetching its name or address.</p> -<div class="refsect3"> -<a name="soup-address-get-sockaddr.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>addr</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>len</p></td> -<td class="parameter_description"><p>return location for sockaddr length</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-address-get-sockaddr.returns"></a><h4>Returns</h4> -<p>the sockaddr, or <code class="literal">NULL</code>. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-address-get-gsockaddr"></a><h3>soup_address_get_gsockaddr ()</h3> -<pre class="programlisting"><span class="returnvalue">GSocketAddress</span> * -soup_address_get_gsockaddr (<em class="parameter"><code><a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> *addr</code></em>);</pre> -<p>Creates a new <span class="type">GSocketAddress</span> corresponding to <em class="parameter"><code>addr</code></em> - (which is assumed -to only have one socket address associated with it).</p> -<div class="refsect3"> -<a name="soup-address-get-gsockaddr.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>addr</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-address-get-gsockaddr.returns"></a><h4>Returns</h4> -<p>a new <span class="type">GSocketAddress</span>. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.32</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-address-get-physical"></a><h3>soup_address_get_physical ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -soup_address_get_physical (<em class="parameter"><code><a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> *addr</code></em>);</pre> -<p>Returns the physical address associated with <em class="parameter"><code>addr</code></em> - as a string. -(Eg, "127.0.0.1"). If the address is not yet known, returns <code class="literal">NULL</code>.</p> -<p>This method is not thread-safe; if you call it while <em class="parameter"><code>addr</code></em> - is being -resolved in another thread, it may return garbage. You can use -<a class="link" href="SoupAddress.html#soup-address-is-resolved" title="soup_address_is_resolved ()"><code class="function">soup_address_is_resolved()</code></a> to safely test whether or not an address -is resolved before fetching its name or address.</p> -<div class="refsect3"> -<a name="soup-address-get-physical.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>addr</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-address-get-physical.returns"></a><h4>Returns</h4> -<p>the physical address, or <code class="literal">NULL</code>. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-address-get-port"></a><h3>soup_address_get_port ()</h3> -<pre class="programlisting"><span class="returnvalue">guint</span> -soup_address_get_port (<em class="parameter"><code><a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> *addr</code></em>);</pre> -<p>Returns the port associated with <em class="parameter"><code>addr</code></em> -.</p> -<div class="refsect3"> -<a name="soup-address-get-port.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>addr</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-address-get-port.returns"></a><h4>Returns</h4> -<p> the port</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-address-equal-by-name"></a><h3>soup_address_equal_by_name ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_address_equal_by_name (<em class="parameter"><code><span class="type">gconstpointer</span> addr1</code></em>, - <em class="parameter"><code><span class="type">gconstpointer</span> addr2</code></em>);</pre> -<p>Tests if <em class="parameter"><code>addr1</code></em> - and <em class="parameter"><code>addr2</code></em> - have the same "name". This method can be -used with <a class="link" href="SoupAddress.html#soup-address-hash-by-name" title="soup_address_hash_by_name ()"><code class="function">soup_address_hash_by_name()</code></a> to create a <span class="type">GHashTable</span> that -hashes on address "names".</p> -<p>Comparing by name normally means comparing the addresses by their -hostnames. But if the address was originally created using an IP -address literal, then it will be compared by that instead.</p> -<p>In particular, if "www.example.com" has the IP address 10.0.0.1, -and <em class="parameter"><code>addr1</code></em> - was created with the name "www.example.com" and <em class="parameter"><code>addr2</code></em> - -was created with the name "10.0.0.1", then they will compare as -unequal for purposes of <a class="link" href="SoupAddress.html#soup-address-equal-by-name" title="soup_address_equal_by_name ()"><code class="function">soup_address_equal_by_name()</code></a>.</p> -<p>This would be used to distinguish hosts in situations where -different virtual hosts on the same IP address should be considered -different. Eg, for purposes of HTTP authentication or cookies, two -hosts with the same IP address but different names are considered -to be different hosts.</p> -<p>See also <a class="link" href="SoupAddress.html#soup-address-equal-by-ip" title="soup_address_equal_by_ip ()"><code class="function">soup_address_equal_by_ip()</code></a>, which compares by IP address -rather than by name.</p> -<div class="refsect3"> -<a name="soup-address-equal-by-name.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>addr1</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> with a resolved name. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Soup.Address]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>addr2</p></td> -<td class="parameter_description"><p>another <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> with a resolved -name. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Soup.Address]</span></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-address-equal-by-name.returns"></a><h4>Returns</h4> -<p> whether or not <em class="parameter"><code>addr1</code></em> -and <em class="parameter"><code>addr2</code></em> -have the same name</p> -</div> -<p class="since">Since: 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-address-hash-by-name"></a><h3>soup_address_hash_by_name ()</h3> -<pre class="programlisting"><span class="returnvalue">guint</span> -soup_address_hash_by_name (<em class="parameter"><code><span class="type">gconstpointer</span> addr</code></em>);</pre> -<p>A hash function (for <span class="type">GHashTable</span>) that corresponds to -<a class="link" href="SoupAddress.html#soup-address-equal-by-name" title="soup_address_equal_by_name ()"><code class="function">soup_address_equal_by_name()</code></a>, qv</p> -<div class="refsect3"> -<a name="soup-address-hash-by-name.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>addr</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a>. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Soup.Address]</span></td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-address-hash-by-name.returns"></a><h4>Returns</h4> -<p> the named-based hash value for <em class="parameter"><code>addr</code></em> -.</p> -</div> -<p class="since">Since: 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-address-equal-by-ip"></a><h3>soup_address_equal_by_ip ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_address_equal_by_ip (<em class="parameter"><code><span class="type">gconstpointer</span> addr1</code></em>, - <em class="parameter"><code><span class="type">gconstpointer</span> addr2</code></em>);</pre> -<p>Tests if <em class="parameter"><code>addr1</code></em> - and <em class="parameter"><code>addr2</code></em> - have the same IP address. This method -can be used with <a class="link" href="SoupAddress.html#soup-address-hash-by-ip" title="soup_address_hash_by_ip ()"><code class="function">soup_address_hash_by_ip()</code></a> to create a -<span class="type">GHashTable</span> that hashes on IP address.</p> -<p>This would be used to distinguish hosts in situations where -different virtual hosts on the same IP address should be considered -the same. Eg, if "www.example.com" and "www.example.net" have the -same IP address, then a single connection can be used to talk -to either of them.</p> -<p>See also <a class="link" href="SoupAddress.html#soup-address-equal-by-name" title="soup_address_equal_by_name ()"><code class="function">soup_address_equal_by_name()</code></a>, which compares by name -rather than by IP address.</p> -<div class="refsect3"> -<a name="soup-address-equal-by-ip.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>addr1</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> with a resolved IP -address. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Soup.Address]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>addr2</p></td> -<td class="parameter_description"><p>another <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> with a resolved -IP address. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Soup.Address]</span></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-address-equal-by-ip.returns"></a><h4>Returns</h4> -<p> whether or not <em class="parameter"><code>addr1</code></em> -and <em class="parameter"><code>addr2</code></em> -have the same IP -address.</p> -</div> -<p class="since">Since: 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-address-hash-by-ip"></a><h3>soup_address_hash_by_ip ()</h3> -<pre class="programlisting"><span class="returnvalue">guint</span> -soup_address_hash_by_ip (<em class="parameter"><code><span class="type">gconstpointer</span> addr</code></em>);</pre> -<p>A hash function (for <span class="type">GHashTable</span>) that corresponds to -<a class="link" href="SoupAddress.html#soup-address-equal-by-ip" title="soup_address_equal_by_ip ()"><code class="function">soup_address_equal_by_ip()</code></a>, qv</p> -<div class="refsect3"> -<a name="soup-address-hash-by-ip.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>addr</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a>. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Soup.Address]</span></td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-address-hash-by-ip.returns"></a><h4>Returns</h4> -<p> the IP-based hash value for <em class="parameter"><code>addr</code></em> -.</p> -</div> -<p class="since">Since: 2.26</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupAddress.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupAddress-struct"></a><h3>SoupAddress</h3> -<pre class="programlisting">typedef struct _SoupAddress SoupAddress;</pre> -</div> -<hr> -<div class="refsect2"> -<a name="SoupAddressFamily"></a><h3>enum SoupAddressFamily</h3> -<p>The supported address families.</p> -<div class="refsect3"> -<a name="SoupAddressFamily.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="enum_members_name"> -<col class="enum_members_description"> -<col width="200px" class="enum_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="enum_member_name"><p><a name="SOUP-ADDRESS-FAMILY-INVALID:CAPS"></a>SOUP_ADDRESS_FAMILY_INVALID</p></td> -<td class="enum_member_description"> -<p>an invalid <a class="link" href="SoupAddress.html" title="SoupAddress"><code class="literal">SoupAddress</code></a></p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-ADDRESS-FAMILY-IPV4:CAPS"></a>SOUP_ADDRESS_FAMILY_IPV4</p></td> -<td class="enum_member_description"> -<p>an IPv4 address</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-ADDRESS-FAMILY-IPV6:CAPS"></a>SOUP_ADDRESS_FAMILY_IPV6</p></td> -<td class="enum_member_description"> -<p>an IPv6 address</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-ADDRESS-ANY-PORT:CAPS"></a><h3>SOUP_ADDRESS_ANY_PORT</h3> -<pre class="programlisting">#define SOUP_ADDRESS_ANY_PORT 0 -</pre> -<p>This can be passed to any <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> method that expects a port, -to indicate that you don't care what port is used.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-ADDRESS-FAMILY:CAPS"></a><h3>SOUP_ADDRESS_FAMILY</h3> -<pre class="programlisting">#define SOUP_ADDRESS_FAMILY "family" -</pre> -<p>Alias for the <a class="link" href="SoupAddress.html#SoupAddress--family" title="The “family” property"><span class="type">“family”</span></a> property. (The -<a class="link" href="SoupAddress.html#SoupAddressFamily" title="enum SoupAddressFamily"><span class="type">SoupAddressFamily</span></a> for this address.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-ADDRESS-NAME:CAPS"></a><h3>SOUP_ADDRESS_NAME</h3> -<pre class="programlisting">#define SOUP_ADDRESS_NAME "name" -</pre> -<p>Alias for the <a class="link" href="SoupAddress.html#SoupAddress--name" title="The “name” property"><span class="type">“name”</span></a> property. (The hostname for -this address.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-ADDRESS-PHYSICAL:CAPS"></a><h3>SOUP_ADDRESS_PHYSICAL</h3> -<pre class="programlisting">#define SOUP_ADDRESS_PHYSICAL "physical" -</pre> -<p>An alias for the <a class="link" href="SoupAddress.html#SoupAddress--physical" title="The “physical” property"><span class="type">“physical”</span></a> property. (The -stringified IP address for this address.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-ADDRESS-PORT:CAPS"></a><h3>SOUP_ADDRESS_PORT</h3> -<pre class="programlisting">#define SOUP_ADDRESS_PORT "port" -</pre> -<p>An alias for the <a class="link" href="SoupAddress.html#SoupAddress--port" title="The “port” property"><span class="type">“port”</span></a> property. (The port for -this address.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-ADDRESS-SOCKADDR:CAPS"></a><h3>SOUP_ADDRESS_SOCKADDR</h3> -<pre class="programlisting">#define SOUP_ADDRESS_SOCKADDR "sockaddr" -</pre> -<p>An alias for the <a class="link" href="SoupAddress.html#SoupAddress--sockaddr" title="The “sockaddr” property"><span class="type">“sockaddr”</span></a> property. (A pointer -to the struct sockaddr for this address.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-ADDRESS-PROTOCOL:CAPS"></a><h3>SOUP_ADDRESS_PROTOCOL</h3> -<pre class="programlisting">#define SOUP_ADDRESS_PROTOCOL "protocol" -</pre> -<p>Alias for the <a class="link" href="SoupAddress.html#SoupAddress--protocol" title="The “protocol” property"><span class="type">“protocol”</span></a> property. (The URI scheme -used with this address.)</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupAddress.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> -<a name="SoupAddress--family"></a><h3>The <code class="literal">“family”</code> property</h3> -<pre class="programlisting"> “family” <a class="link" href="SoupAddress.html#SoupAddressFamily" title="enum SoupAddressFamily"><span class="type">SoupAddressFamily</span></a></pre> -<p>Address family for this address.</p> -<p>Flags: Read / Write / Construct Only</p> -<p>Default value: SOUP_ADDRESS_FAMILY_INVALID</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupAddress--name"></a><h3>The <code class="literal">“name”</code> property</h3> -<pre class="programlisting"> “name” <span class="type">gchar</span> *</pre> -<p>Hostname for this address.</p> -<p>Flags: Read / Write / Construct Only</p> -<p>Default value: NULL</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupAddress--physical"></a><h3>The <code class="literal">“physical”</code> property</h3> -<pre class="programlisting"> “physical” <span class="type">gchar</span> *</pre> -<p>IP address for this address.</p> -<p>Flags: Read</p> -<p>Default value: NULL</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupAddress--port"></a><h3>The <code class="literal">“port”</code> property</h3> -<pre class="programlisting"> “port” <span class="type">gint</span></pre> -<p>Port for this address.</p> -<p>Flags: Read / Write / Construct Only</p> -<p>Allowed values: [-1,65535]</p> -<p>Default value: -1</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupAddress--protocol"></a><h3>The <code class="literal">“protocol”</code> property</h3> -<pre class="programlisting"> “protocol” <span class="type">gchar</span> *</pre> -<p>URI scheme for this address.</p> -<p>Flags: Read / Write / Construct Only</p> -<p>Default value: NULL</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupAddress--sockaddr"></a><h3>The <code class="literal">“sockaddr”</code> property</h3> -<pre class="programlisting"> “sockaddr” <span class="type">gpointer</span></pre> -<p>struct sockaddr for this address.</p> -<p>Flags: Read / Write / Construct Only</p> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/SoupAuth.html b/docs/reference/html/SoupAuth.html deleted file mode 100644 index fb2a7a7d..00000000 --- a/docs/reference/html/SoupAuth.html +++ /dev/null @@ -1,921 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SoupAuth: 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="ch02.html" title="Core API"> -<link rel="prev" href="ch02.html" title="Core API"> -<link rel="next" href="SoupAuthDomain.html" title="SoupAuthDomain"> -<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="#SoupAuth.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupAuth.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> - <a href="#SoupAuth.properties" class="shortcut">Properties</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="ch02.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="SoupAuthDomain.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="SoupAuth"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="SoupAuth.top_of_page"></a>SoupAuth</span></h2> -<p>SoupAuth — HTTP client-side authentication support</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="SoupAuth.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="SoupAuth.html" title="SoupAuth"><span class="returnvalue">SoupAuth</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupAuth.html#soup-auth-new" title="soup_auth_new ()">soup_auth_new</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupAuth.html#soup-auth-update" title="soup_auth_update ()">soup_auth_update</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupAuth.html#soup-auth-negotiate-supported" title="soup_auth_negotiate_supported ()">soup_auth_negotiate_supported</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupAuth.html#soup-auth-is-for-proxy" title="soup_auth_is_for_proxy ()">soup_auth_is_for_proxy</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupAuth.html#soup-auth-get-scheme-name" title="soup_auth_get_scheme_name ()">soup_auth_get_scheme_name</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupAuth.html#soup-auth-get-host" title="soup_auth_get_host ()">soup_auth_get_host</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupAuth.html#soup-auth-get-realm" title="soup_auth_get_realm ()">soup_auth_get_realm</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="SoupAuth.html#soup-auth-get-info" title="soup_auth_get_info ()">soup_auth_get_info</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupAuth.html#soup-auth-authenticate" title="soup_auth_authenticate ()">soup_auth_authenticate</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupAuth.html#soup-auth-can-authenticate" title="soup_auth_can_authenticate ()">soup_auth_can_authenticate</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupAuth.html#soup-auth-is-authenticated" title="soup_auth_is_authenticated ()">soup_auth_is_authenticated</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupAuth.html#soup-auth-is-ready" title="soup_auth_is_ready ()">soup_auth_is_ready</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="SoupAuth.html#soup-auth-get-authorization" title="soup_auth_get_authorization ()">soup_auth_get_authorization</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GSList</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupAuth.html#soup-auth-get-protection-space" title="soup_auth_get_protection_space ()">soup_auth_get_protection_space</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupAuth.html#soup-auth-free-protection-space" title="soup_auth_free_protection_space ()">soup_auth_free_protection_space</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupAuth.properties"></a><h2>Properties</h2> -<div class="informaltable"><table class="informaltable" border="0"> -<colgroup> -<col width="150px" class="properties_type"> -<col width="300px" class="properties_name"> -<col width="200px" class="properties_flags"> -</colgroup> -<tbody> -<tr> -<td class="property_type"> -<span class="type">gchar</span> *</td> -<td class="property_name"><a class="link" href="SoupAuth.html#SoupAuth--host" title="The “host” property">host</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><span class="type">gboolean</span></td> -<td class="property_name"><a class="link" href="SoupAuth.html#SoupAuth--is-authenticated" title="The “is-authenticated” property">is-authenticated</a></td> -<td class="property_flags">Read</td> -</tr> -<tr> -<td class="property_type"><span class="type">gboolean</span></td> -<td class="property_name"><a class="link" href="SoupAuth.html#SoupAuth--is-for-proxy" title="The “is-for-proxy” property">is-for-proxy</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">gchar</span> *</td> -<td class="property_name"><a class="link" href="SoupAuth.html#SoupAuth--realm" title="The “realm” property">realm</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">gchar</span> *</td> -<td class="property_name"><a class="link" href="SoupAuth.html#SoupAuth--scheme-name" title="The “scheme-name” property">scheme-name</a></td> -<td class="property_flags">Read</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupAuth.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="SoupAuth.html#SoupAuth-struct" title="SoupAuth">SoupAuth</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupAuth.html#SOUP-TYPE-AUTH-BASIC:CAPS" title="SOUP_TYPE_AUTH_BASIC">SOUP_TYPE_AUTH_BASIC</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupAuth.html#SOUP-TYPE-AUTH-DIGEST:CAPS" title="SOUP_TYPE_AUTH_DIGEST">SOUP_TYPE_AUTH_DIGEST</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupAuth.html#SOUP-TYPE-AUTH-NTLM:CAPS" title="SOUP_TYPE_AUTH_NTLM">SOUP_TYPE_AUTH_NTLM</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupAuth.html#SOUP-TYPE-AUTH-NEGOTIATE:CAPS" title="SOUP_TYPE_AUTH_NEGOTIATE">SOUP_TYPE_AUTH_NEGOTIATE</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupAuth.html#SOUP-AUTH-SCHEME-NAME:CAPS" title="SOUP_AUTH_SCHEME_NAME">SOUP_AUTH_SCHEME_NAME</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupAuth.html#SOUP-AUTH-REALM:CAPS" title="SOUP_AUTH_REALM">SOUP_AUTH_REALM</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupAuth.html#SOUP-AUTH-HOST:CAPS" title="SOUP_AUTH_HOST">SOUP_AUTH_HOST</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupAuth.html#SOUP-AUTH-IS-FOR-PROXY:CAPS" title="SOUP_AUTH_IS_FOR_PROXY">SOUP_AUTH_IS_FOR_PROXY</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupAuth.html#SOUP-AUTH-IS-AUTHENTICATED:CAPS" title="SOUP_AUTH_IS_AUTHENTICATED">SOUP_AUTH_IS_AUTHENTICATED</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupAuth.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> GObject - <span class="lineart">╰──</span> SoupAuth -</pre> -</div> -<div class="refsect1"> -<a name="SoupAuth.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="SoupAuth.description"></a><h2>Description</h2> -<p><a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a> objects store the authentication data associated with a -given bit of web space. They are created automatically by -<a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a>.</p> -</div> -<div class="refsect1"> -<a name="SoupAuth.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="soup-auth-new"></a><h3>soup_auth_new ()</h3> -<pre class="programlisting"><a class="link" href="SoupAuth.html" title="SoupAuth"><span class="returnvalue">SoupAuth</span></a> * -soup_auth_new (<em class="parameter"><code><span class="type">GType</span> type</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>const <span class="type">char</span> *auth_header</code></em>);</pre> -<p>Creates a new <a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a> of type <em class="parameter"><code>type</code></em> - with the information from -<em class="parameter"><code>msg</code></em> - and <em class="parameter"><code>auth_header</code></em> -.</p> -<p>This is called by <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a>; you will normally not create auths -yourself.</p> -<div class="refsect3"> -<a name="soup-auth-new.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>type</p></td> -<td class="parameter_description"><p>the type of auth to create (a subtype of <a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</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 <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> the auth is being created for</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>auth_header</p></td> -<td class="parameter_description"><p>the WWW-Authenticate/Proxy-Authenticate header</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-auth-new.returns"></a><h4>Returns</h4> -<p>the new <a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a>, or <code class="literal">NULL</code> if it could -not be created. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-auth-update"></a><h3>soup_auth_update ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_auth_update (<em class="parameter"><code><a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a> *auth</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>const <span class="type">char</span> *auth_header</code></em>);</pre> -<p>Updates <em class="parameter"><code>auth</code></em> - with the information from <em class="parameter"><code>msg</code></em> - and <em class="parameter"><code>auth_header</code></em> -, -possibly un-authenticating it. As with <a class="link" href="SoupAuth.html#soup-auth-new" title="soup_auth_new ()"><code class="function">soup_auth_new()</code></a>, this is -normally only used by <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a>.</p> -<div class="refsect3"> -<a name="soup-auth-update.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>auth</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</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 <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> <em class="parameter"><code>auth</code></em> -is being updated for</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>auth_header</p></td> -<td class="parameter_description"><p>the WWW-Authenticate/Proxy-Authenticate header</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-auth-update.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if <em class="parameter"><code>auth</code></em> -is still a valid (but potentially -unauthenticated) <a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a>. <code class="literal">FALSE</code> if something about <em class="parameter"><code>auth_params</code></em> -could not be parsed or incorporated into <em class="parameter"><code>auth</code></em> -at all.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-auth-negotiate-supported"></a><h3>soup_auth_negotiate_supported ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_auth_negotiate_supported (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> -<p>Indicates whether libsoup was built with GSSAPI support. If this is -<code class="literal">FALSE</code>, <a class="link" href="SoupAuth.html#SOUP-TYPE-AUTH-NEGOTIATE:CAPS" title="SOUP_TYPE_AUTH_NEGOTIATE"><code class="literal">SOUP_TYPE_AUTH_NEGOTIATE</code></a> will still be defined and can -still be added to a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a>, but libsoup will never attempt to -actually use this auth type.</p> -<p class="since">Since: 2.54</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-auth-is-for-proxy"></a><h3>soup_auth_is_for_proxy ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_auth_is_for_proxy (<em class="parameter"><code><a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a> *auth</code></em>);</pre> -<p>Tests whether or not <em class="parameter"><code>auth</code></em> - is associated with a proxy server rather -than an "origin" server.</p> -<div class="refsect3"> -<a name="soup-auth-is-for-proxy.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>auth</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-auth-is-for-proxy.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> or <code class="literal">FALSE</code></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-auth-get-scheme-name"></a><h3>soup_auth_get_scheme_name ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -soup_auth_get_scheme_name (<em class="parameter"><code><a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a> *auth</code></em>);</pre> -<p>Returns <em class="parameter"><code>auth</code></em> -'s scheme name. (Eg, "Basic", "Digest", or "NTLM")</p> -<div class="refsect3"> -<a name="soup-auth-get-scheme-name.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>auth</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-auth-get-scheme-name.returns"></a><h4>Returns</h4> -<p> the scheme name</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-auth-get-host"></a><h3>soup_auth_get_host ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -soup_auth_get_host (<em class="parameter"><code><a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a> *auth</code></em>);</pre> -<p>Returns the host that <em class="parameter"><code>auth</code></em> - is associated with.</p> -<div class="refsect3"> -<a name="soup-auth-get-host.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>auth</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-auth-get-host.returns"></a><h4>Returns</h4> -<p> the hostname</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-auth-get-realm"></a><h3>soup_auth_get_realm ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -soup_auth_get_realm (<em class="parameter"><code><a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a> *auth</code></em>);</pre> -<p>Returns <em class="parameter"><code>auth</code></em> -'s realm. This is an identifier that distinguishes -separate authentication spaces on a given server, and may be some -string that is meaningful to the user. (Although it is probably not -localized.)</p> -<div class="refsect3"> -<a name="soup-auth-get-realm.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>auth</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-auth-get-realm.returns"></a><h4>Returns</h4> -<p> the realm name</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-auth-get-info"></a><h3>soup_auth_get_info ()</h3> -<pre class="programlisting"><span class="returnvalue">char</span> * -soup_auth_get_info (<em class="parameter"><code><a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a> *auth</code></em>);</pre> -<p>Gets an opaque identifier for <em class="parameter"><code>auth</code></em> -, for use as a hash key or the -like. <a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a> objects from the same server with the same -identifier refer to the same authentication domain (eg, the URLs -associated with them take the same usernames and passwords).</p> -<div class="refsect3"> -<a name="soup-auth-get-info.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>auth</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-auth-get-info.returns"></a><h4>Returns</h4> -<p> the identifier</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-auth-authenticate"></a><h3>soup_auth_authenticate ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_auth_authenticate (<em class="parameter"><code><a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a> *auth</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *username</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *password</code></em>);</pre> -<p>Call this on an auth to authenticate it; normally this will cause -the auth's message to be requeued with the new authentication info.</p> -<div class="refsect3"> -<a name="soup-auth-authenticate.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>auth</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>username</p></td> -<td class="parameter_description"><p>the username provided by the user or client</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>password</p></td> -<td class="parameter_description"><p>the password provided by the user or client</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-auth-can-authenticate"></a><h3>soup_auth_can_authenticate ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_auth_can_authenticate (<em class="parameter"><code><a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a> *auth</code></em>);</pre> -<p>Tests if <em class="parameter"><code>auth</code></em> - is able to authenticate by providing credentials to the -<a class="link" href="SoupAuth.html#soup-auth-authenticate" title="soup_auth_authenticate ()"><code class="function">soup_auth_authenticate()</code></a>.</p> -<div class="refsect3"> -<a name="soup-auth-can-authenticate.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>auth</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-auth-can-authenticate.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if <em class="parameter"><code>auth</code></em> -is able to accept credentials.</p> -</div> -<p class="since">Since: 2.54</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-auth-is-authenticated"></a><h3>soup_auth_is_authenticated ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_auth_is_authenticated (<em class="parameter"><code><a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a> *auth</code></em>);</pre> -<p>Tests if <em class="parameter"><code>auth</code></em> - has been given a username and password</p> -<div class="refsect3"> -<a name="soup-auth-is-authenticated.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>auth</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-auth-is-authenticated.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if <em class="parameter"><code>auth</code></em> -has been given a username and password</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-auth-is-ready"></a><h3>soup_auth_is_ready ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_auth_is_ready (<em class="parameter"><code><a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a> *auth</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>);</pre> -<p>Tests if <em class="parameter"><code>auth</code></em> - is ready to make a request for <em class="parameter"><code>msg</code></em> - with. For most -auths, this is equivalent to <a class="link" href="SoupAuth.html#soup-auth-is-authenticated" title="soup_auth_is_authenticated ()"><code class="function">soup_auth_is_authenticated()</code></a>, but for -some auth types (eg, NTLM), the auth may be sendable (eg, as an -authentication request) even before it is authenticated.</p> -<div class="refsect3"> -<a name="soup-auth-is-ready.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>auth</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-auth-is-ready.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if <em class="parameter"><code>auth</code></em> -is ready to make a request with.</p> -</div> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-auth-get-authorization"></a><h3>soup_auth_get_authorization ()</h3> -<pre class="programlisting"><span class="returnvalue">char</span> * -soup_auth_get_authorization (<em class="parameter"><code><a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a> *auth</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>);</pre> -<p>Generates an appropriate "Authorization" header for <em class="parameter"><code>msg</code></em> -. (The -session will only call this if <a class="link" href="SoupAuth.html#soup-auth-is-authenticated" title="soup_auth_is_authenticated ()"><code class="function">soup_auth_is_authenticated()</code></a> -returned <code class="literal">TRUE</code>.)</p> -<div class="refsect3"> -<a name="soup-auth-get-authorization.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>auth</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</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 <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> to be authorized</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-auth-get-authorization.returns"></a><h4>Returns</h4> -<p> the "Authorization" header, which must be freed.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-auth-get-protection-space"></a><h3>soup_auth_get_protection_space ()</h3> -<pre class="programlisting"><span class="returnvalue">GSList</span> * -soup_auth_get_protection_space (<em class="parameter"><code><a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a> *auth</code></em>, - <em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *source_uri</code></em>);</pre> -<p>Returns a list of paths on the server which <em class="parameter"><code>auth</code></em> - extends over. -(All subdirectories of these paths are also assumed to be part -of <em class="parameter"><code>auth</code></em> -'s protection space, unless otherwise discovered not to -be.)</p> -<div class="refsect3"> -<a name="soup-auth-get-protection-space.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>auth</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>source_uri</p></td> -<td class="parameter_description"><p>the URI of the request that <em class="parameter"><code>auth</code></em> -was generated in -response to.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-auth-get-protection-space.returns"></a><h4>Returns</h4> -<p>the list of -paths, which can be freed with <a class="link" href="SoupAuth.html#soup-auth-free-protection-space" title="soup_auth_free_protection_space ()"><code class="function">soup_auth_free_protection_space()</code></a>. </p> -<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-auth-free-protection-space"></a><h3>soup_auth_free_protection_space ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_auth_free_protection_space (<em class="parameter"><code><a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a> *auth</code></em>, - <em class="parameter"><code><span class="type">GSList</span> *space</code></em>);</pre> -<p>Frees <em class="parameter"><code>space</code></em> -.</p> -<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> -<div class="refsect3"> -<a name="soup-auth-free-protection-space.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>auth</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>space</p></td> -<td class="parameter_description"><p>the return value from <a class="link" href="SoupAuth.html#soup-auth-get-protection-space" title="soup_auth_get_protection_space ()"><code class="function">soup_auth_get_protection_space()</code></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -</div> -<div class="refsect1"> -<a name="SoupAuth.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupAuth-struct"></a><h3>SoupAuth</h3> -<pre class="programlisting">typedef struct _SoupAuth SoupAuth;</pre> -<p>The abstract base class for handling authentication. Specific HTTP -Authentication mechanisms are implemented by its subclasses, but -applications never need to be aware of the specific subclasses -being used.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-TYPE-AUTH-BASIC:CAPS"></a><h3>SOUP_TYPE_AUTH_BASIC</h3> -<pre class="programlisting">#define SOUP_TYPE_AUTH_BASIC (soup_auth_basic_get_type ()) -</pre> -<p>A <span class="type">GType</span> corresponding to HTTP "Basic" authentication. -<a href="SoupSession.html#SoupSession-struct"><span class="type">SoupSessions</span></a> support this by default; if you want to disable -support for it, call <a class="link" href="SoupSession.html#soup-session-remove-feature-by-type" title="soup_session_remove_feature_by_type ()"><code class="function">soup_session_remove_feature_by_type()</code></a>, -passing <a class="link" href="SoupAuth.html#SOUP-TYPE-AUTH-BASIC:CAPS" title="SOUP_TYPE_AUTH_BASIC"><code class="literal">SOUP_TYPE_AUTH_BASIC</code></a>.</p> -<p class="since">Since: 2.34</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-TYPE-AUTH-DIGEST:CAPS"></a><h3>SOUP_TYPE_AUTH_DIGEST</h3> -<pre class="programlisting">#define SOUP_TYPE_AUTH_DIGEST (soup_auth_digest_get_type ()) -</pre> -<p>A <span class="type">GType</span> corresponding to HTTP "Digest" authentication. -<a href="SoupSession.html#SoupSession-struct"><span class="type">SoupSessions</span></a> support this by default; if you want to disable -support for it, call <a class="link" href="SoupSession.html#soup-session-remove-feature-by-type" title="soup_session_remove_feature_by_type ()"><code class="function">soup_session_remove_feature_by_type()</code></a>, -passing <a class="link" href="SoupAuth.html#SOUP-TYPE-AUTH-DIGEST:CAPS" title="SOUP_TYPE_AUTH_DIGEST"><code class="literal">SOUP_TYPE_AUTH_DIGEST</code></a>.</p> -<p class="since">Since: 2.34</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-TYPE-AUTH-NTLM:CAPS"></a><h3>SOUP_TYPE_AUTH_NTLM</h3> -<pre class="programlisting">#define SOUP_TYPE_AUTH_NTLM (soup_auth_ntlm_get_type ()) -</pre> -<p>A <span class="type">GType</span> corresponding to HTTP-based NTLM authentication. -<a href="SoupSession.html#SoupSession-struct"><span class="type">SoupSessions</span></a> do not support this type by default; if you want to -enable support for it, call <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>, -passing <a class="link" href="SoupAuth.html#SOUP-TYPE-AUTH-NTLM:CAPS" title="SOUP_TYPE_AUTH_NTLM"><code class="literal">SOUP_TYPE_AUTH_NTLM</code></a>.</p> -<p class="since">Since: 2.34</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-TYPE-AUTH-NEGOTIATE:CAPS"></a><h3>SOUP_TYPE_AUTH_NEGOTIATE</h3> -<pre class="programlisting">#define SOUP_TYPE_AUTH_NEGOTIATE (soup_auth_negotiate_get_type ()) -</pre> -<p>A <span class="type">GType</span> corresponding to HTTP-based GSS-Negotiate authentication. -<a href="SoupSession.html#SoupSession-struct"><span class="type">SoupSessions</span></a> do not support this type by default; if you want to -enable support for it, call <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>, -passing <a class="link" href="SoupAuth.html#SOUP-TYPE-AUTH-NEGOTIATE:CAPS" title="SOUP_TYPE_AUTH_NEGOTIATE"><code class="literal">SOUP_TYPE_AUTH_NEGOTIATE</code></a>.</p> -<p>This auth type will only work if libsoup was compiled with GSSAPI -support; you can check <a class="link" href="SoupAuth.html#soup-auth-negotiate-supported" title="soup_auth_negotiate_supported ()"><code class="function">soup_auth_negotiate_supported()</code></a> to see if it -was.</p> -<p class="since">Since: 2.54</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-AUTH-SCHEME-NAME:CAPS"></a><h3>SOUP_AUTH_SCHEME_NAME</h3> -<pre class="programlisting">#define SOUP_AUTH_SCHEME_NAME "scheme-name" -</pre> -<p>An alias for the <a class="link" href="SoupAuth.html#SoupAuth--scheme-name" title="The “scheme-name” property"><span class="type">“scheme-name”</span></a> property. (The -authentication scheme name.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-AUTH-REALM:CAPS"></a><h3>SOUP_AUTH_REALM</h3> -<pre class="programlisting">#define SOUP_AUTH_REALM "realm" -</pre> -<p>An alias for the <a class="link" href="SoupAuth.html#SoupAuth--realm" title="The “realm” property"><span class="type">“realm”</span></a> property. (The -authentication realm.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-AUTH-HOST:CAPS"></a><h3>SOUP_AUTH_HOST</h3> -<pre class="programlisting">#define SOUP_AUTH_HOST "host" -</pre> -<p>An alias for the <a class="link" href="SoupAuth.html#SoupAuth--host" title="The “host” property"><span class="type">“host”</span></a> property. (The -host being authenticated to.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-AUTH-IS-FOR-PROXY:CAPS"></a><h3>SOUP_AUTH_IS_FOR_PROXY</h3> -<pre class="programlisting">#define SOUP_AUTH_IS_FOR_PROXY "is-for-proxy" -</pre> -<p>An alias for the <a class="link" href="SoupAuth.html#SoupAuth--is-for-proxy" title="The “is-for-proxy” property"><span class="type">“is-for-proxy”</span></a> property. (Whether -or not the auth is for a proxy server.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-AUTH-IS-AUTHENTICATED:CAPS"></a><h3>SOUP_AUTH_IS_AUTHENTICATED</h3> -<pre class="programlisting">#define SOUP_AUTH_IS_AUTHENTICATED "is-authenticated" -</pre> -<p>An alias for the <a class="link" href="SoupAuth.html#SoupAuth--is-authenticated" title="The “is-authenticated” property"><span class="type">“is-authenticated”</span></a> property. -(Whether or not the auth has been authenticated.)</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupAuth.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> -<a name="SoupAuth--host"></a><h3>The <code class="literal">“host”</code> property</h3> -<pre class="programlisting"> “host” <span class="type">gchar</span> *</pre> -<p>Authentication host.</p> -<p>Flags: Read / Write</p> -<p>Default value: NULL</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupAuth--is-authenticated"></a><h3>The <code class="literal">“is-authenticated”</code> property</h3> -<pre class="programlisting"> “is-authenticated” <span class="type">gboolean</span></pre> -<p>Whether or not the auth is authenticated.</p> -<p>Flags: Read</p> -<p>Default value: FALSE</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupAuth--is-for-proxy"></a><h3>The <code class="literal">“is-for-proxy”</code> property</h3> -<pre class="programlisting"> “is-for-proxy” <span class="type">gboolean</span></pre> -<p>Whether or not the auth is for a proxy server.</p> -<p>Flags: Read / Write</p> -<p>Default value: FALSE</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupAuth--realm"></a><h3>The <code class="literal">“realm”</code> property</h3> -<pre class="programlisting"> “realm” <span class="type">gchar</span> *</pre> -<p>Authentication realm.</p> -<p>Flags: Read / Write</p> -<p>Default value: NULL</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupAuth--scheme-name"></a><h3>The <code class="literal">“scheme-name”</code> property</h3> -<pre class="programlisting"> “scheme-name” <span class="type">gchar</span> *</pre> -<p>Authentication scheme name.</p> -<p>Flags: Read</p> -<p>Default value: NULL</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupAuth.see-also"></a><h2>See Also</h2> -<p><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a></p> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/SoupAuthDomain.html b/docs/reference/html/SoupAuthDomain.html deleted file mode 100644 index dcc3d3d2..00000000 --- a/docs/reference/html/SoupAuthDomain.html +++ /dev/null @@ -1,928 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SoupAuthDomain: 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="ch02.html" title="Core API"> -<link rel="prev" href="SoupAuth.html" title="SoupAuth"> -<link rel="next" href="SoupAuthDomainBasic.html" title="SoupAuthDomainBasic"> -<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="#SoupAuthDomain.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupAuthDomain.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> - <a href="#SoupAuthDomain.properties" class="shortcut">Properties</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="SoupAuth.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="SoupAuthDomainBasic.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="SoupAuthDomain"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="SoupAuthDomain.top_of_page"></a>SoupAuthDomain</span></h2> -<p>SoupAuthDomain — Server-side authentication</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="SoupAuthDomain.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"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupAuthDomain.html#soup-auth-domain-add-path" title="soup_auth_domain_add_path ()">soup_auth_domain_add_path</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupAuthDomain.html#soup-auth-domain-remove-path" title="soup_auth_domain_remove_path ()">soup_auth_domain_remove_path</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<span class="c_punctuation">(</span><a class="link" href="SoupAuthDomain.html#SoupAuthDomainFilter" title="SoupAuthDomainFilter ()">*SoupAuthDomainFilter</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupAuthDomain.html#soup-auth-domain-set-filter" title="soup_auth_domain_set_filter ()">soup_auth_domain_set_filter</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupAuthDomain.html#soup-auth-domain-get-realm" title="soup_auth_domain_get_realm ()">soup_auth_domain_get_realm</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<span class="c_punctuation">(</span><a class="link" href="SoupAuthDomain.html#SoupAuthDomainGenericAuthCallback" title="SoupAuthDomainGenericAuthCallback ()">*SoupAuthDomainGenericAuthCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupAuthDomain.html#soup-auth-domain-set-generic-auth-callback" title="soup_auth_domain_set_generic_auth_callback ()">soup_auth_domain_set_generic_auth_callback</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupAuthDomain.html#soup-auth-domain-check-password" title="soup_auth_domain_check_password ()">soup_auth_domain_check_password</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupAuthDomain.html#soup-auth-domain-covers" title="soup_auth_domain_covers ()">soup_auth_domain_covers</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="SoupAuthDomain.html#soup-auth-domain-accepts" title="soup_auth_domain_accepts ()">soup_auth_domain_accepts</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupAuthDomain.html#soup-auth-domain-challenge" title="soup_auth_domain_challenge ()">soup_auth_domain_challenge</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupAuthDomain.properties"></a><h2>Properties</h2> -<div class="informaltable"><table class="informaltable" border="0"> -<colgroup> -<col width="150px" class="properties_type"> -<col width="300px" class="properties_name"> -<col width="200px" class="properties_flags"> -</colgroup> -<tbody> -<tr> -<td class="property_type"> -<span class="type">gchar</span> *</td> -<td class="property_name"><a class="link" href="SoupAuthDomain.html#SoupAuthDomain--add-path" title="The “add-path” property">add-path</a></td> -<td class="property_flags">Write</td> -</tr> -<tr> -<td class="property_type"><span class="type">gpointer</span></td> -<td class="property_name"><a class="link" href="SoupAuthDomain.html#SoupAuthDomain--filter" title="The “filter” property">filter</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><span class="type">gpointer</span></td> -<td class="property_name"><a class="link" href="SoupAuthDomain.html#SoupAuthDomain--filter-data" title="The “filter-data” property">filter-data</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><span class="type">gpointer</span></td> -<td class="property_name"><a class="link" href="SoupAuthDomain.html#SoupAuthDomain--generic-auth-callback" title="The “generic-auth-callback” property">generic-auth-callback</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><span class="type">gpointer</span></td> -<td class="property_name"><a class="link" href="SoupAuthDomain.html#SoupAuthDomain--generic-auth-data" title="The “generic-auth-data” property">generic-auth-data</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><span class="type">gboolean</span></td> -<td class="property_name"><a class="link" href="SoupAuthDomain.html#SoupAuthDomain--proxy" title="The “proxy” property">proxy</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">gchar</span> *</td> -<td class="property_name"><a class="link" href="SoupAuthDomain.html#SoupAuthDomain--realm" title="The “realm” property">realm</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">gchar</span> *</td> -<td class="property_name"><a class="link" href="SoupAuthDomain.html#SoupAuthDomain--remove-path" title="The “remove-path” property">remove-path</a></td> -<td class="property_flags">Write</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupAuthDomain.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="SoupAuthDomain.html#SoupAuthDomain-struct" title="SoupAuthDomain">SoupAuthDomain</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-REALM:CAPS" title="SOUP_AUTH_DOMAIN_REALM">SOUP_AUTH_DOMAIN_REALM</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-PROXY:CAPS" title="SOUP_AUTH_DOMAIN_PROXY">SOUP_AUTH_DOMAIN_PROXY</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-ADD-PATH:CAPS" title="SOUP_AUTH_DOMAIN_ADD_PATH">SOUP_AUTH_DOMAIN_ADD_PATH</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-REMOVE-PATH:CAPS" title="SOUP_AUTH_DOMAIN_REMOVE_PATH">SOUP_AUTH_DOMAIN_REMOVE_PATH</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-FILTER:CAPS" title="SOUP_AUTH_DOMAIN_FILTER">SOUP_AUTH_DOMAIN_FILTER</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-FILTER-DATA:CAPS" title="SOUP_AUTH_DOMAIN_FILTER_DATA">SOUP_AUTH_DOMAIN_FILTER_DATA</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-GENERIC-AUTH-CALLBACK:CAPS" title="SOUP_AUTH_DOMAIN_GENERIC_AUTH_CALLBACK">SOUP_AUTH_DOMAIN_GENERIC_AUTH_CALLBACK</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-GENERIC-AUTH-DATA:CAPS" title="SOUP_AUTH_DOMAIN_GENERIC_AUTH_DATA">SOUP_AUTH_DOMAIN_GENERIC_AUTH_DATA</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupAuthDomain.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> GObject - <span class="lineart">╰──</span> SoupAuthDomain - <span class="lineart">├──</span> <a class="link" href="SoupAuthDomainBasic.html" title="SoupAuthDomainBasic">SoupAuthDomainBasic</a> - <span class="lineart">╰──</span> <a class="link" href="SoupAuthDomainDigest.html" title="SoupAuthDomainDigest">SoupAuthDomainDigest</a> -</pre> -</div> -<div class="refsect1"> -<a name="SoupAuthDomain.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="SoupAuthDomain.description"></a><h2>Description</h2> -<p>A <a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a> manages authentication for all or part of a -<a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a>. To make a server require authentication, first create -an appropriate subclass of <a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a>, and then add it to the -server with <a class="link" href="SoupServer.html#soup-server-add-auth-domain" title="soup_server_add_auth_domain ()"><code class="function">soup_server_add_auth_domain()</code></a>.</p> -<p>In order for an auth domain to have any effect, you must add one or -more paths to it (via <a class="link" href="SoupAuthDomain.html#soup-auth-domain-add-path" title="soup_auth_domain_add_path ()"><code class="function">soup_auth_domain_add_path()</code></a> or the -<a class="link" href="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-ADD-PATH:CAPS" title="SOUP_AUTH_DOMAIN_ADD_PATH"><code class="literal">SOUP_AUTH_DOMAIN_ADD_PATH</code></a> property). To require authentication for -all ordinary requests, add the path "/". (Note that this does not -include the special "*" URI (eg, "OPTIONS *"), which must be added -as a separate path if you want to cover it.)</p> -<p>If you need greater control over which requests should and -shouldn't be authenticated, add paths covering everything you -<span class="emphasis"><em>might</em></span> want authenticated, and then use a -filter (<a class="link" href="SoupAuthDomain.html#soup-auth-domain-set-filter" title="soup_auth_domain_set_filter ()"><code class="function">soup_auth_domain_set_filter()</code></a>) to bypass authentication for -those requests that don't need it.</p> -</div> -<div class="refsect1"> -<a name="SoupAuthDomain.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="soup-auth-domain-add-path"></a><h3>soup_auth_domain_add_path ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_auth_domain_add_path (<em class="parameter"><code><a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a> *domain</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *path</code></em>);</pre> -<p>Adds <em class="parameter"><code>path</code></em> - to <em class="parameter"><code>domain</code></em> -, such that requests under <em class="parameter"><code>path</code></em> - on <em class="parameter"><code>domain</code></em> -'s -server will require authentication (unless overridden by -<a class="link" href="SoupAuthDomain.html#soup-auth-domain-remove-path" title="soup_auth_domain_remove_path ()"><code class="function">soup_auth_domain_remove_path()</code></a> or <a class="link" href="SoupAuthDomain.html#soup-auth-domain-set-filter" title="soup_auth_domain_set_filter ()"><code class="function">soup_auth_domain_set_filter()</code></a>).</p> -<p>You can also add paths by setting the <a class="link" href="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-ADD-PATH:CAPS" title="SOUP_AUTH_DOMAIN_ADD_PATH"><code class="literal">SOUP_AUTH_DOMAIN_ADD_PATH</code></a> -property, which can also be used to add one or more paths at -construct time.</p> -<div class="refsect3"> -<a name="soup-auth-domain-add-path.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>domain</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>path</p></td> -<td class="parameter_description"><p>the path to add to <em class="parameter"><code>domain</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-auth-domain-remove-path"></a><h3>soup_auth_domain_remove_path ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_auth_domain_remove_path (<em class="parameter"><code><a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a> *domain</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *path</code></em>);</pre> -<p>Removes <em class="parameter"><code>path</code></em> - from <em class="parameter"><code>domain</code></em> -, such that requests under <em class="parameter"><code>path</code></em> - on -<em class="parameter"><code>domain</code></em> -'s server will NOT require authentication.</p> -<p>This is not simply an undo-er for <a class="link" href="SoupAuthDomain.html#soup-auth-domain-add-path" title="soup_auth_domain_add_path ()"><code class="function">soup_auth_domain_add_path()</code></a>; it -can be used to "carve out" a subtree that does not require -authentication inside a hierarchy that does. Note also that unlike -with <a class="link" href="SoupAuthDomain.html#soup-auth-domain-add-path" title="soup_auth_domain_add_path ()"><code class="function">soup_auth_domain_add_path()</code></a>, this cannot be overridden by -adding a filter, as filters can only bypass authentication that -would otherwise be required, not require it where it would -otherwise be unnecessary.</p> -<p>You can also remove paths by setting the -<a class="link" href="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-REMOVE-PATH:CAPS" title="SOUP_AUTH_DOMAIN_REMOVE_PATH"><code class="literal">SOUP_AUTH_DOMAIN_REMOVE_PATH</code></a> property, which can also be used to -remove one or more paths at construct time.</p> -<div class="refsect3"> -<a name="soup-auth-domain-remove-path.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>domain</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>path</p></td> -<td class="parameter_description"><p>the path to remove from <em class="parameter"><code>domain</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SoupAuthDomainFilter"></a><h3>SoupAuthDomainFilter ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -<span class="c_punctuation">(</span>*SoupAuthDomainFilter<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a> *domain</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><span class="type">gpointer</span> user_data</code></em>);</pre> -<p>The prototype for a <a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a> filter; see -<a class="link" href="SoupAuthDomain.html#soup-auth-domain-set-filter" title="soup_auth_domain_set_filter ()"><code class="function">soup_auth_domain_set_filter()</code></a> for details.</p> -<div class="refsect3"> -<a name="SoupAuthDomainFilter.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>domain</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>the data passed to <a class="link" href="SoupAuthDomain.html#soup-auth-domain-set-filter" title="soup_auth_domain_set_filter ()"><code class="function">soup_auth_domain_set_filter()</code></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="SoupAuthDomainFilter.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if <em class="parameter"><code>msg</code></em> -requires authentication, <code class="literal">FALSE</code> if not.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-auth-domain-set-filter"></a><h3>soup_auth_domain_set_filter ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_auth_domain_set_filter (<em class="parameter"><code><a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a> *domain</code></em>, - <em class="parameter"><code><a class="link" href="SoupAuthDomain.html#SoupAuthDomainFilter" title="SoupAuthDomainFilter ()"><span class="type">SoupAuthDomainFilter</span></a> filter</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> filter_data</code></em>, - <em class="parameter"><code><span class="type">GDestroyNotify</span> dnotify</code></em>);</pre> -<p>Adds <em class="parameter"><code>filter</code></em> - as an authentication filter to <em class="parameter"><code>domain</code></em> -. The filter -gets a chance to bypass authentication for certain requests that -would otherwise require it. Eg, it might check the message's path -in some way that is too complicated to do via the other methods, or -it might check the message's method, and allow GETs but not PUTs.</p> -<p>The filter function returns <code class="literal">TRUE</code> if the request should still -require authentication, or <code class="literal">FALSE</code> if authentication is unnecessary -for this request.</p> -<p>To help prevent security holes, your filter should return <code class="literal">TRUE</code> by -default, and only return <code class="literal">FALSE</code> under specifically-tested -circumstances, rather than the other way around. Eg, in the example -above, where you want to authenticate PUTs but not GETs, you should -check if the method is GET and return <code class="literal">FALSE</code> in that case, and then -return <code class="literal">TRUE</code> for all other methods (rather than returning <code class="literal">TRUE</code> for -PUT and <code class="literal">FALSE</code> for all other methods). This way if it turned out -(now or later) that some paths supported additional methods besides -GET and PUT, those methods would default to being NOT allowed for -unauthenticated users.</p> -<p>You can also set the filter by setting the <a class="link" href="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-FILTER:CAPS" title="SOUP_AUTH_DOMAIN_FILTER"><code class="literal">SOUP_AUTH_DOMAIN_FILTER</code></a> -and <a class="link" href="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-FILTER-DATA:CAPS" title="SOUP_AUTH_DOMAIN_FILTER_DATA"><code class="literal">SOUP_AUTH_DOMAIN_FILTER_DATA</code></a> properties, which can also be -used to set the filter at construct time.</p> -<div class="refsect3"> -<a name="soup-auth-domain-set-filter.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>domain</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>filter</p></td> -<td class="parameter_description"><p>the auth filter for <em class="parameter"><code>domain</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>filter_data</p></td> -<td class="parameter_description"><p>data to pass to <em class="parameter"><code>filter</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>dnotify</p></td> -<td class="parameter_description"><p>destroy notifier to free <em class="parameter"><code>filter_data</code></em> -when <em class="parameter"><code>domain</code></em> -is destroyed</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-auth-domain-get-realm"></a><h3>soup_auth_domain_get_realm ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -soup_auth_domain_get_realm (<em class="parameter"><code><a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a> *domain</code></em>);</pre> -<p>Gets the realm name associated with <em class="parameter"><code>domain</code></em> -</p> -<div class="refsect3"> -<a name="soup-auth-domain-get-realm.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>domain</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-auth-domain-get-realm.returns"></a><h4>Returns</h4> -<p> <em class="parameter"><code>domain</code></em> -'s realm</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SoupAuthDomainGenericAuthCallback"></a><h3>SoupAuthDomainGenericAuthCallback ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -<span class="c_punctuation">(</span>*SoupAuthDomainGenericAuthCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a> *domain</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>const <span class="type">char</span> *username</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> -<p>The prototype for a <a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a> generic authentication callback.</p> -<p>The callback should look up the user's password, call -<a class="link" href="SoupAuthDomain.html#soup-auth-domain-check-password" title="soup_auth_domain_check_password ()"><code class="function">soup_auth_domain_check_password()</code></a>, and use the return value from -that method as its own return value.</p> -<p>In general, for security reasons, it is preferable to use the -auth-domain-specific auth callbacks (eg, -<a class="link" href="SoupAuthDomainBasic.html#SoupAuthDomainBasicAuthCallback" title="SoupAuthDomainBasicAuthCallback ()"><span class="type">SoupAuthDomainBasicAuthCallback</span></a> and -<a class="link" href="SoupAuthDomainDigest.html#SoupAuthDomainDigestAuthCallback" title="SoupAuthDomainDigestAuthCallback ()"><span class="type">SoupAuthDomainDigestAuthCallback</span></a>), because they don't require -keeping a cleartext password database. Most users will use the same -password for many different sites, meaning if any site with a -cleartext password database is compromised, accounts on other -servers might be compromised as well. For many of the cases where -<a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> is used, this is not really relevant, but it may still -be worth considering.</p> -<div class="refsect3"> -<a name="SoupAuthDomainGenericAuthCallback.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>domain</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</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 <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> being authenticated</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>username</p></td> -<td class="parameter_description"><p>the username from <em class="parameter"><code>msg</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>the data passed to -<a class="link" href="SoupAuthDomain.html#soup-auth-domain-set-generic-auth-callback" title="soup_auth_domain_set_generic_auth_callback ()"><code class="function">soup_auth_domain_set_generic_auth_callback()</code></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="SoupAuthDomainGenericAuthCallback.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if <em class="parameter"><code>msg</code></em> -is authenticated, <code class="literal">FALSE</code> if not.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-auth-domain-set-generic-auth-callback"></a><h3>soup_auth_domain_set_generic_auth_callback ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_auth_domain_set_generic_auth_callback - (<em class="parameter"><code><a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a> *domain</code></em>, - <em class="parameter"><code><a class="link" href="SoupAuthDomain.html#SoupAuthDomainGenericAuthCallback" title="SoupAuthDomainGenericAuthCallback ()"><span class="type">SoupAuthDomainGenericAuthCallback</span></a> auth_callback</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> auth_data</code></em>, - <em class="parameter"><code><span class="type">GDestroyNotify</span> dnotify</code></em>);</pre> -<p>Sets <em class="parameter"><code>auth_callback</code></em> - as an authentication-handling callback for -<em class="parameter"><code>domain</code></em> -. Whenever a request comes in to <em class="parameter"><code>domain</code></em> - which cannot be -authenticated via a domain-specific auth callback (eg, -<a class="link" href="SoupAuthDomainDigest.html#SoupAuthDomainDigestAuthCallback" title="SoupAuthDomainDigestAuthCallback ()"><span class="type">SoupAuthDomainDigestAuthCallback</span></a>), the generic auth callback -will be invoked. See <a class="link" href="SoupAuthDomain.html#SoupAuthDomainGenericAuthCallback" title="SoupAuthDomainGenericAuthCallback ()"><span class="type">SoupAuthDomainGenericAuthCallback</span></a> for information -on what the callback should do.</p> -<div class="refsect3"> -<a name="soup-auth-domain-set-generic-auth-callback.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>domain</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>auth_callback</p></td> -<td class="parameter_description"><p>the auth callback</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>auth_data</p></td> -<td class="parameter_description"><p>data to pass to <em class="parameter"><code>auth_callback</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>dnotify</p></td> -<td class="parameter_description"><p>destroy notifier to free <em class="parameter"><code>auth_data</code></em> -when <em class="parameter"><code>domain</code></em> -is destroyed</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-auth-domain-check-password"></a><h3>soup_auth_domain_check_password ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_auth_domain_check_password (<em class="parameter"><code><a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a> *domain</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>const <span class="type">char</span> *username</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *password</code></em>);</pre> -<p>Checks if <em class="parameter"><code>msg</code></em> - authenticates to <em class="parameter"><code>domain</code></em> - via <em class="parameter"><code>username</code></em> - and -<em class="parameter"><code>password</code></em> -. This would normally be called from a -<a class="link" href="SoupAuthDomain.html#SoupAuthDomainGenericAuthCallback" title="SoupAuthDomainGenericAuthCallback ()"><span class="type">SoupAuthDomainGenericAuthCallback</span></a>.</p> -<div class="refsect3"> -<a name="soup-auth-domain-check-password.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>domain</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>username</p></td> -<td class="parameter_description"><p>a username</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>password</p></td> -<td class="parameter_description"><p>a password</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-auth-domain-check-password.returns"></a><h4>Returns</h4> -<p> whether or not the message is authenticated</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-auth-domain-covers"></a><h3>soup_auth_domain_covers ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_auth_domain_covers (<em class="parameter"><code><a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a> *domain</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>);</pre> -<p>Checks if <em class="parameter"><code>domain</code></em> - requires <em class="parameter"><code>msg</code></em> - to be authenticated (according to -its paths and filter function). This does not actually look at -whether <em class="parameter"><code>msg</code></em> - <span class="emphasis"><em>is</em></span> authenticated, merely whether -or not it needs to be.</p> -<p>This is used by <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> internally and is probably of no use to -anyone else.</p> -<div class="refsect3"> -<a name="soup-auth-domain-covers.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>domain</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-auth-domain-covers.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if <em class="parameter"><code>domain</code></em> -requires <em class="parameter"><code>msg</code></em> -to be authenticated</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-auth-domain-accepts"></a><h3>soup_auth_domain_accepts ()</h3> -<pre class="programlisting"><span class="returnvalue">char</span> * -soup_auth_domain_accepts (<em class="parameter"><code><a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a> *domain</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>);</pre> -<p>Checks if <em class="parameter"><code>msg</code></em> - contains appropriate authorization for <em class="parameter"><code>domain</code></em> - to -accept it. Mirroring <a class="link" href="SoupAuthDomain.html#soup-auth-domain-covers" title="soup_auth_domain_covers ()"><code class="function">soup_auth_domain_covers()</code></a>, this does not check -whether or not <em class="parameter"><code>domain</code></em> - <span class="emphasis"><em>cares</em></span> if <em class="parameter"><code>msg</code></em> - is -authorized.</p> -<p>This is used by <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> internally and is probably of no use to -anyone else.</p> -<div class="refsect3"> -<a name="soup-auth-domain-accepts.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>domain</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-auth-domain-accepts.returns"></a><h4>Returns</h4> -<p>the username that <em class="parameter"><code>msg</code></em> -has authenticated -as, if in fact it has authenticated. <code class="literal">NULL</code> otherwise. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-auth-domain-challenge"></a><h3>soup_auth_domain_challenge ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_auth_domain_challenge (<em class="parameter"><code><a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a> *domain</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>);</pre> -<p>Adds a "WWW-Authenticate" or "Proxy-Authenticate" header to <em class="parameter"><code>msg</code></em> -, -requesting that the client authenticate, and sets <em class="parameter"><code>msg</code></em> -'s status -accordingly.</p> -<p>This is used by <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> internally and is probably of no use to -anyone else.</p> -<div class="refsect3"> -<a name="soup-auth-domain-challenge.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>domain</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -</div> -<div class="refsect1"> -<a name="SoupAuthDomain.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupAuthDomain-struct"></a><h3>SoupAuthDomain</h3> -<pre class="programlisting">typedef struct _SoupAuthDomain SoupAuthDomain;</pre> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-AUTH-DOMAIN-REALM:CAPS"></a><h3>SOUP_AUTH_DOMAIN_REALM</h3> -<pre class="programlisting">#define SOUP_AUTH_DOMAIN_REALM "realm" -</pre> -<p>Alias for the <a class="link" href="SoupAuthDomain.html#SoupAuthDomain--realm" title="The “realm” property"><span class="type">“realm”</span></a> property. (The realm of -this auth domain.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-AUTH-DOMAIN-PROXY:CAPS"></a><h3>SOUP_AUTH_DOMAIN_PROXY</h3> -<pre class="programlisting">#define SOUP_AUTH_DOMAIN_PROXY "proxy" -</pre> -<p>Alias for the <a class="link" href="SoupAuthDomain.html#SoupAuthDomain--proxy" title="The “proxy” property"><span class="type">“proxy”</span></a> property. (Whether or -not this is a proxy auth domain.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-AUTH-DOMAIN-ADD-PATH:CAPS"></a><h3>SOUP_AUTH_DOMAIN_ADD_PATH</h3> -<pre class="programlisting">#define SOUP_AUTH_DOMAIN_ADD_PATH "add-path" -</pre> -<p>Alias for the <a class="link" href="SoupAuthDomain.html#SoupAuthDomain--add-path" title="The “add-path” property"><span class="type">“add-path”</span></a> property. (Shortcut -for calling <a class="link" href="SoupAuthDomain.html#soup-auth-domain-add-path" title="soup_auth_domain_add_path ()"><code class="function">soup_auth_domain_add_path()</code></a>.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-AUTH-DOMAIN-REMOVE-PATH:CAPS"></a><h3>SOUP_AUTH_DOMAIN_REMOVE_PATH</h3> -<pre class="programlisting">#define SOUP_AUTH_DOMAIN_REMOVE_PATH "remove-path" -</pre> -<p>Alias for the <a class="link" href="SoupAuthDomain.html#SoupAuthDomain--remove-path" title="The “remove-path” property"><span class="type">“remove-path”</span></a> property. -(Shortcut for calling <a class="link" href="SoupAuthDomain.html#soup-auth-domain-remove-path" title="soup_auth_domain_remove_path ()"><code class="function">soup_auth_domain_remove_path()</code></a>.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-AUTH-DOMAIN-FILTER:CAPS"></a><h3>SOUP_AUTH_DOMAIN_FILTER</h3> -<pre class="programlisting">#define SOUP_AUTH_DOMAIN_FILTER "filter" -</pre> -<p>Alias for the <a class="link" href="SoupAuthDomain.html#SoupAuthDomain--filter" title="The “filter” property"><span class="type">“filter”</span></a> property. (The -<a class="link" href="SoupAuthDomain.html#SoupAuthDomainFilter" title="SoupAuthDomainFilter ()"><span class="type">SoupAuthDomainFilter</span></a> for the domain.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-AUTH-DOMAIN-FILTER-DATA:CAPS"></a><h3>SOUP_AUTH_DOMAIN_FILTER_DATA</h3> -<pre class="programlisting">#define SOUP_AUTH_DOMAIN_FILTER_DATA "filter-data" -</pre> -<p>Alias for the <a class="link" href="SoupAuthDomain.html#SoupAuthDomain--filter-data" title="The “filter-data” property"><span class="type">“filter-data”</span></a> property. (Data -to pass to the <a class="link" href="SoupAuthDomain.html#SoupAuthDomainFilter" title="SoupAuthDomainFilter ()"><span class="type">SoupAuthDomainFilter</span></a>.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-AUTH-DOMAIN-GENERIC-AUTH-CALLBACK:CAPS"></a><h3>SOUP_AUTH_DOMAIN_GENERIC_AUTH_CALLBACK</h3> -<pre class="programlisting">#define SOUP_AUTH_DOMAIN_GENERIC_AUTH_CALLBACK "generic-auth-callback" -</pre> -<p>Alias for the <a class="link" href="SoupAuthDomain.html#SoupAuthDomain--generic-auth-callback" title="The “generic-auth-callback” property"><span class="type">“generic-auth-callback”</span></a> property. -(The <a class="link" href="SoupAuthDomain.html#SoupAuthDomainGenericAuthCallback" title="SoupAuthDomainGenericAuthCallback ()"><span class="type">SoupAuthDomainGenericAuthCallback</span></a>.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-AUTH-DOMAIN-GENERIC-AUTH-DATA:CAPS"></a><h3>SOUP_AUTH_DOMAIN_GENERIC_AUTH_DATA</h3> -<pre class="programlisting">#define SOUP_AUTH_DOMAIN_GENERIC_AUTH_DATA "generic-auth-data" -</pre> -<p>Alias for the <a class="link" href="SoupAuthDomain.html#SoupAuthDomain--generic-auth-data" title="The “generic-auth-data” property"><span class="type">“generic-auth-data”</span></a> property. -(The data to pass to the <a class="link" href="SoupAuthDomain.html#SoupAuthDomainGenericAuthCallback" title="SoupAuthDomainGenericAuthCallback ()"><span class="type">SoupAuthDomainGenericAuthCallback</span></a>.)</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupAuthDomain.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> -<a name="SoupAuthDomain--add-path"></a><h3>The <code class="literal">“add-path”</code> property</h3> -<pre class="programlisting"> “add-path” <span class="type">gchar</span> *</pre> -<p>Add a path covered by this auth domain.</p> -<p>Flags: Write</p> -<p>Default value: NULL</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupAuthDomain--filter"></a><h3>The <code class="literal">“filter”</code> property</h3> -<pre class="programlisting"> “filter” <span class="type">gpointer</span></pre> -<p>A filter for deciding whether or not to require authentication.</p> -<p>Flags: Read / Write</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupAuthDomain--filter-data"></a><h3>The <code class="literal">“filter-data”</code> property</h3> -<pre class="programlisting"> “filter-data” <span class="type">gpointer</span></pre> -<p>Data to pass to filter.</p> -<p>Flags: Read / Write</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupAuthDomain--generic-auth-callback"></a><h3>The <code class="literal">“generic-auth-callback”</code> property</h3> -<pre class="programlisting"> “generic-auth-callback” <span class="type">gpointer</span></pre> -<p>An authentication callback that can be used with any SoupAuthDomain subclass.</p> -<p>Flags: Read / Write</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupAuthDomain--generic-auth-data"></a><h3>The <code class="literal">“generic-auth-data”</code> property</h3> -<pre class="programlisting"> “generic-auth-data” <span class="type">gpointer</span></pre> -<p>Data to pass to auth callback.</p> -<p>Flags: Read / Write</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupAuthDomain--proxy"></a><h3>The <code class="literal">“proxy”</code> property</h3> -<pre class="programlisting"> “proxy” <span class="type">gboolean</span></pre> -<p>Whether or not this is a proxy auth domain.</p> -<p>Flags: Read / Write / Construct Only</p> -<p>Default value: FALSE</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupAuthDomain--realm"></a><h3>The <code class="literal">“realm”</code> property</h3> -<pre class="programlisting"> “realm” <span class="type">gchar</span> *</pre> -<p>The realm of this auth domain.</p> -<p>Flags: Read / Write / Construct Only</p> -<p>Default value: NULL</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupAuthDomain--remove-path"></a><h3>The <code class="literal">“remove-path”</code> property</h3> -<pre class="programlisting"> “remove-path” <span class="type">gchar</span> *</pre> -<p>Remove a path covered by this auth domain.</p> -<p>Flags: Write</p> -<p>Default value: NULL</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupAuthDomain.see-also"></a><h2>See Also</h2> -<p><a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a></p> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/SoupAuthDomainBasic.html b/docs/reference/html/SoupAuthDomainBasic.html deleted file mode 100644 index cef727f1..00000000 --- a/docs/reference/html/SoupAuthDomainBasic.html +++ /dev/null @@ -1,339 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SoupAuthDomainBasic: 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="ch02.html" title="Core API"> -<link rel="prev" href="SoupAuthDomain.html" title="SoupAuthDomain"> -<link rel="next" href="SoupAuthDomainDigest.html" title="SoupAuthDomainDigest"> -<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="#SoupAuthDomainBasic.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupAuthDomainBasic.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> - <a href="#SoupAuthDomainBasic.properties" class="shortcut">Properties</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="SoupAuthDomain.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="SoupAuthDomainDigest.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="SoupAuthDomainBasic"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="SoupAuthDomainBasic.top_of_page"></a>SoupAuthDomainBasic</span></h2> -<p>SoupAuthDomainBasic — Server-side "Basic" authentication</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="SoupAuthDomainBasic.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="SoupAuthDomain.html" title="SoupAuthDomain"><span class="returnvalue">SoupAuthDomain</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupAuthDomainBasic.html#soup-auth-domain-basic-new" title="soup_auth_domain_basic_new ()">soup_auth_domain_basic_new</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<span class="c_punctuation">(</span><a class="link" href="SoupAuthDomainBasic.html#SoupAuthDomainBasicAuthCallback" title="SoupAuthDomainBasicAuthCallback ()">*SoupAuthDomainBasicAuthCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupAuthDomainBasic.html#soup-auth-domain-basic-set-auth-callback" title="soup_auth_domain_basic_set_auth_callback ()">soup_auth_domain_basic_set_auth_callback</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupAuthDomainBasic.properties"></a><h2>Properties</h2> -<div class="informaltable"><table class="informaltable" border="0"> -<colgroup> -<col width="150px" class="properties_type"> -<col width="300px" class="properties_name"> -<col width="200px" class="properties_flags"> -</colgroup> -<tbody> -<tr> -<td class="property_type"><span class="type">gpointer</span></td> -<td class="property_name"><a class="link" href="SoupAuthDomainBasic.html#SoupAuthDomainBasic--auth-callback" title="The “auth-callback” property">auth-callback</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><span class="type">gpointer</span></td> -<td class="property_name"><a class="link" href="SoupAuthDomainBasic.html#SoupAuthDomainBasic--auth-data" title="The “auth-data” property">auth-data</a></td> -<td class="property_flags">Read / Write</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupAuthDomainBasic.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="SoupAuthDomainBasic.html#SoupAuthDomainBasic-struct" title="SoupAuthDomainBasic">SoupAuthDomainBasic</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupAuthDomainBasic.html#SOUP-AUTH-DOMAIN-BASIC-AUTH-CALLBACK:CAPS" title="SOUP_AUTH_DOMAIN_BASIC_AUTH_CALLBACK">SOUP_AUTH_DOMAIN_BASIC_AUTH_CALLBACK</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupAuthDomainBasic.html#SOUP-AUTH-DOMAIN-BASIC-AUTH-DATA:CAPS" title="SOUP_AUTH_DOMAIN_BASIC_AUTH_DATA">SOUP_AUTH_DOMAIN_BASIC_AUTH_DATA</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupAuthDomainBasic.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> GObject - <span class="lineart">╰──</span> <a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain">SoupAuthDomain</a> - <span class="lineart">╰──</span> SoupAuthDomainBasic -</pre> -</div> -<div class="refsect1"> -<a name="SoupAuthDomainBasic.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="SoupAuthDomainBasic.description"></a><h2>Description</h2> -<p><a class="link" href="SoupAuthDomainBasic.html" title="SoupAuthDomainBasic"><span class="type">SoupAuthDomainBasic</span></a> handles the server side of HTTP "Basic" (ie, -cleartext password) authentication.</p> -</div> -<div class="refsect1"> -<a name="SoupAuthDomainBasic.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="soup-auth-domain-basic-new"></a><h3>soup_auth_domain_basic_new ()</h3> -<pre class="programlisting"><a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="returnvalue">SoupAuthDomain</span></a> * -soup_auth_domain_basic_new (<em class="parameter"><code>const <span class="type">char</span> *optname1</code></em>, - <em class="parameter"><code>...</code></em>);</pre> -<p>Creates a <a class="link" href="SoupAuthDomainBasic.html" title="SoupAuthDomainBasic"><span class="type">SoupAuthDomainBasic</span></a>. You must set the -<a class="link" href="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-REALM:CAPS" title="SOUP_AUTH_DOMAIN_REALM"><code class="literal">SOUP_AUTH_DOMAIN_REALM</code></a> parameter, to indicate the realm name to be -returned with the authentication challenge to the client. Other -parameters are optional.</p> -<div class="refsect3"> -<a name="soup-auth-domain-basic-new.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>optname1</p></td> -<td class="parameter_description"><p>name of first option, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>...</p></td> -<td class="parameter_description"><p>option name/value pairs</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-auth-domain-basic-new.returns"></a><h4>Returns</h4> -<p> the new <a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SoupAuthDomainBasicAuthCallback"></a><h3>SoupAuthDomainBasicAuthCallback ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -<span class="c_punctuation">(</span>*SoupAuthDomainBasicAuthCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a> *domain</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>const <span class="type">char</span> *username</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *password</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> -<p>Callback used by <a class="link" href="SoupAuthDomainBasic.html" title="SoupAuthDomainBasic"><span class="type">SoupAuthDomainBasic</span></a> for authentication purposes. -The application should verify that <em class="parameter"><code>username</code></em> - and <em class="parameter"><code>password</code></em> - and valid -and return <code class="literal">TRUE</code> or <code class="literal">FALSE</code>.</p> -<p>If you are maintaining your own password database (rather than -using the password to authenticate against some other system like -PAM or a remote server), you should make sure you know what you are -doing. In particular, don't store cleartext passwords, or -easily-computed hashes of cleartext passwords, even if you don't -care that much about the security of your server, because users -will frequently use the same password for multiple sites, and so -compromising any site with a cleartext (or easily-cracked) password -database may give attackers access to other more-interesting sites -as well.</p> -<div class="refsect3"> -<a name="SoupAuthDomainBasicAuthCallback.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>domain</p></td> -<td class="parameter_description"><p>the domain</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>msg</p></td> -<td class="parameter_description"><p>the message being authenticated</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>username</p></td> -<td class="parameter_description"><p>the username provided by the client</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>password</p></td> -<td class="parameter_description"><p>the password provided by the client</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>the data passed to <a class="link" href="SoupAuthDomainBasic.html#soup-auth-domain-basic-set-auth-callback" title="soup_auth_domain_basic_set_auth_callback ()"><code class="function">soup_auth_domain_basic_set_auth_callback()</code></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="SoupAuthDomainBasicAuthCallback.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if <em class="parameter"><code>username</code></em> -and <em class="parameter"><code>password</code></em> -are valid</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-auth-domain-basic-set-auth-callback"></a><h3>soup_auth_domain_basic_set_auth_callback ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_auth_domain_basic_set_auth_callback - (<em class="parameter"><code><a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a> *domain</code></em>, - <em class="parameter"><code><a class="link" href="SoupAuthDomainBasic.html#SoupAuthDomainBasicAuthCallback" title="SoupAuthDomainBasicAuthCallback ()"><span class="type">SoupAuthDomainBasicAuthCallback</span></a> callback</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>, - <em class="parameter"><code><span class="type">GDestroyNotify</span> dnotify</code></em>);</pre> -<p>Sets the callback that <em class="parameter"><code>domain</code></em> - will use to authenticate incoming -requests. For each request containing authorization, <em class="parameter"><code>domain</code></em> - will -invoke the callback, and then either accept or reject the request -based on <em class="parameter"><code>callback</code></em> -'s return value.</p> -<p>You can also set the auth callback by setting the -<a class="link" href="SoupAuthDomainBasic.html#SOUP-AUTH-DOMAIN-BASIC-AUTH-CALLBACK:CAPS" title="SOUP_AUTH_DOMAIN_BASIC_AUTH_CALLBACK"><code class="literal">SOUP_AUTH_DOMAIN_BASIC_AUTH_CALLBACK</code></a> and -<a class="link" href="SoupAuthDomainBasic.html#SOUP-AUTH-DOMAIN-BASIC-AUTH-DATA:CAPS" title="SOUP_AUTH_DOMAIN_BASIC_AUTH_DATA"><code class="literal">SOUP_AUTH_DOMAIN_BASIC_AUTH_DATA</code></a> properties, which can also be -used to set the callback at construct time.</p> -<div class="refsect3"> -<a name="soup-auth-domain-basic-set-auth-callback.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>domain</p></td> -<td class="parameter_description"><p>the domain</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>callback</p></td> -<td class="parameter_description"><p>the callback</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>data to pass to <em class="parameter"><code>auth_callback</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>dnotify</p></td> -<td class="parameter_description"><p>destroy notifier to free <em class="parameter"><code>user_data</code></em> -when <em class="parameter"><code>domain</code></em> -is destroyed</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -</div> -<div class="refsect1"> -<a name="SoupAuthDomainBasic.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupAuthDomainBasic-struct"></a><h3>SoupAuthDomainBasic</h3> -<pre class="programlisting">typedef struct _SoupAuthDomainBasic SoupAuthDomainBasic;</pre> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-AUTH-DOMAIN-BASIC-AUTH-CALLBACK:CAPS"></a><h3>SOUP_AUTH_DOMAIN_BASIC_AUTH_CALLBACK</h3> -<pre class="programlisting">#define SOUP_AUTH_DOMAIN_BASIC_AUTH_CALLBACK "auth-callback" -</pre> -<p>Alias for the <a class="link" href="SoupAuthDomainBasic.html#SoupAuthDomainBasic--auth-callback" title="The “auth-callback” property"><span class="type">“auth-callback”</span></a> property. -(The <a class="link" href="SoupAuthDomainBasic.html#SoupAuthDomainBasicAuthCallback" title="SoupAuthDomainBasicAuthCallback ()"><span class="type">SoupAuthDomainBasicAuthCallback</span></a>.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-AUTH-DOMAIN-BASIC-AUTH-DATA:CAPS"></a><h3>SOUP_AUTH_DOMAIN_BASIC_AUTH_DATA</h3> -<pre class="programlisting">#define SOUP_AUTH_DOMAIN_BASIC_AUTH_DATA "auth-data" -</pre> -<p>Alias for the <a class="link" href="SoupAuthDomainBasic.html#SoupAuthDomainBasic--auth-data" title="The “auth-data” property"><span class="type">“auth-data”</span></a> property. -(The data to pass to the <a class="link" href="SoupAuthDomainBasic.html#SoupAuthDomainBasicAuthCallback" title="SoupAuthDomainBasicAuthCallback ()"><span class="type">SoupAuthDomainBasicAuthCallback</span></a>.)</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupAuthDomainBasic.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> -<a name="SoupAuthDomainBasic--auth-callback"></a><h3>The <code class="literal">“auth-callback”</code> property</h3> -<pre class="programlisting"> “auth-callback” <span class="type">gpointer</span></pre> -<p>Password-checking callback.</p> -<p>Flags: Read / Write</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupAuthDomainBasic--auth-data"></a><h3>The <code class="literal">“auth-data”</code> property</h3> -<pre class="programlisting"> “auth-data” <span class="type">gpointer</span></pre> -<p>Data to pass to authentication callback.</p> -<p>Flags: Read / Write</p> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/SoupAuthDomainDigest.html b/docs/reference/html/SoupAuthDomainDigest.html deleted file mode 100644 index 3e6f780f..00000000 --- a/docs/reference/html/SoupAuthDomainDigest.html +++ /dev/null @@ -1,391 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SoupAuthDomainDigest: 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="ch02.html" title="Core API"> -<link rel="prev" href="SoupAuthDomainBasic.html" title="SoupAuthDomainBasic"> -<link rel="next" href="SoupCache.html" title="SoupCache"> -<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="#SoupAuthDomainDigest.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupAuthDomainDigest.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> - <a href="#SoupAuthDomainDigest.properties" class="shortcut">Properties</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="SoupAuthDomainBasic.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="SoupCache.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="SoupAuthDomainDigest"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="SoupAuthDomainDigest.top_of_page"></a>SoupAuthDomainDigest</span></h2> -<p>SoupAuthDomainDigest — Server-side "Digest" authentication</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="SoupAuthDomainDigest.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="SoupAuthDomain.html" title="SoupAuthDomain"><span class="returnvalue">SoupAuthDomain</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupAuthDomainDigest.html#soup-auth-domain-digest-new" title="soup_auth_domain_digest_new ()">soup_auth_domain_digest_new</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<span class="c_punctuation">(</span><a class="link" href="SoupAuthDomainDigest.html#SoupAuthDomainDigestAuthCallback" title="SoupAuthDomainDigestAuthCallback ()">*SoupAuthDomainDigestAuthCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupAuthDomainDigest.html#soup-auth-domain-digest-set-auth-callback" title="soup_auth_domain_digest_set_auth_callback ()">soup_auth_domain_digest_set_auth_callback</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="SoupAuthDomainDigest.html#soup-auth-domain-digest-encode-password" title="soup_auth_domain_digest_encode_password ()">soup_auth_domain_digest_encode_password</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupAuthDomainDigest.properties"></a><h2>Properties</h2> -<div class="informaltable"><table class="informaltable" border="0"> -<colgroup> -<col width="150px" class="properties_type"> -<col width="300px" class="properties_name"> -<col width="200px" class="properties_flags"> -</colgroup> -<tbody> -<tr> -<td class="property_type"><span class="type">gpointer</span></td> -<td class="property_name"><a class="link" href="SoupAuthDomainDigest.html#SoupAuthDomainDigest--auth-callback" title="The “auth-callback” property">auth-callback</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><span class="type">gpointer</span></td> -<td class="property_name"><a class="link" href="SoupAuthDomainDigest.html#SoupAuthDomainDigest--auth-data" title="The “auth-data” property">auth-data</a></td> -<td class="property_flags">Read / Write</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupAuthDomainDigest.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="SoupAuthDomainDigest.html#SoupAuthDomainDigest-struct" title="SoupAuthDomainDigest">SoupAuthDomainDigest</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupAuthDomainDigest.html#SOUP-AUTH-DOMAIN-DIGEST-AUTH-CALLBACK:CAPS" title="SOUP_AUTH_DOMAIN_DIGEST_AUTH_CALLBACK">SOUP_AUTH_DOMAIN_DIGEST_AUTH_CALLBACK</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupAuthDomainDigest.html#SOUP-AUTH-DOMAIN-DIGEST-AUTH-DATA:CAPS" title="SOUP_AUTH_DOMAIN_DIGEST_AUTH_DATA">SOUP_AUTH_DOMAIN_DIGEST_AUTH_DATA</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupAuthDomainDigest.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> GObject - <span class="lineart">╰──</span> <a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain">SoupAuthDomain</a> - <span class="lineart">╰──</span> SoupAuthDomainDigest -</pre> -</div> -<div class="refsect1"> -<a name="SoupAuthDomainDigest.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="SoupAuthDomainDigest.description"></a><h2>Description</h2> -<p><a class="link" href="SoupAuthDomainDigest.html" title="SoupAuthDomainDigest"><span class="type">SoupAuthDomainDigest</span></a> handles the server side of HTTP "Digest" -authentication.</p> -</div> -<div class="refsect1"> -<a name="SoupAuthDomainDigest.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="soup-auth-domain-digest-new"></a><h3>soup_auth_domain_digest_new ()</h3> -<pre class="programlisting"><a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="returnvalue">SoupAuthDomain</span></a> * -soup_auth_domain_digest_new (<em class="parameter"><code>const <span class="type">char</span> *optname1</code></em>, - <em class="parameter"><code>...</code></em>);</pre> -<p>Creates a <a class="link" href="SoupAuthDomainDigest.html" title="SoupAuthDomainDigest"><span class="type">SoupAuthDomainDigest</span></a>. You must set the -<a class="link" href="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-REALM:CAPS" title="SOUP_AUTH_DOMAIN_REALM"><code class="literal">SOUP_AUTH_DOMAIN_REALM</code></a> parameter, to indicate the realm name to be -returned with the authentication challenge to the client. Other -parameters are optional.</p> -<div class="refsect3"> -<a name="soup-auth-domain-digest-new.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>optname1</p></td> -<td class="parameter_description"><p>name of first option, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>...</p></td> -<td class="parameter_description"><p>option name/value pairs</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-auth-domain-digest-new.returns"></a><h4>Returns</h4> -<p> the new <a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SoupAuthDomainDigestAuthCallback"></a><h3>SoupAuthDomainDigestAuthCallback ()</h3> -<pre class="programlisting"><span class="returnvalue">char</span> * -<span class="c_punctuation">(</span>*SoupAuthDomainDigestAuthCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a> *domain</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>const <span class="type">char</span> *username</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> -<p>Callback used by <a class="link" href="SoupAuthDomainDigest.html" title="SoupAuthDomainDigest"><span class="type">SoupAuthDomainDigest</span></a> for authentication purposes. -The application should look up <em class="parameter"><code>username</code></em> - in its password database, -and return the corresponding encoded password (see -<a class="link" href="SoupAuthDomainDigest.html#soup-auth-domain-digest-encode-password" title="soup_auth_domain_digest_encode_password ()"><code class="function">soup_auth_domain_digest_encode_password()</code></a>).</p> -<div class="refsect3"> -<a name="SoupAuthDomainDigestAuthCallback.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>domain</p></td> -<td class="parameter_description"><p>the domain</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>msg</p></td> -<td class="parameter_description"><p>the message being authenticated</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>username</p></td> -<td class="parameter_description"><p>the username provided by the client</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>the data passed to <a class="link" href="SoupAuthDomainDigest.html#soup-auth-domain-digest-set-auth-callback" title="soup_auth_domain_digest_set_auth_callback ()"><code class="function">soup_auth_domain_digest_set_auth_callback()</code></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="SoupAuthDomainDigestAuthCallback.returns"></a><h4>Returns</h4> -<p>the encoded password, or <code class="literal">NULL</code> if -<em class="parameter"><code>username</code></em> -is not a valid user. <em class="parameter"><code>domain</code></em> -will free the password when -it is done with it. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-auth-domain-digest-set-auth-callback"></a><h3>soup_auth_domain_digest_set_auth_callback ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_auth_domain_digest_set_auth_callback - (<em class="parameter"><code><a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a> *domain</code></em>, - <em class="parameter"><code><a class="link" href="SoupAuthDomainDigest.html#SoupAuthDomainDigestAuthCallback" title="SoupAuthDomainDigestAuthCallback ()"><span class="type">SoupAuthDomainDigestAuthCallback</span></a> callback</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>, - <em class="parameter"><code><span class="type">GDestroyNotify</span> dnotify</code></em>);</pre> -<p>Sets the callback that <em class="parameter"><code>domain</code></em> - will use to authenticate incoming -requests. For each request containing authorization, <em class="parameter"><code>domain</code></em> - will -invoke the callback, and then either accept or reject the request -based on <em class="parameter"><code>callback</code></em> -'s return value.</p> -<p>You can also set the auth callback by setting the -<a class="link" href="SoupAuthDomainDigest.html#SOUP-AUTH-DOMAIN-DIGEST-AUTH-CALLBACK:CAPS" title="SOUP_AUTH_DOMAIN_DIGEST_AUTH_CALLBACK"><code class="literal">SOUP_AUTH_DOMAIN_DIGEST_AUTH_CALLBACK</code></a> and -<a class="link" href="SoupAuthDomainDigest.html#SOUP-AUTH-DOMAIN-DIGEST-AUTH-DATA:CAPS" title="SOUP_AUTH_DOMAIN_DIGEST_AUTH_DATA"><code class="literal">SOUP_AUTH_DOMAIN_DIGEST_AUTH_DATA</code></a> properties, which can also be -used to set the callback at construct time.</p> -<div class="refsect3"> -<a name="soup-auth-domain-digest-set-auth-callback.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>domain</p></td> -<td class="parameter_description"><p>the domain</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>callback</p></td> -<td class="parameter_description"><p>the callback</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>data to pass to <em class="parameter"><code>auth_callback</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>dnotify</p></td> -<td class="parameter_description"><p>destroy notifier to free <em class="parameter"><code>user_data</code></em> -when <em class="parameter"><code>domain</code></em> -is destroyed</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-auth-domain-digest-encode-password"></a><h3>soup_auth_domain_digest_encode_password ()</h3> -<pre class="programlisting"><span class="returnvalue">char</span> * -soup_auth_domain_digest_encode_password - (<em class="parameter"><code>const <span class="type">char</span> *username</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *realm</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *password</code></em>);</pre> -<p>Encodes the username/realm/password triplet for Digest -authentication. (That is, it returns a stringified MD5 hash of -<em class="parameter"><code>username</code></em> -, <em class="parameter"><code>realm</code></em> -, and <em class="parameter"><code>password</code></em> - concatenated together). This is -the form that is needed as the return value of -<a class="link" href="SoupAuthDomainDigest.html" title="SoupAuthDomainDigest"><span class="type">SoupAuthDomainDigest</span></a>'s auth handler.</p> -<p>For security reasons, you should store the encoded hash, rather -than storing the cleartext password itself and calling this method -only when you need to verify it. This way, if your server is -compromised, the attackers will not gain access to cleartext -passwords which might also be usable at other sites. (Note also -that the encoded password returned by this method is identical to -the encoded password stored in an Apache .htdigest file.)</p> -<div class="refsect3"> -<a name="soup-auth-domain-digest-encode-password.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>username</p></td> -<td class="parameter_description"><p>a username</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>realm</p></td> -<td class="parameter_description"><p>an auth realm name</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>password</p></td> -<td class="parameter_description"><p>the password for <em class="parameter"><code>username</code></em> -in <em class="parameter"><code>realm</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-auth-domain-digest-encode-password.returns"></a><h4>Returns</h4> -<p> the encoded password</p> -</div> -</div> -</div> -<div class="refsect1"> -<a name="SoupAuthDomainDigest.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupAuthDomainDigest-struct"></a><h3>SoupAuthDomainDigest</h3> -<pre class="programlisting">typedef struct _SoupAuthDomainDigest SoupAuthDomainDigest;</pre> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-AUTH-DOMAIN-DIGEST-AUTH-CALLBACK:CAPS"></a><h3>SOUP_AUTH_DOMAIN_DIGEST_AUTH_CALLBACK</h3> -<pre class="programlisting">#define SOUP_AUTH_DOMAIN_DIGEST_AUTH_CALLBACK "auth-callback" -</pre> -<p>Alias for the <a class="link" href="SoupAuthDomainDigest.html#SoupAuthDomainDigest--auth-callback" title="The “auth-callback” property"><span class="type">“auth-callback”</span></a> property. -(The <a class="link" href="SoupAuthDomainDigest.html#SoupAuthDomainDigestAuthCallback" title="SoupAuthDomainDigestAuthCallback ()"><span class="type">SoupAuthDomainDigestAuthCallback</span></a>.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-AUTH-DOMAIN-DIGEST-AUTH-DATA:CAPS"></a><h3>SOUP_AUTH_DOMAIN_DIGEST_AUTH_DATA</h3> -<pre class="programlisting">#define SOUP_AUTH_DOMAIN_DIGEST_AUTH_DATA "auth-data" -</pre> -<p>Alias for the <a class="link" href="SoupAuthDomainDigest.html#SoupAuthDomainDigest--auth-callback" title="The “auth-callback” property"><span class="type">“auth-callback”</span></a> property. -(The <a class="link" href="SoupAuthDomainDigest.html#SoupAuthDomainDigestAuthCallback" title="SoupAuthDomainDigestAuthCallback ()"><span class="type">SoupAuthDomainDigestAuthCallback</span></a>.)</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupAuthDomainDigest.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> -<a name="SoupAuthDomainDigest--auth-callback"></a><h3>The <code class="literal">“auth-callback”</code> property</h3> -<pre class="programlisting"> “auth-callback” <span class="type">gpointer</span></pre> -<p>Password-finding callback.</p> -<p>Flags: Read / Write</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupAuthDomainDigest--auth-data"></a><h3>The <code class="literal">“auth-data”</code> property</h3> -<pre class="programlisting"> “auth-data” <span class="type">gpointer</span></pre> -<p>Data to pass to authentication callback.</p> -<p>Flags: Read / Write</p> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/SoupAuthManager.html b/docs/reference/html/SoupAuthManager.html deleted file mode 100644 index 62839636..00000000 --- a/docs/reference/html/SoupAuthManager.html +++ /dev/null @@ -1,284 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SoupAuthManager: 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="SoupSessionFeature.html" title="SoupSessionFeature"> -<link rel="next" href="SoupContentDecoder.html" title="SoupContentDecoder"> -<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="#SoupAuthManager.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupAuthManager.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> - <a href="#SoupAuthManager.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_signals"> <span class="dim">|</span> - <a href="#SoupAuthManager.signals" class="shortcut">Signals</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="SoupSessionFeature.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="SoupContentDecoder.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="SoupAuthManager"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="SoupAuthManager.top_of_page"></a>SoupAuthManager</span></h2> -<p>SoupAuthManager — HTTP client-side authentication handler</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="SoupAuthManager.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"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupAuthManager.html#soup-auth-manager-use-auth" title="soup_auth_manager_use_auth ()">soup_auth_manager_use_auth</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupAuthManager.html#soup-auth-manager-clear-cached-credentials" title="soup_auth_manager_clear_cached_credentials ()">soup_auth_manager_clear_cached_credentials</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupAuthManager.signals"></a><h2>Signals</h2> -<div class="informaltable"><table class="informaltable" border="0"> -<colgroup> -<col width="150px" class="signals_return"> -<col width="300px" class="signals_name"> -<col width="200px" class="signals_flags"> -</colgroup> -<tbody><tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="SoupAuthManager.html#SoupAuthManager-authenticate" title="The “authenticate” signal">authenticate</a></td> -<td class="signal_flags">Run First</td> -</tr></tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupAuthManager.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="SoupAuthManager.html#SoupAuthManager-struct" title="SoupAuthManager">SoupAuthManager</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupAuthManager.html#SOUP-TYPE-AUTH-MANAGER:CAPS" title="SOUP_TYPE_AUTH_MANAGER">SOUP_TYPE_AUTH_MANAGER</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupAuthManager.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> GObject - <span class="lineart">╰──</span> SoupAuthManager -</pre> -</div> -<div class="refsect1"> -<a name="SoupAuthManager.implemented-interfaces"></a><h2>Implemented Interfaces</h2> -<p> -SoupAuthManager implements - <a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature">SoupSessionFeature</a>.</p> -</div> -<div class="refsect1"> -<a name="SoupAuthManager.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="SoupAuthManager.description"></a><h2>Description</h2> -<p><a class="link" href="SoupAuthManager.html" title="SoupAuthManager"><span class="type">SoupAuthManager</span></a> is the <a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature"><span class="type">SoupSessionFeature</span></a> that handles HTTP -authentication for a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a>.</p> -<p>A <a class="link" href="SoupAuthManager.html" title="SoupAuthManager"><span class="type">SoupAuthManager</span></a> is added to the session by default, and normally -you don't need to worry about it at all. However, if you want to -disable HTTP authentication, you can remove the feature from the -session with <a class="link" href="SoupSession.html#soup-session-remove-feature-by-type" title="soup_session_remove_feature_by_type ()"><code class="function">soup_session_remove_feature_by_type()</code></a>, or disable it on -individual requests with <a class="link" href="SoupMessage.html#soup-message-disable-feature" title="soup_message_disable_feature ()"><code class="function">soup_message_disable_feature()</code></a>.</p> -</div> -<div class="refsect1"> -<a name="SoupAuthManager.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="soup-auth-manager-use-auth"></a><h3>soup_auth_manager_use_auth ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_auth_manager_use_auth (<em class="parameter"><code><a class="link" href="SoupAuthManager.html" title="SoupAuthManager"><span class="type">SoupAuthManager</span></a> *manager</code></em>, - <em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>, - <em class="parameter"><code><a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a> *auth</code></em>);</pre> -<p>Records that <em class="parameter"><code>auth</code></em> - is to be used under <em class="parameter"><code>uri</code></em> -, as though a -WWW-Authenticate header had been received at that URI. This can be -used to "preload" <em class="parameter"><code>manager</code></em> -'s auth cache, to avoid an extra HTTP -round trip in the case where you know ahead of time that a 401 -response will be returned.</p> -<p>This is only useful for authentication types where the initial -Authorization header does not depend on any additional information -from the server. (Eg, Basic or NTLM, but not Digest.)</p> -<div class="refsect3"> -<a name="soup-auth-manager-use-auth.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>manager</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAuthManager.html" title="SoupAuthManager"><span class="type">SoupAuthManager</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>uri</p></td> -<td class="parameter_description"><p>the <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> under which <em class="parameter"><code>auth</code></em> -is to be used</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>auth</p></td> -<td class="parameter_description"><p>the <a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a> to use</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-auth-manager-clear-cached-credentials"></a><h3>soup_auth_manager_clear_cached_credentials ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_auth_manager_clear_cached_credentials - (<em class="parameter"><code><a class="link" href="SoupAuthManager.html" title="SoupAuthManager"><span class="type">SoupAuthManager</span></a> *manager</code></em>);</pre> -<p>Clear all credentials cached by <em class="parameter"><code>manager</code></em> -</p> -<div class="refsect3"> -<a name="soup-auth-manager-clear-cached-credentials.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>manager</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAuthManager.html" title="SoupAuthManager"><span class="type">SoupAuthManager</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<p class="since">Since: 2.58</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupAuthManager.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupAuthManager-struct"></a><h3>SoupAuthManager</h3> -<pre class="programlisting">typedef struct _SoupAuthManager SoupAuthManager;</pre> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-TYPE-AUTH-MANAGER:CAPS"></a><h3>SOUP_TYPE_AUTH_MANAGER</h3> -<pre class="programlisting">#define SOUP_TYPE_AUTH_MANAGER (soup_auth_manager_get_type ()) -</pre> -<p>The <span class="type">GType</span> of <a class="link" href="SoupAuthManager.html" title="SoupAuthManager"><span class="type">SoupAuthManager</span></a>; you can use this with -<a class="link" href="SoupSession.html#soup-session-remove-feature-by-type" title="soup_session_remove_feature_by_type ()"><code class="function">soup_session_remove_feature_by_type()</code></a> or -<a class="link" href="SoupMessage.html#soup-message-disable-feature" title="soup_message_disable_feature ()"><code class="function">soup_message_disable_feature()</code></a>.</p> -<p>(Although this type has only been publicly visible since libsoup -2.42, it has always existed in the background, and you can use -<code class="literal"><code class="code">g_type_from_name ("SoupAuthManager")</code></code> -to get its <span class="type">GType</span> in earlier releases.)</p> -<p class="since">Since: 2.42</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupAuthManager.signal-details"></a><h2>Signal Details</h2> -<div class="refsect2"> -<a name="SoupAuthManager-authenticate"></a><h3>The <code class="literal">“authenticate”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="SoupAuthManager.html" title="SoupAuthManager"><span class="type">SoupAuthManager</span></a> *manager, - <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg, - <a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a> *auth, - <span class="type">gboolean</span> retrying, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted when the manager requires the application to -provide authentication credentials.</p> -<p><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> connects to this signal and emits its own -<a class="link" href="SoupSession.html#SoupSession-authenticate" title="The “authenticate” signal"><span class="type">“authenticate”</span></a> signal when it is emitted, so -you shouldn't need to use this signal directly.</p> -<div class="refsect3"> -<a name="SoupAuthManager-authenticate.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>manager</p></td> -<td class="parameter_description"><p>the <a class="link" href="SoupAuthManager.html" title="SoupAuthManager"><span class="type">SoupAuthManager</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 <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> being sent</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>auth</p></td> -<td class="parameter_description"><p>the <a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a> to authenticate</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>retrying</p></td> -<td class="parameter_description"><p><code class="literal">TRUE</code> if this is the second (or later) attempt</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run First</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupAuthManager.see-also"></a><h2>See Also</h2> -<p><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a>, <a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a></p> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/SoupCache.html b/docs/reference/html/SoupCache.html deleted file mode 100644 index e1122014..00000000 --- a/docs/reference/html/SoupCache.html +++ /dev/null @@ -1,431 +0,0 @@ -<!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: 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="ch02.html" title="Core API"> -<link rel="prev" href="SoupAuthDomainDigest.html" title="SoupAuthDomainDigest"> -<link rel="next" href="SoupCookie.html" title="SoupCookie"> -<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="#SoupCache.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupCache.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> - <a href="#SoupCache.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> - <a href="#SoupCache.properties" class="shortcut">Properties</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="SoupAuthDomainDigest.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="SoupCookie.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></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 — Caching support</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="SoupCache.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="SoupCache.html" title="SoupCache"><span class="returnvalue">SoupCache</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupCache.html#soup-cache-new" title="soup_cache_new ()">soup_cache_new</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupCache.html#soup-cache-flush" title="soup_cache_flush ()">soup_cache_flush</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupCache.html#soup-cache-clear" title="soup_cache_clear ()">soup_cache_clear</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupCache.html#soup-cache-dump" title="soup_cache_dump ()">soup_cache_dump</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupCache.html#soup-cache-load" title="soup_cache_load ()">soup_cache_load</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">guint</span> -</td> -<td class="function_name"> -<a class="link" href="SoupCache.html#soup-cache-get-max-size" title="soup_cache_get_max_size ()">soup_cache_get_max_size</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupCache.html#soup-cache-set-max-size" title="soup_cache_set_max_size ()">soup_cache_set_max_size</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupCache.properties"></a><h2>Properties</h2> -<div class="informaltable"><table class="informaltable" border="0"> -<colgroup> -<col width="150px" class="properties_type"> -<col width="300px" class="properties_name"> -<col width="200px" class="properties_flags"> -</colgroup> -<tbody> -<tr> -<td class="property_type"> -<span class="type">gchar</span> *</td> -<td class="property_name"><a class="link" href="SoupCache.html#SoupCache--cache-dir" title="The “cache-dir” property">cache-dir</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -<tr> -<td class="property_type"><a class="link" href="SoupCache.html#SoupCacheType" title="enum SoupCacheType"><span class="type">SoupCacheType</span></a></td> -<td class="property_name"><a class="link" href="SoupCache.html#SoupCache--cache-type" title="The “cache-type” property">cache-type</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupCache.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">struct</td> -<td class="function_name"><a class="link" href="SoupCache.html#SoupCache-struct" title="struct SoupCache">SoupCache</a></td> -</tr> -<tr> -<td class="datatype_keyword">enum</td> -<td class="function_name"><a class="link" href="SoupCache.html#SoupCacheType" title="enum SoupCacheType">SoupCacheType</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupCache.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> GObject - <span class="lineart">╰──</span> 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> and SoupContentProcessor.</p> -</div> -<div class="refsect1"> -<a name="SoupCache.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="SoupCache.description"></a><h2>Description</h2> -<p><a class="link" href="SoupCache.html" title="SoupCache"><span class="type">SoupCache</span></a> implements a file-based cache for HTTP resources.</p> -</div> -<div class="refsect1"> -<a name="SoupCache.functions_details"></a><h2>Functions</h2> -<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="refsect3"> -<a name="soup-cache-new.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>cache_dir</p></td> -<td class="parameter_description"><p>the directory to store the cached data, or <code class="literal">NULL</code> -to use the default one. Note that since the cache isn't safe to access for -multiple processes at once, and the default directory isn't namespaced by -process, clients are strongly discouraged from passing <code class="literal">NULL</code>. </p></td> -<td class="parameter_annotations"><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 class="parameter_name"><p>cache_type</p></td> -<td class="parameter_description"><p>the <a class="link" href="SoupCache.html#SoupCacheType" title="enum SoupCacheType"><span class="type">SoupCacheType</span></a> of the cache</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-cache-new.returns"></a><h4>Returns</h4> -<p> a new <a class="link" href="SoupCache.html" title="SoupCache"><span class="type">SoupCache</span></a></p> -</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 <span class="type">GMainContext</span> -associated with <em class="parameter"><code>cache</code></em> -'s session as long as needed.</p> -<p>Contrast with <a class="link" href="SoupCache.html#soup-cache-dump" title="soup_cache_dump ()"><code class="function">soup_cache_dump()</code></a>, which writes out the cache index -file.</p> -<div class="refsect3"> -<a name="soup-cache-flush.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>cache</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCache.html" title="SoupCache"><span class="type">SoupCache</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</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.</p> -<div class="refsect3"> -<a name="soup-cache-clear.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>cache</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCache.html" title="SoupCache"><span class="type">SoupCache</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</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>Synchronously writes the cache index out to disk. Contrast with -<a class="link" href="SoupCache.html#soup-cache-flush" title="soup_cache_flush ()"><code class="function">soup_cache_flush()</code></a>, which writes pending cache -<span class="emphasis"><em>entries</em></span> to disk.</p> -<p>You must call this before exiting if you want your cache data to -persist between sessions.</p> -<div class="refsect3"> -<a name="soup-cache-dump.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>cache</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCache.html" title="SoupCache"><span class="type">SoupCache</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<p class="since">Since: 2.34.</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>Loads the contents of <em class="parameter"><code>cache</code></em> -'s index into memory.</p> -<div class="refsect3"> -<a name="soup-cache-load.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>cache</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCache.html" title="SoupCache"><span class="type">SoupCache</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<p class="since">Since: 2.34</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cache-get-max-size"></a><h3>soup_cache_get_max_size ()</h3> -<pre class="programlisting"><span class="returnvalue">guint</span> -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>Gets the maximum size of the cache.</p> -<div class="refsect3"> -<a name="soup-cache-get-max-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>cache</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCache.html" title="SoupCache"><span class="type">SoupCache</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-cache-get-max-size.returns"></a><h4>Returns</h4> -<p> the maximum size of the cache, in bytes.</p> -</div> -<p class="since">Since: 2.34</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><span class="type">guint</span> max_size</code></em>);</pre> -<p>Sets the maximum size of the cache.</p> -<div class="refsect3"> -<a name="soup-cache-set-max-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>cache</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCache.html" title="SoupCache"><span class="type">SoupCache</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>max_size</p></td> -<td class="parameter_description"><p>the maximum size of the cache, in bytes</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.34</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupCache.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupCache-struct"></a><h3>struct SoupCache</h3> -<pre class="programlisting">struct SoupCache;</pre> -</div> -<hr> -<div class="refsect2"> -<a name="SoupCacheType"></a><h3>enum SoupCacheType</h3> -<p>The type of cache; this affects what kinds of responses will be -saved.</p> -<div class="refsect3"> -<a name="SoupCacheType.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="enum_members_name"> -<col class="enum_members_description"> -<col width="200px" class="enum_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="enum_member_name"><p><a name="SOUP-CACHE-SINGLE-USER:CAPS"></a>SOUP_CACHE_SINGLE_USER</p></td> -<td class="enum_member_description"> -<p>a single-user cache</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-CACHE-SHARED:CAPS"></a>SOUP_CACHE_SHARED</p></td> -<td class="enum_member_description"> -<p>a shared cache</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.34</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” <span class="type">gchar</span> *</pre> -<p>The directory to store the cache files.</p> -<p>Flags: Read / Write / Construct Only</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></pre> -<p>Whether the cache is private or shared.</p> -<p>Flags: Read / Write / Construct Only</p> -<p>Default value: SOUP_CACHE_SINGLE_USER</p> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/SoupContentDecoder.html b/docs/reference/html/SoupContentDecoder.html deleted file mode 100644 index 9082cb93..00000000 --- a/docs/reference/html/SoupContentDecoder.html +++ /dev/null @@ -1,108 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SoupContentDecoder: 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="SoupAuthManager.html" title="SoupAuthManager"> -<link rel="next" href="SoupContentSniffer.html" title="SoupContentSniffer"> -<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="#SoupContentDecoder.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupContentDecoder.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> - <a href="#SoupContentDecoder.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="SoupAuthManager.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="SoupContentSniffer.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="SoupContentDecoder"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="SoupContentDecoder.top_of_page"></a>SoupContentDecoder</span></h2> -<p>SoupContentDecoder — Content-Encoding handler</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="SoupContentDecoder.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="SoupContentDecoder.html#SoupContentDecoder-struct" title="SoupContentDecoder">SoupContentDecoder</a></td> -</tr></tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupContentDecoder.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> GObject - <span class="lineart">╰──</span> SoupContentDecoder -</pre> -</div> -<div class="refsect1"> -<a name="SoupContentDecoder.implemented-interfaces"></a><h2>Implemented Interfaces</h2> -<p> -SoupContentDecoder implements - <a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature">SoupSessionFeature</a> and SoupContentProcessor.</p> -</div> -<div class="refsect1"> -<a name="SoupContentDecoder.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="SoupContentDecoder.description"></a><h2>Description</h2> -<p><a class="link" href="SoupContentDecoder.html" title="SoupContentDecoder"><span class="type">SoupContentDecoder</span></a> handles adding the "Accept-Encoding" header on -outgoing messages, and processing the "Content-Encoding" header on -incoming ones. Currently it supports the "gzip" and "deflate" -content codings.</p> -<p>If you are using a plain <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> (ie, not <a class="link" href="SoupSessionAsync.html" title="SoupSessionAsync"><span class="type">SoupSessionAsync</span></a> or -<a class="link" href="SoupSessionSync.html" title="SoupSessionSync"><span class="type">SoupSessionSync</span></a>), then a <a class="link" href="SoupContentDecoder.html" title="SoupContentDecoder"><span class="type">SoupContentDecoder</span></a> will automatically be -added to the session by default. (You can use -<a class="link" href="SoupSession.html#SOUP-SESSION-REMOVE-FEATURE-BY-TYPE:CAPS" title="SOUP_SESSION_REMOVE_FEATURE_BY_TYPE"><code class="literal">SOUP_SESSION_REMOVE_FEATURE_BY_TYPE</code></a> at construct time if you don't -want this.) If you are using one of the deprecated <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> -subclasses, you can add a <a class="link" href="SoupContentDecoder.html" title="SoupContentDecoder"><span class="type">SoupContentDecoder</span></a> to your 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> -<p>If <a class="link" href="SoupContentDecoder.html" title="SoupContentDecoder"><span class="type">SoupContentDecoder</span></a> successfully decodes the Content-Encoding, -it will set the <a class="link" href="SoupMessage.html#SOUP-MESSAGE-CONTENT-DECODED:CAPS"><code class="literal">SOUP_MESSAGE_CONTENT_DECODED</code></a> flag on the message, -and the message body and the chunks in the <a class="link" href="SoupMessage.html#SoupMessage-got-chunk" title="The “got-chunk” signal"><span class="type">“got_chunk”</span></a> -signals will contain the decoded data; however, the message headers -will be unchanged (and so "Content-Encoding" will still be present, -"Content-Length" will describe the original encoded length, etc).</p> -<p>If "Content-Encoding" contains any encoding types that -<a class="link" href="SoupContentDecoder.html" title="SoupContentDecoder"><span class="type">SoupContentDecoder</span></a> doesn't recognize, then none of the encodings -will be decoded (and the <a class="link" href="SoupMessage.html#SOUP-MESSAGE-CONTENT-DECODED:CAPS"><code class="literal">SOUP_MESSAGE_CONTENT_DECODED</code></a> flag will -not be set).</p> -<p>(Note that currently there is no way to (automatically) use -Content-Encoding when sending a request body, or to pick specific -encoding types to support.)</p> -</div> -<div class="refsect1"> -<a name="SoupContentDecoder.functions_details"></a><h2>Functions</h2> -<p></p> -</div> -<div class="refsect1"> -<a name="SoupContentDecoder.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupContentDecoder-struct"></a><h3>SoupContentDecoder</h3> -<pre class="programlisting">typedef struct _SoupContentDecoder SoupContentDecoder;</pre> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/SoupContentSniffer.html b/docs/reference/html/SoupContentSniffer.html deleted file mode 100644 index 7bfe8abf..00000000 --- a/docs/reference/html/SoupContentSniffer.html +++ /dev/null @@ -1,219 +0,0 @@ -<!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>
\ No newline at end of file diff --git a/docs/reference/html/SoupCookie.html b/docs/reference/html/SoupCookie.html deleted file mode 100644 index 45f6443d..00000000 --- a/docs/reference/html/SoupCookie.html +++ /dev/null @@ -1,1468 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SoupCookie: 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="ch02.html" title="Core API"> -<link rel="prev" href="SoupCache.html" title="SoupCache"> -<link rel="next" href="SoupMessage.html" title="SoupMessage"> -<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="#SoupCookie.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupCookie.object-hierarchy" class="shortcut">Object Hierarchy</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="SoupCache.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="SoupMessage.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="SoupCookie"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="SoupCookie.top_of_page"></a>SoupCookie</span></h2> -<p>SoupCookie — HTTP Cookies</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="SoupCookie.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="SoupCookie.html" title="SoupCookie"><span class="returnvalue">SoupCookie</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupCookie.html#soup-cookie-new" title="soup_cookie_new ()">soup_cookie_new</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupCookie.html" title="SoupCookie"><span class="returnvalue">SoupCookie</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupCookie.html#soup-cookie-parse" title="soup_cookie_parse ()">soup_cookie_parse</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupCookie.html" title="SoupCookie"><span class="returnvalue">SoupCookie</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupCookie.html#soup-cookie-copy" title="soup_cookie_copy ()">soup_cookie_copy</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupCookie.html#soup-cookie-free" title="soup_cookie_free ()">soup_cookie_free</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupCookie.html#soup-cookie-set-name" title="soup_cookie_set_name ()">soup_cookie_set_name</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupCookie.html#soup-cookie-get-name" title="soup_cookie_get_name ()">soup_cookie_get_name</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupCookie.html#soup-cookie-set-value" title="soup_cookie_set_value ()">soup_cookie_set_value</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupCookie.html#soup-cookie-get-value" title="soup_cookie_get_value ()">soup_cookie_get_value</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupCookie.html#soup-cookie-set-domain" title="soup_cookie_set_domain ()">soup_cookie_set_domain</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupCookie.html#soup-cookie-get-domain" title="soup_cookie_get_domain ()">soup_cookie_get_domain</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupCookie.html#soup-cookie-set-path" title="soup_cookie_set_path ()">soup_cookie_set_path</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupCookie.html#soup-cookie-get-path" title="soup_cookie_get_path ()">soup_cookie_get_path</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupCookie.html#soup-cookie-set-max-age" title="soup_cookie_set_max_age ()">soup_cookie_set_max_age</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupCookie.html#soup-cookie-set-expires" title="soup_cookie_set_expires ()">soup_cookie_set_expires</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="returnvalue">SoupDate</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupCookie.html#soup-cookie-get-expires" title="soup_cookie_get_expires ()">soup_cookie_get_expires</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupCookie.html#soup-cookie-set-secure" title="soup_cookie_set_secure ()">soup_cookie_set_secure</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupCookie.html#soup-cookie-get-secure" title="soup_cookie_get_secure ()">soup_cookie_get_secure</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupCookie.html#soup-cookie-set-http-only" title="soup_cookie_set_http_only ()">soup_cookie_set_http_only</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupCookie.html#soup-cookie-get-http-only" title="soup_cookie_get_http_only ()">soup_cookie_get_http_only</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupCookie.html#soup-cookie-applies-to-uri" title="soup_cookie_applies_to_uri ()">soup_cookie_applies_to_uri</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupCookie.html#soup-cookie-domain-matches" title="soup_cookie_domain_matches ()">soup_cookie_domain_matches</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="SoupCookie.html#soup-cookie-to-cookie-header" title="soup_cookie_to_cookie_header ()">soup_cookie_to_cookie_header</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="SoupCookie.html#soup-cookie-to-set-cookie-header" title="soup_cookie_to_set_cookie_header ()">soup_cookie_to_set_cookie_header</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GSList</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupCookie.html#soup-cookies-from-request" title="soup_cookies_from_request ()">soup_cookies_from_request</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GSList</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupCookie.html#soup-cookies-from-response" title="soup_cookies_from_response ()">soup_cookies_from_response</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupCookie.html#soup-cookies-to-request" title="soup_cookies_to_request ()">soup_cookies_to_request</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupCookie.html#soup-cookies-to-response" title="soup_cookies_to_response ()">soup_cookies_to_response</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="SoupCookie.html#soup-cookies-to-cookie-header" title="soup_cookies_to_cookie_header ()">soup_cookies_to_cookie_header</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupCookie.html#soup-cookies-free" title="soup_cookies_free ()">soup_cookies_free</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupCookie.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="SoupCookie.html#SoupCookie-struct" title="SoupCookie">SoupCookie</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupCookie.html#SOUP-COOKIE-MAX-AGE-ONE-HOUR:CAPS" title="SOUP_COOKIE_MAX_AGE_ONE_HOUR">SOUP_COOKIE_MAX_AGE_ONE_HOUR</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupCookie.html#SOUP-COOKIE-MAX-AGE-ONE-DAY:CAPS" title="SOUP_COOKIE_MAX_AGE_ONE_DAY">SOUP_COOKIE_MAX_AGE_ONE_DAY</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupCookie.html#SOUP-COOKIE-MAX-AGE-ONE-WEEK:CAPS" title="SOUP_COOKIE_MAX_AGE_ONE_WEEK">SOUP_COOKIE_MAX_AGE_ONE_WEEK</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupCookie.html#SOUP-COOKIE-MAX-AGE-ONE-YEAR:CAPS" title="SOUP_COOKIE_MAX_AGE_ONE_YEAR">SOUP_COOKIE_MAX_AGE_ONE_YEAR</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupCookie.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> <a href="/home/claudio/gnome3/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a> - <span class="lineart">╰──</span> SoupCookie -</pre> -</div> -<div class="refsect1"> -<a name="SoupCookie.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="SoupCookie.description"></a><h2>Description</h2> -<p><a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> implements HTTP cookies, as described by <a class="ulink" href="http://tools.ietf.org/html/rfc6265.txt" target="_top">RFC 6265</a>.</p> -<p>To have a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> handle cookies for your appliction -automatically, use a <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a>.</p> -</div> -<div class="refsect1"> -<a name="SoupCookie.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="soup-cookie-new"></a><h3>soup_cookie_new ()</h3> -<pre class="programlisting"><a class="link" href="SoupCookie.html" title="SoupCookie"><span class="returnvalue">SoupCookie</span></a> * -soup_cookie_new (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *value</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *domain</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *path</code></em>, - <em class="parameter"><code><span class="type">int</span> max_age</code></em>);</pre> -<p>Creates a new <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> with the given attributes. (Use -<a class="link" href="SoupCookie.html#soup-cookie-set-secure" title="soup_cookie_set_secure ()"><code class="function">soup_cookie_set_secure()</code></a> and <a class="link" href="SoupCookie.html#soup-cookie-set-http-only" title="soup_cookie_set_http_only ()"><code class="function">soup_cookie_set_http_only()</code></a> if you -need to set those attributes on the returned cookie.)</p> -<p>If <em class="parameter"><code>domain</code></em> - starts with ".", that indicates a domain (which matches -the string after the ".", or any hostname that has <em class="parameter"><code>domain</code></em> - as a -suffix). Otherwise, it is a hostname and must match exactly.</p> -<p><em class="parameter"><code>max_age</code></em> - is used to set the "expires" attribute on the cookie; pass --1 to not include the attribute (indicating that the cookie expires -with the current session), 0 for an already-expired cookie, or a -lifetime in seconds. You can use the constants -<a class="link" href="SoupCookie.html#SOUP-COOKIE-MAX-AGE-ONE-HOUR:CAPS" title="SOUP_COOKIE_MAX_AGE_ONE_HOUR"><code class="literal">SOUP_COOKIE_MAX_AGE_ONE_HOUR</code></a>, <a class="link" href="SoupCookie.html#SOUP-COOKIE-MAX-AGE-ONE-DAY:CAPS" title="SOUP_COOKIE_MAX_AGE_ONE_DAY"><code class="literal">SOUP_COOKIE_MAX_AGE_ONE_DAY</code></a>, -<a class="link" href="SoupCookie.html#SOUP-COOKIE-MAX-AGE-ONE-WEEK:CAPS" title="SOUP_COOKIE_MAX_AGE_ONE_WEEK"><code class="literal">SOUP_COOKIE_MAX_AGE_ONE_WEEK</code></a> and <a class="link" href="SoupCookie.html#SOUP-COOKIE-MAX-AGE-ONE-YEAR:CAPS" title="SOUP_COOKIE_MAX_AGE_ONE_YEAR"><code class="literal">SOUP_COOKIE_MAX_AGE_ONE_YEAR</code></a> (or -multiples thereof) to calculate this value. (If you really care -about setting the exact time that the cookie will expire, use -<a class="link" href="SoupCookie.html#soup-cookie-set-expires" title="soup_cookie_set_expires ()"><code class="function">soup_cookie_set_expires()</code></a>.)</p> -<div class="refsect3"> -<a name="soup-cookie-new.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>name</p></td> -<td class="parameter_description"><p>cookie name</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>value</p></td> -<td class="parameter_description"><p>cookie value</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>domain</p></td> -<td class="parameter_description"><p>cookie domain or hostname</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>path</p></td> -<td class="parameter_description"><p>cookie path, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>max_age</p></td> -<td class="parameter_description"><p>max age of the cookie, or -1 for a session cookie</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-cookie-new.returns"></a><h4>Returns</h4> -<p> a new <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a>.</p> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-parse"></a><h3>soup_cookie_parse ()</h3> -<pre class="programlisting"><a class="link" href="SoupCookie.html" title="SoupCookie"><span class="returnvalue">SoupCookie</span></a> * -soup_cookie_parse (<em class="parameter"><code>const <span class="type">char</span> *header</code></em>, - <em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *origin</code></em>);</pre> -<p>Parses <em class="parameter"><code>header</code></em> - and returns a <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a>. (If <em class="parameter"><code>header</code></em> - contains -multiple cookies, only the first one will be parsed.)</p> -<p>If <em class="parameter"><code>header</code></em> - does not have "path" or "domain" attributes, they will -be defaulted from <em class="parameter"><code>origin</code></em> -. If <em class="parameter"><code>origin</code></em> - is <code class="literal">NULL</code>, path will default -to "/", but domain will be left as <code class="literal">NULL</code>. Note that this is not a -valid state for a <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a>, and you will need to fill in some -appropriate string for the domain if you want to actually make use -of the cookie.</p> -<div class="refsect3"> -<a name="soup-cookie-parse.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>header</p></td> -<td class="parameter_description"><p>a cookie string (eg, the value of a Set-Cookie header)</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>origin</p></td> -<td class="parameter_description"><p>origin of the cookie, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-cookie-parse.returns"></a><h4>Returns</h4> -<p>a new <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a>, or <code class="literal">NULL</code> if it could -not be parsed, or contained an illegal "domain" attribute for a -cookie originating from <em class="parameter"><code>origin</code></em> -. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-copy"></a><h3>soup_cookie_copy ()</h3> -<pre class="programlisting"><a class="link" href="SoupCookie.html" title="SoupCookie"><span class="returnvalue">SoupCookie</span></a> * -soup_cookie_copy (<em class="parameter"><code><a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> *cookie</code></em>);</pre> -<p>Copies <em class="parameter"><code>cookie</code></em> -.</p> -<div class="refsect3"> -<a name="soup-cookie-copy.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>cookie</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-cookie-copy.returns"></a><h4>Returns</h4> -<p> a copy of <em class="parameter"><code>cookie</code></em> -</p> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-free"></a><h3>soup_cookie_free ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_cookie_free (<em class="parameter"><code><a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> *cookie</code></em>);</pre> -<p>Frees <em class="parameter"><code>cookie</code></em> -</p> -<div class="refsect3"> -<a name="soup-cookie-free.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>cookie</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-set-name"></a><h3>soup_cookie_set_name ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_cookie_set_name (<em class="parameter"><code><a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> *cookie</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre> -<p>Sets <em class="parameter"><code>cookie</code></em> -'s name to <em class="parameter"><code>name</code></em> -</p> -<div class="refsect3"> -<a name="soup-cookie-set-name.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>cookie</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>name</p></td> -<td class="parameter_description"><p>the new name</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-get-name"></a><h3>soup_cookie_get_name ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -soup_cookie_get_name (<em class="parameter"><code><a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> *cookie</code></em>);</pre> -<p>Gets <em class="parameter"><code>cookie</code></em> -'s name</p> -<div class="refsect3"> -<a name="soup-cookie-get-name.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>cookie</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-cookie-get-name.returns"></a><h4>Returns</h4> -<p> <em class="parameter"><code>cookie</code></em> -'s name</p> -</div> -<p class="since">Since: 2.32</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-set-value"></a><h3>soup_cookie_set_value ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_cookie_set_value (<em class="parameter"><code><a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> *cookie</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre> -<p>Sets <em class="parameter"><code>cookie</code></em> -'s value to <em class="parameter"><code>value</code></em> -</p> -<div class="refsect3"> -<a name="soup-cookie-set-value.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>cookie</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>value</p></td> -<td class="parameter_description"><p>the new value</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-get-value"></a><h3>soup_cookie_get_value ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -soup_cookie_get_value (<em class="parameter"><code><a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> *cookie</code></em>);</pre> -<p>Gets <em class="parameter"><code>cookie</code></em> -'s value</p> -<div class="refsect3"> -<a name="soup-cookie-get-value.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>cookie</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-cookie-get-value.returns"></a><h4>Returns</h4> -<p> <em class="parameter"><code>cookie</code></em> -'s value</p> -</div> -<p class="since">Since: 2.32</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-set-domain"></a><h3>soup_cookie_set_domain ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_cookie_set_domain (<em class="parameter"><code><a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> *cookie</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *domain</code></em>);</pre> -<p>Sets <em class="parameter"><code>cookie</code></em> -'s domain to <em class="parameter"><code>domain</code></em> -</p> -<div class="refsect3"> -<a name="soup-cookie-set-domain.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>cookie</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>domain</p></td> -<td class="parameter_description"><p>the new domain</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-get-domain"></a><h3>soup_cookie_get_domain ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -soup_cookie_get_domain (<em class="parameter"><code><a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> *cookie</code></em>);</pre> -<p>Gets <em class="parameter"><code>cookie</code></em> -'s domain</p> -<div class="refsect3"> -<a name="soup-cookie-get-domain.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>cookie</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-cookie-get-domain.returns"></a><h4>Returns</h4> -<p> <em class="parameter"><code>cookie</code></em> -'s domain</p> -</div> -<p class="since">Since: 2.32</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-set-path"></a><h3>soup_cookie_set_path ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_cookie_set_path (<em class="parameter"><code><a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> *cookie</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *path</code></em>);</pre> -<p>Sets <em class="parameter"><code>cookie</code></em> -'s path to <em class="parameter"><code>path</code></em> -</p> -<div class="refsect3"> -<a name="soup-cookie-set-path.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>cookie</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>path</p></td> -<td class="parameter_description"><p>the new path</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-get-path"></a><h3>soup_cookie_get_path ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -soup_cookie_get_path (<em class="parameter"><code><a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> *cookie</code></em>);</pre> -<p>Gets <em class="parameter"><code>cookie</code></em> -'s path</p> -<div class="refsect3"> -<a name="soup-cookie-get-path.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>cookie</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-cookie-get-path.returns"></a><h4>Returns</h4> -<p> <em class="parameter"><code>cookie</code></em> -'s path</p> -</div> -<p class="since">Since: 2.32</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-set-max-age"></a><h3>soup_cookie_set_max_age ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_cookie_set_max_age (<em class="parameter"><code><a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> *cookie</code></em>, - <em class="parameter"><code><span class="type">int</span> max_age</code></em>);</pre> -<p>Sets <em class="parameter"><code>cookie</code></em> -'s max age to <em class="parameter"><code>max_age</code></em> -. If <em class="parameter"><code>max_age</code></em> - is -1, the cookie -is a session cookie, and will expire at the end of the client's -session. Otherwise, it is the number of seconds until the cookie -expires. You can use the constants <a class="link" href="SoupCookie.html#SOUP-COOKIE-MAX-AGE-ONE-HOUR:CAPS" title="SOUP_COOKIE_MAX_AGE_ONE_HOUR"><code class="literal">SOUP_COOKIE_MAX_AGE_ONE_HOUR</code></a>, -<a class="link" href="SoupCookie.html#SOUP-COOKIE-MAX-AGE-ONE-DAY:CAPS" title="SOUP_COOKIE_MAX_AGE_ONE_DAY"><code class="literal">SOUP_COOKIE_MAX_AGE_ONE_DAY</code></a>, <a class="link" href="SoupCookie.html#SOUP-COOKIE-MAX-AGE-ONE-WEEK:CAPS" title="SOUP_COOKIE_MAX_AGE_ONE_WEEK"><code class="literal">SOUP_COOKIE_MAX_AGE_ONE_WEEK</code></a> and -<a class="link" href="SoupCookie.html#SOUP-COOKIE-MAX-AGE-ONE-YEAR:CAPS" title="SOUP_COOKIE_MAX_AGE_ONE_YEAR"><code class="literal">SOUP_COOKIE_MAX_AGE_ONE_YEAR</code></a> (or multiples thereof) to calculate -this value. (A value of 0 indicates that the cookie should be -considered already-expired.)</p> -<p>(This sets the same property as <a class="link" href="SoupCookie.html#soup-cookie-set-expires" title="soup_cookie_set_expires ()"><code class="function">soup_cookie_set_expires()</code></a>.)</p> -<div class="refsect3"> -<a name="soup-cookie-set-max-age.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>cookie</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>max_age</p></td> -<td class="parameter_description"><p>the new max age</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-set-expires"></a><h3>soup_cookie_set_expires ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_cookie_set_expires (<em class="parameter"><code><a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> *cookie</code></em>, - <em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *expires</code></em>);</pre> -<p>Sets <em class="parameter"><code>cookie</code></em> -'s expiration time to <em class="parameter"><code>expires</code></em> -. If <em class="parameter"><code>expires</code></em> - is <code class="literal">NULL</code>, -<em class="parameter"><code>cookie</code></em> - will be a session cookie and will expire at the end of the -client's session.</p> -<p>(This sets the same property as <a class="link" href="SoupCookie.html#soup-cookie-set-max-age" title="soup_cookie_set_max_age ()"><code class="function">soup_cookie_set_max_age()</code></a>.)</p> -<div class="refsect3"> -<a name="soup-cookie-set-expires.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>cookie</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>expires</p></td> -<td class="parameter_description"><p>the new expiration time, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-get-expires"></a><h3>soup_cookie_get_expires ()</h3> -<pre class="programlisting"><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="returnvalue">SoupDate</span></a> * -soup_cookie_get_expires (<em class="parameter"><code><a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> *cookie</code></em>);</pre> -<p>Gets <em class="parameter"><code>cookie</code></em> -'s expiration time.</p> -<div class="refsect3"> -<a name="soup-cookie-get-expires.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>cookie</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-cookie-get-expires.returns"></a><h4>Returns</h4> -<p><em class="parameter"><code>cookie</code></em> -'s expiration -time, which is owned by <em class="parameter"><code>cookie</code></em> -and should not be modified or -freed. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.32</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-set-secure"></a><h3>soup_cookie_set_secure ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_cookie_set_secure (<em class="parameter"><code><a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> *cookie</code></em>, - <em class="parameter"><code><span class="type">gboolean</span> secure</code></em>);</pre> -<p>Sets <em class="parameter"><code>cookie</code></em> -'s secure attribute to <em class="parameter"><code>secure</code></em> -. If <code class="literal">TRUE</code>, <em class="parameter"><code>cookie</code></em> - will -only be transmitted from the client to the server over secure -(https) connections.</p> -<div class="refsect3"> -<a name="soup-cookie-set-secure.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>cookie</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>secure</p></td> -<td class="parameter_description"><p>the new value for the secure attribute</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-get-secure"></a><h3>soup_cookie_get_secure ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_cookie_get_secure (<em class="parameter"><code><a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> *cookie</code></em>);</pre> -<p>Gets <em class="parameter"><code>cookie</code></em> -'s secure attribute</p> -<div class="refsect3"> -<a name="soup-cookie-get-secure.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>cookie</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-cookie-get-secure.returns"></a><h4>Returns</h4> -<p> <em class="parameter"><code>cookie</code></em> -'s secure attribute</p> -</div> -<p class="since">Since: 2.32</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-set-http-only"></a><h3>soup_cookie_set_http_only ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_cookie_set_http_only (<em class="parameter"><code><a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> *cookie</code></em>, - <em class="parameter"><code><span class="type">gboolean</span> http_only</code></em>);</pre> -<p>Sets <em class="parameter"><code>cookie</code></em> -'s HttpOnly attribute to <em class="parameter"><code>http_only</code></em> -. If <code class="literal">TRUE</code>, <em class="parameter"><code>cookie</code></em> - -will be marked as "http only", meaning it should not be exposed to -web page scripts or other untrusted code.</p> -<div class="refsect3"> -<a name="soup-cookie-set-http-only.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>cookie</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>http_only</p></td> -<td class="parameter_description"><p>the new value for the HttpOnly attribute</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-get-http-only"></a><h3>soup_cookie_get_http_only ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_cookie_get_http_only (<em class="parameter"><code><a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> *cookie</code></em>);</pre> -<p>Gets <em class="parameter"><code>cookie</code></em> -'s HttpOnly attribute</p> -<div class="refsect3"> -<a name="soup-cookie-get-http-only.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>cookie</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-cookie-get-http-only.returns"></a><h4>Returns</h4> -<p> <em class="parameter"><code>cookie</code></em> -'s HttpOnly attribute</p> -</div> -<p class="since">Since: 2.32</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-applies-to-uri"></a><h3>soup_cookie_applies_to_uri ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_cookie_applies_to_uri (<em class="parameter"><code><a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> *cookie</code></em>, - <em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>);</pre> -<p>Tests if <em class="parameter"><code>cookie</code></em> - should be sent to <em class="parameter"><code>uri</code></em> -.</p> -<p>(At the moment, this does not check that <em class="parameter"><code>cookie</code></em> -'s domain matches -<em class="parameter"><code>uri</code></em> -, because it assumes that the caller has already done that. -But don't rely on that; it may change in the future.)</p> -<div class="refsect3"> -<a name="soup-cookie-applies-to-uri.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>cookie</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>uri</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-cookie-applies-to-uri.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if <em class="parameter"><code>cookie</code></em> -should be sent to <em class="parameter"><code>uri</code></em> -, <code class="literal">FALSE</code> if -not</p> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-domain-matches"></a><h3>soup_cookie_domain_matches ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_cookie_domain_matches (<em class="parameter"><code><a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> *cookie</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *host</code></em>);</pre> -<p>Checks if the <em class="parameter"><code>cookie</code></em> -'s domain and <em class="parameter"><code>host</code></em> - match in the sense that -<em class="parameter"><code>cookie</code></em> - should be sent when making a request to <em class="parameter"><code>host</code></em> -, or that -<em class="parameter"><code>cookie</code></em> - should be accepted when receiving a response from <em class="parameter"><code>host</code></em> -.</p> -<div class="refsect3"> -<a name="soup-cookie-domain-matches.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>cookie</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>host</p></td> -<td class="parameter_description"><p>a URI</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-cookie-domain-matches.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if the domains match, <code class="literal">FALSE</code> otherwise</p> -</div> -<p class="since">Since: 2.30</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-to-cookie-header"></a><h3>soup_cookie_to_cookie_header ()</h3> -<pre class="programlisting"><span class="returnvalue">char</span> * -soup_cookie_to_cookie_header (<em class="parameter"><code><a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> *cookie</code></em>);</pre> -<p>Serializes <em class="parameter"><code>cookie</code></em> - in the format used by the Cookie header (ie, for -returning a cookie from a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> to a server).</p> -<div class="refsect3"> -<a name="soup-cookie-to-cookie-header.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>cookie</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-cookie-to-cookie-header.returns"></a><h4>Returns</h4> -<p> the header</p> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-to-set-cookie-header"></a><h3>soup_cookie_to_set_cookie_header ()</h3> -<pre class="programlisting"><span class="returnvalue">char</span> * -soup_cookie_to_set_cookie_header (<em class="parameter"><code><a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> *cookie</code></em>);</pre> -<p>Serializes <em class="parameter"><code>cookie</code></em> - in the format used by the Set-Cookie header -(ie, for sending a cookie from a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> to a client).</p> -<div class="refsect3"> -<a name="soup-cookie-to-set-cookie-header.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>cookie</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-cookie-to-set-cookie-header.returns"></a><h4>Returns</h4> -<p> the header</p> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookies-from-request"></a><h3>soup_cookies_from_request ()</h3> -<pre class="programlisting"><span class="returnvalue">GSList</span> * -soup_cookies_from_request (<em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>);</pre> -<p>Parses <em class="parameter"><code>msg</code></em> -'s Cookie request header and returns a <span class="type">GSList</span> of -<a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a>s. As the "Cookie" header, unlike "Set-Cookie", -only contains cookie names and values, none of the other -<a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> fields will be filled in. (Thus, you can't generally -pass a cookie returned from this method directly to -<a class="link" href="SoupCookie.html#soup-cookies-to-response" title="soup_cookies_to_response ()"><code class="function">soup_cookies_to_response()</code></a>.)</p> -<div class="refsect3"> -<a name="soup-cookies-from-request.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>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> containing a "Cookie" request header</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-cookies-from-request.returns"></a><h4>Returns</h4> -<p>a <span class="type">GSList</span> -of <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a>s, which can be freed with -<a class="link" href="SoupCookie.html#soup-cookies-free" title="soup_cookies_free ()"><code class="function">soup_cookies_free()</code></a>. </p> -<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> SoupCookie][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookies-from-response"></a><h3>soup_cookies_from_response ()</h3> -<pre class="programlisting"><span class="returnvalue">GSList</span> * -soup_cookies_from_response (<em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>);</pre> -<p>Parses <em class="parameter"><code>msg</code></em> -'s Set-Cookie response headers and returns a <span class="type">GSList</span> of -<a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a>s. Cookies that do not specify "path" or -"domain" attributes will have their values defaulted from <em class="parameter"><code>msg</code></em> -.</p> -<div class="refsect3"> -<a name="soup-cookies-from-response.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>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> containing a "Set-Cookie" response header</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-cookies-from-response.returns"></a><h4>Returns</h4> -<p>a <span class="type">GSList</span> -of <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a>s, which can be freed with -<a class="link" href="SoupCookie.html#soup-cookies-free" title="soup_cookies_free ()"><code class="function">soup_cookies_free()</code></a>. </p> -<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> SoupCookie][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookies-to-request"></a><h3>soup_cookies_to_request ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_cookies_to_request (<em class="parameter"><code><span class="type">GSList</span> *cookies</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>);</pre> -<p>Adds the name and value of each cookie in <em class="parameter"><code>cookies</code></em> - to <em class="parameter"><code>msg</code></em> -'s -"Cookie" request. (If <em class="parameter"><code>msg</code></em> - already has a "Cookie" request header, -these cookies will be appended to the cookies already present. Be -careful that you do not append the same cookies twice, eg, when -requeuing a message.)</p> -<div class="refsect3"> -<a name="soup-cookies-to-request.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>cookies</p></td> -<td class="parameter_description"><p>a <span class="type">GSList</span> of <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></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> SoupCookie]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookies-to-response"></a><h3>soup_cookies_to_response ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_cookies_to_response (<em class="parameter"><code><span class="type">GSList</span> *cookies</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>);</pre> -<p>Appends a "Set-Cookie" response header to <em class="parameter"><code>msg</code></em> - for each cookie in -<em class="parameter"><code>cookies</code></em> -. (This is in addition to any other "Set-Cookie" headers -<em class="parameter"><code>msg</code></em> - may already have.)</p> -<div class="refsect3"> -<a name="soup-cookies-to-response.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>cookies</p></td> -<td class="parameter_description"><p>a <span class="type">GSList</span> of <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></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> SoupCookie]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookies-to-cookie-header"></a><h3>soup_cookies_to_cookie_header ()</h3> -<pre class="programlisting"><span class="returnvalue">char</span> * -soup_cookies_to_cookie_header (<em class="parameter"><code><span class="type">GSList</span> *cookies</code></em>);</pre> -<p>Serializes a <span class="type">GSList</span> of <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> into a string suitable for -setting as the value of the "Cookie" header.</p> -<div class="refsect3"> -<a name="soup-cookies-to-cookie-header.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>cookies</p></td> -<td class="parameter_description"><p>a <span class="type">GSList</span> of <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></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> SoupCookie]</span></td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-cookies-to-cookie-header.returns"></a><h4>Returns</h4> -<p> the serialization of <em class="parameter"><code>cookies</code></em> -</p> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookies-free"></a><h3>soup_cookies_free ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_cookies_free (<em class="parameter"><code><span class="type">GSList</span> *cookies</code></em>);</pre> -<p>Frees <em class="parameter"><code>cookies</code></em> -.</p> -<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> -<div class="refsect3"> -<a name="soup-cookies-free.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>cookies</p></td> -<td class="parameter_description"><p>a <span class="type">GSList</span> of <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></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> SoupCookie]</span></td> -</tr></tbody> -</table></div> -</div> -<p class="since">Since: 2.24</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupCookie.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupCookie-struct"></a><h3>SoupCookie</h3> -<pre class="programlisting">typedef struct { - char *name; - char *value; - char *domain; - char *path; - SoupDate *expires; - gboolean secure; - gboolean http_only; -} SoupCookie; -</pre> -<p>An HTTP cookie.</p> -<p><em class="parameter"><code>name</code></em> - and <em class="parameter"><code>value</code></em> - will be set for all cookies. If the cookie is -generated from a string that appears to have no name, then <em class="parameter"><code>name</code></em> - -will be the empty string.</p> -<p><em class="parameter"><code>domain</code></em> - and <em class="parameter"><code>path</code></em> - give the host or domain, and path within that -host/domain, to restrict this cookie to. If <em class="parameter"><code>domain</code></em> - starts with -".", that indicates a domain (which matches the string after the -".", or any hostname that has <em class="parameter"><code>domain</code></em> - as a suffix). Otherwise, it -is a hostname and must match exactly.</p> -<p><em class="parameter"><code>expires</code></em> - will be non-<code class="literal">NULL</code> if the cookie uses either the original -"expires" attribute, or the newer "max-age" attribute. If <em class="parameter"><code>expires</code></em> - -is <code class="literal">NULL</code>, it indicates that neither "expires" nor "max-age" was -specified, and the cookie expires at the end of the session.</p> -<p>If <em class="parameter"><code>http_only</code></em> - is set, the cookie should not be exposed to untrusted -code (eg, javascript), so as to minimize the danger posed by -cross-site scripting attacks.</p> -<div class="refsect3"> -<a name="SoupCookie.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="struct_members_name"> -<col class="struct_members_description"> -<col width="200px" class="struct_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="SoupCookie-struct.name"></a>name</code></em>;</p></td> -<td class="struct_member_description"><p>the cookie name</p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="SoupCookie-struct.value"></a>value</code></em>;</p></td> -<td class="struct_member_description"><p>the cookie value</p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="SoupCookie-struct.domain"></a>domain</code></em>;</p></td> -<td class="struct_member_description"><p>the "domain" attribute, or else the hostname that the -cookie came from.</p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="SoupCookie-struct.path"></a>path</code></em>;</p></td> -<td class="struct_member_description"><p>the "path" attribute, or <code class="literal">NULL</code></p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *<em class="structfield"><code><a name="SoupCookie-struct.expires"></a>expires</code></em>;</p></td> -<td class="struct_member_description"><p>the cookie expiration time, or <code class="literal">NULL</code> for a session cookie</p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><span class="type">gboolean</span> <em class="structfield"><code><a name="SoupCookie-struct.secure"></a>secure</code></em>;</p></td> -<td class="struct_member_description"><p><code class="literal">TRUE</code> if the cookie should only be tranferred over SSL</p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><span class="type">gboolean</span> <em class="structfield"><code><a name="SoupCookie-struct.http-only"></a>http_only</code></em>;</p></td> -<td class="struct_member_description"><p><code class="literal">TRUE</code> if the cookie should not be exposed to scripts</p></td> -<td class="struct_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-COOKIE-MAX-AGE-ONE-HOUR:CAPS"></a><h3>SOUP_COOKIE_MAX_AGE_ONE_HOUR</h3> -<pre class="programlisting">#define SOUP_COOKIE_MAX_AGE_ONE_HOUR (60 * 60) -</pre> -<p>A constant corresponding to 1 hour, for use with <a class="link" href="SoupCookie.html#soup-cookie-new" title="soup_cookie_new ()"><code class="function">soup_cookie_new()</code></a> -and <a class="link" href="SoupCookie.html#soup-cookie-set-max-age" title="soup_cookie_set_max_age ()"><code class="function">soup_cookie_set_max_age()</code></a>.</p> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-COOKIE-MAX-AGE-ONE-DAY:CAPS"></a><h3>SOUP_COOKIE_MAX_AGE_ONE_DAY</h3> -<pre class="programlisting">#define SOUP_COOKIE_MAX_AGE_ONE_DAY (SOUP_COOKIE_MAX_AGE_ONE_HOUR * 24) -</pre> -<p>A constant corresponding to 1 day, for use with <a class="link" href="SoupCookie.html#soup-cookie-new" title="soup_cookie_new ()"><code class="function">soup_cookie_new()</code></a> -and <a class="link" href="SoupCookie.html#soup-cookie-set-max-age" title="soup_cookie_set_max_age ()"><code class="function">soup_cookie_set_max_age()</code></a>.</p> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-COOKIE-MAX-AGE-ONE-WEEK:CAPS"></a><h3>SOUP_COOKIE_MAX_AGE_ONE_WEEK</h3> -<pre class="programlisting">#define SOUP_COOKIE_MAX_AGE_ONE_WEEK (SOUP_COOKIE_MAX_AGE_ONE_DAY * 7) -</pre> -<p>A constant corresponding to 1 week, for use with <a class="link" href="SoupCookie.html#soup-cookie-new" title="soup_cookie_new ()"><code class="function">soup_cookie_new()</code></a> -and <a class="link" href="SoupCookie.html#soup-cookie-set-max-age" title="soup_cookie_set_max_age ()"><code class="function">soup_cookie_set_max_age()</code></a>.</p> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-COOKIE-MAX-AGE-ONE-YEAR:CAPS"></a><h3>SOUP_COOKIE_MAX_AGE_ONE_YEAR</h3> -<pre class="programlisting">#define SOUP_COOKIE_MAX_AGE_ONE_YEAR (SOUP_COOKIE_MAX_AGE_ONE_DAY * 365.2422) -</pre> -<p>A constant corresponding to 1 year, for use with <a class="link" href="SoupCookie.html#soup-cookie-new" title="soup_cookie_new ()"><code class="function">soup_cookie_new()</code></a> -and <a class="link" href="SoupCookie.html#soup-cookie-set-max-age" title="soup_cookie_set_max_age ()"><code class="function">soup_cookie_set_max_age()</code></a>.</p> -<p class="since">Since: 2.24</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupCookie.see-also"></a><h2>See Also</h2> -<p><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>, <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a></p> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/SoupCookieJar.html b/docs/reference/html/SoupCookieJar.html deleted file mode 100644 index 1b322e8a..00000000 --- a/docs/reference/html/SoupCookieJar.html +++ /dev/null @@ -1,860 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SoupCookieJar: 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="SoupContentSniffer.html" title="SoupContentSniffer"> -<link rel="next" href="SoupCookieJarText.html" title="SoupCookieJarText"> -<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="#SoupCookieJar.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupCookieJar.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> - <a href="#SoupCookieJar.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> - <a href="#SoupCookieJar.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> - <a href="#SoupCookieJar.signals" class="shortcut">Signals</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="SoupContentSniffer.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="SoupCookieJarText.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="SoupCookieJar"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="SoupCookieJar.top_of_page"></a>SoupCookieJar</span></h2> -<p>SoupCookieJar — Automatic cookie handling for SoupSession</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="SoupCookieJar.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="SoupCookieJar.html" title="SoupCookieJar"><span class="returnvalue">SoupCookieJar</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupCookieJar.html#soup-cookie-jar-new" title="soup_cookie_jar_new ()">soup_cookie_jar_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="SoupCookieJar.html#soup-cookie-jar-get-cookies" title="soup_cookie_jar_get_cookies ()">soup_cookie_jar_get_cookies</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GSList</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupCookieJar.html#soup-cookie-jar-get-cookie-list" title="soup_cookie_jar_get_cookie_list ()">soup_cookie_jar_get_cookie_list</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupCookieJar.html#soup-cookie-jar-set-cookie" title="soup_cookie_jar_set_cookie ()">soup_cookie_jar_set_cookie</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupCookieJar.html#soup-cookie-jar-set-cookie-with-first-party" title="soup_cookie_jar_set_cookie_with_first_party ()">soup_cookie_jar_set_cookie_with_first_party</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupCookieJar.html#soup-cookie-jar-add-cookie" title="soup_cookie_jar_add_cookie ()">soup_cookie_jar_add_cookie</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupCookieJar.html#soup-cookie-jar-add-cookie-with-first-party" title="soup_cookie_jar_add_cookie_with_first_party ()">soup_cookie_jar_add_cookie_with_first_party</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupCookieJar.html#soup-cookie-jar-delete-cookie" title="soup_cookie_jar_delete_cookie ()">soup_cookie_jar_delete_cookie</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GSList</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupCookieJar.html#soup-cookie-jar-all-cookies" title="soup_cookie_jar_all_cookies ()">soup_cookie_jar_all_cookies</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupCookieJar.html#SoupCookieJarAcceptPolicy" title="enum SoupCookieJarAcceptPolicy"><span class="returnvalue">SoupCookieJarAcceptPolicy</span></a> -</td> -<td class="function_name"> -<a class="link" href="SoupCookieJar.html#soup-cookie-jar-get-accept-policy" title="soup_cookie_jar_get_accept_policy ()">soup_cookie_jar_get_accept_policy</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupCookieJar.html#soup-cookie-jar-set-accept-policy" title="soup_cookie_jar_set_accept_policy ()">soup_cookie_jar_set_accept_policy</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupCookieJar.html#soup-cookie-jar-is-persistent" title="soup_cookie_jar_is_persistent ()">soup_cookie_jar_is_persistent</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupCookieJar.properties"></a><h2>Properties</h2> -<div class="informaltable"><table class="informaltable" border="0"> -<colgroup> -<col width="150px" class="properties_type"> -<col width="300px" class="properties_name"> -<col width="200px" class="properties_flags"> -</colgroup> -<tbody> -<tr> -<td class="property_type"><a class="link" href="SoupCookieJar.html#SoupCookieJarAcceptPolicy" title="enum SoupCookieJarAcceptPolicy"><span class="type">SoupCookieJarAcceptPolicy</span></a></td> -<td class="property_name"><a class="link" href="SoupCookieJar.html#SoupCookieJar--accept-policy" title="The “accept-policy” property">accept-policy</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><span class="type">gboolean</span></td> -<td class="property_name"><a class="link" href="SoupCookieJar.html#SoupCookieJar--read-only" title="The “read-only” property">read-only</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupCookieJar.signals"></a><h2>Signals</h2> -<div class="informaltable"><table class="informaltable" border="0"> -<colgroup> -<col width="150px" class="signals_return"> -<col width="300px" class="signals_name"> -<col width="200px" class="signals_flags"> -</colgroup> -<tbody><tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="SoupCookieJar.html#SoupCookieJar-changed" title="The “changed” signal">changed</a></td> -<td class="signal_flags">Run First</td> -</tr></tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupCookieJar.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="SoupCookieJar.html#SoupCookieJar-struct" title="SoupCookieJar">SoupCookieJar</a></td> -</tr> -<tr> -<td class="datatype_keyword">enum</td> -<td class="function_name"><a class="link" href="SoupCookieJar.html#SoupCookieJarAcceptPolicy" title="enum SoupCookieJarAcceptPolicy">SoupCookieJarAcceptPolicy</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupCookieJar.html#SOUP-COOKIE-JAR-READ-ONLY:CAPS" title="SOUP_COOKIE_JAR_READ_ONLY">SOUP_COOKIE_JAR_READ_ONLY</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupCookieJar.html#SOUP-COOKIE-JAR-ACCEPT-POLICY:CAPS" title="SOUP_COOKIE_JAR_ACCEPT_POLICY">SOUP_COOKIE_JAR_ACCEPT_POLICY</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupCookieJar.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> GObject - <span class="lineart">╰──</span> SoupCookieJar - <span class="lineart">├──</span> <a class="link" href="SoupCookieJarDB.html" title="SoupCookieJarDB">SoupCookieJarDB</a> - <span class="lineart">╰──</span> <a class="link" href="SoupCookieJarText.html" title="SoupCookieJarText">SoupCookieJarText</a> -</pre> -</div> -<div class="refsect1"> -<a name="SoupCookieJar.implemented-interfaces"></a><h2>Implemented Interfaces</h2> -<p> -SoupCookieJar implements - <a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature">SoupSessionFeature</a>.</p> -</div> -<div class="refsect1"> -<a name="SoupCookieJar.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="SoupCookieJar.description"></a><h2>Description</h2> -<p>A <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a> stores <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a>s and arrange for them -to be sent with the appropriate <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>s. -<a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a> implements <a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature"><span class="type">SoupSessionFeature</span></a>, so you can add a -cookie jar 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> -<p>Note that the base <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a> class does not support any form -of long-term cookie persistence.</p> -</div> -<div class="refsect1"> -<a name="SoupCookieJar.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="soup-cookie-jar-new"></a><h3>soup_cookie_jar_new ()</h3> -<pre class="programlisting"><a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="returnvalue">SoupCookieJar</span></a> * -soup_cookie_jar_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> -<p>Creates a new <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a>. The base <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a> class does -not support persistent storage of cookies; use a subclass for that.</p> -<div class="refsect3"> -<a name="soup-cookie-jar-new.returns"></a><h4>Returns</h4> -<p> a new <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a></p> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-jar-get-cookies"></a><h3>soup_cookie_jar_get_cookies ()</h3> -<pre class="programlisting"><span class="returnvalue">char</span> * -soup_cookie_jar_get_cookies (<em class="parameter"><code><a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a> *jar</code></em>, - <em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>, - <em class="parameter"><code><span class="type">gboolean</span> for_http</code></em>);</pre> -<p>Retrieves (in Cookie-header form) the list of cookies that would -be sent with a request to <em class="parameter"><code>uri</code></em> -.</p> -<p>If <em class="parameter"><code>for_http</code></em> - is <code class="literal">TRUE</code>, the return value will include cookies marked -"HttpOnly" (that is, cookies that the server wishes to keep hidden -from client-side scripting operations such as the JavaScript -document.cookies property). Since <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a> sets the Cookie -header itself when making the actual HTTP request, you should -almost certainly be setting <em class="parameter"><code>for_http</code></em> - to <code class="literal">FALSE</code> if you are calling -this.</p> -<div class="refsect3"> -<a name="soup-cookie-jar-get-cookies.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>jar</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>uri</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>for_http</p></td> -<td class="parameter_description"><p>whether or not the return value is being passed directly -to an HTTP operation</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-cookie-jar-get-cookies.returns"></a><h4>Returns</h4> -<p>the cookies, in string form, or <code class="literal">NULL</code> if -there are no cookies for <em class="parameter"><code>uri</code></em> -. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-jar-get-cookie-list"></a><h3>soup_cookie_jar_get_cookie_list ()</h3> -<pre class="programlisting"><span class="returnvalue">GSList</span> * -soup_cookie_jar_get_cookie_list (<em class="parameter"><code><a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a> *jar</code></em>, - <em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>, - <em class="parameter"><code><span class="type">gboolean</span> for_http</code></em>);</pre> -<p>Retrieves the list of cookies that would be sent with a request to <em class="parameter"><code>uri</code></em> - -as a <span class="type">GSList</span> of <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> objects.</p> -<p>If <em class="parameter"><code>for_http</code></em> - is <code class="literal">TRUE</code>, the return value will include cookies marked -"HttpOnly" (that is, cookies that the server wishes to keep hidden -from client-side scripting operations such as the JavaScript -document.cookies property). Since <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a> sets the Cookie -header itself when making the actual HTTP request, you should -almost certainly be setting <em class="parameter"><code>for_http</code></em> - to <code class="literal">FALSE</code> if you are calling -this.</p> -<div class="refsect3"> -<a name="soup-cookie-jar-get-cookie-list.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>jar</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>uri</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>for_http</p></td> -<td class="parameter_description"><p>whether or not the return value is being passed directly -to an HTTP operation</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-cookie-jar-get-cookie-list.returns"></a><h4>Returns</h4> -<p>a <span class="type">GSList</span> -with the cookies in the <em class="parameter"><code>jar</code></em> -that would be sent with a request to <em class="parameter"><code>uri</code></em> -. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> Soup.Cookie]</span></p> -</div> -<p class="since">Since: 2.40</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-jar-set-cookie"></a><h3>soup_cookie_jar_set_cookie ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_cookie_jar_set_cookie (<em class="parameter"><code><a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a> *jar</code></em>, - <em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *cookie</code></em>);</pre> -<p>Adds <em class="parameter"><code>cookie</code></em> - to <em class="parameter"><code>jar</code></em> -, exactly as though it had appeared in a -Set-Cookie header returned from a request to <em class="parameter"><code>uri</code></em> -.</p> -<p>Keep in mind that if the <a class="link" href="SoupCookieJar.html#SoupCookieJarAcceptPolicy" title="enum SoupCookieJarAcceptPolicy"><span class="type">SoupCookieJarAcceptPolicy</span></a> -<a class="link" href="SoupCookieJar.html#SOUP-COOKIE-JAR-ACCEPT-NO-THIRD-PARTY:CAPS"><code class="literal">SOUP_COOKIE_JAR_ACCEPT_NO_THIRD_PARTY</code></a> is set you'll need to use -<a class="link" href="SoupCookieJar.html#soup-cookie-jar-set-cookie-with-first-party" title="soup_cookie_jar_set_cookie_with_first_party ()"><code class="function">soup_cookie_jar_set_cookie_with_first_party()</code></a>, otherwise the jar -will have no way of knowing if the cookie is being set by a third -party or not.</p> -<div class="refsect3"> -<a name="soup-cookie-jar-set-cookie.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>jar</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>uri</p></td> -<td class="parameter_description"><p>the URI setting the cookie</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>cookie</p></td> -<td class="parameter_description"><p>the stringified cookie to set</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-jar-set-cookie-with-first-party"></a><h3>soup_cookie_jar_set_cookie_with_first_party ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_cookie_jar_set_cookie_with_first_party - (<em class="parameter"><code><a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a> *jar</code></em>, - <em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>, - <em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *first_party</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *cookie</code></em>);</pre> -<p>Adds <em class="parameter"><code>cookie</code></em> - to <em class="parameter"><code>jar</code></em> -, exactly as though it had appeared in a -Set-Cookie header returned from a request to <em class="parameter"><code>uri</code></em> -. <em class="parameter"><code>first_party</code></em> - -will be used to reject cookies coming from third party resources in -case such a security policy is set in the <em class="parameter"><code>jar</code></em> -.</p> -<div class="refsect3"> -<a name="soup-cookie-jar-set-cookie-with-first-party.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>jar</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>uri</p></td> -<td class="parameter_description"><p>the URI setting the cookie</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>first_party</p></td> -<td class="parameter_description"><p>the URI for the main document</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>cookie</p></td> -<td class="parameter_description"><p>the stringified cookie to set</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.30</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-jar-add-cookie"></a><h3>soup_cookie_jar_add_cookie ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_cookie_jar_add_cookie (<em class="parameter"><code><a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a> *jar</code></em>, - <em class="parameter"><code><a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> *cookie</code></em>);</pre> -<p>Adds <em class="parameter"><code>cookie</code></em> - to <em class="parameter"><code>jar</code></em> -, emitting the 'changed' signal if we are modifying -an existing cookie or adding a valid new cookie ('valid' means -that the cookie's expire date is not in the past).</p> -<p><em class="parameter"><code>cookie</code></em> - will be 'stolen' by the jar, so don't free it afterwards.</p> -<div class="refsect3"> -<a name="soup-cookie-jar-add-cookie.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>jar</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>cookie</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a>. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-jar-add-cookie-with-first-party"></a><h3>soup_cookie_jar_add_cookie_with_first_party ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_cookie_jar_add_cookie_with_first_party - (<em class="parameter"><code><a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a> *jar</code></em>, - <em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *first_party</code></em>, - <em class="parameter"><code><a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> *cookie</code></em>);</pre> -<p>Adds <em class="parameter"><code>cookie</code></em> - to <em class="parameter"><code>jar</code></em> -, emitting the 'changed' signal if we are modifying -an existing cookie or adding a valid new cookie ('valid' means -that the cookie's expire date is not in the past).</p> -<p><em class="parameter"><code>first_party</code></em> - will be used to reject cookies coming from third party -resources in case such a security policy is set in the <em class="parameter"><code>jar</code></em> -.</p> -<p><em class="parameter"><code>cookie</code></em> - will be 'stolen' by the jar, so don't free it afterwards.</p> -<div class="refsect3"> -<a name="soup-cookie-jar-add-cookie-with-first-party.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>jar</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>first_party</p></td> -<td class="parameter_description"><p>the URI for the main document</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>cookie</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a>. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.40</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-jar-delete-cookie"></a><h3>soup_cookie_jar_delete_cookie ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_cookie_jar_delete_cookie (<em class="parameter"><code><a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a> *jar</code></em>, - <em class="parameter"><code><a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> *cookie</code></em>);</pre> -<p>Deletes <em class="parameter"><code>cookie</code></em> - from <em class="parameter"><code>jar</code></em> -, emitting the 'changed' signal.</p> -<div class="refsect3"> -<a name="soup-cookie-jar-delete-cookie.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>jar</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>cookie</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-jar-all-cookies"></a><h3>soup_cookie_jar_all_cookies ()</h3> -<pre class="programlisting"><span class="returnvalue">GSList</span> * -soup_cookie_jar_all_cookies (<em class="parameter"><code><a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a> *jar</code></em>);</pre> -<p>Constructs a <span class="type">GSList</span> with every cookie inside the <em class="parameter"><code>jar</code></em> -. -The cookies in the list are a copy of the original, so -you have to free them when you are done with them.</p> -<div class="refsect3"> -<a name="soup-cookie-jar-all-cookies.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>jar</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-cookie-jar-all-cookies.returns"></a><h4>Returns</h4> -<p>a <span class="type">GSList</span> -with all the cookies in the <em class="parameter"><code>jar</code></em> -. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> Soup.Cookie]</span></p> -</div> -<p class="since">Since: 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-jar-get-accept-policy"></a><h3>soup_cookie_jar_get_accept_policy ()</h3> -<pre class="programlisting"><a class="link" href="SoupCookieJar.html#SoupCookieJarAcceptPolicy" title="enum SoupCookieJarAcceptPolicy"><span class="returnvalue">SoupCookieJarAcceptPolicy</span></a> -soup_cookie_jar_get_accept_policy (<em class="parameter"><code><a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a> *jar</code></em>);</pre> -<p>Gets <em class="parameter"><code>jar</code></em> -'s <a class="link" href="SoupCookieJar.html#SoupCookieJarAcceptPolicy" title="enum SoupCookieJarAcceptPolicy"><span class="type">SoupCookieJarAcceptPolicy</span></a></p> -<div class="refsect3"> -<a name="soup-cookie-jar-get-accept-policy.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>jar</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-cookie-jar-get-accept-policy.returns"></a><h4>Returns</h4> -<p> the <a class="link" href="SoupCookieJar.html#SoupCookieJarAcceptPolicy" title="enum SoupCookieJarAcceptPolicy"><span class="type">SoupCookieJarAcceptPolicy</span></a> set in the <em class="parameter"><code>jar</code></em> -</p> -</div> -<p class="since">Since: 2.30</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-jar-set-accept-policy"></a><h3>soup_cookie_jar_set_accept_policy ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_cookie_jar_set_accept_policy (<em class="parameter"><code><a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a> *jar</code></em>, - <em class="parameter"><code><a class="link" href="SoupCookieJar.html#SoupCookieJarAcceptPolicy" title="enum SoupCookieJarAcceptPolicy"><span class="type">SoupCookieJarAcceptPolicy</span></a> policy</code></em>);</pre> -<p>Sets <em class="parameter"><code>policy</code></em> - as the cookie acceptance policy for <em class="parameter"><code>jar</code></em> -.</p> -<div class="refsect3"> -<a name="soup-cookie-jar-set-accept-policy.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>jar</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>policy</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookieJar.html#SoupCookieJarAcceptPolicy" title="enum SoupCookieJarAcceptPolicy"><span class="type">SoupCookieJarAcceptPolicy</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.30</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-cookie-jar-is-persistent"></a><h3>soup_cookie_jar_is_persistent ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_cookie_jar_is_persistent (<em class="parameter"><code><a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a> *jar</code></em>);</pre> -<p>Gets whether <em class="parameter"><code>jar</code></em> - stores cookies persistenly.</p> -<div class="refsect3"> -<a name="soup-cookie-jar-is-persistent.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>jar</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-cookie-jar-is-persistent.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if <em class="parameter"><code>jar</code></em> -storage is persistent or <code class="literal">FALSE</code> otherwise.</p> -</div> -<p class="since">Since: 2.40</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupCookieJar.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupCookieJar-struct"></a><h3>SoupCookieJar</h3> -<pre class="programlisting">typedef struct _SoupCookieJar SoupCookieJar;</pre> -</div> -<hr> -<div class="refsect2"> -<a name="SoupCookieJarAcceptPolicy"></a><h3>enum SoupCookieJarAcceptPolicy</h3> -<p>The policy for accepting or rejecting cookies returned in -responses.</p> -<div class="refsect3"> -<a name="SoupCookieJarAcceptPolicy.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="enum_members_name"> -<col class="enum_members_description"> -<col width="200px" class="enum_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="enum_member_name"><p><a name="SOUP-COOKIE-JAR-ACCEPT-ALWAYS:CAPS"></a>SOUP_COOKIE_JAR_ACCEPT_ALWAYS</p></td> -<td class="enum_member_description"> -<p>accept all cookies unconditionally.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-COOKIE-JAR-ACCEPT-NEVER:CAPS"></a>SOUP_COOKIE_JAR_ACCEPT_NEVER</p></td> -<td class="enum_member_description"> -<p>reject all cookies unconditionally.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-COOKIE-JAR-ACCEPT-NO-THIRD-PARTY:CAPS"></a>SOUP_COOKIE_JAR_ACCEPT_NO_THIRD_PARTY</p></td> -<td class="enum_member_description"> -<p>accept all cookies set by -the main document loaded in the application using libsoup. An -example of the most common case, web browsers, would be: If -http://www.example.com is the page loaded, accept all cookies set -by example.com, but if a resource from http://www.third-party.com -is loaded from that page reject any cookie that it could try to -set. For libsoup to be able to tell apart first party cookies from -the rest, the application must call <a class="link" href="SoupMessage.html#soup-message-set-first-party" title="soup_message_set_first_party ()"><code class="function">soup_message_set_first_party()</code></a> -on each outgoing <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>, setting the <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> of the main -document. If no first party is set in a message when this policy is -in effect, cookies will be assumed to be third party by default.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.30</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-COOKIE-JAR-READ-ONLY:CAPS"></a><h3>SOUP_COOKIE_JAR_READ_ONLY</h3> -<pre class="programlisting">#define SOUP_COOKIE_JAR_READ_ONLY "read-only" -</pre> -<p>Alias for the <a class="link" href="SoupCookieJar.html#SoupCookieJar--read-only" title="The “read-only” property"><span class="type">“read-only”</span></a> property. (Whether -or not the cookie jar is read-only.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-COOKIE-JAR-ACCEPT-POLICY:CAPS"></a><h3>SOUP_COOKIE_JAR_ACCEPT_POLICY</h3> -<pre class="programlisting">#define SOUP_COOKIE_JAR_ACCEPT_POLICY "accept-policy" -</pre> -<p>Alias for the <a class="link" href="SoupCookieJar.html#SoupCookieJar--accept-policy" title="The “accept-policy” property"><span class="type">“accept-policy”</span></a> property.</p> -<p class="since">Since: 2.30</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupCookieJar.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> -<a name="SoupCookieJar--accept-policy"></a><h3>The <code class="literal">“accept-policy”</code> property</h3> -<pre class="programlisting"> “accept-policy” <a class="link" href="SoupCookieJar.html#SoupCookieJarAcceptPolicy" title="enum SoupCookieJarAcceptPolicy"><span class="type">SoupCookieJarAcceptPolicy</span></a></pre> -<p>The policy the jar should follow to accept or reject cookies</p> -<p>Flags: Read / Write</p> -<p>Default value: SOUP_COOKIE_JAR_ACCEPT_ALWAYS</p> -<p class="since">Since: 2.30</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupCookieJar--read-only"></a><h3>The <code class="literal">“read-only”</code> property</h3> -<pre class="programlisting"> “read-only” <span class="type">gboolean</span></pre> -<p>Whether or not the cookie jar is read-only.</p> -<p>Flags: Read / Write / Construct Only</p> -<p>Default value: FALSE</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupCookieJar.signal-details"></a><h2>Signal Details</h2> -<div class="refsect2"> -<a name="SoupCookieJar-changed"></a><h3>The <code class="literal">“changed”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a> *jar, - <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> *old_cookie, - <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> *new_cookie, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted when <em class="parameter"><code>jar</code></em> - changes. If a cookie has been added, -<em class="parameter"><code>new_cookie</code></em> - will contain the newly-added cookie and -<em class="parameter"><code>old_cookie</code></em> - will be <code class="literal">NULL</code>. If a cookie has been deleted, -<em class="parameter"><code>old_cookie</code></em> - will contain the to-be-deleted cookie and -<em class="parameter"><code>new_cookie</code></em> - will be <code class="literal">NULL</code>. If a cookie has been changed, -<em class="parameter"><code>old_cookie</code></em> - will contain its old value, and <em class="parameter"><code>new_cookie</code></em> - its -new value.</p> -<div class="refsect3"> -<a name="SoupCookieJar-changed.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>jar</p></td> -<td class="parameter_description"><p>the <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>old_cookie</p></td> -<td class="parameter_description"><p>the old <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> value</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>new_cookie</p></td> -<td class="parameter_description"><p>the new <a class="link" href="SoupCookie.html" title="SoupCookie"><span class="type">SoupCookie</span></a> value</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run First</p> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/SoupCookieJarDB.html b/docs/reference/html/SoupCookieJarDB.html deleted file mode 100644 index 1a77cbb9..00000000 --- a/docs/reference/html/SoupCookieJarDB.html +++ /dev/null @@ -1,192 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SoupCookieJarDB: 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="SoupCookieJarText.html" title="SoupCookieJarText"> -<link rel="next" href="SoupLogger.html" title="SoupLogger"> -<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="#SoupCookieJarDB.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupCookieJarDB.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> - <a href="#SoupCookieJarDB.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> - <a href="#SoupCookieJarDB.properties" class="shortcut">Properties</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="SoupCookieJarText.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="SoupLogger.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="SoupCookieJarDB"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="SoupCookieJarDB.top_of_page"></a>SoupCookieJarDB</span></h2> -<p>SoupCookieJarDB — Database-based Cookie Jar</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="SoupCookieJarDB.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="SoupCookieJar.html" title="SoupCookieJar"><span class="returnvalue">SoupCookieJar</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupCookieJarDB.html#soup-cookie-jar-db-new" title="soup_cookie_jar_db_new ()">soup_cookie_jar_db_new</a> <span class="c_punctuation">()</span> -</td> -</tr></tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupCookieJarDB.properties"></a><h2>Properties</h2> -<div class="informaltable"><table class="informaltable" border="0"> -<colgroup> -<col width="150px" class="properties_type"> -<col width="300px" class="properties_name"> -<col width="200px" class="properties_flags"> -</colgroup> -<tbody><tr> -<td class="property_type"> -<span class="type">gchar</span> *</td> -<td class="property_name"><a class="link" href="SoupCookieJarDB.html#SoupCookieJarDB--filename" title="The “filename” property">filename</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr></tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupCookieJarDB.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="SoupCookieJarDB.html#SoupCookieJarDB-struct" title="SoupCookieJarDB">SoupCookieJarDB</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupCookieJarDB.html#SOUP-COOKIE-JAR-DB-FILENAME:CAPS" title="SOUP_COOKIE_JAR_DB_FILENAME">SOUP_COOKIE_JAR_DB_FILENAME</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupCookieJarDB.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> GObject - <span class="lineart">╰──</span> <a class="link" href="SoupCookieJar.html" title="SoupCookieJar">SoupCookieJar</a> - <span class="lineart">╰──</span> SoupCookieJarDB -</pre> -</div> -<div class="refsect1"> -<a name="SoupCookieJarDB.implemented-interfaces"></a><h2>Implemented Interfaces</h2> -<p> -SoupCookieJarDB implements - <a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature">SoupSessionFeature</a>.</p> -</div> -<div class="refsect1"> -<a name="SoupCookieJarDB.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="SoupCookieJarDB.description"></a><h2>Description</h2> -<p><a class="link" href="SoupCookieJarDB.html" title="SoupCookieJarDB"><span class="type">SoupCookieJarDB</span></a> is a <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a> that reads cookies from and -writes them to a sqlite database in the new Mozilla format.</p> -<p>(This is identical to <code class="literal">SoupCookieJarSqlite</code> in -libsoup-gnome; it has just been moved into libsoup proper, and -renamed to avoid conflicting.)</p> -</div> -<div class="refsect1"> -<a name="SoupCookieJarDB.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="soup-cookie-jar-db-new"></a><h3>soup_cookie_jar_db_new ()</h3> -<pre class="programlisting"><a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="returnvalue">SoupCookieJar</span></a> * -soup_cookie_jar_db_new (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>, - <em class="parameter"><code><span class="type">gboolean</span> read_only</code></em>);</pre> -<p>Creates a <a class="link" href="SoupCookieJarDB.html" title="SoupCookieJarDB"><span class="type">SoupCookieJarDB</span></a>.</p> -<p><em class="parameter"><code>filename</code></em> - will be read in at startup to create an initial set of -cookies. If <em class="parameter"><code>read_only</code></em> - is <code class="literal">FALSE</code>, then the non-session cookies will -be written to <em class="parameter"><code>filename</code></em> - when the 'changed' signal is emitted from -the jar. (If <em class="parameter"><code>read_only</code></em> - is <code class="literal">TRUE</code>, then the cookie jar will only be -used for this session, and changes made to it will be lost when the -jar is destroyed.)</p> -<div class="refsect3"> -<a name="soup-cookie-jar-db-new.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>filename</p></td> -<td class="parameter_description"><p>the filename to read to/write from, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>read_only</p></td> -<td class="parameter_description"><p><code class="literal">TRUE</code> if <em class="parameter"><code>filename</code></em> -is read-only</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-cookie-jar-db-new.returns"></a><h4>Returns</h4> -<p> the new <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a></p> -</div> -<p class="since">Since: 2.42</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupCookieJarDB.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupCookieJarDB-struct"></a><h3>SoupCookieJarDB</h3> -<pre class="programlisting">typedef struct _SoupCookieJarDB SoupCookieJarDB;</pre> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-COOKIE-JAR-DB-FILENAME:CAPS"></a><h3>SOUP_COOKIE_JAR_DB_FILENAME</h3> -<pre class="programlisting">#define SOUP_COOKIE_JAR_DB_FILENAME "filename" -</pre> -<p>Alias for the <a class="link" href="SoupCookieJarDB.html#SoupCookieJarDB--filename" title="The “filename” property"><span class="type">“filename”</span></a> property. (The -cookie-storage filename.)</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupCookieJarDB.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> -<a name="SoupCookieJarDB--filename"></a><h3>The <code class="literal">“filename”</code> property</h3> -<pre class="programlisting"> “filename” <span class="type">gchar</span> *</pre> -<p>Cookie-storage filename.</p> -<p>Flags: Read / Write / Construct Only</p> -<p>Default value: NULL</p> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/SoupCookieJarText.html b/docs/reference/html/SoupCookieJarText.html deleted file mode 100644 index 72ae02dd..00000000 --- a/docs/reference/html/SoupCookieJarText.html +++ /dev/null @@ -1,189 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SoupCookieJarText: 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="SoupCookieJar.html" title="SoupCookieJar"> -<link rel="next" href="SoupCookieJarDB.html" title="SoupCookieJarDB"> -<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="#SoupCookieJarText.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupCookieJarText.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> - <a href="#SoupCookieJarText.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> - <a href="#SoupCookieJarText.properties" class="shortcut">Properties</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="SoupCookieJar.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="SoupCookieJarDB.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="SoupCookieJarText"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="SoupCookieJarText.top_of_page"></a>SoupCookieJarText</span></h2> -<p>SoupCookieJarText — Text-file-based ("cookies.txt") Cookie Jar</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="SoupCookieJarText.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="SoupCookieJar.html" title="SoupCookieJar"><span class="returnvalue">SoupCookieJar</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupCookieJarText.html#soup-cookie-jar-text-new" title="soup_cookie_jar_text_new ()">soup_cookie_jar_text_new</a> <span class="c_punctuation">()</span> -</td> -</tr></tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupCookieJarText.properties"></a><h2>Properties</h2> -<div class="informaltable"><table class="informaltable" border="0"> -<colgroup> -<col width="150px" class="properties_type"> -<col width="300px" class="properties_name"> -<col width="200px" class="properties_flags"> -</colgroup> -<tbody><tr> -<td class="property_type"> -<span class="type">gchar</span> *</td> -<td class="property_name"><a class="link" href="SoupCookieJarText.html#SoupCookieJarText--filename" title="The “filename” property">filename</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr></tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupCookieJarText.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="SoupCookieJarText.html#SoupCookieJarText-struct" title="SoupCookieJarText">SoupCookieJarText</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupCookieJarText.html#SOUP-COOKIE-JAR-TEXT-FILENAME:CAPS" title="SOUP_COOKIE_JAR_TEXT_FILENAME">SOUP_COOKIE_JAR_TEXT_FILENAME</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupCookieJarText.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> GObject - <span class="lineart">╰──</span> <a class="link" href="SoupCookieJar.html" title="SoupCookieJar">SoupCookieJar</a> - <span class="lineart">╰──</span> SoupCookieJarText -</pre> -</div> -<div class="refsect1"> -<a name="SoupCookieJarText.implemented-interfaces"></a><h2>Implemented Interfaces</h2> -<p> -SoupCookieJarText implements - <a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature">SoupSessionFeature</a>.</p> -</div> -<div class="refsect1"> -<a name="SoupCookieJarText.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="SoupCookieJarText.description"></a><h2>Description</h2> -<p><a class="link" href="SoupCookieJarText.html" title="SoupCookieJarText"><span class="type">SoupCookieJarText</span></a> is a <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a> that reads cookies from and -writes them to a text file in the Mozilla "cookies.txt" format.</p> -</div> -<div class="refsect1"> -<a name="SoupCookieJarText.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="soup-cookie-jar-text-new"></a><h3>soup_cookie_jar_text_new ()</h3> -<pre class="programlisting"><a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="returnvalue">SoupCookieJar</span></a> * -soup_cookie_jar_text_new (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>, - <em class="parameter"><code><span class="type">gboolean</span> read_only</code></em>);</pre> -<p>Creates a <a class="link" href="SoupCookieJarText.html" title="SoupCookieJarText"><span class="type">SoupCookieJarText</span></a>.</p> -<p><em class="parameter"><code>filename</code></em> - will be read in at startup to create an initial set of -cookies. If <em class="parameter"><code>read_only</code></em> - is <code class="literal">FALSE</code>, then the non-session cookies will -be written to <em class="parameter"><code>filename</code></em> - when the 'changed' signal is emitted from -the jar. (If <em class="parameter"><code>read_only</code></em> - is <code class="literal">TRUE</code>, then the cookie jar will only be -used for this session, and changes made to it will be lost when the -jar is destroyed.)</p> -<div class="refsect3"> -<a name="soup-cookie-jar-text-new.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>filename</p></td> -<td class="parameter_description"><p>the filename to read to/write from</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>read_only</p></td> -<td class="parameter_description"><p><code class="literal">TRUE</code> if <em class="parameter"><code>filename</code></em> -is read-only</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-cookie-jar-text-new.returns"></a><h4>Returns</h4> -<p> the new <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a></p> -</div> -<p class="since">Since: 2.26</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupCookieJarText.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupCookieJarText-struct"></a><h3>SoupCookieJarText</h3> -<pre class="programlisting">typedef struct _SoupCookieJarText SoupCookieJarText;</pre> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-COOKIE-JAR-TEXT-FILENAME:CAPS"></a><h3>SOUP_COOKIE_JAR_TEXT_FILENAME</h3> -<pre class="programlisting">#define SOUP_COOKIE_JAR_TEXT_FILENAME "filename" -</pre> -<p>Alias for the <a class="link" href="SoupCookieJarText.html#SoupCookieJarText--filename" title="The “filename” property"><span class="type">“filename”</span></a> property. (The -cookie-storage filename.)</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupCookieJarText.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> -<a name="SoupCookieJarText--filename"></a><h3>The <code class="literal">“filename”</code> property</h3> -<pre class="programlisting"> “filename” <span class="type">gchar</span> *</pre> -<p>Cookie-storage filename.</p> -<p>Flags: Read / Write / Construct Only</p> -<p>Default value: NULL</p> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/SoupLogger.html b/docs/reference/html/SoupLogger.html deleted file mode 100644 index 7ed95d3a..00000000 --- a/docs/reference/html/SoupLogger.html +++ /dev/null @@ -1,595 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SoupLogger: 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="SoupCookieJarDB.html" title="SoupCookieJarDB"> -<link rel="next" href="SoupProxyResolverDefault.html" title="SoupProxyResolverDefault"> -<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="#SoupLogger.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupLogger.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> - <a href="#SoupLogger.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> - <a href="#SoupLogger.properties" class="shortcut">Properties</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="SoupCookieJarDB.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="SoupProxyResolverDefault.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="SoupLogger"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="SoupLogger.top_of_page"></a>SoupLogger</span></h2> -<p>SoupLogger — Debug logging support</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="SoupLogger.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="SoupLogger.html" title="SoupLogger"><span class="returnvalue">SoupLogger</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupLogger.html#soup-logger-new" title="soup_logger_new ()">soup_logger_new</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupLogger.html#SoupLoggerLogLevel" title="enum SoupLoggerLogLevel"><span class="returnvalue">SoupLoggerLogLevel</span></a> -</td> -<td class="function_name"> -<span class="c_punctuation">(</span><a class="link" href="SoupLogger.html#SoupLoggerFilter" title="SoupLoggerFilter ()">*SoupLoggerFilter</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupLogger.html#soup-logger-set-request-filter" title="soup_logger_set_request_filter ()">soup_logger_set_request_filter</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupLogger.html#soup-logger-set-response-filter" title="soup_logger_set_response_filter ()">soup_logger_set_response_filter</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<span class="c_punctuation">(</span><a class="link" href="SoupLogger.html#SoupLoggerPrinter" title="SoupLoggerPrinter ()">*SoupLoggerPrinter</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupLogger.html#soup-logger-set-printer" title="soup_logger_set_printer ()">soup_logger_set_printer</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupLogger.properties"></a><h2>Properties</h2> -<div class="informaltable"><table class="informaltable" border="0"> -<colgroup> -<col width="150px" class="properties_type"> -<col width="300px" class="properties_name"> -<col width="200px" class="properties_flags"> -</colgroup> -<tbody> -<tr> -<td class="property_type"><a class="link" href="SoupLogger.html#SoupLoggerLogLevel" title="enum SoupLoggerLogLevel"><span class="type">SoupLoggerLogLevel</span></a></td> -<td class="property_name"><a class="link" href="SoupLogger.html#SoupLogger--level" title="The “level” property">level</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><span class="type">gint</span></td> -<td class="property_name"><a class="link" href="SoupLogger.html#SoupLogger--max-body-size" title="The “max-body-size” property">max-body-size</a></td> -<td class="property_flags">Read / Write</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupLogger.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="SoupLogger.html#SoupLogger-struct" title="SoupLogger">SoupLogger</a></td> -</tr> -<tr> -<td class="datatype_keyword">enum</td> -<td class="function_name"><a class="link" href="SoupLogger.html#SoupLoggerLogLevel" title="enum SoupLoggerLogLevel">SoupLoggerLogLevel</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupLogger.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> GObject - <span class="lineart">╰──</span> SoupLogger -</pre> -</div> -<div class="refsect1"> -<a name="SoupLogger.implemented-interfaces"></a><h2>Implemented Interfaces</h2> -<p> -SoupLogger implements - <a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature">SoupSessionFeature</a>.</p> -</div> -<div class="refsect1"> -<a name="SoupLogger.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="SoupLogger.description"></a><h2>Description</h2> -<p><a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a> watches a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> and logs the HTTP traffic that -it generates, for debugging purposes. Many applications use an -environment variable to determine whether or not to use -<a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a>, and to determine the amount of debugging output.</p> -<p>To use <a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a>, first create a logger with <a class="link" href="SoupLogger.html#soup-logger-new" title="soup_logger_new ()"><code class="function">soup_logger_new()</code></a>, -optionally configure it with <a class="link" href="SoupLogger.html#soup-logger-set-request-filter" title="soup_logger_set_request_filter ()"><code class="function">soup_logger_set_request_filter()</code></a>, -<a class="link" href="SoupLogger.html#soup-logger-set-response-filter" title="soup_logger_set_response_filter ()"><code class="function">soup_logger_set_response_filter()</code></a>, and <a class="link" href="SoupLogger.html#soup-logger-set-printer" title="soup_logger_set_printer ()"><code class="function">soup_logger_set_printer()</code></a>, -and then attach it to a session (or multiple sessions) 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>.</p> -<p>By default, the debugging output is sent to -<code class="literal">stdout</code>, and looks something like:</p> -<div class="informalexample"><pre class="screen"> -> POST /unauth HTTP/1.1 -> Soup-Debug-Timestamp: 1200171744 -> Soup-Debug: SoupSessionAsync 1 (0x612190), SoupMessage 1 (0x617000), SoupSocket 1 (0x612220) -> Host: localhost -> Content-Type: text/plain -> Connection: close -> -> This is a test. - -< HTTP/1.1 201 Created -< Soup-Debug-Timestamp: 1200171744 -< Soup-Debug: SoupMessage 1 (0x617000) -< Date: Sun, 12 Jan 2008 21:02:24 GMT -< Content-Length: 0 -</pre></div> -<p>The <code class="literal">Soup-Debug-Timestamp</code> line gives the time (as -a <span class="type">time_t</span>) when the request was sent, or the response fully -received.</p> -<p>The <code class="literal">Soup-Debug</code> line gives further debugging -information about the <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a>, <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>, and <a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a> -involved; the hex numbers are the addresses of the objects in -question (which may be useful if you are running in a debugger). -The decimal IDs are simply counters that uniquely identify objects -across the lifetime of the <a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a>. In particular, this can be -used to identify when multiple messages are sent across the same -connection.</p> -<p>Currently, the request half of the message is logged just before -the first byte of the request gets written to the network (from the -<a class="link" href="SoupMessage.html#SoupMessage-starting" title="The “starting” signal"><span class="type">“starting”</span></a> signal), which means that if you have -not made the complete request body available at that point, it will -not be logged.</p> -<p>The response is logged just after the last byte of the response -body is read from the network (from the <a class="link" href="SoupMessage.html#SoupMessage-got-body" title="The “got-body” signal"><span class="type">“got_body”</span></a> or -<a class="link" href="SoupMessage.html#SoupMessage-got-informational" title="The “got-informational” signal"><span class="type">“got_informational”</span></a> signal), which means that the -<a class="link" href="SoupMessage.html#SoupMessage-got-headers" title="The “got-headers” signal"><span class="type">“got_headers”</span></a> signal, and anything triggered off it -(such as <a class="link" href="SoupSession.html#SoupSession-authenticate" title="The “authenticate” signal"><span class="type">“authenticate”</span></a>) will be emitted -<span class="emphasis"><em>before</em></span> the response headers are actually -logged.</p> -<p>If the response doesn't happen to trigger the -<a class="link" href="SoupMessage.html#SoupMessage-got-body" title="The “got-body” signal"><span class="type">“got_body”</span></a> nor <a class="link" href="SoupMessage.html#SoupMessage-got-informational" title="The “got-informational” signal"><span class="type">“got_informational”</span></a> signals -due to, for example, a cancellation before receiving the last byte -of the response body, the response will still be logged on the -event of the <a class="link" href="SoupMessage.html#SoupMessage-finished" title="The “finished” signal"><span class="type">“finished”</span></a> signal.</p> -</div> -<div class="refsect1"> -<a name="SoupLogger.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="soup-logger-new"></a><h3>soup_logger_new ()</h3> -<pre class="programlisting"><a class="link" href="SoupLogger.html" title="SoupLogger"><span class="returnvalue">SoupLogger</span></a> * -soup_logger_new (<em class="parameter"><code><a class="link" href="SoupLogger.html#SoupLoggerLogLevel" title="enum SoupLoggerLogLevel"><span class="type">SoupLoggerLogLevel</span></a> level</code></em>, - <em class="parameter"><code><span class="type">int</span> max_body_size</code></em>);</pre> -<p>Creates a new <a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a> with the given debug level. If <em class="parameter"><code>level</code></em> - is -<a class="link" href="SoupLogger.html#SOUP-LOGGER-LOG-BODY:CAPS"><code class="literal">SOUP_LOGGER_LOG_BODY</code></a>, <em class="parameter"><code>max_body_size</code></em> - gives the maximum number of -bytes of the body that will be logged. (-1 means "no limit".)</p> -<p>If you need finer control over what message parts are and aren't -logged, use <a class="link" href="SoupLogger.html#soup-logger-set-request-filter" title="soup_logger_set_request_filter ()"><code class="function">soup_logger_set_request_filter()</code></a> and -<a class="link" href="SoupLogger.html#soup-logger-set-response-filter" title="soup_logger_set_response_filter ()"><code class="function">soup_logger_set_response_filter()</code></a>.</p> -<div class="refsect3"> -<a name="soup-logger-new.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>level</p></td> -<td class="parameter_description"><p>the debug level</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>max_body_size</p></td> -<td class="parameter_description"><p>the maximum body size to output, or -1</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-logger-new.returns"></a><h4>Returns</h4> -<p> a new <a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SoupLoggerFilter"></a><h3>SoupLoggerFilter ()</h3> -<pre class="programlisting"><a class="link" href="SoupLogger.html#SoupLoggerLogLevel" title="enum SoupLoggerLogLevel"><span class="returnvalue">SoupLoggerLogLevel</span></a> -<span class="c_punctuation">(</span>*SoupLoggerFilter<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a> *logger</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><span class="type">gpointer</span> user_data</code></em>);</pre> -<p>The prototype for a logging filter. The filter callback will be -invoked for each request or response, and should analyze it and -return a <a class="link" href="SoupLogger.html#SoupLoggerLogLevel" title="enum SoupLoggerLogLevel"><span class="type">SoupLoggerLogLevel</span></a> value indicating how much of the -message to log. Eg, it might choose between <a class="link" href="SoupLogger.html#SOUP-LOGGER-LOG-BODY:CAPS"><code class="literal">SOUP_LOGGER_LOG_BODY</code></a> -and <a class="link" href="SoupLogger.html#SOUP-LOGGER-LOG-HEADERS:CAPS"><code class="literal">SOUP_LOGGER_LOG_HEADERS</code></a> depending on the Content-Type.</p> -<div class="refsect3"> -<a name="SoupLoggerFilter.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>logger</p></td> -<td class="parameter_description"><p>the <a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</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 being logged</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>the data passed to <a class="link" href="SoupLogger.html#soup-logger-set-request-filter" title="soup_logger_set_request_filter ()"><code class="function">soup_logger_set_request_filter()</code></a> -or <a class="link" href="SoupLogger.html#soup-logger-set-response-filter" title="soup_logger_set_response_filter ()"><code class="function">soup_logger_set_response_filter()</code></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="SoupLoggerFilter.returns"></a><h4>Returns</h4> -<p> a <a class="link" href="SoupLogger.html#SoupLoggerLogLevel" title="enum SoupLoggerLogLevel"><span class="type">SoupLoggerLogLevel</span></a> value indicating how much of -the message to log</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-logger-set-request-filter"></a><h3>soup_logger_set_request_filter ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_logger_set_request_filter (<em class="parameter"><code><a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a> *logger</code></em>, - <em class="parameter"><code><a class="link" href="SoupLogger.html#SoupLoggerFilter" title="SoupLoggerFilter ()"><span class="type">SoupLoggerFilter</span></a> request_filter</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> filter_data</code></em>, - <em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>);</pre> -<p>Sets up a filter to determine the log level for a given request. -For each HTTP request <em class="parameter"><code>logger</code></em> - will invoke <em class="parameter"><code>request_filter</code></em> - to -determine how much (if any) of that request to log. (If you do not -set a request filter, <em class="parameter"><code>logger</code></em> - will just always log requests at the -level passed to <a class="link" href="SoupLogger.html#soup-logger-new" title="soup_logger_new ()"><code class="function">soup_logger_new()</code></a>.)</p> -<div class="refsect3"> -<a name="soup-logger-set-request-filter.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>logger</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>request_filter</p></td> -<td class="parameter_description"><p>the callback for request debugging</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>filter_data</p></td> -<td class="parameter_description"><p>data to pass to the callback</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>destroy</p></td> -<td class="parameter_description"><p>a <span class="type">GDestroyNotify</span> to free <em class="parameter"><code>filter_data</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-logger-set-response-filter"></a><h3>soup_logger_set_response_filter ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_logger_set_response_filter (<em class="parameter"><code><a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a> *logger</code></em>, - <em class="parameter"><code><a class="link" href="SoupLogger.html#SoupLoggerFilter" title="SoupLoggerFilter ()"><span class="type">SoupLoggerFilter</span></a> response_filter</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> filter_data</code></em>, - <em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>);</pre> -<p>Sets up a filter to determine the log level for a given response. -For each HTTP response <em class="parameter"><code>logger</code></em> - will invoke <em class="parameter"><code>response_filter</code></em> - to -determine how much (if any) of that response to log. (If you do not -set a response filter, <em class="parameter"><code>logger</code></em> - will just always log responses at -the level passed to <a class="link" href="SoupLogger.html#soup-logger-new" title="soup_logger_new ()"><code class="function">soup_logger_new()</code></a>.)</p> -<div class="refsect3"> -<a name="soup-logger-set-response-filter.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>logger</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>response_filter</p></td> -<td class="parameter_description"><p>the callback for response debugging</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>filter_data</p></td> -<td class="parameter_description"><p>data to pass to the callback</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>destroy</p></td> -<td class="parameter_description"><p>a <span class="type">GDestroyNotify</span> to free <em class="parameter"><code>filter_data</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SoupLoggerPrinter"></a><h3>SoupLoggerPrinter ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -<span class="c_punctuation">(</span>*SoupLoggerPrinter<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a> *logger</code></em>, - <em class="parameter"><code><a class="link" href="SoupLogger.html#SoupLoggerLogLevel" title="enum SoupLoggerLogLevel"><span class="type">SoupLoggerLogLevel</span></a> level</code></em>, - <em class="parameter"><code><span class="type">char</span> direction</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *data</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> -<p>The prototype for a custom printing callback.</p> -<p><em class="parameter"><code>level</code></em> - indicates what kind of information is being printed. Eg, it -will be <a class="link" href="SoupLogger.html#SOUP-LOGGER-LOG-HEADERS:CAPS"><code class="literal">SOUP_LOGGER_LOG_HEADERS</code></a> if <em class="parameter"><code>data</code></em> - is header data.</p> -<p><em class="parameter"><code>direction</code></em> - is either '<', '>', or ' ', and <em class="parameter"><code>data</code></em> - is the single line -to print; the printer is expected to add a terminating newline.</p> -<p>To get the effect of the default printer, you would do:</p> -<div class="informalexample"> - <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> - <tbody> - <tr> - <td class="listing_lines" align="right"><pre>1</pre></td> - <td class="listing_code"><pre class="programlisting"><span class="function">printf</span> <span class="gtkdoc opt">(</span><span class="string">"%c %s</span><span class="gtkdoc esc">\n</span><span class="string">"</span><span class="gtkdoc opt">,</span> direction<span class="gtkdoc opt">,</span> data<span class="gtkdoc opt">);</span></pre></td> - </tr> - </tbody> - </table> -</div> - -<div class="refsect3"> -<a name="SoupLoggerPrinter.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>logger</p></td> -<td class="parameter_description"><p>the <a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>level</p></td> -<td class="parameter_description"><p>the level of the information being printed.</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>direction</p></td> -<td class="parameter_description"><p>a single-character prefix to <em class="parameter"><code>data</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>data</p></td> -<td class="parameter_description"><p>data to print</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>the data passed to <a class="link" href="SoupLogger.html#soup-logger-set-printer" title="soup_logger_set_printer ()"><code class="function">soup_logger_set_printer()</code></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-logger-set-printer"></a><h3>soup_logger_set_printer ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_logger_set_printer (<em class="parameter"><code><a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a> *logger</code></em>, - <em class="parameter"><code><a class="link" href="SoupLogger.html#SoupLoggerPrinter" title="SoupLoggerPrinter ()"><span class="type">SoupLoggerPrinter</span></a> printer</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> printer_data</code></em>, - <em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>);</pre> -<p>Sets up an alternate log printing routine, if you don't want -the log to go to <code class="literal">stdout</code>.</p> -<div class="refsect3"> -<a name="soup-logger-set-printer.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>logger</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>printer</p></td> -<td class="parameter_description"><p>the callback for printing logging output</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>printer_data</p></td> -<td class="parameter_description"><p>data to pass to the callback</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>destroy</p></td> -<td class="parameter_description"><p>a <span class="type">GDestroyNotify</span> to free <em class="parameter"><code>printer_data</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -</div> -<div class="refsect1"> -<a name="SoupLogger.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupLogger-struct"></a><h3>SoupLogger</h3> -<pre class="programlisting">typedef struct _SoupLogger SoupLogger;</pre> -</div> -<hr> -<div class="refsect2"> -<a name="SoupLoggerLogLevel"></a><h3>enum SoupLoggerLogLevel</h3> -<p>Describes the level of logging output to provide.</p> -<div class="refsect3"> -<a name="SoupLoggerLogLevel.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="enum_members_name"> -<col class="enum_members_description"> -<col width="200px" class="enum_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="enum_member_name"><p><a name="SOUP-LOGGER-LOG-NONE:CAPS"></a>SOUP_LOGGER_LOG_NONE</p></td> -<td class="enum_member_description"> -<p>No logging</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-LOGGER-LOG-MINIMAL:CAPS"></a>SOUP_LOGGER_LOG_MINIMAL</p></td> -<td class="enum_member_description"> -<p>Log the Request-Line or Status-Line and -the Soup-Debug pseudo-headers</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-LOGGER-LOG-HEADERS:CAPS"></a>SOUP_LOGGER_LOG_HEADERS</p></td> -<td class="enum_member_description"> -<p>Log the full request/response headers</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-LOGGER-LOG-BODY:CAPS"></a>SOUP_LOGGER_LOG_BODY</p></td> -<td class="enum_member_description"> -<p>Log the full headers and request/response -bodies.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -</div> -<div class="refsect1"> -<a name="SoupLogger.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> -<a name="SoupLogger--level"></a><h3>The <code class="literal">“level”</code> property</h3> -<pre class="programlisting"> “level” <a class="link" href="SoupLogger.html#SoupLoggerLogLevel" title="enum SoupLoggerLogLevel"><span class="type">SoupLoggerLogLevel</span></a></pre> -<p>The level of logging output</p> -<p>Flags: Read / Write</p> -<p>Default value: SOUP_LOGGER_LOG_MINIMAL</p> -<p class="since">Since: 2.56</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupLogger--max-body-size"></a><h3>The <code class="literal">“max-body-size”</code> property</h3> -<pre class="programlisting"> “max-body-size” <span class="type">gint</span></pre> -<p>If <a class="link" href="SoupLogger.html#SoupLogger--level" title="The “level” property"><span class="type">“level”</span></a> is <a class="link" href="SoupLogger.html#SOUP-LOGGER-LOG-BODY:CAPS"><code class="literal">SOUP_LOGGER_LOG_BODY</code></a>, this gives -the maximum number of bytes of the body that will be logged. -(-1 means "no limit".)</p> -<p>Flags: Read / Write</p> -<p>Allowed values: >= -1</p> -<p>Default value: -1</p> -<p class="since">Since: 2.56</p> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/SoupMessage.html b/docs/reference/html/SoupMessage.html deleted file mode 100644 index 5c59e8cb..00000000 --- a/docs/reference/html/SoupMessage.html +++ /dev/null @@ -1,2737 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SoupMessage: 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="ch02.html" title="Core API"> -<link rel="prev" href="SoupCookie.html" title="SoupCookie"> -<link rel="next" href="SoupMessageHeaders.html" title="SoupMessageHeaders"> -<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="#SoupMessage.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupMessage.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> - <a href="#SoupMessage.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> - <a href="#SoupMessage.signals" class="shortcut">Signals</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="SoupCookie.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="SoupMessageHeaders.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="SoupMessage"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="SoupMessage.top_of_page"></a>SoupMessage</span></h2> -<p>SoupMessage — An HTTP request and response.</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="SoupMessage.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="SoupMessage.html" title="SoupMessage"><span class="returnvalue">SoupMessage</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupMessage.html#soup-message-new" title="soup_message_new ()">soup_message_new</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="returnvalue">SoupMessage</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupMessage.html#soup-message-new-from-uri" title="soup_message_new_from_uri ()">soup_message_new_from_uri</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessage.html#soup-message-set-request" title="soup_message_set_request ()">soup_message_set_request</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessage.html#soup-message-set-response" title="soup_message_set_response ()">soup_message_set_response</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessage.html#soup-message-set-http-version" title="soup_message_set_http_version ()">soup_message_set_http_version</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupMessage.html#SoupHTTPVersion" title="enum SoupHTTPVersion"><span class="returnvalue">SoupHTTPVersion</span></a> -</td> -<td class="function_name"> -<a class="link" href="SoupMessage.html#soup-message-get-http-version" title="soup_message_get_http_version ()">soup_message_get_http_version</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupURI.html" title="SoupURI"><span class="returnvalue">SoupURI</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupMessage.html#soup-message-get-uri" title="soup_message_get_uri ()">soup_message_get_uri</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessage.html#soup-message-set-uri" title="soup_message_set_uri ()">soup_message_set_uri</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupAddress.html" title="SoupAddress"><span class="returnvalue">SoupAddress</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupMessage.html#soup-message-get-address" title="soup_message_get_address ()">soup_message_get_address</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessage.html#soup-message-set-status" title="soup_message_set_status ()">soup_message_set_status</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessage.html#soup-message-set-status-full" title="soup_message_set_status_full ()">soup_message_set_status_full</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessage.html#soup-message-set-redirect" title="soup_message_set_redirect ()">soup_message_set_redirect</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessage.html#soup-message-is-keepalive" title="soup_message_is_keepalive ()">soup_message_is_keepalive</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessage.html#soup-message-get-https-status" title="soup_message_get_https_status ()">soup_message_get_https_status</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessage.html#soup-message-set-first-party" title="soup_message_set_first_party ()">soup_message_set_first_party</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupURI.html" title="SoupURI"><span class="returnvalue">SoupURI</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupMessage.html#soup-message-get-first-party" title="soup_message_get_first_party ()">soup_message_get_first_party</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">guint</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessage.html#soup-message-add-header-handler" title="soup_message_add_header_handler ()">soup_message_add_header_handler</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">guint</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessage.html#soup-message-add-status-code-handler" title="soup_message_add_status_code_handler ()">soup_message_add_status_code_handler</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessage.html#soup-message-set-flags" title="soup_message_set_flags ()">soup_message_set_flags</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupMessage.html#SoupMessageFlags" title="enum SoupMessageFlags"><span class="returnvalue">SoupMessageFlags</span></a> -</td> -<td class="function_name"> -<a class="link" href="SoupMessage.html#soup-message-get-flags" title="soup_message_get_flags ()">soup_message_get_flags</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="returnvalue">SoupBuffer</span></a> * -</td> -<td class="function_name"> -<span class="c_punctuation">(</span><a class="link" href="SoupMessage.html#SoupChunkAllocator" title="SoupChunkAllocator ()">*SoupChunkAllocator</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessage.html#soup-message-disable-feature" title="soup_message_disable_feature ()">soup_message_disable_feature</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupRequest.html" title="SoupRequest"><span class="returnvalue">SoupRequest</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupMessage.html#soup-message-get-soup-request" title="soup_message_get_soup_request ()">soup_message_get_soup_request</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupMessage.html#SoupMessagePriority" title="enum SoupMessagePriority"><span class="returnvalue">SoupMessagePriority</span></a> -</td> -<td class="function_name"> -<a class="link" href="SoupMessage.html#soup-message-get-priority" title="soup_message_get_priority ()">soup_message_get_priority</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessage.html#soup-message-set-priority" title="soup_message_set_priority ()">soup_message_set_priority</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupMessage.properties"></a><h2>Properties</h2> -<div class="informaltable"><table class="informaltable" border="0"> -<colgroup> -<col width="150px" class="properties_type"> -<col width="300px" class="properties_name"> -<col width="200px" class="properties_flags"> -</colgroup> -<tbody> -<tr> -<td class="property_type"> -<a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *</td> -<td class="property_name"><a class="link" href="SoupMessage.html#SoupMessage--first-party" title="The “first-party” property">first-party</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><a class="link" href="SoupMessage.html#SoupMessageFlags" title="enum SoupMessageFlags"><span class="type">SoupMessageFlags</span></a></td> -<td class="property_name"><a class="link" href="SoupMessage.html#SoupMessage--flags" title="The “flags” property">flags</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><a class="link" href="SoupMessage.html#SoupHTTPVersion" title="enum SoupHTTPVersion"><span class="type">SoupHTTPVersion</span></a></td> -<td class="property_name"><a class="link" href="SoupMessage.html#SoupMessage--http-version" title="The “http-version” property">http-version</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">gchar</span> *</td> -<td class="property_name"><a class="link" href="SoupMessage.html#SoupMessage--method" title="The “method” property">method</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><a class="link" href="SoupMessage.html#SoupMessagePriority" title="enum SoupMessagePriority"><span class="type">SoupMessagePriority</span></a></td> -<td class="property_name"><a class="link" href="SoupMessage.html#SoupMessage--priority" title="The “priority” property">priority</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">gchar</span> *</td> -<td class="property_name"><a class="link" href="SoupMessage.html#SoupMessage--reason-phrase" title="The “reason-phrase” property">reason-phrase</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a> *</td> -<td class="property_name"><a class="link" href="SoupMessage.html#SoupMessage--request-body" title="The “request-body” property">request-body</a></td> -<td class="property_flags">Read</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">GBytes</span> *</td> -<td class="property_name"><a class="link" href="SoupMessage.html#SoupMessage--request-body-data" title="The “request-body-data” property">request-body-data</a></td> -<td class="property_flags">Read</td> -</tr> -<tr> -<td class="property_type"> -<a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *</td> -<td class="property_name"><a class="link" href="SoupMessage.html#SoupMessage--request-headers" title="The “request-headers” property">request-headers</a></td> -<td class="property_flags">Read</td> -</tr> -<tr> -<td class="property_type"> -<a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a> *</td> -<td class="property_name"><a class="link" href="SoupMessage.html#SoupMessage--response-body" title="The “response-body” property">response-body</a></td> -<td class="property_flags">Read</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">GBytes</span> *</td> -<td class="property_name"><a class="link" href="SoupMessage.html#SoupMessage--response-body-data" title="The “response-body-data” property">response-body-data</a></td> -<td class="property_flags">Read</td> -</tr> -<tr> -<td class="property_type"> -<a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *</td> -<td class="property_name"><a class="link" href="SoupMessage.html#SoupMessage--response-headers" title="The “response-headers” property">response-headers</a></td> -<td class="property_flags">Read</td> -</tr> -<tr> -<td class="property_type"><span class="type">gboolean</span></td> -<td class="property_name"><a class="link" href="SoupMessage.html#SoupMessage--server-side" title="The “server-side” property">server-side</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -<tr> -<td class="property_type"><span class="type">guint</span></td> -<td class="property_name"><a class="link" href="SoupMessage.html#SoupMessage--status-code" title="The “status-code” property">status-code</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">GTlsCertificate</span> *</td> -<td class="property_name"><a class="link" href="SoupMessage.html#SoupMessage--tls-certificate" title="The “tls-certificate” property">tls-certificate</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><span class="type">GTlsCertificateFlags</span></td> -<td class="property_name"><a class="link" href="SoupMessage.html#SoupMessage--tls-errors" title="The “tls-errors” property">tls-errors</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *</td> -<td class="property_name"><a class="link" href="SoupMessage.html#SoupMessage--uri" title="The “uri” property">uri</a></td> -<td class="property_flags">Read / Write</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupMessage.signals"></a><h2>Signals</h2> -<div class="informaltable"><table class="informaltable" border="0"> -<colgroup> -<col width="150px" class="signals_return"> -<col width="300px" class="signals_name"> -<col width="200px" class="signals_flags"> -</colgroup> -<tbody> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="SoupMessage.html#SoupMessage-content-sniffed" title="The “content-sniffed” signal">content-sniffed</a></td> -<td class="signal_flags">Run First</td> -</tr> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="SoupMessage.html#SoupMessage-finished" title="The “finished” signal">finished</a></td> -<td class="signal_flags">Run First</td> -</tr> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="SoupMessage.html#SoupMessage-got-body" title="The “got-body” signal">got-body</a></td> -<td class="signal_flags">Run First</td> -</tr> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="SoupMessage.html#SoupMessage-got-chunk" title="The “got-chunk” signal">got-chunk</a></td> -<td class="signal_flags">Run First</td> -</tr> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="SoupMessage.html#SoupMessage-got-headers" title="The “got-headers” signal">got-headers</a></td> -<td class="signal_flags">Run First</td> -</tr> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="SoupMessage.html#SoupMessage-got-informational" title="The “got-informational” signal">got-informational</a></td> -<td class="signal_flags">Run First</td> -</tr> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="SoupMessage.html#SoupMessage-network-event" title="The “network-event” signal">network-event</a></td> -<td class="signal_flags">Run First</td> -</tr> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="SoupMessage.html#SoupMessage-restarted" title="The “restarted” signal">restarted</a></td> -<td class="signal_flags">Run First</td> -</tr> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="SoupMessage.html#SoupMessage-starting" title="The “starting” signal">starting</a></td> -<td class="signal_flags">Run First</td> -</tr> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="SoupMessage.html#SoupMessage-wrote-body" title="The “wrote-body” signal">wrote-body</a></td> -<td class="signal_flags">Run First</td> -</tr> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="SoupMessage.html#SoupMessage-wrote-body-data" title="The “wrote-body-data” signal">wrote-body-data</a></td> -<td class="signal_flags">Run First</td> -</tr> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="SoupMessage.html#SoupMessage-wrote-chunk" title="The “wrote-chunk” signal">wrote-chunk</a></td> -<td class="signal_flags">Run First</td> -</tr> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="SoupMessage.html#SoupMessage-wrote-headers" title="The “wrote-headers” signal">wrote-headers</a></td> -<td class="signal_flags">Run First</td> -</tr> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="SoupMessage.html#SoupMessage-wrote-informational" title="The “wrote-informational” signal">wrote-informational</a></td> -<td class="signal_flags">Run First</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupMessage.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="SoupMessage.html#SoupMessage-struct" title="SoupMessage">SoupMessage</a></td> -</tr> -<tr> -<td class="datatype_keyword">enum</td> -<td class="function_name"><a class="link" href="SoupMessage.html#SoupHTTPVersion" title="enum SoupHTTPVersion">SoupHTTPVersion</a></td> -</tr> -<tr> -<td class="datatype_keyword">enum</td> -<td class="function_name"><a class="link" href="SoupMessage.html#SoupMessageFlags" title="enum SoupMessageFlags">SoupMessageFlags</a></td> -</tr> -<tr> -<td class="datatype_keyword">enum</td> -<td class="function_name"><a class="link" href="SoupMessage.html#SoupMessagePriority" title="enum SoupMessagePriority">SoupMessagePriority</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupMessage.html#SOUP-MESSAGE-METHOD:CAPS" title="SOUP_MESSAGE_METHOD">SOUP_MESSAGE_METHOD</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupMessage.html#SOUP-MESSAGE-URI:CAPS" title="SOUP_MESSAGE_URI">SOUP_MESSAGE_URI</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupMessage.html#SOUP-MESSAGE-HTTP-VERSION:CAPS" title="SOUP_MESSAGE_HTTP_VERSION">SOUP_MESSAGE_HTTP_VERSION</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupMessage.html#SOUP-MESSAGE-FLAGS:CAPS" title="SOUP_MESSAGE_FLAGS">SOUP_MESSAGE_FLAGS</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupMessage.html#SOUP-MESSAGE-STATUS-CODE:CAPS" title="SOUP_MESSAGE_STATUS_CODE">SOUP_MESSAGE_STATUS_CODE</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupMessage.html#SOUP-MESSAGE-REASON-PHRASE:CAPS" title="SOUP_MESSAGE_REASON_PHRASE">SOUP_MESSAGE_REASON_PHRASE</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupMessage.html#SOUP-MESSAGE-SERVER-SIDE:CAPS" title="SOUP_MESSAGE_SERVER_SIDE">SOUP_MESSAGE_SERVER_SIDE</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupMessage.html#SOUP-MESSAGE-FIRST-PARTY:CAPS" title="SOUP_MESSAGE_FIRST_PARTY">SOUP_MESSAGE_FIRST_PARTY</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupMessage.html#SOUP-MESSAGE-PRIORITY:CAPS" title="SOUP_MESSAGE_PRIORITY">SOUP_MESSAGE_PRIORITY</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupMessage.html#SOUP-MESSAGE-REQUEST-BODY:CAPS" title="SOUP_MESSAGE_REQUEST_BODY">SOUP_MESSAGE_REQUEST_BODY</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupMessage.html#SOUP-MESSAGE-REQUEST-BODY-DATA:CAPS" title="SOUP_MESSAGE_REQUEST_BODY_DATA">SOUP_MESSAGE_REQUEST_BODY_DATA</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupMessage.html#SOUP-MESSAGE-REQUEST-HEADERS:CAPS" title="SOUP_MESSAGE_REQUEST_HEADERS">SOUP_MESSAGE_REQUEST_HEADERS</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupMessage.html#SOUP-MESSAGE-RESPONSE-BODY:CAPS" title="SOUP_MESSAGE_RESPONSE_BODY">SOUP_MESSAGE_RESPONSE_BODY</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupMessage.html#SOUP-MESSAGE-RESPONSE-BODY-DATA:CAPS" title="SOUP_MESSAGE_RESPONSE_BODY_DATA">SOUP_MESSAGE_RESPONSE_BODY_DATA</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupMessage.html#SOUP-MESSAGE-RESPONSE-HEADERS:CAPS" title="SOUP_MESSAGE_RESPONSE_HEADERS">SOUP_MESSAGE_RESPONSE_HEADERS</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupMessage.html#SOUP-MESSAGE-TLS-CERTIFICATE:CAPS" title="SOUP_MESSAGE_TLS_CERTIFICATE">SOUP_MESSAGE_TLS_CERTIFICATE</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupMessage.html#SOUP-MESSAGE-TLS-ERRORS:CAPS" title="SOUP_MESSAGE_TLS_ERRORS">SOUP_MESSAGE_TLS_ERRORS</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupMessage.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> GObject - <span class="lineart">╰──</span> SoupMessage -</pre> -</div> -<div class="refsect1"> -<a name="SoupMessage.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="SoupMessage.description"></a><h2>Description</h2> -<p>A <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> represents an HTTP message that is being sent or -received.</p> -<p>For client-side usage, if you are using the traditional -<a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> APIs (<a class="link" href="SoupSession.html#soup-session-queue-message" title="soup_session_queue_message ()"><code class="function">soup_session_queue_message()</code></a> and -<a class="link" href="SoupSession.html#soup-session-send-message" title="soup_session_send_message ()"><code class="function">soup_session_send_message()</code></a>), you would create a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> with -<a class="link" href="SoupMessage.html#soup-message-new" title="soup_message_new ()"><code class="function">soup_message_new()</code></a> or <a class="link" href="SoupMessage.html#soup-message-new-from-uri" title="soup_message_new_from_uri ()"><code class="function">soup_message_new_from_uri()</code></a>, set up its -fields appropriately, and send it. If you are using the newer -<a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a> API, you would create a request with -<a class="link" href="SoupSession.html#soup-session-request-http" title="soup_session_request_http ()"><code class="function">soup_session_request_http()</code></a> or <a class="link" href="SoupSession.html#soup-session-request-http-uri" title="soup_session_request_http_uri ()"><code class="function">soup_session_request_http_uri()</code></a>, and -the returned <a class="link" href="SoupRequestHTTP.html" title="SoupRequestHTTP"><span class="type">SoupRequestHTTP</span></a> will already have an associated -<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> that you can retrieve via -<a class="link" href="SoupRequestHTTP.html#soup-request-http-get-message" title="soup_request_http_get_message ()"><code class="function">soup_request_http_get_message()</code></a>.</p> -<p>For server-side usage, <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> will create <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>s automatically for incoming requests, which your application -will receive via handlers.</p> -<p>Note that libsoup's terminology here does not quite match the HTTP -specification: in RFC 2616, an "HTTP-message" is -<span class="emphasis"><em>either</em></span> a Request, <span class="emphasis"><em>or</em></span> a -Response. In libsoup, a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> combines both the request and -the response.</p> -</div> -<div class="refsect1"> -<a name="SoupMessage.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="soup-message-new"></a><h3>soup_message_new ()</h3> -<pre class="programlisting"><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="returnvalue">SoupMessage</span></a> * -soup_message_new (<em class="parameter"><code>const <span class="type">char</span> *method</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *uri_string</code></em>);</pre> -<p>Creates a new empty <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>, which will connect to <em class="parameter"><code>uri</code></em> -</p> -<div class="refsect3"> -<a name="soup-message-new.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>method</p></td> -<td class="parameter_description"><p>the HTTP method for the created request</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>uri_string</p></td> -<td class="parameter_description"><p>the destination endpoint (as a string)</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-message-new.returns"></a><h4>Returns</h4> -<p>the new <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> (or <code class="literal">NULL</code> if <em class="parameter"><code>uri</code></em> -could not be parsed). </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-new-from-uri"></a><h3>soup_message_new_from_uri ()</h3> -<pre class="programlisting"><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="returnvalue">SoupMessage</span></a> * -soup_message_new_from_uri (<em class="parameter"><code>const <span class="type">char</span> *method</code></em>, - <em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>);</pre> -<p>Creates a new empty <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>, which will connect to <em class="parameter"><code>uri</code></em> -</p> -<div class="refsect3"> -<a name="soup-message-new-from-uri.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>method</p></td> -<td class="parameter_description"><p>the HTTP method for the created request</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>uri</p></td> -<td class="parameter_description"><p>the destination endpoint (as a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a>)</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-message-new-from-uri.returns"></a><h4>Returns</h4> -<p> the new <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-set-request"></a><h3>soup_message_set_request ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_set_request (<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>const <span class="type">char</span> *content_type</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessageBody.html#SoupMemoryUse" title="enum SoupMemoryUse"><span class="type">SoupMemoryUse</span></a> req_use</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *req_body</code></em>, - <em class="parameter"><code><span class="type">gsize</span> req_length</code></em>);</pre> -<p>Convenience function to set the request body of a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>. If -<em class="parameter"><code>content_type</code></em> - is <code class="literal">NULL</code>, the request body must be empty as well.</p> -<div class="refsect3"> -<a name="soup-message-set-request.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>msg</p></td> -<td class="parameter_description"><p>the message</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>content_type</p></td> -<td class="parameter_description"><p>MIME Content-Type of the body. </p></td> -<td class="parameter_annotations"><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 class="parameter_name"><p>req_use</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageBody.html#SoupMemoryUse" title="enum SoupMemoryUse"><span class="type">SoupMemoryUse</span></a> describing how to handle <em class="parameter"><code>req_body</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>req_body</p></td> -<td class="parameter_description"><p>a data buffer containing the body of the message request. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=req_length][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint8]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>req_length</p></td> -<td class="parameter_description"><p>the byte length of <em class="parameter"><code>req_body</code></em> -.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-set-response"></a><h3>soup_message_set_response ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_set_response (<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>const <span class="type">char</span> *content_type</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessageBody.html#SoupMemoryUse" title="enum SoupMemoryUse"><span class="type">SoupMemoryUse</span></a> resp_use</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *resp_body</code></em>, - <em class="parameter"><code><span class="type">gsize</span> resp_length</code></em>);</pre> -<p>Convenience function to set the response body of a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>. If -<em class="parameter"><code>content_type</code></em> - is <code class="literal">NULL</code>, the response body must be empty as well.</p> -<div class="refsect3"> -<a name="soup-message-set-response.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>msg</p></td> -<td class="parameter_description"><p>the message</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>content_type</p></td> -<td class="parameter_description"><p>MIME Content-Type of the body. </p></td> -<td class="parameter_annotations"><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 class="parameter_name"><p>resp_use</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageBody.html#SoupMemoryUse" title="enum SoupMemoryUse"><span class="type">SoupMemoryUse</span></a> describing how to handle <em class="parameter"><code>resp_body</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>resp_body</p></td> -<td class="parameter_description"><p>a data buffer containing the body of the message response. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=resp_length][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint8]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>resp_length</p></td> -<td class="parameter_description"><p>the byte length of <em class="parameter"><code>resp_body</code></em> -.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-set-http-version"></a><h3>soup_message_set_http_version ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_set_http_version (<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="SoupMessage.html#SoupHTTPVersion" title="enum SoupHTTPVersion"><span class="type">SoupHTTPVersion</span></a> version</code></em>);</pre> -<p>Sets the HTTP version on <em class="parameter"><code>msg</code></em> -. The default version is -<a class="link" href="SoupMessage.html#SOUP-HTTP-1-1:CAPS"><code class="literal">SOUP_HTTP_1_1</code></a>. Setting it to <a class="link" href="SoupMessage.html#SOUP-HTTP-1-0:CAPS"><code class="literal">SOUP_HTTP_1_0</code></a> will prevent certain -functionality from being used.</p> -<div class="refsect3"> -<a name="soup-message-set-http-version.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>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>version</p></td> -<td class="parameter_description"><p>the HTTP version</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-get-http-version"></a><h3>soup_message_get_http_version ()</h3> -<pre class="programlisting"><a class="link" href="SoupMessage.html#SoupHTTPVersion" title="enum SoupHTTPVersion"><span class="returnvalue">SoupHTTPVersion</span></a> -soup_message_get_http_version (<em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>);</pre> -<p>Gets the HTTP version of <em class="parameter"><code>msg</code></em> -. This is the minimum of the -version from the request and the version from the response.</p> -<div class="refsect3"> -<a name="soup-message-get-http-version.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>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-message-get-http-version.returns"></a><h4>Returns</h4> -<p> the HTTP version</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-get-uri"></a><h3>soup_message_get_uri ()</h3> -<pre class="programlisting"><a class="link" href="SoupURI.html" title="SoupURI"><span class="returnvalue">SoupURI</span></a> * -soup_message_get_uri (<em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>);</pre> -<p>Gets <em class="parameter"><code>msg</code></em> -'s URI</p> -<div class="refsect3"> -<a name="soup-message-get-uri.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>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-message-get-uri.returns"></a><h4>Returns</h4> -<p>the URI <em class="parameter"><code>msg</code></em> -is targeted for. </p> -<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-set-uri"></a><h3>soup_message_set_uri ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_set_uri (<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="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>);</pre> -<p>Sets <em class="parameter"><code>msg</code></em> -'s URI to <em class="parameter"><code>uri</code></em> -. If <em class="parameter"><code>msg</code></em> - has already been sent and you want -to re-send it with the new URI, you need to call -<a class="link" href="SoupSession.html#soup-session-requeue-message" title="soup_session_requeue_message ()"><code class="function">soup_session_requeue_message()</code></a>.</p> -<div class="refsect3"> -<a name="soup-message-set-uri.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>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>uri</p></td> -<td class="parameter_description"><p>the new <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-get-address"></a><h3>soup_message_get_address ()</h3> -<pre class="programlisting"><a class="link" href="SoupAddress.html" title="SoupAddress"><span class="returnvalue">SoupAddress</span></a> * -soup_message_get_address (<em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>);</pre> -<p>Gets the address <em class="parameter"><code>msg</code></em> -'s URI points to. After first setting the -URI on a message, this will be unresolved, although the message's -session will resolve it before sending the message.</p> -<div class="refsect3"> -<a name="soup-message-get-address.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>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-message-get-address.returns"></a><h4>Returns</h4> -<p>the address <em class="parameter"><code>msg</code></em> -'s URI points to. </p> -<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-set-status"></a><h3>soup_message_set_status ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_set_status (<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><span class="type">guint</span> status_code</code></em>);</pre> -<p>Sets <em class="parameter"><code>msg</code></em> -'s status code to <em class="parameter"><code>status_code</code></em> -. If <em class="parameter"><code>status_code</code></em> - is a -known value, it will also set <em class="parameter"><code>msg</code></em> -'s reason_phrase.</p> -<div class="refsect3"> -<a name="soup-message-set-status.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>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>status_code</p></td> -<td class="parameter_description"><p>an HTTP status code</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-set-status-full"></a><h3>soup_message_set_status_full ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_set_status_full (<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><span class="type">guint</span> status_code</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *reason_phrase</code></em>);</pre> -<p>Sets <em class="parameter"><code>msg</code></em> -'s status code and reason phrase.</p> -<div class="refsect3"> -<a name="soup-message-set-status-full.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>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>status_code</p></td> -<td class="parameter_description"><p>an HTTP status code</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>reason_phrase</p></td> -<td class="parameter_description"><p>a description of the status</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-set-redirect"></a><h3>soup_message_set_redirect ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_set_redirect (<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><span class="type">guint</span> status_code</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *redirect_uri</code></em>);</pre> -<p>Sets <em class="parameter"><code>msg</code></em> -'s status_code to <em class="parameter"><code>status_code</code></em> - and adds a Location header -pointing to <em class="parameter"><code>redirect_uri</code></em> -. Use this from a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> when you -want to redirect the client to another URI.</p> -<p><em class="parameter"><code>redirect_uri</code></em> - can be a relative URI, in which case it is -interpreted relative to <em class="parameter"><code>msg</code></em> -'s current URI. In particular, if -<em class="parameter"><code>redirect_uri</code></em> - is just a path, it will replace the path -<span class="emphasis"><em>and query</em></span> of <em class="parameter"><code>msg</code></em> -'s URI.</p> -<div class="refsect3"> -<a name="soup-message-set-redirect.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>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>status_code</p></td> -<td class="parameter_description"><p>a 3xx status code</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>redirect_uri</p></td> -<td class="parameter_description"><p>the URI to redirect <em class="parameter"><code>msg</code></em> -to</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.38</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-is-keepalive"></a><h3>soup_message_is_keepalive ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_message_is_keepalive (<em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>);</pre> -<p>Determines whether or not <em class="parameter"><code>msg</code></em> -'s connection can be kept alive for -further requests after processing <em class="parameter"><code>msg</code></em> -, based on the HTTP version, -Connection header, etc.</p> -<div class="refsect3"> -<a name="soup-message-is-keepalive.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>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-message-is-keepalive.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> or <code class="literal">FALSE</code>.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-get-https-status"></a><h3>soup_message_get_https_status ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_message_get_https_status (<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><span class="type">GTlsCertificate</span> **certificate</code></em>, - <em class="parameter"><code><span class="type">GTlsCertificateFlags</span> *errors</code></em>);</pre> -<p>If <em class="parameter"><code>msg</code></em> - is using https (or attempted to use https but got -<a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-SSL-FAILED:CAPS"><code class="literal">SOUP_STATUS_SSL_FAILED</code></a>), this retrieves the <span class="type">GTlsCertificate</span> -associated with its connection, and the <span class="type">GTlsCertificateFlags</span> -showing what problems, if any, have been found with that -certificate.</p> -<div class="note"><p>This is only meaningful with messages processed by a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> and is -not useful for messages received by a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a></p></div> -<div class="refsect3"> -<a name="soup-message-get-https-status.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>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>certificate</p></td> -<td class="parameter_description"><p><em class="parameter"><code>msg</code></em> -'s TLS certificate. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>errors</p></td> -<td class="parameter_description"><p>the verification status of <em class="parameter"><code>certificate</code></em> -. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-message-get-https-status.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if <em class="parameter"><code>msg</code></em> -used/attempted https, <code class="literal">FALSE</code> if not</p> -</div> -<p class="since">Since: 2.34</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-set-first-party"></a><h3>soup_message_set_first_party ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_set_first_party (<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="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *first_party</code></em>);</pre> -<p>Sets <em class="parameter"><code>first_party</code></em> - as the main document <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> for <em class="parameter"><code>msg</code></em> -. For -details of when and how this is used refer to the documentation for -<a class="link" href="SoupCookieJar.html#SoupCookieJarAcceptPolicy" title="enum SoupCookieJarAcceptPolicy"><span class="type">SoupCookieJarAcceptPolicy</span></a>.</p> -<div class="refsect3"> -<a name="soup-message-set-first-party.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>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>first_party</p></td> -<td class="parameter_description"><p>the <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> for the <em class="parameter"><code>msg</code></em> -'s first party</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.30</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-get-first-party"></a><h3>soup_message_get_first_party ()</h3> -<pre class="programlisting"><a class="link" href="SoupURI.html" title="SoupURI"><span class="returnvalue">SoupURI</span></a> * -soup_message_get_first_party (<em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>);</pre> -<p>Gets <em class="parameter"><code>msg</code></em> -'s first-party <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p> -<div class="refsect3"> -<a name="soup-message-get-first-party.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>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-message-get-first-party.returns"></a><h4>Returns</h4> -<p>the <em class="parameter"><code>msg</code></em> -'s first party <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a>. </p> -<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.30</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-add-header-handler"></a><h3>soup_message_add_header_handler ()</h3> -<pre class="programlisting"><span class="returnvalue">guint</span> -soup_message_add_header_handler (<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>const <span class="type">char</span> *signal</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *header</code></em>, - <em class="parameter"><code><span class="type">GCallback</span> callback</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> -<p>Adds a signal handler to <em class="parameter"><code>msg</code></em> - for <em class="parameter"><code>signal</code></em> -, as with -<code class="function">g_signal_connect()</code>, but the <em class="parameter"><code>callback</code></em> - will only be run if <em class="parameter"><code>msg</code></em> -'s -incoming messages headers (that is, the -<code class="literal">request_headers</code> for a client <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>, or -the <code class="literal">response_headers</code> for a server <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>) -contain a header named <em class="parameter"><code>header</code></em> -.</p> -<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> -<div class="refsect3"> -<a name="soup-message-add-header-handler.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>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>signal</p></td> -<td class="parameter_description"><p>signal to connect the handler to.</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>header</p></td> -<td class="parameter_description"><p>HTTP response header to match against</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>callback</p></td> -<td class="parameter_description"><p>the header handler</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>data to pass to <em class="parameter"><code>handler_cb</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-message-add-header-handler.returns"></a><h4>Returns</h4> -<p> the handler ID from <code class="function">g_signal_connect()</code></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-add-status-code-handler"></a><h3>soup_message_add_status_code_handler ()</h3> -<pre class="programlisting"><span class="returnvalue">guint</span> -soup_message_add_status_code_handler (<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>const <span class="type">char</span> *signal</code></em>, - <em class="parameter"><code><span class="type">guint</span> status_code</code></em>, - <em class="parameter"><code><span class="type">GCallback</span> callback</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> -<p>Adds a signal handler to <em class="parameter"><code>msg</code></em> - for <em class="parameter"><code>signal</code></em> -, as with -<code class="function">g_signal_connect()</code>, but the <em class="parameter"><code>callback</code></em> - will only be run if <em class="parameter"><code>msg</code></em> - has -the status <em class="parameter"><code>status_code</code></em> -.</p> -<p><em class="parameter"><code>signal</code></em> - must be a signal that will be emitted after <em class="parameter"><code>msg</code></em> -'s status -is set. For a client <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>, this means it can't be a "wrote" -signal. For a server <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>, this means it can't be a "got" -signal.</p> -<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> -<div class="refsect3"> -<a name="soup-message-add-status-code-handler.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>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>signal</p></td> -<td class="parameter_description"><p>signal to connect the handler to.</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>status_code</p></td> -<td class="parameter_description"><p>status code to match against</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>callback</p></td> -<td class="parameter_description"><p>the header handler</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>data to pass to <em class="parameter"><code>handler_cb</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-message-add-status-code-handler.returns"></a><h4>Returns</h4> -<p> the handler ID from <code class="function">g_signal_connect()</code></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-set-flags"></a><h3>soup_message_set_flags ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_set_flags (<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="SoupMessage.html#SoupMessageFlags" title="enum SoupMessageFlags"><span class="type">SoupMessageFlags</span></a> flags</code></em>);</pre> -<p>Sets the specified flags on <em class="parameter"><code>msg</code></em> -.</p> -<div class="refsect3"> -<a name="soup-message-set-flags.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>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>flags</p></td> -<td class="parameter_description"><p>a set of <a class="link" href="SoupMessage.html#SoupMessageFlags" title="enum SoupMessageFlags"><span class="type">SoupMessageFlags</span></a> values</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-get-flags"></a><h3>soup_message_get_flags ()</h3> -<pre class="programlisting"><a class="link" href="SoupMessage.html#SoupMessageFlags" title="enum SoupMessageFlags"><span class="returnvalue">SoupMessageFlags</span></a> -soup_message_get_flags (<em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>);</pre> -<p>Gets the flags on <em class="parameter"><code>msg</code></em> -</p> -<div class="refsect3"> -<a name="soup-message-get-flags.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>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-message-get-flags.returns"></a><h4>Returns</h4> -<p> the flags</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SoupChunkAllocator"></a><h3>SoupChunkAllocator ()</h3> -<pre class="programlisting"><a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="returnvalue">SoupBuffer</span></a> * -<span class="c_punctuation">(</span>*SoupChunkAllocator<span class="c_punctuation">)</span> (<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><span class="type">gsize</span> max_len</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> -<div class="warning"> -<p><code class="literal">SoupChunkAllocator</code> is deprecated and should not be used in newly-written code.</p> -<p>Use <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a> if you want to read into your -own buffers.</p> -</div> -<p>The prototype for a chunk allocation callback. This should allocate -a new <a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> and return it for the I/O layer to read message -body data off the network into.</p> -<p>If <em class="parameter"><code>max_len</code></em> - is non-0, it indicates the maximum number of bytes that -could be read, based on what is known about the message size. Note -that this might be a very large number, and you should not simply -try to allocate that many bytes blindly. If <em class="parameter"><code>max_len</code></em> - is 0, that -means that libsoup does not know how many bytes remain to be read, -and the allocator should return a buffer of a size that it finds -convenient.</p> -<p>If the allocator returns <code class="literal">NULL</code>, the message will be paused. It is -up to the application to make sure that it gets unpaused when it -becomes possible to allocate a new buffer.</p> -<div class="refsect3"> -<a name="SoupChunkAllocator.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>msg</p></td> -<td class="parameter_description"><p>the <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> the chunk is being allocated for</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>max_len</p></td> -<td class="parameter_description"><p>the maximum length that will be read, or 0.</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>the data passed to <code class="function">soup_message_set_chunk_allocator()</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="SoupChunkAllocator.returns"></a><h4>Returns</h4> -<p>the new buffer (or <code class="literal">NULL</code>). </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-disable-feature"></a><h3>soup_message_disable_feature ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_disable_feature (<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><span class="type">GType</span> feature_type</code></em>);</pre> -<p>This disables the actions of <a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature"><span class="type">SoupSessionFeature</span></a>s with the -given <em class="parameter"><code>feature_type</code></em> - (or a subclass of that type) on <em class="parameter"><code>msg</code></em> -, so that -<em class="parameter"><code>msg</code></em> - is processed as though the feature(s) hadn't been added to the -session. Eg, passing <span class="type">SOUP_TYPE_CONTENT_SNIFFER</span> for <em class="parameter"><code>feature_type</code></em> - -will disable Content-Type sniffing on the message.</p> -<p>You must call this before queueing <em class="parameter"><code>msg</code></em> - on a session; calling it on -a message that has already been queued is undefined. In particular, -you cannot call this on a message that is being requeued after a -redirect or authentication.</p> -<div class="refsect3"> -<a name="soup-message-disable-feature.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>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>feature_type</p></td> -<td class="parameter_description"><p>the <span class="type">GType</span> of a <a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature"><span class="type">SoupSessionFeature</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.28</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-get-soup-request"></a><h3>soup_message_get_soup_request ()</h3> -<pre class="programlisting"><a class="link" href="SoupRequest.html" title="SoupRequest"><span class="returnvalue">SoupRequest</span></a> * -soup_message_get_soup_request (<em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>);</pre> -<p>If <em class="parameter"><code>msg</code></em> - is associated with a <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a>, this returns that -request. Otherwise it returns <code class="literal">NULL</code>.</p> -<div class="refsect3"> -<a name="soup-message-get-soup-request.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>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-message-get-soup-request.returns"></a><h4>Returns</h4> -<p><em class="parameter"><code>msg</code></em> -'s associated <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a>. </p> -<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-get-priority"></a><h3>soup_message_get_priority ()</h3> -<pre class="programlisting"><a class="link" href="SoupMessage.html#SoupMessagePriority" title="enum SoupMessagePriority"><span class="returnvalue">SoupMessagePriority</span></a> -soup_message_get_priority (<em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>);</pre> -<p>Retrieves the <a class="link" href="SoupMessage.html#SoupMessagePriority" title="enum SoupMessagePriority"><span class="type">SoupMessagePriority</span></a>. If not set this value defaults -to <a class="link" href="SoupMessage.html#SOUP-MESSAGE-PRIORITY-NORMAL:CAPS"><span class="type">SOUP_MESSAGE_PRIORITY_NORMAL</span></a>.</p> -<div class="refsect3"> -<a name="soup-message-get-priority.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>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-message-get-priority.returns"></a><h4>Returns</h4> -<p> the priority of the message.</p> -</div> -<p class="since">Since: 2.44</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-set-priority"></a><h3>soup_message_set_priority ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_set_priority (<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="SoupMessage.html#SoupMessagePriority" title="enum SoupMessagePriority"><span class="type">SoupMessagePriority</span></a> priority</code></em>);</pre> -<p>Sets the priority of a message. Note that this won't have any -effect unless used before the message is added to the session's -message processing queue.</p> -<p>The message will be placed just before any other previously added -message with lower priority (messages with the same priority are -processed on a FIFO basis).</p> -<p>Setting priorities does not currently work with <a class="link" href="SoupSessionSync.html" title="SoupSessionSync"><span class="type">SoupSessionSync</span></a> -(or with synchronous messages on a plain <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a>) because in -the synchronous/blocking case, priority ends up being determined -semi-randomly by thread scheduling.</p> -<div class="refsect3"> -<a name="soup-message-set-priority.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>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>priority</p></td> -<td class="parameter_description"><p>the <a class="link" href="SoupMessage.html#SoupMessagePriority" title="enum SoupMessagePriority"><span class="type">SoupMessagePriority</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.44</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupMessage.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupMessage-struct"></a><h3>SoupMessage</h3> -<pre class="programlisting">typedef struct { - const char *method; - - guint status_code; - char *reason_phrase; - - SoupMessageBody *request_body; - SoupMessageHeaders *request_headers; - - SoupMessageBody *response_body; - SoupMessageHeaders *response_headers; -} SoupMessage; -</pre> -<p>Represents an HTTP message being sent or received.</p> -<p><em class="parameter"><code>status_code</code></em> - will normally be a <a class="link" href="libsoup-2.4-soup-status.html#SoupStatus" title="enum SoupStatus"><span class="type">SoupStatus</span></a> value, eg, -<a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-OK:CAPS"><code class="literal">SOUP_STATUS_OK</code></a>, though of course it might actually be an unknown -status code. <em class="parameter"><code>reason_phrase</code></em> - is the actual text returned from the -server, which may or may not correspond to the "standard" -description of <em class="parameter"><code>status_code</code></em> -. At any rate, it is almost certainly -not localized, and not very descriptive even if it is in the user's -language; you should not use <em class="parameter"><code>reason_phrase</code></em> - in user-visible -messages. Rather, you should look at <em class="parameter"><code>status_code</code></em> -, and determine an -end-user-appropriate message based on that and on what you were -trying to do.</p> -<p>As described in the <a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a> documentation, the -<em class="parameter"><code>request_body</code></em> - and <em class="parameter"><code>response_body</code></em> - <code class="literal">data</code> fields -will not necessarily be filled in at all times. When the body -fields are filled in, they will be terminated with a '\0' byte -(which is not included in the <code class="literal">length</code>), so you -can use them as ordinary C strings (assuming that you know that the -body doesn't have any other '\0' bytes).</p> -<p>For a client-side <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>, <em class="parameter"><code>request_body</code></em> -'s -<code class="literal">data</code> is usually filled in right before libsoup -writes the request to the network, but you should not count on -this; use <a class="link" href="SoupMessageBody.html#soup-message-body-flatten" title="soup_message_body_flatten ()"><code class="function">soup_message_body_flatten()</code></a> if you want to ensure that -<code class="literal">data</code> is filled in. If you are not using -<a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a> to read the response, then <em class="parameter"><code>response_body</code></em> -'s -<code class="literal">data</code> will be filled in before -<a class="link" href="SoupMessage.html#SoupMessage-finished" title="The “finished” signal"><span class="type">“finished”</span></a> is emitted. (If you are using <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a>, -then the message body is not accumulated by default, so -<em class="parameter"><code>response_body</code></em> -'s <code class="literal">data</code> will always be <code class="literal">NULL</code>.)</p> -<p>For a server-side <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>, <em class="parameter"><code>request_body</code></em> -'s <code class="literal">data</code> will be -filled in before <a class="link" href="SoupMessage.html#SoupMessage-got-body" title="The “got-body” signal"><span class="type">“got_body”</span></a> is emitted.</p> -<p>To prevent the <code class="literal">data</code> field from being filled in at all (eg, if you -are handling the data from a <a class="link" href="SoupMessage.html#SoupMessage-got-chunk" title="The “got-chunk” signal"><span class="type">“got_chunk”</span></a>, and so don't -need to see it all at the end), call -<a class="link" href="SoupMessageBody.html#soup-message-body-set-accumulate" title="soup_message_body_set_accumulate ()"><code class="function">soup_message_body_set_accumulate()</code></a> on <em class="parameter"><code>response_body</code></em> - or -<em class="parameter"><code>request_body</code></em> - as appropriate, passing <code class="literal">FALSE</code>.</p> -<div class="refsect3"> -<a name="SoupMessage.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="struct_members_name"> -<col class="struct_members_description"> -<col width="200px" class="struct_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="struct_member_name"><p>const <span class="type">char</span> *<em class="structfield"><code><a name="SoupMessage-struct.method"></a>method</code></em>;</p></td> -<td class="struct_member_description"><p>the HTTP method</p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><span class="type">guint</span> <em class="structfield"><code><a name="SoupMessage-struct.status-code"></a>status_code</code></em>;</p></td> -<td class="struct_member_description"><p>the HTTP status code</p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="SoupMessage-struct.reason-phrase"></a>reason_phrase</code></em>;</p></td> -<td class="struct_member_description"><p>the status phrase associated with <em class="parameter"><code>status_code</code></em> -</p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a> *<em class="structfield"><code><a name="SoupMessage-struct.request-body"></a>request_body</code></em>;</p></td> -<td class="struct_member_description"><p>the request body</p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *<em class="structfield"><code><a name="SoupMessage-struct.request-headers"></a>request_headers</code></em>;</p></td> -<td class="struct_member_description"><p>the request headers</p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a> *<em class="structfield"><code><a name="SoupMessage-struct.response-body"></a>response_body</code></em>;</p></td> -<td class="struct_member_description"><p>the response body</p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *<em class="structfield"><code><a name="SoupMessage-struct.response-headers"></a>response_headers</code></em>;</p></td> -<td class="struct_member_description"><p>the response headers</p></td> -<td class="struct_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SoupHTTPVersion"></a><h3>enum SoupHTTPVersion</h3> -<p>Indicates the HTTP protocol version being used.</p> -<div class="refsect3"> -<a name="SoupHTTPVersion.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="enum_members_name"> -<col class="enum_members_description"> -<col width="200px" class="enum_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="enum_member_name"><p><a name="SOUP-HTTP-1-0:CAPS"></a>SOUP_HTTP_1_0</p></td> -<td class="enum_member_description"> -<p>HTTP 1.0 (RFC 1945)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-HTTP-1-1:CAPS"></a>SOUP_HTTP_1_1</p></td> -<td class="enum_member_description"> -<p>HTTP 1.1 (RFC 2616)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessageFlags"></a><h3>enum SoupMessageFlags</h3> -<p>Various flags that can be set on a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> to alter its -behavior.</p> -<div class="refsect3"> -<a name="SoupMessageFlags.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="enum_members_name"> -<col class="enum_members_description"> -<col width="200px" class="enum_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="enum_member_name"><p><a name="SOUP-MESSAGE-NO-REDIRECT:CAPS"></a>SOUP_MESSAGE_NO_REDIRECT</p></td> -<td class="enum_member_description"> -<p>The session should not follow redirect - (3xx) responses received by this message.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-MESSAGE-CAN-REBUILD:CAPS"></a>SOUP_MESSAGE_CAN_REBUILD</p></td> -<td class="enum_member_description"> -<p>The caller will rebuild the request - body if the message is restarted; see - <a class="link" href="SoupMessageBody.html#soup-message-body-set-accumulate" title="soup_message_body_set_accumulate ()"><code class="function">soup_message_body_set_accumulate()</code></a> for more details.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-MESSAGE-OVERWRITE-CHUNKS:CAPS"></a>SOUP_MESSAGE_OVERWRITE_CHUNKS</p></td> -<td class="enum_member_description"> -<p>Deprecated: equivalent to calling - <a class="link" href="SoupMessageBody.html#soup-message-body-set-accumulate" title="soup_message_body_set_accumulate ()"><code class="function">soup_message_body_set_accumulate()</code></a> on the incoming message body - (ie, <a class="link" href="SoupMessage.html#SoupMessage--response-body" title="The “response-body” property"><span class="type">“response_body”</span></a> for a client-side request), - passing <code class="literal">FALSE</code>.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-MESSAGE-CONTENT-DECODED:CAPS"></a>SOUP_MESSAGE_CONTENT_DECODED</p></td> -<td class="enum_member_description"> -<p>Set by <a class="link" href="SoupContentDecoder.html" title="SoupContentDecoder"><span class="type">SoupContentDecoder</span></a> to - indicate that it has removed the Content-Encoding on a message (and - so headers such as Content-Length may no longer accurately describe - the body).</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-MESSAGE-CERTIFICATE-TRUSTED:CAPS"></a>SOUP_MESSAGE_CERTIFICATE_TRUSTED</p></td> -<td class="enum_member_description"> -<p>if set after an https response - has been received, indicates that the server's SSL certificate is - trusted according to the session's CA.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-MESSAGE-NEW-CONNECTION:CAPS"></a>SOUP_MESSAGE_NEW_CONNECTION</p></td> -<td class="enum_member_description"> -<p>Requests that the message should be - sent on a newly-created connection, not reusing an existing - persistent connection. Note that messages with non-idempotent - <a class="link" href="SoupMessage.html#SoupMessage--method" title="The “method” property"><span class="type">“method”</span></a>s behave this way by default, unless - <a class="link" href="SoupMessage.html#SOUP-MESSAGE-IDEMPOTENT:CAPS"><span class="type">SOUP_MESSAGE_IDEMPOTENT</span></a> is set.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-MESSAGE-IDEMPOTENT:CAPS"></a>SOUP_MESSAGE_IDEMPOTENT</p></td> -<td class="enum_member_description"> -<p>The message is considered idempotent, - regardless its <a class="link" href="SoupMessage.html#SoupMessage--method" title="The “method” property"><span class="type">“method”</span></a>, and allows reuse of existing - idle connections, instead of always requiring a new one, unless - <a class="link" href="SoupMessage.html#SOUP-MESSAGE-NEW-CONNECTION:CAPS"><span class="type">SOUP_MESSAGE_NEW_CONNECTION</span></a> is set.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-MESSAGE-IGNORE-CONNECTION-LIMITS:CAPS"></a>SOUP_MESSAGE_IGNORE_CONNECTION_LIMITS</p></td> -<td class="enum_member_description"> -<p>Request that a new connection is - created for the message if there aren't idle connections available - and it's not possible to create new connections due to any of the - connection limits has been reached. If a dedicated connection is - eventually created for this message, it will be dropped when the - message finishes. Since 2.50</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-MESSAGE-DO-NOT-USE-AUTH-CACHE:CAPS"></a>SOUP_MESSAGE_DO_NOT_USE_AUTH_CACHE</p></td> -<td class="enum_member_description"> -<p>The <a class="link" href="SoupAuthManager.html" title="SoupAuthManager"><span class="type">SoupAuthManager</span></a> should not use - the credentials cache for this message, neither to use cached credentials - to automatically authenticate this message nor to cache the credentials - after the message is successfully authenticated. This applies to both server - and proxy authentication. Note that <a class="link" href="SoupSession.html#SoupSession-authenticate" title="The “authenticate” signal"><span class="type">“authenticate”</span></a> signal will - be emitted, if you want to disable authentication for a message use - <a class="link" href="SoupMessage.html#soup-message-disable-feature" title="soup_message_disable_feature ()"><code class="function">soup_message_disable_feature()</code></a> passing <a class="link" href="SoupAuthManager.html#SOUP-TYPE-AUTH-MANAGER:CAPS" title="SOUP_TYPE_AUTH_MANAGER"><span class="type">SOUP_TYPE_AUTH_MANAGER</span></a> instead. Since 2.58</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessagePriority"></a><h3>enum SoupMessagePriority</h3> -<p>Priorities that can be set on a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> to instruct the -message queue to process it before any other message with lower -priority.</p> -<div class="refsect3"> -<a name="SoupMessagePriority.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="enum_members_name"> -<col class="enum_members_description"> -<col width="200px" class="enum_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="enum_member_name"><p><a name="SOUP-MESSAGE-PRIORITY-VERY-LOW:CAPS"></a>SOUP_MESSAGE_PRIORITY_VERY_LOW</p></td> -<td class="enum_member_description"> -<p>The lowest priority, the messages - with this priority will be the last ones to be attended.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-MESSAGE-PRIORITY-LOW:CAPS"></a>SOUP_MESSAGE_PRIORITY_LOW</p></td> -<td class="enum_member_description"> -<p>Use this for low priority messages, a - <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> with the default priority will be processed first.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-MESSAGE-PRIORITY-NORMAL:CAPS"></a>SOUP_MESSAGE_PRIORITY_NORMAL</p></td> -<td class="enum_member_description"> -<p>The default priotity, this is the - priority assigned to the <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> by default.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-MESSAGE-PRIORITY-HIGH:CAPS"></a>SOUP_MESSAGE_PRIORITY_HIGH</p></td> -<td class="enum_member_description"> -<p>High priority, a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> with - this priority will be processed before the ones with the default - priority.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-MESSAGE-PRIORITY-VERY-HIGH:CAPS"></a>SOUP_MESSAGE_PRIORITY_VERY_HIGH</p></td> -<td class="enum_member_description"> -<p>The highest priority, use this - for very urgent <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> as they will be the first ones to be - attended.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-MESSAGE-METHOD:CAPS"></a><h3>SOUP_MESSAGE_METHOD</h3> -<pre class="programlisting">#define SOUP_MESSAGE_METHOD "method" -</pre> -<p>Alias for the <a class="link" href="SoupMessage.html#SoupMessage--method" title="The “method” property"><span class="type">“method”</span></a> property. (The message's -HTTP method.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-MESSAGE-URI:CAPS"></a><h3>SOUP_MESSAGE_URI</h3> -<pre class="programlisting">#define SOUP_MESSAGE_URI "uri" -</pre> -<p>Alias for the <a class="link" href="SoupMessage.html#SoupMessage--uri" title="The “uri” property"><span class="type">“uri”</span></a> property. (The message's -<a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a>.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-MESSAGE-HTTP-VERSION:CAPS"></a><h3>SOUP_MESSAGE_HTTP_VERSION</h3> -<pre class="programlisting">#define SOUP_MESSAGE_HTTP_VERSION "http-version" -</pre> -<p>Alias for the <a class="link" href="SoupMessage.html#SoupMessage--http-version" title="The “http-version” property"><span class="type">“http-version”</span></a> property. (The -message's <a class="link" href="SoupMessage.html#SoupHTTPVersion" title="enum SoupHTTPVersion"><span class="type">SoupHTTPVersion</span></a>.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-MESSAGE-FLAGS:CAPS"></a><h3>SOUP_MESSAGE_FLAGS</h3> -<pre class="programlisting">#define SOUP_MESSAGE_FLAGS "flags" -</pre> -<p>Alias for the <a class="link" href="SoupMessage.html#SoupMessage--flags" title="The “flags” property"><span class="type">“flags”</span></a> property. (The message's -<a class="link" href="SoupMessage.html#SoupMessageFlags" title="enum SoupMessageFlags"><span class="type">SoupMessageFlags</span></a>.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-MESSAGE-STATUS-CODE:CAPS"></a><h3>SOUP_MESSAGE_STATUS_CODE</h3> -<pre class="programlisting">#define SOUP_MESSAGE_STATUS_CODE "status-code" -</pre> -<p>Alias for the <a class="link" href="SoupMessage.html#SoupMessage--status-code" title="The “status-code” property"><span class="type">“status-code”</span></a> property. (The -message's HTTP response status code.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-MESSAGE-REASON-PHRASE:CAPS"></a><h3>SOUP_MESSAGE_REASON_PHRASE</h3> -<pre class="programlisting">#define SOUP_MESSAGE_REASON_PHRASE "reason-phrase" -</pre> -<p>Alias for the <a class="link" href="SoupMessage.html#SoupMessage--reason-phrase" title="The “reason-phrase” property"><span class="type">“reason-phrase”</span></a> property. (The -message's HTTP response reason phrase.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-MESSAGE-SERVER-SIDE:CAPS"></a><h3>SOUP_MESSAGE_SERVER_SIDE</h3> -<pre class="programlisting">#define SOUP_MESSAGE_SERVER_SIDE "server-side" -</pre> -<p>Alias for the <a class="link" href="SoupMessage.html#SoupMessage--server-side" title="The “server-side” property"><span class="type">“server-side”</span></a> property. (<code class="literal">TRUE</code> if -the message was created by <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a>.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-MESSAGE-FIRST-PARTY:CAPS"></a><h3>SOUP_MESSAGE_FIRST_PARTY</h3> -<pre class="programlisting">#define SOUP_MESSAGE_FIRST_PARTY "first-party" -</pre> -<p>Alias for the <a class="link" href="SoupMessage.html#SoupMessage--first-party" title="The “first-party” property"><span class="type">“first-party”</span></a> property. (The -<a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> loaded in the application when the message was -queued.)</p> -<p class="since">Since: 2.30</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-MESSAGE-PRIORITY:CAPS"></a><h3>SOUP_MESSAGE_PRIORITY</h3> -<pre class="programlisting">#define SOUP_MESSAGE_PRIORITY "priority" -</pre> -<p>Sets the priority of the <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>. See -<a class="link" href="SoupMessage.html#soup-message-set-priority" title="soup_message_set_priority ()"><code class="function">soup_message_set_priority()</code></a> for further details.</p> -<p class="since">Since: 2.44</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-MESSAGE-REQUEST-BODY:CAPS"></a><h3>SOUP_MESSAGE_REQUEST_BODY</h3> -<pre class="programlisting">#define SOUP_MESSAGE_REQUEST_BODY "request-body" -</pre> -<p>Alias for the <a class="link" href="SoupMessage.html#SoupMessage--request-body" title="The “request-body” property"><span class="type">“request-body”</span></a> property. (The -message's HTTP request body.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-MESSAGE-REQUEST-BODY-DATA:CAPS"></a><h3>SOUP_MESSAGE_REQUEST_BODY_DATA</h3> -<pre class="programlisting">#define SOUP_MESSAGE_REQUEST_BODY_DATA "request-body-data" -</pre> -<p>Alias for the <a class="link" href="SoupMessage.html#SoupMessage--request-body-data" title="The “request-body-data” property"><span class="type">“request-body-data”</span></a> property. (The -message's HTTP request body, as a <span class="type">GBytes</span>.)</p> -<p class="since">Since: 2.46</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-MESSAGE-REQUEST-HEADERS:CAPS"></a><h3>SOUP_MESSAGE_REQUEST_HEADERS</h3> -<pre class="programlisting">#define SOUP_MESSAGE_REQUEST_HEADERS "request-headers" -</pre> -<p>Alias for the <a class="link" href="SoupMessage.html#SoupMessage--request-headers" title="The “request-headers” property"><span class="type">“request-headers”</span></a> property. (The -message's HTTP request headers.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-MESSAGE-RESPONSE-BODY:CAPS"></a><h3>SOUP_MESSAGE_RESPONSE_BODY</h3> -<pre class="programlisting">#define SOUP_MESSAGE_RESPONSE_BODY "response-body" -</pre> -<p>Alias for the <a class="link" href="SoupMessage.html#SoupMessage--response-body" title="The “response-body” property"><span class="type">“response-body”</span></a> property. (The -message's HTTP response body.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-MESSAGE-RESPONSE-BODY-DATA:CAPS"></a><h3>SOUP_MESSAGE_RESPONSE_BODY_DATA</h3> -<pre class="programlisting">#define SOUP_MESSAGE_RESPONSE_BODY_DATA "response-body-data" -</pre> -<p>Alias for the <a class="link" href="SoupMessage.html#SoupMessage--response-body-data" title="The “response-body-data” property"><span class="type">“response-body-data”</span></a> property. (The -message's HTTP response body, as a <span class="type">GBytes</span>.)</p> -<p class="since">Since: 2.46</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-MESSAGE-RESPONSE-HEADERS:CAPS"></a><h3>SOUP_MESSAGE_RESPONSE_HEADERS</h3> -<pre class="programlisting">#define SOUP_MESSAGE_RESPONSE_HEADERS "response-headers" -</pre> -<p>Alias for the <a class="link" href="SoupMessage.html#SoupMessage--response-headers" title="The “response-headers” property"><span class="type">“response-headers”</span></a> property. (The -message's HTTP response headers.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-MESSAGE-TLS-CERTIFICATE:CAPS"></a><h3>SOUP_MESSAGE_TLS_CERTIFICATE</h3> -<pre class="programlisting">#define SOUP_MESSAGE_TLS_CERTIFICATE "tls-certificate" -</pre> -<p>Alias for the <a class="link" href="SoupMessage.html#SoupMessage--tls-certificate" title="The “tls-certificate” property"><span class="type">“tls-certificate”</span></a> property. (The -TLS certificate associated with the message, if any.)</p> -<p class="since">Since: 2.34</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-MESSAGE-TLS-ERRORS:CAPS"></a><h3>SOUP_MESSAGE_TLS_ERRORS</h3> -<pre class="programlisting">#define SOUP_MESSAGE_TLS_ERRORS "tls-errors" -</pre> -<p>Alias for the <a class="link" href="SoupMessage.html#SoupMessage--tls-errors" title="The “tls-errors” property"><span class="type">“tls-errors”</span></a> property. (The -verification errors on <a class="link" href="SoupMessage.html#SoupMessage--tls-certificate" title="The “tls-certificate” property"><span class="type">“tls-certificate”</span></a>.)</p> -<p class="since">Since: 2.34</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupMessage.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> -<a name="SoupMessage--first-party"></a><h3>The <code class="literal">“first-party”</code> property</h3> -<pre class="programlisting"> “first-party” <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *</pre> -<p>The <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> loaded in the application when the message was -queued.</p> -<p>Flags: Read / Write</p> -<p class="since">Since: 2.30</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessage--flags"></a><h3>The <code class="literal">“flags”</code> property</h3> -<pre class="programlisting"> “flags” <a class="link" href="SoupMessage.html#SoupMessageFlags" title="enum SoupMessageFlags"><span class="type">SoupMessageFlags</span></a></pre> -<p>Various message options.</p> -<p>Flags: Read / Write</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessage--http-version"></a><h3>The <code class="literal">“http-version”</code> property</h3> -<pre class="programlisting"> “http-version” <a class="link" href="SoupMessage.html#SoupHTTPVersion" title="enum SoupHTTPVersion"><span class="type">SoupHTTPVersion</span></a></pre> -<p>The HTTP protocol version to use.</p> -<p>Flags: Read / Write</p> -<p>Default value: SOUP_HTTP_1_1</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessage--method"></a><h3>The <code class="literal">“method”</code> property</h3> -<pre class="programlisting"> “method” <span class="type">gchar</span> *</pre> -<p>The message's HTTP method.</p> -<p>Flags: Read / Write</p> -<p>Default value: "GET"</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessage--priority"></a><h3>The <code class="literal">“priority”</code> property</h3> -<pre class="programlisting"> “priority” <a class="link" href="SoupMessage.html#SoupMessagePriority" title="enum SoupMessagePriority"><span class="type">SoupMessagePriority</span></a></pre> -<p>The priority of the message.</p> -<p>Flags: Read / Write</p> -<p>Default value: SOUP_MESSAGE_PRIORITY_NORMAL</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessage--reason-phrase"></a><h3>The <code class="literal">“reason-phrase”</code> property</h3> -<pre class="programlisting"> “reason-phrase” <span class="type">gchar</span> *</pre> -<p>The HTTP response reason phrase.</p> -<p>Flags: Read / Write</p> -<p>Default value: NULL</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessage--request-body"></a><h3>The <code class="literal">“request-body”</code> property</h3> -<pre class="programlisting"> “request-body” <a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a> *</pre> -<p>The HTTP request content.</p> -<p>Flags: Read</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessage--request-body-data"></a><h3>The <code class="literal">“request-body-data”</code> property</h3> -<pre class="programlisting"> “request-body-data” <span class="type">GBytes</span> *</pre> -<p>The message's HTTP request body, as a <span class="type">GBytes</span>.</p> -<p>Flags: Read</p> -<p class="since">Since: 2.46</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessage--request-headers"></a><h3>The <code class="literal">“request-headers”</code> property</h3> -<pre class="programlisting"> “request-headers” <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *</pre> -<p>The HTTP request headers.</p> -<p>Flags: Read</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessage--response-body"></a><h3>The <code class="literal">“response-body”</code> property</h3> -<pre class="programlisting"> “response-body” <a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a> *</pre> -<p>The HTTP response content.</p> -<p>Flags: Read</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessage--response-body-data"></a><h3>The <code class="literal">“response-body-data”</code> property</h3> -<pre class="programlisting"> “response-body-data” <span class="type">GBytes</span> *</pre> -<p>The message's HTTP response body, as a <span class="type">GBytes</span>.</p> -<p>Flags: Read</p> -<p class="since">Since: 2.46</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessage--response-headers"></a><h3>The <code class="literal">“response-headers”</code> property</h3> -<pre class="programlisting"> “response-headers” <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *</pre> -<p>The HTTP response headers.</p> -<p>Flags: Read</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessage--server-side"></a><h3>The <code class="literal">“server-side”</code> property</h3> -<pre class="programlisting"> “server-side” <span class="type">gboolean</span></pre> -<p>Whether or not the message is server-side rather than client-side.</p> -<p>Flags: Read / Write / Construct Only</p> -<p>Default value: FALSE</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessage--status-code"></a><h3>The <code class="literal">“status-code”</code> property</h3> -<pre class="programlisting"> “status-code” <span class="type">guint</span></pre> -<p>The HTTP response status code.</p> -<p>Flags: Read / Write</p> -<p>Allowed values: <= 999</p> -<p>Default value: 0</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessage--tls-certificate"></a><h3>The <code class="literal">“tls-certificate”</code> property</h3> -<pre class="programlisting"> “tls-certificate” <span class="type">GTlsCertificate</span> *</pre> -<p>The <span class="type">GTlsCertificate</span> associated with the message</p> -<p>Flags: Read / Write</p> -<p class="since">Since: 2.34</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessage--tls-errors"></a><h3>The <code class="literal">“tls-errors”</code> property</h3> -<pre class="programlisting"> “tls-errors” <span class="type">GTlsCertificateFlags</span></pre> -<p>The verification errors on <a class="link" href="SoupMessage.html#SoupMessage--tls-certificate" title="The “tls-certificate” property"><span class="type">“tls-certificate”</span></a></p> -<p>Flags: Read / Write</p> -<p class="since">Since: 2.34</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessage--uri"></a><h3>The <code class="literal">“uri”</code> property</h3> -<pre class="programlisting"> “uri” <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *</pre> -<p>The message's Request-URI.</p> -<p>Flags: Read / Write</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupMessage.signal-details"></a><h2>Signal Details</h2> -<div class="refsect2"> -<a name="SoupMessage-content-sniffed"></a><h3>The <code class="literal">“content-sniffed”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg, - <span class="type">gchar</span> *type, - <span class="type">GHashTable</span> *params, - <span class="type">gpointer</span> user_data)</pre> -<p>This signal is emitted after <a class="link" href="SoupMessage.html#SoupMessage-got-headers" title="The “got-headers” signal"><span class="type">“got-headers”</span></a>, and -before the first <a class="link" href="SoupMessage.html#SoupMessage-got-chunk" title="The “got-chunk” signal"><span class="type">“got-chunk”</span></a>. If content -sniffing is disabled, or no content sniffing will be -performed, due to the sniffer deciding to trust the -Content-Type sent by the server, this signal is emitted -immediately after <a class="link" href="SoupMessage.html#SoupMessage-got-headers" title="The “got-headers” signal"><span class="type">“got-headers”</span></a>, and <em class="parameter"><code>type</code></em> - is -<code class="literal">NULL</code>.</p> -<p>If the <a class="link" href="SoupContentSniffer.html" title="SoupContentSniffer"><span class="type">SoupContentSniffer</span></a> feature is enabled, and the -sniffer decided to perform sniffing, the first -<a class="link" href="SoupMessage.html#SoupMessage-got-chunk" title="The “got-chunk” signal"><span class="type">“got-chunk”</span></a> emission may be delayed, so that the -sniffer has enough data to correctly sniff the content. It -notified the library user that the content has been -sniffed, and allows it to change the header contents in the -message, if desired.</p> -<p>After this signal is emitted, the data that was spooled so -that sniffing could be done is delivered on the first -emission of <a class="link" href="SoupMessage.html#SoupMessage-got-chunk" title="The “got-chunk” signal"><span class="type">“got-chunk”</span></a>.</p> -<div class="refsect3"> -<a name="SoupMessage-content-sniffed.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>msg</p></td> -<td class="parameter_description"><p>the message</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>type</p></td> -<td class="parameter_description"><p>the content type that we got from sniffing</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>params</p></td> -<td class="parameter_description"><p>a <span class="type">GHashTable</span> with the parameters. </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]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run First</p> -<p class="since">Since: 2.28</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessage-finished"></a><h3>The <code class="literal">“finished”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted when all HTTP processing is finished for a message. -(After <a class="link" href="SoupMessage.html#SoupMessage-got-body" title="The “got-body” signal"><span class="type">“got_body”</span></a> for client-side messages, or -after <a class="link" href="SoupMessage.html#SoupMessage-wrote-body" title="The “wrote-body” signal"><span class="type">“wrote_body”</span></a> for server-side messages.)</p> -<div class="refsect3"> -<a name="SoupMessage-finished.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>msg</p></td> -<td class="parameter_description"><p>the message</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run First</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessage-got-body"></a><h3>The <code class="literal">“got-body”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted after receiving the complete message body. (For a -server-side message, this means it has received the request -body. For a client-side message, this means it has received -the response body and is nearly done with the message.)</p> -<p>See also <a class="link" href="SoupMessage.html#soup-message-add-header-handler" title="soup_message_add_header_handler ()"><code class="function">soup_message_add_header_handler()</code></a> and -<a class="link" href="SoupMessage.html#soup-message-add-status-code-handler" title="soup_message_add_status_code_handler ()"><code class="function">soup_message_add_status_code_handler()</code></a>, which can be used -to connect to a subset of emissions of this signal.</p> -<div class="refsect3"> -<a name="SoupMessage-got-body.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>msg</p></td> -<td class="parameter_description"><p>the message</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run First</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessage-got-chunk"></a><h3>The <code class="literal">“got-chunk”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg, - <a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> *chunk, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted after receiving a chunk of a message body. Note -that "chunk" in this context means any subpiece of the -body, not necessarily the specific HTTP 1.1 chunks sent by -the other side.</p> -<p>If you cancel or requeue <em class="parameter"><code>msg</code></em> - while processing this signal, -then the current HTTP I/O will be stopped after this signal -emission finished, and <em class="parameter"><code>msg</code></em> -'s connection will be closed.</p> -<div class="refsect3"> -<a name="SoupMessage-got-chunk.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>msg</p></td> -<td class="parameter_description"><p>the message</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>chunk</p></td> -<td class="parameter_description"><p>the just-read chunk</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run First</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessage-got-headers"></a><h3>The <code class="literal">“got-headers”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted after receiving all message headers for a message. -(For a client-side message, this is after receiving the -Status-Line and response headers; for a server-side -message, it is after receiving the Request-Line and request -headers.)</p> -<p>See also <a class="link" href="SoupMessage.html#soup-message-add-header-handler" title="soup_message_add_header_handler ()"><code class="function">soup_message_add_header_handler()</code></a> and -<a class="link" href="SoupMessage.html#soup-message-add-status-code-handler" title="soup_message_add_status_code_handler ()"><code class="function">soup_message_add_status_code_handler()</code></a>, which can be used -to connect to a subset of emissions of this signal.</p> -<p>If you cancel or requeue <em class="parameter"><code>msg</code></em> - while processing this signal, -then the current HTTP I/O will be stopped after this signal -emission finished, and <em class="parameter"><code>msg</code></em> -'s connection will be closed. -(If you need to requeue a message--eg, after handling -authentication or redirection--it is usually better to -requeue it from a <a class="link" href="SoupMessage.html#SoupMessage-got-body" title="The “got-body” signal"><span class="type">“got_body”</span></a> handler rather -than a <a class="link" href="SoupMessage.html#SoupMessage-got-headers" title="The “got-headers” signal"><span class="type">“got_headers”</span></a> handler, so that the -existing HTTP connection can be reused.)</p> -<div class="refsect3"> -<a name="SoupMessage-got-headers.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>msg</p></td> -<td class="parameter_description"><p>the message</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run First</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessage-got-informational"></a><h3>The <code class="literal">“got-informational”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted after receiving a 1xx (Informational) response for -a (client-side) message. The response_headers will be -filled in with the headers associated with the -informational response; however, those header values will -be erased after this signal is done.</p> -<p>If you cancel or requeue <em class="parameter"><code>msg</code></em> - while processing this signal, -then the current HTTP I/O will be stopped after this signal -emission finished, and <em class="parameter"><code>msg</code></em> -'s connection will be closed.</p> -<div class="refsect3"> -<a name="SoupMessage-got-informational.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>msg</p></td> -<td class="parameter_description"><p>the message</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run First</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessage-network-event"></a><h3>The <code class="literal">“network-event”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg, - <span class="type">GSocketClientEvent</span> event, - <span class="type">GIOStream</span> *connection, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted to indicate that some network-related event -related to <em class="parameter"><code>msg</code></em> - has occurred. This essentially proxies the -<span class="type">“event”</span> signal, but only for events that -occur while <em class="parameter"><code>msg</code></em> - "owns" the connection; if <em class="parameter"><code>msg</code></em> - is sent on -an existing persistent connection, then this signal will -not be emitted. (If you want to force the message to be -sent on a new connection, set the -<a class="link" href="SoupMessage.html#SOUP-MESSAGE-NEW-CONNECTION:CAPS"><code class="literal">SOUP_MESSAGE_NEW_CONNECTION</code></a> flag on it.)</p> -<p>See <span class="type">“event”</span> for more information on what -the different values of <em class="parameter"><code>event</code></em> - correspond to, and what -<em class="parameter"><code>connection</code></em> - will be in each case.</p> -<div class="refsect3"> -<a name="SoupMessage-network-event.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>msg</p></td> -<td class="parameter_description"><p>the message</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>event</p></td> -<td class="parameter_description"><p>the network event</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>connection</p></td> -<td class="parameter_description"><p>the current state of the network connection</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run First</p> -<p class="since">Since: 2.38</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessage-restarted"></a><h3>The <code class="literal">“restarted”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted when a request that was already sent once is now -being sent again (eg, because the first attempt received a -redirection response, or because we needed to use -authentication).</p> -<div class="refsect3"> -<a name="SoupMessage-restarted.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>msg</p></td> -<td class="parameter_description"><p>the message</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run First</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessage-starting"></a><h3>The <code class="literal">“starting”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted just before a message is sent.</p> -<div class="refsect3"> -<a name="SoupMessage-starting.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>msg</p></td> -<td class="parameter_description"><p>the message</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run First</p> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessage-wrote-body"></a><h3>The <code class="literal">“wrote-body”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted immediately after writing the complete body for a -message. (For a client-side message, this means that -libsoup is done writing and is now waiting for the response -from the server. For a server-side message, this means that -libsoup has finished writing the response and is nearly -done with the message.)</p> -<div class="refsect3"> -<a name="SoupMessage-wrote-body.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>msg</p></td> -<td class="parameter_description"><p>the message</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run First</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessage-wrote-body-data"></a><h3>The <code class="literal">“wrote-body-data”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg, - <a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> *chunk, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted immediately after writing a portion of the message -body to the network.</p> -<p>Unlike <a class="link" href="SoupMessage.html#SoupMessage-wrote-chunk" title="The “wrote-chunk” signal"><span class="type">“wrote_chunk”</span></a>, this is emitted after -every successful <code class="function">write()</code> call, not only after finishing a -complete "chunk".</p> -<div class="refsect3"> -<a name="SoupMessage-wrote-body-data.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>msg</p></td> -<td class="parameter_description"><p>the message</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>chunk</p></td> -<td class="parameter_description"><p>the data written</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run First</p> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessage-wrote-chunk"></a><h3>The <code class="literal">“wrote-chunk”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted immediately after writing a body chunk for a message.</p> -<p>Note that this signal is not parallel to -<a class="link" href="SoupMessage.html#SoupMessage-got-chunk" title="The “got-chunk” signal"><span class="type">“got_chunk”</span></a>; it is emitted only when a complete -chunk (added with <a class="link" href="SoupMessageBody.html#soup-message-body-append" title="soup_message_body_append ()"><code class="function">soup_message_body_append()</code></a> or -<a class="link" href="SoupMessageBody.html#soup-message-body-append-buffer" title="soup_message_body_append_buffer ()"><code class="function">soup_message_body_append_buffer()</code></a>) has been written. To get -more useful continuous progress information, use -<a class="link" href="SoupMessage.html#SoupMessage-wrote-body-data" title="The “wrote-body-data” signal"><span class="type">“wrote_body_data”</span></a>.</p> -<div class="refsect3"> -<a name="SoupMessage-wrote-chunk.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>msg</p></td> -<td class="parameter_description"><p>the message</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run First</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessage-wrote-headers"></a><h3>The <code class="literal">“wrote-headers”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted immediately after writing the headers for a -message. (For a client-side message, this is after writing -the request headers; for a server-side message, it is after -writing the response headers.)</p> -<div class="refsect3"> -<a name="SoupMessage-wrote-headers.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>msg</p></td> -<td class="parameter_description"><p>the message</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run First</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessage-wrote-informational"></a><h3>The <code class="literal">“wrote-informational”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted immediately after writing a 1xx (Informational) -response for a (server-side) message.</p> -<div class="refsect3"> -<a name="SoupMessage-wrote-informational.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>msg</p></td> -<td class="parameter_description"><p>the message</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run First</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupMessage.see-also"></a><h2>See Also</h2> -<p><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a>, <a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a></p> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/SoupMessageBody.html b/docs/reference/html/SoupMessageBody.html deleted file mode 100644 index ec02c57f..00000000 --- a/docs/reference/html/SoupMessageBody.html +++ /dev/null @@ -1,1269 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SoupMessageBody: 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="ch02.html" title="Core API"> -<link rel="prev" href="SoupMessageHeaders.html" title="SoupMessageHeaders"> -<link rel="next" href="libsoup-2.4-soup-method.html" title="soup-method"> -<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="#SoupMessageBody.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupMessageBody.object-hierarchy" class="shortcut">Object Hierarchy</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="SoupMessageHeaders.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="libsoup-2.4-soup-method.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="SoupMessageBody"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="SoupMessageBody.top_of_page"></a>SoupMessageBody</span></h2> -<p>SoupMessageBody — HTTP message body</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="SoupMessageBody.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="SoupMessageBody.html#SoupBuffer"><span class="returnvalue">SoupBuffer</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupMessageBody.html#soup-buffer-new" title="soup_buffer_new ()">soup_buffer_new</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="returnvalue">SoupBuffer</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupMessageBody.html#soup-buffer-new-subbuffer" title="soup_buffer_new_subbuffer ()">soup_buffer_new_subbuffer</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="returnvalue">SoupBuffer</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupMessageBody.html#soup-buffer-new-with-owner" title="soup_buffer_new_with_owner ()">soup_buffer_new_with_owner</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="returnvalue">SoupBuffer</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupMessageBody.html#soup-buffer-new-take" title="soup_buffer_new_take ()">soup_buffer_new_take</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gpointer</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageBody.html#soup-buffer-get-owner" title="soup_buffer_get_owner ()">soup_buffer_get_owner</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageBody.html#soup-buffer-get-data" title="soup_buffer_get_data ()">soup_buffer_get_data</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="returnvalue">SoupBuffer</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupMessageBody.html#soup-buffer-copy" title="soup_buffer_copy ()">soup_buffer_copy</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageBody.html#soup-buffer-free" title="soup_buffer_free ()">soup_buffer_free</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GBytes</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupMessageBody.html#soup-buffer-get-as-bytes" title="soup_buffer_get_as_bytes ()">soup_buffer_get_as_bytes</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="returnvalue">SoupMessageBody</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupMessageBody.html#soup-message-body-new" title="soup_message_body_new ()">soup_message_body_new</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageBody.html#soup-message-body-free" title="soup_message_body_free ()">soup_message_body_free</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageBody.html#soup-message-body-set-accumulate" title="soup_message_body_set_accumulate ()">soup_message_body_set_accumulate</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageBody.html#soup-message-body-get-accumulate" title="soup_message_body_get_accumulate ()">soup_message_body_get_accumulate</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageBody.html#soup-message-body-append" title="soup_message_body_append ()">soup_message_body_append</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageBody.html#soup-message-body-append-buffer" title="soup_message_body_append_buffer ()">soup_message_body_append_buffer</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageBody.html#soup-message-body-append-take" title="soup_message_body_append_take ()">soup_message_body_append_take</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageBody.html#soup-message-body-truncate" title="soup_message_body_truncate ()">soup_message_body_truncate</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageBody.html#soup-message-body-complete" title="soup_message_body_complete ()">soup_message_body_complete</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="returnvalue">SoupBuffer</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupMessageBody.html#soup-message-body-flatten" title="soup_message_body_flatten ()">soup_message_body_flatten</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="returnvalue">SoupBuffer</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupMessageBody.html#soup-message-body-get-chunk" title="soup_message_body_get_chunk ()">soup_message_body_get_chunk</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageBody.html#soup-message-body-got-chunk" title="soup_message_body_got_chunk ()">soup_message_body_got_chunk</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageBody.html#soup-message-body-wrote-chunk" title="soup_message_body_wrote_chunk ()">soup_message_body_wrote_chunk</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<a name="SoupBuffer"></a><div class="refsect1"> -<a name="SoupMessageBody.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="SoupMessageBody.html#SoupBuffer-struct" title="SoupBuffer">SoupBuffer</a></td> -</tr> -<tr> -<td class="datatype_keyword">enum</td> -<td class="function_name"><a class="link" href="SoupMessageBody.html#SoupMemoryUse" title="enum SoupMemoryUse">SoupMemoryUse</a></td> -</tr> -<tr> -<td class="datatype_keyword"> </td> -<td class="function_name"><a class="link" href="SoupMessageBody.html#SoupMessageBody-struct" title="SoupMessageBody">SoupMessageBody</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupMessageBody.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> <a href="/home/claudio/gnome3/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a> - <span class="lineart">├──</span> SoupBuffer - <span class="lineart">╰──</span> SoupMessageBody -</pre> -</div> -<div class="refsect1"> -<a name="SoupMessageBody.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="SoupMessageBody.description"></a><h2>Description</h2> -<p><a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a> represents the request or response body of a -<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>.</p> -<p>In addition to <a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a>, libsoup also defines a "smaller" -data buffer type, <a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a>, which is primarily used as a -component of <a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a>. In particular, when using chunked -encoding to transmit or receive a message, each chunk is -represented as a <a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a>.</p> -</div> -<div class="refsect1"> -<a name="SoupMessageBody.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="soup-buffer-new"></a><h3>soup_buffer_new ()</h3> -<pre class="programlisting"><a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="returnvalue">SoupBuffer</span></a> * -soup_buffer_new (<em class="parameter"><code><a class="link" href="SoupMessageBody.html#SoupMemoryUse" title="enum SoupMemoryUse"><span class="type">SoupMemoryUse</span></a> use</code></em>, - <em class="parameter"><code><span class="type">gconstpointer</span> data</code></em>, - <em class="parameter"><code><span class="type">gsize</span> length</code></em>);</pre> -<p>Creates a new <a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> containing <em class="parameter"><code>length</code></em> - bytes from <em class="parameter"><code>data</code></em> -.</p> -<div class="refsect3"> -<a name="soup-buffer-new.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>use</p></td> -<td class="parameter_description"><p>how <em class="parameter"><code>data</code></em> -is to be used by the buffer</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>data</p></td> -<td class="parameter_description"><p>data. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=length][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint8]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>length</p></td> -<td class="parameter_description"><p>length of <em class="parameter"><code>data</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-buffer-new.returns"></a><h4>Returns</h4> -<p> the new <a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a>.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-buffer-new-subbuffer"></a><h3>soup_buffer_new_subbuffer ()</h3> -<pre class="programlisting"><a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="returnvalue">SoupBuffer</span></a> * -soup_buffer_new_subbuffer (<em class="parameter"><code><a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> *parent</code></em>, - <em class="parameter"><code><span class="type">gsize</span> offset</code></em>, - <em class="parameter"><code><span class="type">gsize</span> length</code></em>);</pre> -<p>Creates a new <a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> containing <em class="parameter"><code>length</code></em> - bytes "copied" from -<em class="parameter"><code>parent</code></em> - starting at <em class="parameter"><code>offset</code></em> -. (Normally this will not actually copy -any data, but will instead simply reference the same data as -<em class="parameter"><code>parent</code></em> - does.)</p> -<div class="refsect3"> -<a name="soup-buffer-new-subbuffer.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>parent</p></td> -<td class="parameter_description"><p>the parent <a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>offset</p></td> -<td class="parameter_description"><p>offset within <em class="parameter"><code>parent</code></em> -to start at</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>length</p></td> -<td class="parameter_description"><p>number of bytes to copy from <em class="parameter"><code>parent</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-buffer-new-subbuffer.returns"></a><h4>Returns</h4> -<p> the new <a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a>.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-buffer-new-with-owner"></a><h3>soup_buffer_new_with_owner ()</h3> -<pre class="programlisting"><a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="returnvalue">SoupBuffer</span></a> * -soup_buffer_new_with_owner (<em class="parameter"><code><span class="type">gconstpointer</span> data</code></em>, - <em class="parameter"><code><span class="type">gsize</span> length</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> owner</code></em>, - <em class="parameter"><code><span class="type">GDestroyNotify</span> owner_dnotify</code></em>);</pre> -<p>Creates a new <a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> containing <em class="parameter"><code>length</code></em> - bytes from <em class="parameter"><code>data</code></em> -. When -the <a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> is freed, it will call <em class="parameter"><code>owner_dnotify</code></em> -, passing -<em class="parameter"><code>owner</code></em> - to it. You must ensure that <em class="parameter"><code>data</code></em> - will remain valid until -<em class="parameter"><code>owner_dnotify</code></em> - is called.</p> -<p>For example, you could use this to create a buffer containing data -returned from libxml without needing to do an extra copy:</p> -<div class="informalexample"> - <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> - <tbody> - <tr> - <td class="listing_lines" align="right"><pre>1 -2 -3</pre></td> - <td class="listing_code"><pre class="programlisting"><span class="function">xmlDocDumpMemory</span> <span class="gtkdoc opt">(</span>doc<span class="gtkdoc opt">, &</span>xmlbody<span class="gtkdoc opt">, &</span>len<span class="gtkdoc opt">);</span> -<span class="keyword">return</span> <span class="function"><a href="SoupMessageBody.html#soup-buffer-new-with-owner">soup_buffer_new_with_owner</a></span> <span class="gtkdoc opt">(</span>xmlbody<span class="gtkdoc opt">,</span> len<span class="gtkdoc opt">,</span> xmlbody<span class="gtkdoc opt">,</span> - <span class="gtkdoc opt">(</span>GDestroyNotify<span class="gtkdoc opt">)</span>xmlFree<span class="gtkdoc opt">);</span></pre></td> - </tr> - </tbody> - </table> -</div> - -<p>In this example, <em class="parameter"><code>data</code></em> - and <em class="parameter"><code>owner</code></em> - are the same, but in other cases -they would be different (eg, <em class="parameter"><code>owner</code></em> - would be a object, and <em class="parameter"><code>data</code></em> - -would be a pointer to one of the object's fields).</p> -<div class="refsect3"> -<a name="soup-buffer-new-with-owner.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>data</p></td> -<td class="parameter_description"><p>data. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=length][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint8]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>length</p></td> -<td class="parameter_description"><p>length of <em class="parameter"><code>data</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>owner</p></td> -<td class="parameter_description"><p>pointer to an object that owns <em class="parameter"><code>data</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>owner_dnotify</p></td> -<td class="parameter_description"><p>a function to free/unref <em class="parameter"><code>owner</code></em> -when -the buffer is freed. </p></td> -<td class="parameter_annotations"><span class="annotation">[<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-buffer-new-with-owner.returns"></a><h4>Returns</h4> -<p> the new <a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a>.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-buffer-new-take"></a><h3>soup_buffer_new_take ()</h3> -<pre class="programlisting"><a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="returnvalue">SoupBuffer</span></a> * -soup_buffer_new_take (<em class="parameter"><code><span class="type">guchar</span> *data</code></em>, - <em class="parameter"><code><span class="type">gsize</span> length</code></em>);</pre> -<p>Creates a new <a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> containing <em class="parameter"><code>length</code></em> - bytes from <em class="parameter"><code>data</code></em> -.</p> -<p>This function is exactly equivalent to <a class="link" href="SoupMessageBody.html#soup-buffer-new" title="soup_buffer_new ()"><code class="function">soup_buffer_new()</code></a> with -<a class="link" href="SoupMessageBody.html#SOUP-MEMORY-TAKE:CAPS"><code class="literal">SOUP_MEMORY_TAKE</code></a> as first argument; it exists mainly for -convenience and simplifying language bindings.</p> -<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> soup_buffer_new]</span></p> -<div class="refsect3"> -<a name="soup-buffer-new-take.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>data</p></td> -<td class="parameter_description"><p>data. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=length][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>length</p></td> -<td class="parameter_description"><p>length of <em class="parameter"><code>data</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-buffer-new-take.returns"></a><h4>Returns</h4> -<p> the new <a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a>.</p> -</div> -<p class="since">Since: 2.32</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-buffer-get-owner"></a><h3>soup_buffer_get_owner ()</h3> -<pre class="programlisting"><span class="returnvalue">gpointer</span> -soup_buffer_get_owner (<em class="parameter"><code><a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> *buffer</code></em>);</pre> -<p>Gets the "owner" object for a buffer created with -<a class="link" href="SoupMessageBody.html#soup-buffer-new-with-owner" title="soup_buffer_new_with_owner ()"><code class="function">soup_buffer_new_with_owner()</code></a>.</p> -<div class="refsect3"> -<a name="soup-buffer-get-owner.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>buffer</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> created with <a class="link" href="SoupMessageBody.html#soup-buffer-new-with-owner" title="soup_buffer_new_with_owner ()"><code class="function">soup_buffer_new_with_owner()</code></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-buffer-get-owner.returns"></a><h4>Returns</h4> -<p>the owner pointer. </p> -<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-buffer-get-data"></a><h3>soup_buffer_get_data ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_buffer_get_data (<em class="parameter"><code><a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> *buffer</code></em>, - <em class="parameter"><code>const <span class="type">guint8</span> **data</code></em>, - <em class="parameter"><code><span class="type">gsize</span> *length</code></em>);</pre> -<p>This function exists for use by language bindings, because it's not -currently possible to get the right effect by annotating the fields -of <a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a>.</p> -<div class="refsect3"> -<a name="soup-buffer-get-data.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>buffer</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>data</p></td> -<td class="parameter_description"><p>the pointer -to the buffer data is stored here. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=length][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>length</p></td> -<td class="parameter_description"><p>the length of the buffer data is stored here. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.32</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-buffer-copy"></a><h3>soup_buffer_copy ()</h3> -<pre class="programlisting"><a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="returnvalue">SoupBuffer</span></a> * -soup_buffer_copy (<em class="parameter"><code><a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> *buffer</code></em>);</pre> -<p>Makes a copy of <em class="parameter"><code>buffer</code></em> -. In reality, <a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> is a refcounted -type, and calling <a class="link" href="SoupMessageBody.html#soup-buffer-copy" title="soup_buffer_copy ()"><code class="function">soup_buffer_copy()</code></a> will normally just increment -the refcount on <em class="parameter"><code>buffer</code></em> - and return it. However, if <em class="parameter"><code>buffer</code></em> - was -created with <a class="link" href="SoupMessageBody.html#SOUP-MEMORY-TEMPORARY:CAPS"><span class="type">SOUP_MEMORY_TEMPORARY</span></a> memory, then <a class="link" href="SoupMessageBody.html#soup-buffer-copy" title="soup_buffer_copy ()"><code class="function">soup_buffer_copy()</code></a> -will actually return a copy of it, so that the data in the copy -will remain valid after the temporary buffer is freed.</p> -<div class="refsect3"> -<a name="soup-buffer-copy.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>buffer</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-buffer-copy.returns"></a><h4>Returns</h4> -<p> the new (or newly-reffed) buffer</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-buffer-free"></a><h3>soup_buffer_free ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_buffer_free (<em class="parameter"><code><a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> *buffer</code></em>);</pre> -<p>Frees <em class="parameter"><code>buffer</code></em> -. (In reality, as described in the documentation for -<a class="link" href="SoupMessageBody.html#soup-buffer-copy" title="soup_buffer_copy ()"><code class="function">soup_buffer_copy()</code></a>, this is actually an "unref" operation, and may -or may not actually free <em class="parameter"><code>buffer</code></em> -.)</p> -<div class="refsect3"> -<a name="soup-buffer-free.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>buffer</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-buffer-get-as-bytes"></a><h3>soup_buffer_get_as_bytes ()</h3> -<pre class="programlisting"><span class="returnvalue">GBytes</span> * -soup_buffer_get_as_bytes (<em class="parameter"><code><a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> *buffer</code></em>);</pre> -<p>Creates a <span class="type">GBytes</span> pointing to the same memory as <em class="parameter"><code>buffer</code></em> -. The -<span class="type">GBytes</span> will hold a reference on <em class="parameter"><code>buffer</code></em> - to ensure that it is not -freed while the <span class="type">GBytes</span> is still valid.</p> -<div class="refsect3"> -<a name="soup-buffer-get-as-bytes.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>buffer</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-buffer-get-as-bytes.returns"></a><h4>Returns</h4> -<p>a new <span class="type">GBytes</span> which has the same content -as the <a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a>. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.40</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-body-new"></a><h3>soup_message_body_new ()</h3> -<pre class="programlisting"><a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="returnvalue">SoupMessageBody</span></a> * -soup_message_body_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> -<p>Creates a new <a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a>. <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> uses this internally; you -will not normally need to call it yourself.</p> -<div class="refsect3"> -<a name="soup-message-body-new.returns"></a><h4>Returns</h4> -<p> a new <a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a>.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-body-free"></a><h3>soup_message_body_free ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_body_free (<em class="parameter"><code><a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a> *body</code></em>);</pre> -<p>Frees <em class="parameter"><code>body</code></em> -. You will not normally need to use this, as -<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> frees its associated message bodies automatically.</p> -<div class="refsect3"> -<a name="soup-message-body-free.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>body</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-body-set-accumulate"></a><h3>soup_message_body_set_accumulate ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_body_set_accumulate (<em class="parameter"><code><a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a> *body</code></em>, - <em class="parameter"><code><span class="type">gboolean</span> accumulate</code></em>);</pre> -<p>Sets or clears the accumulate flag on <em class="parameter"><code>body</code></em> -. (The default value is -<code class="literal">TRUE</code>.) If set to <code class="literal">FALSE</code>, <em class="parameter"><code>body</code></em> -'s <code class="literal">data</code> field will not be filled in -after the body is fully sent/received, and the chunks that make up -<em class="parameter"><code>body</code></em> - may be discarded when they are no longer needed.</p> -<p>In particular, if you set this flag to <code class="literal">FALSE</code> on an "incoming" -message body (that is, the <a class="link" href="SoupMessage.html#SoupMessage--response-body" title="The “response-body” property"><span class="type">“response_body”</span></a> of a -client-side message, or <a class="link" href="SoupMessage.html#SoupMessage--request-body" title="The “request-body” property"><span class="type">“request_body”</span></a> of a server-side -message), this will cause each chunk of the body to be discarded -after its corresponding <a class="link" href="SoupMessage.html#SoupMessage-got-chunk" title="The “got-chunk” signal"><span class="type">“got_chunk”</span></a> signal is emitted. -(This is equivalent to setting the deprecated -<a class="link" href="SoupMessage.html#SOUP-MESSAGE-OVERWRITE-CHUNKS:CAPS"><code class="literal">SOUP_MESSAGE_OVERWRITE_CHUNKS</code></a> flag on the message.)</p> -<p>If you set this flag to <code class="literal">FALSE</code> on the <a class="link" href="SoupMessage.html#SoupMessage--response-body" title="The “response-body” property"><span class="type">“response_body”</span></a> of -a server-side message, it will cause each chunk of the body to be -discarded after its corresponding <a class="link" href="SoupMessage.html#SoupMessage-wrote-chunk" title="The “wrote-chunk” signal"><span class="type">“wrote_chunk”</span></a> signal -is emitted.</p> -<p>If you set the flag to <code class="literal">FALSE</code> on the <a class="link" href="SoupMessage.html#SoupMessage--request-body" title="The “request-body” property"><span class="type">“request_body”</span></a> of a -client-side message, it will block the accumulation of chunks into -<em class="parameter"><code>body</code></em> -'s <code class="literal">data</code> field, but it will not normally cause the chunks to -be discarded after being written like in the server-side -<a class="link" href="SoupMessage.html#SoupMessage--response-body" title="The “response-body” property"><span class="type">“response_body”</span></a> case, because the request body needs to -be kept around in case the request needs to be sent a second time -due to redirection or authentication. However, if you set the -<a class="link" href="SoupMessage.html#SOUP-MESSAGE-CAN-REBUILD:CAPS"><code class="literal">SOUP_MESSAGE_CAN_REBUILD</code></a> flag on the message, then the chunks will -be discarded, and you will be responsible for recreating the -request body after the <a class="link" href="SoupMessage.html#SoupMessage-restarted" title="The “restarted” signal"><span class="type">“restarted”</span></a> signal is emitted.</p> -<div class="refsect3"> -<a name="soup-message-body-set-accumulate.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>body</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>accumulate</p></td> -<td class="parameter_description"><p>whether or not to accumulate body chunks in <em class="parameter"><code>body</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-body-get-accumulate"></a><h3>soup_message_body_get_accumulate ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_message_body_get_accumulate (<em class="parameter"><code><a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a> *body</code></em>);</pre> -<p>Gets the accumulate flag on <em class="parameter"><code>body</code></em> -; see -<a class="link" href="SoupMessageBody.html#soup-message-body-set-accumulate" title="soup_message_body_set_accumulate ()"><code class="function">soup_message_body_set_accumulate()</code></a> for details.</p> -<div class="refsect3"> -<a name="soup-message-body-get-accumulate.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>body</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-message-body-get-accumulate.returns"></a><h4>Returns</h4> -<p> the accumulate flag for <em class="parameter"><code>body</code></em> -.</p> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-body-append"></a><h3>soup_message_body_append ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_body_append (<em class="parameter"><code><a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a> *body</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessageBody.html#SoupMemoryUse" title="enum SoupMemoryUse"><span class="type">SoupMemoryUse</span></a> use</code></em>, - <em class="parameter"><code><span class="type">gconstpointer</span> data</code></em>, - <em class="parameter"><code><span class="type">gsize</span> length</code></em>);</pre> -<p>Appends <em class="parameter"><code>length</code></em> - bytes from <em class="parameter"><code>data</code></em> - to <em class="parameter"><code>body</code></em> - according to <em class="parameter"><code>use</code></em> -.</p> -<div class="refsect3"> -<a name="soup-message-body-append.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>body</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>use</p></td> -<td class="parameter_description"><p>how to use <em class="parameter"><code>data</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>data</p></td> -<td class="parameter_description"><p>data to append. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=length][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint8]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>length</p></td> -<td class="parameter_description"><p>length of <em class="parameter"><code>data</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-body-append-buffer"></a><h3>soup_message_body_append_buffer ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_body_append_buffer (<em class="parameter"><code><a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a> *body</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> *buffer</code></em>);</pre> -<p>Appends the data from <em class="parameter"><code>buffer</code></em> - to <em class="parameter"><code>body</code></em> -. (<a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a> uses -<a href="SoupMessageBody.html#SoupBuffer-struct"><span class="type">SoupBuffers</span></a> internally, so this is normally a constant-time -operation that doesn't actually require copying the data in -<em class="parameter"><code>buffer</code></em> -.)</p> -<div class="refsect3"> -<a name="soup-message-body-append-buffer.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>body</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>buffer</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-body-append-take"></a><h3>soup_message_body_append_take ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_body_append_take (<em class="parameter"><code><a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a> *body</code></em>, - <em class="parameter"><code><span class="type">guchar</span> *data</code></em>, - <em class="parameter"><code><span class="type">gsize</span> length</code></em>);</pre> -<p>Appends <em class="parameter"><code>length</code></em> - bytes from <em class="parameter"><code>data</code></em> - to <em class="parameter"><code>body</code></em> -.</p> -<p>This function is exactly equivalent to <a class="link" href="SoupMessageBody.html#soup-message-body-append" title="soup_message_body_append ()"><code class="function">soup_message_body_append()</code></a> -with <a class="link" href="SoupMessageBody.html#SOUP-MEMORY-TAKE:CAPS"><code class="literal">SOUP_MEMORY_TAKE</code></a> as second argument; it exists mainly for -convenience and simplifying language bindings.</p> -<p><span class="annotation">[<acronym title="Rename the original symbol's name to SYMBOL."><span class="acronym">rename-to</span></acronym> soup_message_body_append]</span></p> -<div class="refsect3"> -<a name="soup-message-body-append-take.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>body</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>data</p></td> -<td class="parameter_description"><p>data to append. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=length][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>length</p></td> -<td class="parameter_description"><p>length of <em class="parameter"><code>data</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.32</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-body-truncate"></a><h3>soup_message_body_truncate ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_body_truncate (<em class="parameter"><code><a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a> *body</code></em>);</pre> -<p>Deletes all of the data in <em class="parameter"><code>body</code></em> -.</p> -<div class="refsect3"> -<a name="soup-message-body-truncate.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>body</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-body-complete"></a><h3>soup_message_body_complete ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_body_complete (<em class="parameter"><code><a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a> *body</code></em>);</pre> -<p>Tags <em class="parameter"><code>body</code></em> - as being complete; Call this when using chunked encoding -after you have appended the last chunk.</p> -<div class="refsect3"> -<a name="soup-message-body-complete.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>body</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-body-flatten"></a><h3>soup_message_body_flatten ()</h3> -<pre class="programlisting"><a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="returnvalue">SoupBuffer</span></a> * -soup_message_body_flatten (<em class="parameter"><code><a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a> *body</code></em>);</pre> -<p>Fills in <em class="parameter"><code>body</code></em> -'s data field with a buffer containing all of the -data in <em class="parameter"><code>body</code></em> - (plus an additional '\0' byte not counted by <em class="parameter"><code>body</code></em> -'s -length field).</p> -<div class="refsect3"> -<a name="soup-message-body-flatten.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>body</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-message-body-flatten.returns"></a><h4>Returns</h4> -<p> a <a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> containing the same data as <em class="parameter"><code>body</code></em> -. -(You must free this buffer if you do not want it.)</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-body-get-chunk"></a><h3>soup_message_body_get_chunk ()</h3> -<pre class="programlisting"><a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="returnvalue">SoupBuffer</span></a> * -soup_message_body_get_chunk (<em class="parameter"><code><a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a> *body</code></em>, - <em class="parameter"><code><span class="type">goffset</span> offset</code></em>);</pre> -<p>Gets a <a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> containing data from <em class="parameter"><code>body</code></em> - starting at <em class="parameter"><code>offset</code></em> -. -The size of the returned chunk is unspecified. You can iterate -through the entire body by first calling -<a class="link" href="SoupMessageBody.html#soup-message-body-get-chunk" title="soup_message_body_get_chunk ()"><code class="function">soup_message_body_get_chunk()</code></a> with an offset of 0, and then on each -successive call, increment the offset by the length of the -previously-returned chunk.</p> -<p>If <em class="parameter"><code>offset</code></em> - is greater than or equal to the total length of <em class="parameter"><code>body</code></em> -, -then the return value depends on whether or not -<a class="link" href="SoupMessageBody.html#soup-message-body-complete" title="soup_message_body_complete ()"><code class="function">soup_message_body_complete()</code></a> has been called or not; if it has, -then <a class="link" href="SoupMessageBody.html#soup-message-body-get-chunk" title="soup_message_body_get_chunk ()"><code class="function">soup_message_body_get_chunk()</code></a> will return a 0-length chunk -(indicating the end of <em class="parameter"><code>body</code></em> -). If it has not, then -<a class="link" href="SoupMessageBody.html#soup-message-body-get-chunk" title="soup_message_body_get_chunk ()"><code class="function">soup_message_body_get_chunk()</code></a> will return <code class="literal">NULL</code> (indicating that -<em class="parameter"><code>body</code></em> - may still potentially have more data, but that data is not -currently available).</p> -<div class="refsect3"> -<a name="soup-message-body-get-chunk.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>body</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>offset</p></td> -<td class="parameter_description"><p>an offset</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-message-body-get-chunk.returns"></a><h4>Returns</h4> -<p>a <a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a>, or <code class="literal">NULL</code>. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-body-got-chunk"></a><h3>soup_message_body_got_chunk ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_body_got_chunk (<em class="parameter"><code><a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a> *body</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> *chunk</code></em>);</pre> -<p>Handles the <a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a> part of receiving a chunk of data from -the network. Normally this means appending <em class="parameter"><code>chunk</code></em> - to <em class="parameter"><code>body</code></em> -, exactly -as with <a class="link" href="SoupMessageBody.html#soup-message-body-append-buffer" title="soup_message_body_append_buffer ()"><code class="function">soup_message_body_append_buffer()</code></a>, but if you have set -<em class="parameter"><code>body</code></em> -'s accumulate flag to <code class="literal">FALSE</code>, then that will not happen.</p> -<p>This is a low-level method which you should not normally need to -use.</p> -<div class="refsect3"> -<a name="soup-message-body-got-chunk.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>body</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>chunk</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> received from the network</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-body-wrote-chunk"></a><h3>soup_message_body_wrote_chunk ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_body_wrote_chunk (<em class="parameter"><code><a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a> *body</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> *chunk</code></em>);</pre> -<p>Handles the <a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a> part of writing a chunk of data to the -network. Normally this is a no-op, but if you have set <em class="parameter"><code>body</code></em> -'s -accumulate flag to <code class="literal">FALSE</code>, then this will cause <em class="parameter"><code>chunk</code></em> - to be -discarded to free up memory.</p> -<p>This is a low-level method which you should not need to use, and -there are further restrictions on its proper use which are not -documented here.</p> -<div class="refsect3"> -<a name="soup-message-body-wrote-chunk.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>body</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>chunk</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> returned from <a class="link" href="SoupMessageBody.html#soup-message-body-get-chunk" title="soup_message_body_get_chunk ()"><code class="function">soup_message_body_get_chunk()</code></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.24</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupMessageBody.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupBuffer-struct"></a><h3>SoupBuffer</h3> -<pre class="programlisting">typedef struct { - const char *data; - gsize length; -} SoupBuffer; -</pre> -<p>A data buffer, generally used to represent a chunk of a -<a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a>.</p> -<p><em class="parameter"><code>data</code></em> - is a <span class="type">char</span> because that's generally convenient; in some -situations you may need to cast it to <span class="type">guchar</span> or another type.</p> -<div class="refsect3"> -<a name="SoupBuffer.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="struct_members_name"> -<col class="struct_members_description"> -<col width="200px" class="struct_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="struct_member_name"><p>const <span class="type">char</span> *<em class="structfield"><code><a name="SoupBuffer-struct.data"></a>data</code></em>;</p></td> -<td class="struct_member_description"><p>the data. </p></td> -<td class="struct_member_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> gpointer]</span></td> -</tr> -<tr> -<td class="struct_member_name"><p><span class="type">gsize</span> <em class="structfield"><code><a name="SoupBuffer-struct.length"></a>length</code></em>;</p></td> -<td class="struct_member_description"><p>length of <em class="parameter"><code>data</code></em> -</p></td> -<td class="struct_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMemoryUse"></a><h3>enum SoupMemoryUse</h3> -<p>Describes how <a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> should use the data passed in by the -caller.</p> -<p>See also <a class="link" href="SoupMessageBody.html#soup-buffer-new-with-owner" title="soup_buffer_new_with_owner ()"><code class="function">soup_buffer_new_with_owner()</code></a>, which allows to you create a -buffer containing data which is owned by another object.</p> -<div class="refsect3"> -<a name="SoupMemoryUse.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="enum_members_name"> -<col class="enum_members_description"> -<col width="200px" class="enum_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="enum_member_name"><p><a name="SOUP-MEMORY-STATIC:CAPS"></a>SOUP_MEMORY_STATIC</p></td> -<td class="enum_member_description"> -<p>The memory is statically allocated and -constant; libsoup can use the passed-in buffer directly and not -need to worry about it being modified or freed.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-MEMORY-TAKE:CAPS"></a>SOUP_MEMORY_TAKE</p></td> -<td class="enum_member_description"> -<p>The caller has allocated the memory for the -<a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a>'s use; libsoup will assume ownership of it and free it -(with <code class="function">g_free()</code>) when it is done with it.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-MEMORY-COPY:CAPS"></a>SOUP_MEMORY_COPY</p></td> -<td class="enum_member_description"> -<p>The passed-in data belongs to the caller; the -<a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> will copy it into new memory, leaving the caller free -to reuse the original memory.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-MEMORY-TEMPORARY:CAPS"></a>SOUP_MEMORY_TEMPORARY</p></td> -<td class="enum_member_description"> -<p>The passed-in data belongs to the caller, -but will remain valid for the lifetime of the <a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a>. The -difference between this and <em class="parameter"><code>SOUP_MEMORY_STATIC</code></em> - is that if you copy -a <em class="parameter"><code>SOUP_MEMORY_TEMPORARY</code></em> - buffer, it will make a copy of the memory -as well, rather than reusing the original memory.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessageBody-struct"></a><h3>SoupMessageBody</h3> -<pre class="programlisting">typedef struct { - const char *data; - goffset length; -} SoupMessageBody; -</pre> -<p>A <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> request or response body.</p> -<p>Note that while <em class="parameter"><code>length</code></em> - always reflects the full length of the -message body, <em class="parameter"><code>data</code></em> - is normally <code class="literal">NULL</code>, and will only be filled in -after <a class="link" href="SoupMessageBody.html#soup-message-body-flatten" title="soup_message_body_flatten ()"><code class="function">soup_message_body_flatten()</code></a> is called. For client-side -messages, this automatically happens for the response body after it -has been fully read, unless you set the -<a class="link" href="SoupMessage.html#SOUP-MESSAGE-OVERWRITE-CHUNKS:CAPS"><code class="literal">SOUP_MESSAGE_OVERWRITE_CHUNKS</code></a> flags. Likewise, for server-side -messages, the request body is automatically filled in after being -read.</p> -<p>As an added bonus, when <em class="parameter"><code>data</code></em> - is filled in, it is always terminated -with a '\0' byte (which is not reflected in <em class="parameter"><code>length</code></em> -).</p> -<div class="refsect3"> -<a name="SoupMessageBody.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="struct_members_name"> -<col class="struct_members_description"> -<col width="200px" class="struct_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="struct_member_name"><p>const <span class="type">char</span> *<em class="structfield"><code><a name="SoupMessageBody-struct.data"></a>data</code></em>;</p></td> -<td class="struct_member_description"><p>the data</p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><span class="type">goffset</span> <em class="structfield"><code><a name="SoupMessageBody-struct.length"></a>length</code></em>;</p></td> -<td class="struct_member_description"><p>length of <em class="parameter"><code>data</code></em> -</p></td> -<td class="struct_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -</div> -<div class="refsect1"> -<a name="SoupMessageBody.see-also"></a><h2>See Also</h2> -<p><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/SoupMessageHeaders.html b/docs/reference/html/SoupMessageHeaders.html deleted file mode 100644 index 237e4fdc..00000000 --- a/docs/reference/html/SoupMessageHeaders.html +++ /dev/null @@ -1,1904 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SoupMessageHeaders: 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="ch02.html" title="Core API"> -<link rel="prev" href="SoupMessage.html" title="SoupMessage"> -<link rel="next" href="SoupMessageBody.html" title="SoupMessageBody"> -<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="#SoupMessageHeaders.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupMessageHeaders.object-hierarchy" class="shortcut">Object Hierarchy</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="SoupMessage.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="SoupMessageBody.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="SoupMessageHeaders"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="SoupMessageHeaders.top_of_page"></a>SoupMessageHeaders</span></h2> -<p>SoupMessageHeaders — HTTP message headers</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="SoupMessageHeaders.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="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="returnvalue">SoupMessageHeaders</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-new" title="soup_message_headers_new ()">soup_message_headers_new</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-free" title="soup_message_headers_free ()">soup_message_headers_free</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-append" title="soup_message_headers_append ()">soup_message_headers_append</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-replace" title="soup_message_headers_replace ()">soup_message_headers_replace</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-remove" title="soup_message_headers_remove ()">soup_message_headers_remove</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-clear" title="soup_message_headers_clear ()">soup_message_headers_clear</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-clean-connection-headers" title="soup_message_headers_clean_connection_headers ()">soup_message_headers_clean_connection_headers</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-get-one" title="soup_message_headers_get_one ()">soup_message_headers_get_one</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-get-list" title="soup_message_headers_get_list ()">soup_message_headers_get_list</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupMessageHeaders.html#SoupMessageHeadersType" title="enum SoupMessageHeadersType"><span class="returnvalue">SoupMessageHeadersType</span></a> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-get-headers-type" title="soup_message_headers_get_headers_type ()">soup_message_headers_get_headers_type</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-header-contains" title="soup_message_headers_header_contains ()">soup_message_headers_header_contains</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-header-equals" title="soup_message_headers_header_equals ()">soup_message_headers_header_equals</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<span class="c_punctuation">(</span><a class="link" href="SoupMessageHeaders.html#SoupMessageHeadersForeachFunc" title="SoupMessageHeadersForeachFunc ()">*SoupMessageHeadersForeachFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-foreach" title="soup_message_headers_foreach ()">soup_message_headers_foreach</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-iter-init" title="soup_message_headers_iter_init ()">soup_message_headers_iter_init</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-iter-next" title="soup_message_headers_iter_next ()">soup_message_headers_iter_next</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupMessageHeaders.html#SoupEncoding" title="enum SoupEncoding"><span class="returnvalue">SoupEncoding</span></a> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-get-encoding" title="soup_message_headers_get_encoding ()">soup_message_headers_get_encoding</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-set-encoding" title="soup_message_headers_set_encoding ()">soup_message_headers_set_encoding</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">goffset</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-get-content-length" title="soup_message_headers_get_content_length ()">soup_message_headers_get_content_length</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-set-content-length" title="soup_message_headers_set_content_length ()">soup_message_headers_set_content_length</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupMessageHeaders.html#SoupExpectation" title="enum SoupExpectation"><span class="returnvalue">SoupExpectation</span></a> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-get-expectations" title="soup_message_headers_get_expectations ()">soup_message_headers_get_expectations</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-set-expectations" title="soup_message_headers_set_expectations ()">soup_message_headers_set_expectations</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-get-content-type" title="soup_message_headers_get_content_type ()">soup_message_headers_get_content_type</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-set-content-type" title="soup_message_headers_set_content_type ()">soup_message_headers_set_content_type</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-get-content-disposition" title="soup_message_headers_get_content_disposition ()">soup_message_headers_get_content_disposition</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-set-content-disposition" title="soup_message_headers_set_content_disposition ()">soup_message_headers_set_content_disposition</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-get-ranges" title="soup_message_headers_get_ranges ()">soup_message_headers_get_ranges</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-set-ranges" title="soup_message_headers_set_ranges ()">soup_message_headers_set_ranges</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-set-range" title="soup_message_headers_set_range ()">soup_message_headers_set_range</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-free-ranges" title="soup_message_headers_free_ranges ()">soup_message_headers_free_ranges</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-get-content-range" title="soup_message_headers_get_content_range ()">soup_message_headers_get_content_range</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-set-content-range" title="soup_message_headers_set_content_range ()">soup_message_headers_set_content_range</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupMessageHeaders.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="typedef_keyword">typedef</td> -<td class="function_name"><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders">SoupMessageHeaders</a></td> -</tr> -<tr> -<td class="datatype_keyword">enum</td> -<td class="function_name"><a class="link" href="SoupMessageHeaders.html#SoupMessageHeadersType" title="enum SoupMessageHeadersType">SoupMessageHeadersType</a></td> -</tr> -<tr> -<td class="datatype_keyword"> </td> -<td class="function_name"><a class="link" href="SoupMessageHeaders.html#SoupMessageHeadersIter" title="SoupMessageHeadersIter">SoupMessageHeadersIter</a></td> -</tr> -<tr> -<td class="datatype_keyword">enum</td> -<td class="function_name"><a class="link" href="SoupMessageHeaders.html#SoupEncoding" title="enum SoupEncoding">SoupEncoding</a></td> -</tr> -<tr> -<td class="datatype_keyword">enum</td> -<td class="function_name"><a class="link" href="SoupMessageHeaders.html#SoupExpectation" title="enum SoupExpectation">SoupExpectation</a></td> -</tr> -<tr> -<td class="datatype_keyword"> </td> -<td class="function_name"><a class="link" href="SoupMessageHeaders.html#SoupRange" title="SoupRange">SoupRange</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupMessageHeaders.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> <a href="/home/claudio/gnome3/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a> - <span class="lineart">╰──</span> SoupMessageHeaders -</pre> -</div> -<div class="refsect1"> -<a name="SoupMessageHeaders.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="SoupMessageHeaders.description"></a><h2>Description</h2> -<p><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> represents the HTTP message headers associated -with a request or response.</p> -</div> -<div class="refsect1"> -<a name="SoupMessageHeaders.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="soup-message-headers-new"></a><h3>soup_message_headers_new ()</h3> -<pre class="programlisting"><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="returnvalue">SoupMessageHeaders</span></a> * -soup_message_headers_new (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html#SoupMessageHeadersType" title="enum SoupMessageHeadersType"><span class="type">SoupMessageHeadersType</span></a> type</code></em>);</pre> -<p>Creates a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a>. (<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> does this -automatically for its own headers. You would only need to use this -method if you are manually parsing or generating message headers.)</p> -<div class="refsect3"> -<a name="soup-message-headers-new.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>type</p></td> -<td class="parameter_description"><p>the type of headers</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-message-headers-new.returns"></a><h4>Returns</h4> -<p> a new <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-headers-free"></a><h3>soup_message_headers_free ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_headers_free (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *hdrs</code></em>);</pre> -<p>Frees <em class="parameter"><code>hdrs</code></em> -.</p> -<div class="refsect3"> -<a name="soup-message-headers-free.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>hdrs</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-headers-append"></a><h3>soup_message_headers_append ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_headers_append (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *hdrs</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *name</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre> -<p>Appends a new header with name <em class="parameter"><code>name</code></em> - and value <em class="parameter"><code>value</code></em> - to <em class="parameter"><code>hdrs</code></em> -. (If -there is an existing header with name <em class="parameter"><code>name</code></em> -, then this creates a -second one, which is only allowed for list-valued headers; see also -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-replace" title="soup_message_headers_replace ()"><code class="function">soup_message_headers_replace()</code></a>.)</p> -<p>The caller is expected to make sure that <em class="parameter"><code>name</code></em> - and <em class="parameter"><code>value</code></em> - are -syntactically correct.</p> -<div class="refsect3"> -<a name="soup-message-headers-append.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>hdrs</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>name</p></td> -<td class="parameter_description"><p>the header name to add</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>value</p></td> -<td class="parameter_description"><p>the new value of <em class="parameter"><code>name</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-headers-replace"></a><h3>soup_message_headers_replace ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_headers_replace (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *hdrs</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *name</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre> -<p>Replaces the value of the header <em class="parameter"><code>name</code></em> - in <em class="parameter"><code>hdrs</code></em> - with <em class="parameter"><code>value</code></em> -. (See -also <a class="link" href="SoupMessageHeaders.html#soup-message-headers-append" title="soup_message_headers_append ()"><code class="function">soup_message_headers_append()</code></a>.)</p> -<p>The caller is expected to make sure that <em class="parameter"><code>name</code></em> - and <em class="parameter"><code>value</code></em> - are -syntactically correct.</p> -<div class="refsect3"> -<a name="soup-message-headers-replace.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>hdrs</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>name</p></td> -<td class="parameter_description"><p>the header name to replace</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>value</p></td> -<td class="parameter_description"><p>the new value of <em class="parameter"><code>name</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-headers-remove"></a><h3>soup_message_headers_remove ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_headers_remove (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *hdrs</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre> -<p>Removes <em class="parameter"><code>name</code></em> - from <em class="parameter"><code>hdrs</code></em> -. If there are multiple values for <em class="parameter"><code>name</code></em> -, -they are all removed.</p> -<div class="refsect3"> -<a name="soup-message-headers-remove.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>hdrs</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>name</p></td> -<td class="parameter_description"><p>the header name to remove</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-headers-clear"></a><h3>soup_message_headers_clear ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_headers_clear (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *hdrs</code></em>);</pre> -<p>Clears <em class="parameter"><code>hdrs</code></em> -.</p> -<div class="refsect3"> -<a name="soup-message-headers-clear.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>hdrs</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-headers-clean-connection-headers"></a><h3>soup_message_headers_clean_connection_headers ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_headers_clean_connection_headers - (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *hdrs</code></em>);</pre> -<p>Removes all the headers listed in the Connection header.</p> -<div class="refsect3"> -<a name="soup-message-headers-clean-connection-headers.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>hdrs</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<p class="since">Since: 2.36</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-headers-get-one"></a><h3>soup_message_headers_get_one ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -soup_message_headers_get_one (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *hdrs</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre> -<p>Gets the value of header <em class="parameter"><code>name</code></em> - in <em class="parameter"><code>hdrs</code></em> -. Use this for headers whose -values are <span class="emphasis"><em>not</em></span> comma-delimited lists, and -which therefore can only appear at most once in the headers. For -list-valued headers, use <a class="link" href="SoupMessageHeaders.html#soup-message-headers-get-list" title="soup_message_headers_get_list ()"><code class="function">soup_message_headers_get_list()</code></a>.</p> -<p>If <em class="parameter"><code>hdrs</code></em> - does erroneously contain multiple copies of the header, it -is not defined which one will be returned. (Ideally, it will return -whichever one makes libsoup most compatible with other HTTP -implementations.)</p> -<div class="refsect3"> -<a name="soup-message-headers-get-one.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>hdrs</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>name</p></td> -<td class="parameter_description"><p>header name</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-message-headers-get-one.returns"></a><h4>Returns</h4> -<p>the header's value or <code class="literal">NULL</code> if not found. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.28</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-headers-get-list"></a><h3>soup_message_headers_get_list ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -soup_message_headers_get_list (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *hdrs</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre> -<p>Gets the value of header <em class="parameter"><code>name</code></em> - in <em class="parameter"><code>hdrs</code></em> -. Use this for headers whose -values are comma-delimited lists, and which are therefore allowed -to appear multiple times in the headers. For non-list-valued -headers, use <a class="link" href="SoupMessageHeaders.html#soup-message-headers-get-one" title="soup_message_headers_get_one ()"><code class="function">soup_message_headers_get_one()</code></a>.</p> -<p>If <em class="parameter"><code>name</code></em> - appears multiple times in <em class="parameter"><code>hdrs</code></em> -, -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-get-list" title="soup_message_headers_get_list ()"><code class="function">soup_message_headers_get_list()</code></a> will concatenate all of the values -together, separated by commas. This is sometimes awkward to parse -(eg, WWW-Authenticate, Set-Cookie), but you have to be able to deal -with it anyway, because the HTTP spec explicitly states that this -transformation is allowed, and so an upstream proxy could do the -same thing.</p> -<div class="refsect3"> -<a name="soup-message-headers-get-list.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>hdrs</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>name</p></td> -<td class="parameter_description"><p>header name</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-message-headers-get-list.returns"></a><h4>Returns</h4> -<p>the header's value or <code class="literal">NULL</code> if not found. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.28</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-headers-get-headers-type"></a><h3>soup_message_headers_get_headers_type ()</h3> -<pre class="programlisting"><a class="link" href="SoupMessageHeaders.html#SoupMessageHeadersType" title="enum SoupMessageHeadersType"><span class="returnvalue">SoupMessageHeadersType</span></a> -soup_message_headers_get_headers_type (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *hdrs</code></em>);</pre> -<p>Gets the type of headers.</p> -<div class="refsect3"> -<a name="soup-message-headers-get-headers-type.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>hdrs</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-message-headers-get-headers-type.returns"></a><h4>Returns</h4> -<p> the header's type.</p> -</div> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-headers-header-contains"></a><h3>soup_message_headers_header_contains ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_message_headers_header_contains (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *hdrs</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *name</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *token</code></em>);</pre> -<p>Checks whether the list-valued header <em class="parameter"><code>name</code></em> - is present in <em class="parameter"><code>hdrs</code></em> -, -and contains a case-insensitive match for <em class="parameter"><code>token</code></em> -.</p> -<p>(If <em class="parameter"><code>name</code></em> - is present in <em class="parameter"><code>hdrs</code></em> -, then this is equivalent to calling -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-contains" title="soup_header_contains ()"><code class="function">soup_header_contains()</code></a> on its value.)</p> -<div class="refsect3"> -<a name="soup-message-headers-header-contains.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>hdrs</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>name</p></td> -<td class="parameter_description"><p>header name</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>token</p></td> -<td class="parameter_description"><p>token to look for</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-message-headers-header-contains.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if the header is present and contains <em class="parameter"><code>token</code></em> -, -<code class="literal">FALSE</code> otherwise.</p> -</div> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-headers-header-equals"></a><h3>soup_message_headers_header_equals ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_message_headers_header_equals (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *hdrs</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *name</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre> -<p>Checks whether the header <em class="parameter"><code>name</code></em> - is present in <em class="parameter"><code>hdrs</code></em> - and is -(case-insensitively) equal to <em class="parameter"><code>value</code></em> -.</p> -<div class="refsect3"> -<a name="soup-message-headers-header-equals.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>hdrs</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>name</p></td> -<td class="parameter_description"><p>header name</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>value</p></td> -<td class="parameter_description"><p>expected value</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-message-headers-header-equals.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if the header is present and its value is -<em class="parameter"><code>value</code></em> -, <code class="literal">FALSE</code> otherwise.</p> -</div> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessageHeadersForeachFunc"></a><h3>SoupMessageHeadersForeachFunc ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -<span class="c_punctuation">(</span>*SoupMessageHeadersForeachFunc<span class="c_punctuation">)</span> (<em class="parameter"><code>const <span class="type">char</span> *name</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *value</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> -<p>The callback passed to <a class="link" href="SoupMessageHeaders.html#soup-message-headers-foreach" title="soup_message_headers_foreach ()"><code class="function">soup_message_headers_foreach()</code></a>.</p> -<div class="refsect3"> -<a name="SoupMessageHeadersForeachFunc.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>name</p></td> -<td class="parameter_description"><p>the header name</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>value</p></td> -<td class="parameter_description"><p>the header value</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>the data passed to <a class="link" href="SoupMessageHeaders.html#soup-message-headers-foreach" title="soup_message_headers_foreach ()"><code class="function">soup_message_headers_foreach()</code></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-headers-foreach"></a><h3>soup_message_headers_foreach ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_headers_foreach (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *hdrs</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessageHeaders.html#SoupMessageHeadersForeachFunc" title="SoupMessageHeadersForeachFunc ()"><span class="type">SoupMessageHeadersForeachFunc</span></a> func</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> -<p>Calls <em class="parameter"><code>func</code></em> - once for each header value in <em class="parameter"><code>hdrs</code></em> -.</p> -<p>Beware that unlike <code class="function">soup_message_headers_get()</code>, this processes the -headers in exactly the way they were added, rather than -concatenating multiple same-named headers into a single value. -(This is intentional; it ensures that if you call -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-append" title="soup_message_headers_append ()"><code class="function">soup_message_headers_append()</code></a> multiple times with the same name, -then the I/O code will output multiple copies of the header when -sending the message to the remote implementation, which may be -required for interoperability in some cases.)</p> -<p>You may not modify the headers from <em class="parameter"><code>func</code></em> -.</p> -<div class="refsect3"> -<a name="soup-message-headers-foreach.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>hdrs</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>func</p></td> -<td class="parameter_description"><p>callback function to run for each header. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>data to pass to <em class="parameter"><code>func</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-headers-iter-init"></a><h3>soup_message_headers_iter_init ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_headers_iter_init (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html#SoupMessageHeadersIter" title="SoupMessageHeadersIter"><span class="type">SoupMessageHeadersIter</span></a> *iter</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *hdrs</code></em>);</pre> -<p>Initializes <em class="parameter"><code>iter</code></em> - for iterating <em class="parameter"><code>hdrs</code></em> -.</p> -<div class="refsect3"> -<a name="soup-message-headers-iter-init.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>iter</p></td> -<td class="parameter_description"><p>a pointer to a <a class="link" href="SoupMessageHeaders.html#SoupMessageHeadersIter" title="SoupMessageHeadersIter"><code class="literal">SoupMessageHeadersIter</code></a> -structure. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>hdrs</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><code class="literal">SoupMessageHeaders</code></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-headers-iter-next"></a><h3>soup_message_headers_iter_next ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_message_headers_iter_next (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html#SoupMessageHeadersIter" title="SoupMessageHeadersIter"><span class="type">SoupMessageHeadersIter</span></a> *iter</code></em>, - <em class="parameter"><code>const <span class="type">char</span> **name</code></em>, - <em class="parameter"><code>const <span class="type">char</span> **value</code></em>);</pre> -<p>Yields the next name/value pair in the <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><code class="literal">SoupMessageHeaders</code></a> being -iterated by <em class="parameter"><code>iter</code></em> -. If <em class="parameter"><code>iter</code></em> - has already yielded the last header, -then <a class="link" href="SoupMessageHeaders.html#soup-message-headers-iter-next" title="soup_message_headers_iter_next ()"><code class="function">soup_message_headers_iter_next()</code></a> will return <code class="literal">FALSE</code> and <em class="parameter"><code>name</code></em> - -and <em class="parameter"><code>value</code></em> - will be unchanged.</p> -<div class="refsect3"> -<a name="soup-message-headers-iter-next.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>iter</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageHeaders.html#SoupMessageHeadersIter" title="SoupMessageHeadersIter"><code class="literal">SoupMessageHeadersIter</code></a>. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>name</p></td> -<td class="parameter_description"><p>pointer to a variable to return -the header name in. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>value</p></td> -<td class="parameter_description"><p>pointer to a variable to return -the header value in. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-message-headers-iter-next.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if another name and value were returned, <code class="literal">FALSE</code> -if the end of the headers has been reached.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-headers-get-encoding"></a><h3>soup_message_headers_get_encoding ()</h3> -<pre class="programlisting"><a class="link" href="SoupMessageHeaders.html#SoupEncoding" title="enum SoupEncoding"><span class="returnvalue">SoupEncoding</span></a> -soup_message_headers_get_encoding (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *hdrs</code></em>);</pre> -<p>Gets the message body encoding that <em class="parameter"><code>hdrs</code></em> - declare. This may not -always correspond to the encoding used on the wire; eg, a HEAD -response may declare a Content-Length or Transfer-Encoding, but -it will never actually include a body.</p> -<div class="refsect3"> -<a name="soup-message-headers-get-encoding.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>hdrs</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-message-headers-get-encoding.returns"></a><h4>Returns</h4> -<p> the encoding declared by <em class="parameter"><code>hdrs</code></em> -.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-headers-set-encoding"></a><h3>soup_message_headers_set_encoding ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_headers_set_encoding (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *hdrs</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessageHeaders.html#SoupEncoding" title="enum SoupEncoding"><span class="type">SoupEncoding</span></a> encoding</code></em>);</pre> -<p>Sets the message body encoding that <em class="parameter"><code>hdrs</code></em> - will declare. In particular, -you should use this if you are going to send a request or response in -chunked encoding.</p> -<div class="refsect3"> -<a name="soup-message-headers-set-encoding.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>hdrs</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>encoding</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageHeaders.html#SoupEncoding" title="enum SoupEncoding"><span class="type">SoupEncoding</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-headers-get-content-length"></a><h3>soup_message_headers_get_content_length ()</h3> -<pre class="programlisting"><span class="returnvalue">goffset</span> -soup_message_headers_get_content_length - (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *hdrs</code></em>);</pre> -<p>Gets the message body length that <em class="parameter"><code>hdrs</code></em> - declare. This will only -be non-0 if <a class="link" href="SoupMessageHeaders.html#soup-message-headers-get-encoding" title="soup_message_headers_get_encoding ()"><code class="function">soup_message_headers_get_encoding()</code></a> returns -<a class="link" href="SoupMessageHeaders.html#SOUP-ENCODING-CONTENT-LENGTH:CAPS"><code class="literal">SOUP_ENCODING_CONTENT_LENGTH</code></a>.</p> -<div class="refsect3"> -<a name="soup-message-headers-get-content-length.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>hdrs</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-message-headers-get-content-length.returns"></a><h4>Returns</h4> -<p> the message body length declared by <em class="parameter"><code>hdrs</code></em> -.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-headers-set-content-length"></a><h3>soup_message_headers_set_content_length ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_headers_set_content_length - (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *hdrs</code></em>, - <em class="parameter"><code><span class="type">goffset</span> content_length</code></em>);</pre> -<p>Sets the message body length that <em class="parameter"><code>hdrs</code></em> - will declare, and sets -<em class="parameter"><code>hdrs</code></em> -'s encoding to <a class="link" href="SoupMessageHeaders.html#SOUP-ENCODING-CONTENT-LENGTH:CAPS"><code class="literal">SOUP_ENCODING_CONTENT_LENGTH</code></a>.</p> -<p>You do not normally need to call this; if <em class="parameter"><code>hdrs</code></em> - is set to use -Content-Length encoding, libsoup will automatically set its -Content-Length header for you immediately before sending the -headers. One situation in which this method is useful is when -generating the response to a HEAD request; Calling -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-set-content-length" title="soup_message_headers_set_content_length ()"><code class="function">soup_message_headers_set_content_length()</code></a> allows you to put the -correct content length into the response without needing to waste -memory by filling in a response body which won't actually be sent.</p> -<div class="refsect3"> -<a name="soup-message-headers-set-content-length.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>hdrs</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>content_length</p></td> -<td class="parameter_description"><p>the message body length</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-headers-get-expectations"></a><h3>soup_message_headers_get_expectations ()</h3> -<pre class="programlisting"><a class="link" href="SoupMessageHeaders.html#SoupExpectation" title="enum SoupExpectation"><span class="returnvalue">SoupExpectation</span></a> -soup_message_headers_get_expectations (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *hdrs</code></em>);</pre> -<p>Gets the expectations declared by <em class="parameter"><code>hdrs</code></em> -'s "Expect" header. -Currently this will either be <a class="link" href="SoupMessageHeaders.html#SOUP-EXPECTATION-CONTINUE:CAPS"><code class="literal">SOUP_EXPECTATION_CONTINUE</code></a> or -<a class="link" href="SoupMessageHeaders.html#SOUP-EXPECTATION-UNRECOGNIZED:CAPS"><code class="literal">SOUP_EXPECTATION_UNRECOGNIZED</code></a>.</p> -<div class="refsect3"> -<a name="soup-message-headers-get-expectations.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>hdrs</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-message-headers-get-expectations.returns"></a><h4>Returns</h4> -<p> the contents of <em class="parameter"><code>hdrs</code></em> -'s "Expect" header</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-headers-set-expectations"></a><h3>soup_message_headers_set_expectations ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_headers_set_expectations (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *hdrs</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessageHeaders.html#SoupExpectation" title="enum SoupExpectation"><span class="type">SoupExpectation</span></a> expectations</code></em>);</pre> -<p>Sets <em class="parameter"><code>hdrs</code></em> -'s "Expect" header according to <em class="parameter"><code>expectations</code></em> -.</p> -<p>Currently <a class="link" href="SoupMessageHeaders.html#SOUP-EXPECTATION-CONTINUE:CAPS"><code class="literal">SOUP_EXPECTATION_CONTINUE</code></a> is the only known expectation -value. You should set this value on a request if you are sending a -large message body (eg, via POST or PUT), and want to give the -server a chance to reject the request after seeing just the headers -(eg, because it will require authentication before allowing you to -post, or because you're POSTing to a URL that doesn't exist). This -saves you from having to transmit the large request body when the -server is just going to ignore it anyway.</p> -<div class="refsect3"> -<a name="soup-message-headers-set-expectations.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>hdrs</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>expectations</p></td> -<td class="parameter_description"><p>the expectations to set</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-headers-get-content-type"></a><h3>soup_message_headers_get_content_type ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -soup_message_headers_get_content_type (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *hdrs</code></em>, - <em class="parameter"><code><span class="type">GHashTable</span> **params</code></em>);</pre> -<p>Looks up the "Content-Type" header in <em class="parameter"><code>hdrs</code></em> -, parses it, and returns -its value in *<em class="parameter"><code>content_type</code></em> - and *<em class="parameter"><code>params</code></em> -. <em class="parameter"><code>params</code></em> - can be <code class="literal">NULL</code> if you -are only interested in the content type itself.</p> -<div class="refsect3"> -<a name="soup-message-headers-get-content-type.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>hdrs</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a></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 the Content-Type parameters (eg, "charset"), or -<code class="literal">NULL</code>. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 utf8][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-message-headers-get-content-type.returns"></a><h4>Returns</h4> -<p>a string with the value of the -"Content-Type" header or <code class="literal">NULL</code> if <em class="parameter"><code>hdrs</code></em> -does not contain that -header or it cannot be parsed (in which case *<em class="parameter"><code>params</code></em> -will be -unchanged). </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-headers-set-content-type"></a><h3>soup_message_headers_set_content_type ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_headers_set_content_type (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *hdrs</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *content_type</code></em>, - <em class="parameter"><code><span class="type">GHashTable</span> *params</code></em>);</pre> -<p>Sets the "Content-Type" header in <em class="parameter"><code>hdrs</code></em> - to <em class="parameter"><code>content_type</code></em> -, -optionally with additional parameters specified in <em class="parameter"><code>params</code></em> -.</p> -<div class="refsect3"> -<a name="soup-message-headers-set-content-type.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>hdrs</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>content_type</p></td> -<td class="parameter_description"><p>the MIME type</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>params</p></td> -<td class="parameter_description"><p>additional -parameters, or <code class="literal">NULL</code>. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 utf8]</span></td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-headers-get-content-disposition"></a><h3>soup_message_headers_get_content_disposition ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_message_headers_get_content_disposition - (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *hdrs</code></em>, - <em class="parameter"><code><span class="type">char</span> **disposition</code></em>, - <em class="parameter"><code><span class="type">GHashTable</span> **params</code></em>);</pre> -<p>Looks up the "Content-Disposition" header in <em class="parameter"><code>hdrs</code></em> -, parses it, and -returns its value in *<em class="parameter"><code>disposition</code></em> - and *<em class="parameter"><code>params</code></em> -. <em class="parameter"><code>params</code></em> - can be -<code class="literal">NULL</code> if you are only interested in the disposition-type.</p> -<p>In HTTP, the most common use of this header is to set a -disposition-type of "attachment", to suggest to the browser that a -response should be saved to disk rather than displayed in the -browser. If <em class="parameter"><code>params</code></em> - contains a "filename" parameter, this is a -suggestion of a filename to use. (If the parameter value in the -header contains an absolute or relative path, libsoup will truncate -it down to just the final path component, so you do not need to -test this yourself.)</p> -<p>Content-Disposition is also used in "multipart/form-data", however -this is handled automatically by <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> and the associated -form methods.</p> -<div class="refsect3"> -<a name="soup-message-headers-get-content-disposition.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>hdrs</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>disposition</p></td> -<td class="parameter_description"><p>return location for the -disposition-type, or <code class="literal">NULL</code>. </p></td> -<td class="parameter_annotations"><span class="annotation">[<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>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>params</p></td> -<td class="parameter_description"><p>return -location for the Content-Disposition parameters, or <code class="literal">NULL</code>. </p></td> -<td class="parameter_annotations"><span class="annotation">[<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="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 utf8]</span></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-message-headers-get-content-disposition.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if <em class="parameter"><code>hdrs</code></em> -contains a "Content-Disposition" -header, <code class="literal">FALSE</code> if not (in which case *<em class="parameter"><code>disposition</code></em> -and *<em class="parameter"><code>params</code></em> -will be unchanged).</p> -</div> -<p class="since">Since: 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-headers-set-content-disposition"></a><h3>soup_message_headers_set_content_disposition ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_headers_set_content_disposition - (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *hdrs</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *disposition</code></em>, - <em class="parameter"><code><span class="type">GHashTable</span> *params</code></em>);</pre> -<p>Sets the "Content-Disposition" header in <em class="parameter"><code>hdrs</code></em> - to <em class="parameter"><code>disposition</code></em> -, -optionally with additional parameters specified in <em class="parameter"><code>params</code></em> -.</p> -<p>See <a class="link" href="SoupMessageHeaders.html#soup-message-headers-get-content-disposition" title="soup_message_headers_get_content_disposition ()"><code class="function">soup_message_headers_get_content_disposition()</code></a> for a discussion -of how Content-Disposition is used in HTTP.</p> -<div class="refsect3"> -<a name="soup-message-headers-set-content-disposition.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>hdrs</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>disposition</p></td> -<td class="parameter_description"><p>the disposition-type</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>params</p></td> -<td class="parameter_description"><p>additional -parameters, or <code class="literal">NULL</code>. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 utf8]</span></td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-headers-get-ranges"></a><h3>soup_message_headers_get_ranges ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_message_headers_get_ranges (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *hdrs</code></em>, - <em class="parameter"><code><span class="type">goffset</span> total_length</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessageHeaders.html#SoupRange" title="SoupRange"><span class="type">SoupRange</span></a> **ranges</code></em>, - <em class="parameter"><code><span class="type">int</span> *length</code></em>);</pre> -<p>Parses <em class="parameter"><code>hdrs</code></em> -'s Range header and returns an array of the requested -byte ranges. The returned array must be freed with -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-free-ranges" title="soup_message_headers_free_ranges ()"><code class="function">soup_message_headers_free_ranges()</code></a>.</p> -<p>If <em class="parameter"><code>total_length</code></em> - is non-0, its value will be used to adjust the -returned ranges to have explicit start and end values, and the -returned ranges will be sorted and non-overlapping. If -<em class="parameter"><code>total_length</code></em> - is 0, then some ranges may have an end value of -1, -as described under <a class="link" href="SoupMessageHeaders.html#SoupRange" title="SoupRange"><span class="type">SoupRange</span></a>, and some of the ranges may be -redundant.</p> -<p>Beware that even if given a <em class="parameter"><code>total_length</code></em> -, this function does not -check that the ranges are satisfiable.</p> -<div class="note"><p> -<a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> has built-in handling for range requests. If your -server handler returns a <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-OK:CAPS"><code class="literal">SOUP_STATUS_OK</code></a> response containing the -complete response body (rather than pausing the message and -returning some of the response body later), and there is a Range -header in the request, then libsoup will automatically convert the -response to a <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-PARTIAL-CONTENT:CAPS"><code class="literal">SOUP_STATUS_PARTIAL_CONTENT</code></a> response containing only -the range(s) requested by the client. - -The only time you need to process the Range header yourself is if -either you need to stream the response body rather than returning -it all at once, or you do not already have the complete response -body available, and only want to generate the parts that were -actually requested by the client. -</p></div> -<div class="refsect3"> -<a name="soup-message-headers-get-ranges.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>hdrs</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>total_length</p></td> -<td class="parameter_description"><p>the total_length of the response body</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>ranges</p></td> -<td class="parameter_description"><p>return location for an array -of <a class="link" href="SoupMessageHeaders.html#SoupRange" title="SoupRange"><span class="type">SoupRange</span></a>. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=length]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>length</p></td> -<td class="parameter_description"><p>the length of the returned array</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-message-headers-get-ranges.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if <em class="parameter"><code>hdrs</code></em> -contained a syntactically-valid -"Range" header, <code class="literal">FALSE</code> otherwise (in which case <em class="parameter"><code>range</code></em> -and <em class="parameter"><code>length</code></em> -will not be set).</p> -</div> -<p class="since">Since: 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-headers-set-ranges"></a><h3>soup_message_headers_set_ranges ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_headers_set_ranges (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *hdrs</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessageHeaders.html#SoupRange" title="SoupRange"><span class="type">SoupRange</span></a> *ranges</code></em>, - <em class="parameter"><code><span class="type">int</span> length</code></em>);</pre> -<p>Sets <em class="parameter"><code>hdrs</code></em> -'s Range header to request the indicated ranges. (If you -only want to request a single range, you can use -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-set-range" title="soup_message_headers_set_range ()"><code class="function">soup_message_headers_set_range()</code></a>.)</p> -<div class="refsect3"> -<a name="soup-message-headers-set-ranges.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>hdrs</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>ranges</p></td> -<td class="parameter_description"><p>an array of <a class="link" href="SoupMessageHeaders.html#SoupRange" title="SoupRange"><span class="type">SoupRange</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>length</p></td> -<td class="parameter_description"><p>the length of <em class="parameter"><code>range</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-headers-set-range"></a><h3>soup_message_headers_set_range ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_headers_set_range (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *hdrs</code></em>, - <em class="parameter"><code><span class="type">goffset</span> start</code></em>, - <em class="parameter"><code><span class="type">goffset</span> end</code></em>);</pre> -<p>Sets <em class="parameter"><code>hdrs</code></em> -'s Range header to request the indicated range. -<em class="parameter"><code>start</code></em> - and <em class="parameter"><code>end</code></em> - are interpreted as in a <a class="link" href="SoupMessageHeaders.html#SoupRange" title="SoupRange"><span class="type">SoupRange</span></a>.</p> -<p>If you need to request multiple ranges, use -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-set-ranges" title="soup_message_headers_set_ranges ()"><code class="function">soup_message_headers_set_ranges()</code></a>.</p> -<div class="refsect3"> -<a name="soup-message-headers-set-range.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>hdrs</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>start</p></td> -<td class="parameter_description"><p>the start of the range to request</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>end</p></td> -<td class="parameter_description"><p>the end of the range to request</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-headers-free-ranges"></a><h3>soup_message_headers_free_ranges ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_headers_free_ranges (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *hdrs</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessageHeaders.html#SoupRange" title="SoupRange"><span class="type">SoupRange</span></a> *ranges</code></em>);</pre> -<p>Frees the array of ranges returned from <a class="link" href="SoupMessageHeaders.html#soup-message-headers-get-ranges" title="soup_message_headers_get_ranges ()"><code class="function">soup_message_headers_get_ranges()</code></a>.</p> -<div class="refsect3"> -<a name="soup-message-headers-free-ranges.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>hdrs</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>ranges</p></td> -<td class="parameter_description"><p>an array of <a class="link" href="SoupMessageHeaders.html#SoupRange" title="SoupRange"><span class="type">SoupRange</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-headers-get-content-range"></a><h3>soup_message_headers_get_content_range ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_message_headers_get_content_range - (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *hdrs</code></em>, - <em class="parameter"><code><span class="type">goffset</span> *start</code></em>, - <em class="parameter"><code><span class="type">goffset</span> *end</code></em>, - <em class="parameter"><code><span class="type">goffset</span> *total_length</code></em>);</pre> -<p>Parses <em class="parameter"><code>hdrs</code></em> -'s Content-Range header and returns it in <em class="parameter"><code>start</code></em> -, -<em class="parameter"><code>end</code></em> -, and <em class="parameter"><code>total_length</code></em> -. If the total length field in the header -was specified as "*", then <em class="parameter"><code>total_length</code></em> - will be set to -1.</p> -<div class="refsect3"> -<a name="soup-message-headers-get-content-range.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>hdrs</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>start</p></td> -<td class="parameter_description"><p>return value for the start of the range. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>end</p></td> -<td class="parameter_description"><p>return value for the end of the range. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>total_length</p></td> -<td class="parameter_description"><p>return value for the total length of the -resource, or <code class="literal">NULL</code> if you don't care. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL may be passed instead of a pointer to a location."><span class="acronym">optional</span></acronym>]</span></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-message-headers-get-content-range.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if <em class="parameter"><code>hdrs</code></em> -contained a "Content-Range" header -containing a byte range which could be parsed, <code class="literal">FALSE</code> otherwise.</p> -</div> -<p class="since">Since: 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-message-headers-set-content-range"></a><h3>soup_message_headers_set_content_range ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_message_headers_set_content_range - (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *hdrs</code></em>, - <em class="parameter"><code><span class="type">goffset</span> start</code></em>, - <em class="parameter"><code><span class="type">goffset</span> end</code></em>, - <em class="parameter"><code><span class="type">goffset</span> total_length</code></em>);</pre> -<p>Sets <em class="parameter"><code>hdrs</code></em> -'s Content-Range header according to the given values. -(Note that <em class="parameter"><code>total_length</code></em> - is the total length of the entire resource -that this is a range of, not simply <em class="parameter"><code>end</code></em> - - <em class="parameter"><code>start</code></em> - + 1.)</p> -<div class="note"><p> -<a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> has built-in handling for range requests, and you do -not normally need to call this function youself. See -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-get-ranges" title="soup_message_headers_get_ranges ()"><code class="function">soup_message_headers_get_ranges()</code></a> for more details. -</p></div> -<div class="refsect3"> -<a name="soup-message-headers-set-content-range.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>hdrs</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>start</p></td> -<td class="parameter_description"><p>the start of the range</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>end</p></td> -<td class="parameter_description"><p>the end of the range</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>total_length</p></td> -<td class="parameter_description"><p>the total length of the resource, or -1 if unknown</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.26</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupMessageHeaders.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupMessageHeaders"></a><h3>SoupMessageHeaders</h3> -<pre class="programlisting">typedef struct SoupMessageHeaders SoupMessageHeaders; -</pre> -<p>The HTTP message headers associated with a request or response.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessageHeadersType"></a><h3>enum SoupMessageHeadersType</h3> -<p>Value passed to <a class="link" href="SoupMessageHeaders.html#soup-message-headers-new" title="soup_message_headers_new ()"><code class="function">soup_message_headers_new()</code></a> to set certain default -behaviors.</p> -<div class="refsect3"> -<a name="SoupMessageHeadersType.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="enum_members_name"> -<col class="enum_members_description"> -<col width="200px" class="enum_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="enum_member_name"><p><a name="SOUP-MESSAGE-HEADERS-REQUEST:CAPS"></a>SOUP_MESSAGE_HEADERS_REQUEST</p></td> -<td class="enum_member_description"> -<p>request headers</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-MESSAGE-HEADERS-RESPONSE:CAPS"></a>SOUP_MESSAGE_HEADERS_RESPONSE</p></td> -<td class="enum_member_description"> -<p>response headers</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-MESSAGE-HEADERS-MULTIPART:CAPS"></a>SOUP_MESSAGE_HEADERS_MULTIPART</p></td> -<td class="enum_member_description"> -<p>multipart body part headers</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SoupMessageHeadersIter"></a><h3>SoupMessageHeadersIter</h3> -<pre class="programlisting">typedef struct { -} SoupMessageHeadersIter; -</pre> -<p>An opaque type used to iterate over a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><code class="literal">SoupMessageHeaders</code></a> -structure.</p> -<p>After intializing the iterator with -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-iter-init" title="soup_message_headers_iter_init ()"><code class="function">soup_message_headers_iter_init()</code></a>, call -<a class="link" href="SoupMessageHeaders.html#soup-message-headers-iter-next" title="soup_message_headers_iter_next ()"><code class="function">soup_message_headers_iter_next()</code></a> to fetch data from it.</p> -<p>You may not modify the headers while iterating over them.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupEncoding"></a><h3>enum SoupEncoding</h3> -<p>How a message body is encoded for transport</p> -<div class="refsect3"> -<a name="SoupEncoding.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="enum_members_name"> -<col class="enum_members_description"> -<col width="200px" class="enum_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="enum_member_name"><p><a name="SOUP-ENCODING-UNRECOGNIZED:CAPS"></a>SOUP_ENCODING_UNRECOGNIZED</p></td> -<td class="enum_member_description"> -<p>unknown / error</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-ENCODING-NONE:CAPS"></a>SOUP_ENCODING_NONE</p></td> -<td class="enum_member_description"> -<p>no body is present (which is not the same as a -0-length body, and only occurs in certain places)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-ENCODING-CONTENT-LENGTH:CAPS"></a>SOUP_ENCODING_CONTENT_LENGTH</p></td> -<td class="enum_member_description"> -<p>Content-Length encoding</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-ENCODING-EOF:CAPS"></a>SOUP_ENCODING_EOF</p></td> -<td class="enum_member_description"> -<p>Response body ends when the connection is closed</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-ENCODING-CHUNKED:CAPS"></a>SOUP_ENCODING_CHUNKED</p></td> -<td class="enum_member_description"> -<p>chunked encoding (currently only supported -for response)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-ENCODING-BYTERANGES:CAPS"></a>SOUP_ENCODING_BYTERANGES</p></td> -<td class="enum_member_description"> -<p>multipart/byteranges (Reserved for future -use: NOT CURRENTLY IMPLEMENTED)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SoupExpectation"></a><h3>enum SoupExpectation</h3> -<p>Represents the parsed value of the "Expect" header.</p> -<div class="refsect3"> -<a name="SoupExpectation.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="enum_members_name"> -<col class="enum_members_description"> -<col width="200px" class="enum_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="enum_member_name"><p><a name="SOUP-EXPECTATION-UNRECOGNIZED:CAPS"></a>SOUP_EXPECTATION_UNRECOGNIZED</p></td> -<td class="enum_member_description"> -<p>any unrecognized expectation</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-EXPECTATION-CONTINUE:CAPS"></a>SOUP_EXPECTATION_CONTINUE</p></td> -<td class="enum_member_description"> -<p>"100-continue"</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SoupRange"></a><h3>SoupRange</h3> -<pre class="programlisting">typedef struct { - goffset start; - goffset end; -} SoupRange; -</pre> -<p>Represents a byte range as used in the Range header.</p> -<p>If <em class="parameter"><code>end</code></em> - is non-negative, then <em class="parameter"><code>start</code></em> - and <em class="parameter"><code>end</code></em> - represent the bounds -of of the range, counting from 0. (Eg, the first 500 bytes would be -represented as <em class="parameter"><code>start</code></em> - = 0 and <em class="parameter"><code>end</code></em> - = 499.)</p> -<p>If <em class="parameter"><code>end</code></em> - is -1 and <em class="parameter"><code>start</code></em> - is non-negative, then this represents a -range starting at <em class="parameter"><code>start</code></em> - and ending with the last byte of the -requested resource body. (Eg, all but the first 500 bytes would be -<em class="parameter"><code>start</code></em> - = 500, and <em class="parameter"><code>end</code></em> - = -1.)</p> -<p>If <em class="parameter"><code>end</code></em> - is -1 and <em class="parameter"><code>start</code></em> - is negative, then it represents a "suffix -range", referring to the last -<em class="parameter"><code>start</code></em> - bytes of the resource body. -(Eg, the last 500 bytes would be <em class="parameter"><code>start</code></em> - = -500 and <em class="parameter"><code>end</code></em> - = -1.)</p> -<div class="refsect3"> -<a name="SoupRange.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="struct_members_name"> -<col class="struct_members_description"> -<col width="200px" class="struct_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="struct_member_name"><p><span class="type">goffset</span> <em class="structfield"><code><a name="SoupRange.start"></a>start</code></em>;</p></td> -<td class="struct_member_description"><p>the start of the range</p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><span class="type">goffset</span> <em class="structfield"><code><a name="SoupRange.end"></a>end</code></em>;</p></td> -<td class="struct_member_description"><p>the end of the range</p></td> -<td class="struct_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.26</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupMessageHeaders.see-also"></a><h2>See Also</h2> -<p><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/SoupMultipart.html b/docs/reference/html/SoupMultipart.html deleted file mode 100644 index b5bc3c74..00000000 --- a/docs/reference/html/SoupMultipart.html +++ /dev/null @@ -1,533 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SoupMultipart: 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="ch02.html" title="Core API"> -<link rel="prev" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html" title="Soup Miscellaneous Utilities"> -<link rel="next" href="SoupMultipartInputStream.html" title="SoupMultipartInputStream"> -<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="#SoupMultipart.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupMultipart.object-hierarchy" class="shortcut">Object Hierarchy</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="SoupMultipartInputStream.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="SoupMultipart"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="SoupMultipart.top_of_page"></a>SoupMultipart</span></h2> -<p>SoupMultipart — multipart HTTP message bodies</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="SoupMultipart.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="SoupMultipart.html" title="SoupMultipart"><span class="returnvalue">SoupMultipart</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupMultipart.html#soup-multipart-new" title="soup_multipart_new ()">soup_multipart_new</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="returnvalue">SoupMultipart</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupMultipart.html#soup-multipart-new-from-message" title="soup_multipart_new_from_message ()">soup_multipart_new_from_message</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMultipart.html#soup-multipart-free" title="soup_multipart_free ()">soup_multipart_free</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">int</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMultipart.html#soup-multipart-get-length" title="soup_multipart_get_length ()">soup_multipart_get_length</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMultipart.html#soup-multipart-get-part" title="soup_multipart_get_part ()">soup_multipart_get_part</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMultipart.html#soup-multipart-append-part" title="soup_multipart_append_part ()">soup_multipart_append_part</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMultipart.html#soup-multipart-append-form-string" title="soup_multipart_append_form_string ()">soup_multipart_append_form_string</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMultipart.html#soup-multipart-append-form-file" title="soup_multipart_append_form_file ()">soup_multipart_append_form_file</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMultipart.html#soup-multipart-to-message" title="soup_multipart_to_message ()">soup_multipart_to_message</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupMultipart.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="typedef_keyword">typedef</td> -<td class="function_name"><a class="link" href="SoupMultipart.html" title="SoupMultipart">SoupMultipart</a></td> -</tr></tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupMultipart.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> <a href="/home/claudio/gnome3/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a> - <span class="lineart">╰──</span> SoupMultipart -</pre> -</div> -<div class="refsect1"> -<a name="SoupMultipart.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="SoupMultipart.description"></a><h2>Description</h2> -</div> -<div class="refsect1"> -<a name="SoupMultipart.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="soup-multipart-new"></a><h3>soup_multipart_new ()</h3> -<pre class="programlisting"><a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="returnvalue">SoupMultipart</span></a> * -soup_multipart_new (<em class="parameter"><code>const <span class="type">char</span> *mime_type</code></em>);</pre> -<p>Creates a new empty <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> with a randomly-generated -boundary string. Note that <em class="parameter"><code>mime_type</code></em> - must be the full MIME type, -including "multipart/".</p> -<div class="refsect3"> -<a name="soup-multipart-new.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>mime_type</p></td> -<td class="parameter_description"><p>the MIME type of the multipart to create.</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-multipart-new.returns"></a><h4>Returns</h4> -<p> a new empty <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> of the given <em class="parameter"><code>mime_type</code></em> -</p> -</div> -<p class="since">Since: 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-multipart-new-from-message"></a><h3>soup_multipart_new_from_message ()</h3> -<pre class="programlisting"><a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="returnvalue">SoupMultipart</span></a> * -soup_multipart_new_from_message (<em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *headers</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a> *body</code></em>);</pre> -<p>Parses <em class="parameter"><code>headers</code></em> - and <em class="parameter"><code>body</code></em> - to form a new <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a></p> -<div class="refsect3"> -<a name="soup-multipart-new-from-message.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>headers</p></td> -<td class="parameter_description"><p>the headers of the HTTP message to parse</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>body</p></td> -<td class="parameter_description"><p>the body of the HTTP message to parse</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-multipart-new-from-message.returns"></a><h4>Returns</h4> -<p>a new <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> (or <code class="literal">NULL</code> if the -message couldn't be parsed or wasn't multipart). </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-multipart-free"></a><h3>soup_multipart_free ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_multipart_free (<em class="parameter"><code><a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> *multipart</code></em>);</pre> -<p>Frees <em class="parameter"><code>multipart</code></em> -</p> -<div class="refsect3"> -<a name="soup-multipart-free.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>multipart</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<p class="since">Since: 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-multipart-get-length"></a><h3>soup_multipart_get_length ()</h3> -<pre class="programlisting"><span class="returnvalue">int</span> -soup_multipart_get_length (<em class="parameter"><code><a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> *multipart</code></em>);</pre> -<p>Gets the number of body parts in <em class="parameter"><code>multipart</code></em> -</p> -<div class="refsect3"> -<a name="soup-multipart-get-length.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>multipart</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-multipart-get-length.returns"></a><h4>Returns</h4> -<p> the number of body parts in <em class="parameter"><code>multipart</code></em> -</p> -</div> -<p class="since">Since: 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-multipart-get-part"></a><h3>soup_multipart_get_part ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_multipart_get_part (<em class="parameter"><code><a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> *multipart</code></em>, - <em class="parameter"><code><span class="type">int</span> part</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> **headers</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> **body</code></em>);</pre> -<p>Gets the indicated body part from <em class="parameter"><code>multipart</code></em> -.</p> -<div class="refsect3"> -<a name="soup-multipart-get-part.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>multipart</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>part</p></td> -<td class="parameter_description"><p>the part number to get (counting from 0)</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>headers</p></td> -<td class="parameter_description"><p>return location for the MIME part -headers. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>body</p></td> -<td class="parameter_description"><p>return location for the MIME part -body. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-multipart-get-part.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> if <em class="parameter"><code>part</code></em> -is out of range (in -which case <em class="parameter"><code>headers</code></em> -and <em class="parameter"><code>body</code></em> -won't be set)</p> -</div> -<p class="since">Since: 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-multipart-append-part"></a><h3>soup_multipart_append_part ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_multipart_append_part (<em class="parameter"><code><a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> *multipart</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *headers</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> *body</code></em>);</pre> -<p>Adds a new MIME part to <em class="parameter"><code>multipart</code></em> - with the given headers and body. -(The multipart will make its own copies of <em class="parameter"><code>headers</code></em> - and <em class="parameter"><code>body</code></em> -, so -you should free your copies if you are not using them for anything -else.)</p> -<div class="refsect3"> -<a name="soup-multipart-append-part.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>multipart</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>headers</p></td> -<td class="parameter_description"><p>the MIME part headers</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>body</p></td> -<td class="parameter_description"><p>the MIME part body</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-multipart-append-form-string"></a><h3>soup_multipart_append_form_string ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_multipart_append_form_string (<em class="parameter"><code><a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> *multipart</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *control_name</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *data</code></em>);</pre> -<p>Adds a new MIME part containing <em class="parameter"><code>data</code></em> - to <em class="parameter"><code>multipart</code></em> -, using -"Content-Disposition: form-data", as per the HTML forms -specification. See <a class="link" href="libsoup-2.4-HTML-Form-Support.html#soup-form-request-new-from-multipart" title="soup_form_request_new_from_multipart ()"><code class="function">soup_form_request_new_from_multipart()</code></a> for more -details.</p> -<div class="refsect3"> -<a name="soup-multipart-append-form-string.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>multipart</p></td> -<td class="parameter_description"><p>a multipart (presumably of type "multipart/form-data")</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>control_name</p></td> -<td class="parameter_description"><p>the name of the control associated with <em class="parameter"><code>data</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>data</p></td> -<td class="parameter_description"><p>the body data</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-multipart-append-form-file"></a><h3>soup_multipart_append_form_file ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_multipart_append_form_file (<em class="parameter"><code><a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> *multipart</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *control_name</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *filename</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *content_type</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> *body</code></em>);</pre> -<p>Adds a new MIME part containing <em class="parameter"><code>body</code></em> - to <em class="parameter"><code>multipart</code></em> -, using -"Content-Disposition: form-data", as per the HTML forms -specification. See <a class="link" href="libsoup-2.4-HTML-Form-Support.html#soup-form-request-new-from-multipart" title="soup_form_request_new_from_multipart ()"><code class="function">soup_form_request_new_from_multipart()</code></a> for more -details.</p> -<div class="refsect3"> -<a name="soup-multipart-append-form-file.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>multipart</p></td> -<td class="parameter_description"><p>a multipart (presumably of type "multipart/form-data")</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>control_name</p></td> -<td class="parameter_description"><p>the name of the control associated with this file</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>filename</p></td> -<td class="parameter_description"><p>the name of the file, or <code class="literal">NULL</code> if not known</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>content_type</p></td> -<td class="parameter_description"><p>the MIME type of the file, or <code class="literal">NULL</code> if not known</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>body</p></td> -<td class="parameter_description"><p>the file data</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-multipart-to-message"></a><h3>soup_multipart_to_message ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_multipart_to_message (<em class="parameter"><code><a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> *multipart</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *dest_headers</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a> *dest_body</code></em>);</pre> -<p>Serializes <em class="parameter"><code>multipart</code></em> - to <em class="parameter"><code>dest_headers</code></em> - and <em class="parameter"><code>dest_body</code></em> -.</p> -<div class="refsect3"> -<a name="soup-multipart-to-message.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>multipart</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>dest_headers</p></td> -<td class="parameter_description"><p>the headers of the HTTP message to serialize <em class="parameter"><code>multipart</code></em> -to</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>dest_body</p></td> -<td class="parameter_description"><p>the body of the HTTP message to serialize <em class="parameter"><code>multipart</code></em> -to</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.26</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupMultipart.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupMultipart"></a><h3>SoupMultipart</h3> -<pre class="programlisting">typedef struct SoupMultipart SoupMultipart; -</pre> -<p>Represents a multipart HTTP message body, parsed according to the -syntax of RFC 2046. Of particular interest to HTTP are -<code class="literal">multipart/byte-ranges</code> and -<code class="literal">multipart/form-data</code>.</p> -<p>Although the headers of a <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> body part will contain the -full headers from that body part, libsoup does not interpret them -according to MIME rules. For example, each body part is assumed to -have "binary" Content-Transfer-Encoding, even if its headers -explicitly state otherwise. In other words, don't try to use -<a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> for handling real MIME multiparts.</p> -<p class="since">Since: 2.26</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupMultipart.see-also"></a><h2>See Also</h2> -<p><a class="link" href="SoupMessageBody.html" title="SoupMessageBody"><span class="type">SoupMessageBody</span></a>, <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a></p> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/SoupMultipartInputStream.html b/docs/reference/html/SoupMultipartInputStream.html deleted file mode 100644 index 1c088301..00000000 --- a/docs/reference/html/SoupMultipartInputStream.html +++ /dev/null @@ -1,396 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SoupMultipartInputStream: 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="ch02.html" title="Core API"> -<link rel="prev" href="SoupMultipart.html" title="SoupMultipart"> -<link rel="next" href="SoupRequest.html" title="SoupRequest"> -<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="#SoupMultipartInputStream.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupMultipartInputStream.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> - <a href="#SoupMultipartInputStream.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> - <a href="#SoupMultipartInputStream.properties" class="shortcut">Properties</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="SoupMultipart.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="SoupRequest.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="SoupMultipartInputStream"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="SoupMultipartInputStream.top_of_page"></a>SoupMultipartInputStream</span></h2> -<p>SoupMultipartInputStream — Multipart input handling stream</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="SoupMultipartInputStream.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="SoupMultipartInputStream.html" title="SoupMultipartInputStream"><span class="returnvalue">SoupMultipartInputStream</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupMultipartInputStream.html#soup-multipart-input-stream-new" title="soup_multipart_input_stream_new ()">soup_multipart_input_stream_new</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="returnvalue">SoupMessageHeaders</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupMultipartInputStream.html#soup-multipart-input-stream-get-headers" title="soup_multipart_input_stream_get_headers ()">soup_multipart_input_stream_get_headers</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GInputStream</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupMultipartInputStream.html#soup-multipart-input-stream-next-part" title="soup_multipart_input_stream_next_part ()">soup_multipart_input_stream_next_part</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupMultipartInputStream.html#soup-multipart-input-stream-next-part-async" title="soup_multipart_input_stream_next_part_async ()">soup_multipart_input_stream_next_part_async</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GInputStream</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupMultipartInputStream.html#soup-multipart-input-stream-next-part-finish" title="soup_multipart_input_stream_next_part_finish ()">soup_multipart_input_stream_next_part_finish</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupMultipartInputStream.properties"></a><h2>Properties</h2> -<div class="informaltable"><table class="informaltable" border="0"> -<colgroup> -<col width="150px" class="properties_type"> -<col width="300px" class="properties_name"> -<col width="200px" class="properties_flags"> -</colgroup> -<tbody><tr> -<td class="property_type"> -<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *</td> -<td class="property_name"><a class="link" href="SoupMultipartInputStream.html#SoupMultipartInputStream--message" title="The “message” property">message</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr></tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupMultipartInputStream.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">struct</td> -<td class="function_name"><a class="link" href="SoupMultipartInputStream.html#SoupMultipartInputStream-struct" title="struct SoupMultipartInputStream">SoupMultipartInputStream</a></td> -</tr></tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupMultipartInputStream.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> GObject - <span class="lineart">╰──</span> GInputStream - <span class="lineart">╰──</span> GFilterInputStream - <span class="lineart">╰──</span> SoupMultipartInputStream -</pre> -</div> -<div class="refsect1"> -<a name="SoupMultipartInputStream.implemented-interfaces"></a><h2>Implemented Interfaces</h2> -<p> -SoupMultipartInputStream implements - GPollableInputStream.</p> -</div> -<div class="refsect1"> -<a name="SoupMultipartInputStream.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="SoupMultipartInputStream.description"></a><h2>Description</h2> -<p>This adds support for the multipart responses. For handling the -multiple parts the user needs to wrap the <span class="type">GInputStream</span> obtained by -sending the request with a <a class="link" href="SoupMultipartInputStream.html" title="SoupMultipartInputStream"><span class="type">SoupMultipartInputStream</span></a> and use -<a class="link" href="SoupMultipartInputStream.html#soup-multipart-input-stream-next-part" title="soup_multipart_input_stream_next_part ()"><code class="function">soup_multipart_input_stream_next_part()</code></a> before reading. Responses -which are not wrapped will be treated like non-multipart responses.</p> -<p>Note that although <a class="link" href="SoupMultipartInputStream.html" title="SoupMultipartInputStream"><span class="type">SoupMultipartInputStream</span></a> is a <span class="type">GInputStream</span>, -you should not read directly from it, and the results are undefined -if you do.</p> -</div> -<div class="refsect1"> -<a name="SoupMultipartInputStream.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="soup-multipart-input-stream-new"></a><h3>soup_multipart_input_stream_new ()</h3> -<pre class="programlisting"><a class="link" href="SoupMultipartInputStream.html" title="SoupMultipartInputStream"><span class="returnvalue">SoupMultipartInputStream</span></a> * -soup_multipart_input_stream_new (<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><span class="type">GInputStream</span> *base_stream</code></em>);</pre> -<p>Creates a new <a class="link" href="SoupMultipartInputStream.html" title="SoupMultipartInputStream"><span class="type">SoupMultipartInputStream</span></a> that wraps the -<span class="type">GInputStream</span> obtained by sending the <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a>. Reads should -not be done directly through this object, use the input streams -returned by <a class="link" href="SoupMultipartInputStream.html#soup-multipart-input-stream-next-part" title="soup_multipart_input_stream_next_part ()"><code class="function">soup_multipart_input_stream_next_part()</code></a> or its async -counterpart instead.</p> -<div class="refsect3"> -<a name="soup-multipart-input-stream-new.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>msg</p></td> -<td class="parameter_description"><p>the <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> the response is related to.</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>base_stream</p></td> -<td class="parameter_description"><p>the <span class="type">GInputStream</span> returned by sending the request.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-multipart-input-stream-new.returns"></a><h4>Returns</h4> -<p> a new <a class="link" href="SoupMultipartInputStream.html" title="SoupMultipartInputStream"><span class="type">SoupMultipartInputStream</span></a></p> -</div> -<p class="since">Since: 2.40</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-multipart-input-stream-get-headers"></a><h3>soup_multipart_input_stream_get_headers ()</h3> -<pre class="programlisting"><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="returnvalue">SoupMessageHeaders</span></a> * -soup_multipart_input_stream_get_headers - (<em class="parameter"><code><a class="link" href="SoupMultipartInputStream.html" title="SoupMultipartInputStream"><span class="type">SoupMultipartInputStream</span></a> *multipart</code></em>);</pre> -<p>Obtains the headers for the part currently being processed. Note -that the <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> that are returned are owned by the -<a class="link" href="SoupMultipartInputStream.html" title="SoupMultipartInputStream"><span class="type">SoupMultipartInputStream</span></a> and will be replaced when a call is made -to <a class="link" href="SoupMultipartInputStream.html#soup-multipart-input-stream-next-part" title="soup_multipart_input_stream_next_part ()"><code class="function">soup_multipart_input_stream_next_part()</code></a> or its async -counterpart, so if keeping the headers is required, a copy must be -made.</p> -<p>Note that if a part had no headers at all an empty <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> -will be returned.</p> -<div class="refsect3"> -<a name="soup-multipart-input-stream-get-headers.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>multipart</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMultipartInputStream.html" title="SoupMultipartInputStream"><span class="type">SoupMultipartInputStream</span></a>.</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-multipart-input-stream-get-headers.returns"></a><h4>Returns</h4> -<p>a <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> -containing the headers for the part currently being processed or -<code class="literal">NULL</code> if the headers failed to parse. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.40</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-multipart-input-stream-next-part"></a><h3>soup_multipart_input_stream_next_part ()</h3> -<pre class="programlisting"><span class="returnvalue">GInputStream</span> * -soup_multipart_input_stream_next_part (<em class="parameter"><code><a class="link" href="SoupMultipartInputStream.html" title="SoupMultipartInputStream"><span class="type">SoupMultipartInputStream</span></a> *multipart</code></em>, - <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>Obtains an input stream for the next part. When dealing with a -multipart response the input stream needs to be wrapped in a -<a class="link" href="SoupMultipartInputStream.html" title="SoupMultipartInputStream"><span class="type">SoupMultipartInputStream</span></a> and this function or its async -counterpart need to be called to obtain the first part for -reading.</p> -<p>After calling this function, -<a class="link" href="SoupMultipartInputStream.html#soup-multipart-input-stream-get-headers" title="soup_multipart_input_stream_get_headers ()"><code class="function">soup_multipart_input_stream_get_headers()</code></a> can be used to obtain the -headers for the first part. A read of 0 bytes indicates the end of -the part; a new call to this function should be done at that point, -to obtain the next part.</p> -<div class="refsect3"> -<a name="soup-multipart-input-stream-next-part.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>multipart</p></td> -<td class="parameter_description"><p>the <a class="link" href="SoupMultipartInputStream.html" title="SoupMultipartInputStream"><span class="type">SoupMultipartInputStream</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>cancellable</p></td> -<td class="parameter_description"><p>a <span class="type">GCancellable</span></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>a <span class="type">GError</span></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-multipart-input-stream-next-part.returns"></a><h4>Returns</h4> -<p>a new <span class="type">GInputStream</span>, or -<code class="literal">NULL</code> if there are no more parts. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.40</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-multipart-input-stream-next-part-async"></a><h3>soup_multipart_input_stream_next_part_async ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_multipart_input_stream_next_part_async - (<em class="parameter"><code><a class="link" href="SoupMultipartInputStream.html" title="SoupMultipartInputStream"><span class="type">SoupMultipartInputStream</span></a> *multipart</code></em>, - <em class="parameter"><code><span class="type">int</span> io_priority</code></em>, - <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>, - <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre> -<p>Obtains a <span class="type">GInputStream</span> for the next request. See -<a class="link" href="SoupMultipartInputStream.html#soup-multipart-input-stream-next-part" title="soup_multipart_input_stream_next_part ()"><code class="function">soup_multipart_input_stream_next_part()</code></a> for details on the -workflow.</p> -<div class="refsect3"> -<a name="soup-multipart-input-stream-next-part-async.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>multipart</p></td> -<td class="parameter_description"><p>the <a class="link" href="SoupMultipartInputStream.html" title="SoupMultipartInputStream"><span class="type">SoupMultipartInputStream</span></a>.</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>io_priority</p></td> -<td class="parameter_description"><p>the I/O priority for the request.</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>cancellable</p></td> -<td class="parameter_description"><p>a <span class="type">GCancellable</span>.</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>callback</p></td> -<td class="parameter_description"><p>callback to call when request is satisfied.</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>data</p></td> -<td class="parameter_description"><p>data for <em class="parameter"><code>callback</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.40</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-multipart-input-stream-next-part-finish"></a><h3>soup_multipart_input_stream_next_part_finish ()</h3> -<pre class="programlisting"><span class="returnvalue">GInputStream</span> * -soup_multipart_input_stream_next_part_finish - (<em class="parameter"><code><a class="link" href="SoupMultipartInputStream.html" title="SoupMultipartInputStream"><span class="type">SoupMultipartInputStream</span></a> *multipart</code></em>, - <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>Finishes an asynchronous request for the next part.</p> -<div class="refsect3"> -<a name="soup-multipart-input-stream-next-part-finish.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>multipart</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMultipartInputStream.html" title="SoupMultipartInputStream"><span class="type">SoupMultipartInputStream</span></a>.</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>result</p></td> -<td class="parameter_description"><p>a <span class="type">GAsyncResult</span>.</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>a <span class="type">GError</span> location to store any error, or <code class="literal">NULL</code> to ignore.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-multipart-input-stream-next-part-finish.returns"></a><h4>Returns</h4> -<p>a newly created -<span class="type">GInputStream</span> for reading the next part or <code class="literal">NULL</code> if there are no -more parts. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.40</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupMultipartInputStream.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupMultipartInputStream-struct"></a><h3>struct SoupMultipartInputStream</h3> -<pre class="programlisting">struct SoupMultipartInputStream;</pre> -</div> -</div> -<div class="refsect1"> -<a name="SoupMultipartInputStream.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> -<a name="SoupMultipartInputStream--message"></a><h3>The <code class="literal">“message”</code> property</h3> -<pre class="programlisting"> “message” <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *</pre> -<p>The SoupMessage.</p> -<p>Flags: Read / Write / Construct Only</p> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/SoupProxyResolverDefault.html b/docs/reference/html/SoupProxyResolverDefault.html deleted file mode 100644 index c52fa23b..00000000 --- a/docs/reference/html/SoupProxyResolverDefault.html +++ /dev/null @@ -1,118 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SoupProxyResolverDefault: 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="SoupLogger.html" title="SoupLogger"> -<link rel="next" href="ch04.html" title="Web Services APIs"> -<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="#SoupProxyResolverDefault.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupProxyResolverDefault.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> - <a href="#SoupProxyResolverDefault.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> - <a href="#SoupProxyResolverDefault.properties" class="shortcut">Properties</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="SoupLogger.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="ch04.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="SoupProxyResolverDefault"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="SoupProxyResolverDefault.top_of_page"></a>SoupProxyResolverDefault</span></h2> -<p>SoupProxyResolverDefault — System proxy configuration integration</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="SoupProxyResolverDefault.properties"></a><h2>Properties</h2> -<div class="informaltable"><table class="informaltable" border="0"> -<colgroup> -<col width="150px" class="properties_type"> -<col width="300px" class="properties_name"> -<col width="200px" class="properties_flags"> -</colgroup> -<tbody><tr> -<td class="property_type"> -<span class="type">GProxyResolver</span> *</td> -<td class="property_name"><a class="link" href="SoupProxyResolverDefault.html#SoupProxyResolverDefault--gproxy-resolver" title="The “gproxy-resolver” property">gproxy-resolver</a></td> -<td class="property_flags">Write</td> -</tr></tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupProxyResolverDefault.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="SoupProxyResolverDefault.html#SoupProxyResolverDefault-struct" title="SoupProxyResolverDefault">SoupProxyResolverDefault</a></td> -</tr></tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupProxyResolverDefault.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> GObject - <span class="lineart">╰──</span> SoupProxyResolverDefault -</pre> -</div> -<div class="refsect1"> -<a name="SoupProxyResolverDefault.implemented-interfaces"></a><h2>Implemented Interfaces</h2> -<p> -SoupProxyResolverDefault implements - <a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature">SoupSessionFeature</a> and SoupProxyURIResolver.</p> -</div> -<div class="refsect1"> -<a name="SoupProxyResolverDefault.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="SoupProxyResolverDefault.description"></a><h2>Description</h2> -<p><a class="link" href="SoupProxyResolverDefault.html" title="SoupProxyResolverDefault"><span class="type">SoupProxyResolverDefault</span></a> is a <span class="type">SoupProxyURIResolver</span> -implementation that uses the default gio <span class="type">GProxyResolver</span> to resolve -proxies.</p> -<p>In libsoup 2.44 and later, you can set the session's -<a class="link" href="SoupSession.html#SoupSession--proxy-resolver" title="The “proxy-resolver” property"><span class="type">“proxy-resolver”</span></a> property to the resolver returned by -<code class="function">g_proxy_resolver_get_default()</code> to get the same effect. Note that -for "plain" <a href="SoupSession.html#SoupSession-struct"><span class="type">SoupSessions</span></a> (ie, not <a class="link" href="SoupSessionAsync.html" title="SoupSessionAsync"><span class="type">SoupSessionAsync</span></a> or -<a class="link" href="SoupSessionSync.html" title="SoupSessionSync"><span class="type">SoupSessionSync</span></a>), this is done for you automatically.</p> -</div> -<div class="refsect1"> -<a name="SoupProxyResolverDefault.functions_details"></a><h2>Functions</h2> -<p></p> -</div> -<div class="refsect1"> -<a name="SoupProxyResolverDefault.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupProxyResolverDefault-struct"></a><h3>SoupProxyResolverDefault</h3> -<pre class="programlisting">typedef struct _SoupProxyResolverDefault SoupProxyResolverDefault;</pre> -</div> -</div> -<div class="refsect1"> -<a name="SoupProxyResolverDefault.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> -<a name="SoupProxyResolverDefault--gproxy-resolver"></a><h3>The <code class="literal">“gproxy-resolver”</code> property</h3> -<pre class="programlisting"> “gproxy-resolver” <span class="type">GProxyResolver</span> *</pre> -<p>The underlying GProxyResolver.</p> -<p>Flags: Write</p> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/SoupRequest.html b/docs/reference/html/SoupRequest.html deleted file mode 100644 index de7e8ba0..00000000 --- a/docs/reference/html/SoupRequest.html +++ /dev/null @@ -1,491 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SoupRequest: 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="ch02.html" title="Core API"> -<link rel="prev" href="SoupMultipartInputStream.html" title="SoupMultipartInputStream"> -<link rel="next" href="SoupRequestHTTP.html" title="SoupRequestHTTP"> -<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="#SoupRequest.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupRequest.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> - <a href="#SoupRequest.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> - <a href="#SoupRequest.properties" class="shortcut">Properties</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="SoupMultipartInputStream.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="SoupRequestHTTP.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="SoupRequest"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="SoupRequest.top_of_page"></a>SoupRequest</span></h2> -<p>SoupRequest — Protocol-independent streaming request interface</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="SoupRequest.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"> -<span class="returnvalue">GInputStream</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupRequest.html#soup-request-send" title="soup_request_send ()">soup_request_send</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupRequest.html#soup-request-send-async" title="soup_request_send_async ()">soup_request_send_async</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GInputStream</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupRequest.html#soup-request-send-finish" title="soup_request_send_finish ()">soup_request_send_finish</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">goffset</span> -</td> -<td class="function_name"> -<a class="link" href="SoupRequest.html#soup-request-get-content-length" title="soup_request_get_content_length ()">soup_request_get_content_length</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupRequest.html#soup-request-get-content-type" title="soup_request_get_content_type ()">soup_request_get_content_type</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupSession.html" title="SoupSession"><span class="returnvalue">SoupSession</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupRequest.html#soup-request-get-session" title="soup_request_get_session ()">soup_request_get_session</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupURI.html" title="SoupURI"><span class="returnvalue">SoupURI</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupRequest.html#soup-request-get-uri" title="soup_request_get_uri ()">soup_request_get_uri</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupRequest.properties"></a><h2>Properties</h2> -<div class="informaltable"><table class="informaltable" border="0"> -<colgroup> -<col width="150px" class="properties_type"> -<col width="300px" class="properties_name"> -<col width="200px" class="properties_flags"> -</colgroup> -<tbody> -<tr> -<td class="property_type"> -<a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *</td> -<td class="property_name"><a class="link" href="SoupRequest.html#SoupRequest--session" title="The “session” property">session</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -<tr> -<td class="property_type"> -<a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *</td> -<td class="property_name"><a class="link" href="SoupRequest.html#SoupRequest--uri" title="The “uri” property">uri</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupRequest.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="SoupRequest.html#SoupRequest-struct" title="SoupRequest">SoupRequest</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupRequest.html#SOUP-REQUEST-SESSION:CAPS" title="SOUP_REQUEST_SESSION">SOUP_REQUEST_SESSION</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupRequest.html#SOUP-REQUEST-URI:CAPS" title="SOUP_REQUEST_URI">SOUP_REQUEST_URI</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupRequest.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> GObject - <span class="lineart">╰──</span> SoupRequest - <span class="lineart">├──</span> <a class="link" href="SoupRequestData.html" title="SoupRequestData">SoupRequestData</a> - <span class="lineart">├──</span> <a class="link" href="SoupRequestFile.html" title="SoupRequestFile">SoupRequestFile</a> - <span class="lineart">╰──</span> <a class="link" href="SoupRequestHTTP.html" title="SoupRequestHTTP">SoupRequestHTTP</a> -</pre> -</div> -<div class="refsect1"> -<a name="SoupRequest.implemented-interfaces"></a><h2>Implemented Interfaces</h2> -<p> -SoupRequest implements - GInitable.</p> -</div> -<div class="refsect1"> -<a name="SoupRequest.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="SoupRequest.description"></a><h2>Description</h2> -<p>A <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a> is created by <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a>, and represents a request -to retrieve a particular URI.</p> -</div> -<div class="refsect1"> -<a name="SoupRequest.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="soup-request-send"></a><h3>soup_request_send ()</h3> -<pre class="programlisting"><span class="returnvalue">GInputStream</span> * -soup_request_send (<em class="parameter"><code><a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a> *request</code></em>, - <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>Synchronously requests the URI pointed to by <em class="parameter"><code>request</code></em> -, and returns -a <span class="type">GInputStream</span> that can be used to read its contents.</p> -<p>Note that you cannot use this method with <a href="SoupRequest.html#SoupRequest-struct"><span class="type">SoupRequests</span></a> attached to -a <a class="link" href="SoupSessionAsync.html" title="SoupSessionAsync"><span class="type">SoupSessionAsync</span></a>.</p> -<div class="refsect3"> -<a name="soup-request-send.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>request</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>cancellable</p></td> -<td class="parameter_description"><p>a <span class="type">GCancellable</span> or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-request-send.returns"></a><h4>Returns</h4> -<p>a <span class="type">GInputStream</span> that can be used to -read from the URI pointed to by <em class="parameter"><code>request</code></em> -. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-request-send-async"></a><h3>soup_request_send_async ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_request_send_async (<em class="parameter"><code><a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a> *request</code></em>, - <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>, - <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> -<p>Begins an asynchronously request for the URI pointed to by -<em class="parameter"><code>request</code></em> -.</p> -<p>Note that you cannot use this method with <a href="SoupRequest.html#SoupRequest-struct"><span class="type">SoupRequests</span></a> attached to -a <a class="link" href="SoupSessionSync.html" title="SoupSessionSync"><span class="type">SoupSessionSync</span></a>.</p> -<div class="refsect3"> -<a name="soup-request-send-async.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>request</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>cancellable</p></td> -<td class="parameter_description"><p>a <span class="type">GCancellable</span> or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>callback</p></td> -<td class="parameter_description"><p>a <span class="type">GAsyncReadyCallback</span></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data passed to <em class="parameter"><code>callback</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-request-send-finish"></a><h3>soup_request_send_finish ()</h3> -<pre class="programlisting"><span class="returnvalue">GInputStream</span> * -soup_request_send_finish (<em class="parameter"><code><a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a> *request</code></em>, - <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>Gets the result of a <a class="link" href="SoupRequest.html#soup-request-send-async" title="soup_request_send_async ()"><code class="function">soup_request_send_async()</code></a>.</p> -<div class="refsect3"> -<a name="soup-request-send-finish.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>request</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>result</p></td> -<td class="parameter_description"><p>the <span class="type">GAsyncResult</span></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-request-send-finish.returns"></a><h4>Returns</h4> -<p>a <span class="type">GInputStream</span> that can be used to -read from the URI pointed to by <em class="parameter"><code>request</code></em> -. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-request-get-content-length"></a><h3>soup_request_get_content_length ()</h3> -<pre class="programlisting"><span class="returnvalue">goffset</span> -soup_request_get_content_length (<em class="parameter"><code><a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a> *request</code></em>);</pre> -<p>Gets the length of the data represented by <em class="parameter"><code>request</code></em> -. For most -request types, this will not be known until after you call -<a class="link" href="SoupRequest.html#soup-request-send" title="soup_request_send ()"><code class="function">soup_request_send()</code></a> or <a class="link" href="SoupRequest.html#soup-request-send-finish" title="soup_request_send_finish ()"><code class="function">soup_request_send_finish()</code></a>.</p> -<div class="refsect3"> -<a name="soup-request-get-content-length.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>request</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-request-get-content-length.returns"></a><h4>Returns</h4> -<p> the length of the data represented by <em class="parameter"><code>request</code></em> -, -or -1 if not known.</p> -</div> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-request-get-content-type"></a><h3>soup_request_get_content_type ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -soup_request_get_content_type (<em class="parameter"><code><a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a> *request</code></em>);</pre> -<p>Gets the type of the data represented by <em class="parameter"><code>request</code></em> -. For most request -types, this will not be known until after you call -<a class="link" href="SoupRequest.html#soup-request-send" title="soup_request_send ()"><code class="function">soup_request_send()</code></a> or <a class="link" href="SoupRequest.html#soup-request-send-finish" title="soup_request_send_finish ()"><code class="function">soup_request_send_finish()</code></a>.</p> -<p>As in the HTTP Content-Type header, this may include parameters -after the MIME type.</p> -<div class="refsect3"> -<a name="soup-request-get-content-type.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>request</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-request-get-content-type.returns"></a><h4>Returns</h4> -<p>the type of the data represented by -<em class="parameter"><code>request</code></em> -, or <code class="literal">NULL</code> if not known. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-request-get-session"></a><h3>soup_request_get_session ()</h3> -<pre class="programlisting"><a class="link" href="SoupSession.html" title="SoupSession"><span class="returnvalue">SoupSession</span></a> * -soup_request_get_session (<em class="parameter"><code><a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a> *request</code></em>);</pre> -<p>Gets <em class="parameter"><code>request</code></em> -'s <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a></p> -<div class="refsect3"> -<a name="soup-request-get-session.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>request</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-request-get-session.returns"></a><h4>Returns</h4> -<p><em class="parameter"><code>request</code></em> -'s <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a>. </p> -<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-request-get-uri"></a><h3>soup_request_get_uri ()</h3> -<pre class="programlisting"><a class="link" href="SoupURI.html" title="SoupURI"><span class="returnvalue">SoupURI</span></a> * -soup_request_get_uri (<em class="parameter"><code><a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a> *request</code></em>);</pre> -<p>Gets <em class="parameter"><code>request</code></em> -'s URI</p> -<div class="refsect3"> -<a name="soup-request-get-uri.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>request</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-request-get-uri.returns"></a><h4>Returns</h4> -<p><em class="parameter"><code>request</code></em> -'s URI. </p> -<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.42</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupRequest.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupRequest-struct"></a><h3>SoupRequest</h3> -<pre class="programlisting">typedef struct _SoupRequest SoupRequest;</pre> -<p>A request to retrieve a particular URI.</p> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-REQUEST-SESSION:CAPS"></a><h3>SOUP_REQUEST_SESSION</h3> -<pre class="programlisting">#define SOUP_REQUEST_SESSION "session" -</pre> -<p>Alias for the <a class="link" href="SoupRequest.html#SoupRequest--session" title="The “session” property"><span class="type">“session”</span></a> property, qv.</p> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-REQUEST-URI:CAPS"></a><h3>SOUP_REQUEST_URI</h3> -<pre class="programlisting">#define SOUP_REQUEST_URI "uri" -</pre> -<p>Alias for the <a class="link" href="SoupRequest.html#SoupRequest--uri" title="The “uri” property"><span class="type">“uri”</span></a> property, qv.</p> -<p class="since">Since: 2.42</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupRequest.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> -<a name="SoupRequest--session"></a><h3>The <code class="literal">“session”</code> property</h3> -<pre class="programlisting"> “session” <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *</pre> -<p>The request's <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a>.</p> -<p>Flags: Read / Write / Construct Only</p> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupRequest--uri"></a><h3>The <code class="literal">“uri”</code> property</h3> -<pre class="programlisting"> “uri” <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *</pre> -<p>The request URI.</p> -<p>Flags: Read / Write / Construct Only</p> -<p class="since">Since: 2.42</p> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/SoupRequestData.html b/docs/reference/html/SoupRequestData.html deleted file mode 100644 index 0c7251d8..00000000 --- a/docs/reference/html/SoupRequestData.html +++ /dev/null @@ -1,86 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SoupRequestData: 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="ch02.html" title="Core API"> -<link rel="prev" href="SoupRequestFile.html" title="SoupRequestFile"> -<link rel="next" href="SoupServer.html" title="SoupServer"> -<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="#SoupRequestData.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupRequestData.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> - <a href="#SoupRequestData.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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="SoupRequestFile.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="SoupServer.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="SoupRequestData"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="SoupRequestData.top_of_page"></a>SoupRequestData</span></h2> -<p>SoupRequestData — SoupRequest support for "data" URIs</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="SoupRequestData.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="SoupRequestData.html#SoupRequestData-struct" title="SoupRequestData">SoupRequestData</a></td> -</tr></tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupRequestData.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> GObject - <span class="lineart">╰──</span> <a class="link" href="SoupRequest.html" title="SoupRequest">SoupRequest</a> - <span class="lineart">╰──</span> SoupRequestData -</pre> -</div> -<div class="refsect1"> -<a name="SoupRequestData.implemented-interfaces"></a><h2>Implemented Interfaces</h2> -<p> -SoupRequestData implements - GInitable.</p> -</div> -<div class="refsect1"> -<a name="SoupRequestData.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="SoupRequestData.description"></a><h2>Description</h2> -<p><a class="link" href="SoupRequestData.html" title="SoupRequestData"><span class="type">SoupRequestData</span></a> implements <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a> for "data" URIs.</p> -</div> -<div class="refsect1"> -<a name="SoupRequestData.functions_details"></a><h2>Functions</h2> -<p></p> -</div> -<div class="refsect1"> -<a name="SoupRequestData.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupRequestData-struct"></a><h3>SoupRequestData</h3> -<pre class="programlisting">typedef struct _SoupRequestData SoupRequestData;</pre> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/SoupRequestFile.html b/docs/reference/html/SoupRequestFile.html deleted file mode 100644 index ffe9d07c..00000000 --- a/docs/reference/html/SoupRequestFile.html +++ /dev/null @@ -1,132 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SoupRequestFile: 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="ch02.html" title="Core API"> -<link rel="prev" href="SoupRequestHTTP.html" title="SoupRequestHTTP"> -<link rel="next" href="SoupRequestData.html" title="SoupRequestData"> -<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="#SoupRequestFile.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupRequestFile.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> - <a href="#SoupRequestFile.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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="SoupRequestHTTP.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="SoupRequestData.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="SoupRequestFile"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="SoupRequestFile.top_of_page"></a>SoupRequestFile</span></h2> -<p>SoupRequestFile — SoupRequest support for "file" and "resource" URIs</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="SoupRequestFile.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"> -<span class="returnvalue">GFile</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupRequestFile.html#soup-request-file-get-file" title="soup_request_file_get_file ()">soup_request_file_get_file</a> <span class="c_punctuation">()</span> -</td> -</tr></tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupRequestFile.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="SoupRequestFile.html#SoupRequestFile-struct" title="SoupRequestFile">SoupRequestFile</a></td> -</tr></tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupRequestFile.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> GObject - <span class="lineart">╰──</span> <a class="link" href="SoupRequest.html" title="SoupRequest">SoupRequest</a> - <span class="lineart">╰──</span> SoupRequestFile -</pre> -</div> -<div class="refsect1"> -<a name="SoupRequestFile.implemented-interfaces"></a><h2>Implemented Interfaces</h2> -<p> -SoupRequestFile implements - GInitable.</p> -</div> -<div class="refsect1"> -<a name="SoupRequestFile.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="SoupRequestFile.description"></a><h2>Description</h2> -<p><a class="link" href="SoupRequestFile.html" title="SoupRequestFile"><span class="type">SoupRequestFile</span></a> implements <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a> for "file" and "resource" -URIs.</p> -</div> -<div class="refsect1"> -<a name="SoupRequestFile.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="soup-request-file-get-file"></a><h3>soup_request_file_get_file ()</h3> -<pre class="programlisting"><span class="returnvalue">GFile</span> * -soup_request_file_get_file (<em class="parameter"><code><a class="link" href="SoupRequestFile.html" title="SoupRequestFile"><span class="type">SoupRequestFile</span></a> *file</code></em>);</pre> -<p>Gets a <span class="type">GFile</span> corresponding to <em class="parameter"><code>file</code></em> -'s URI</p> -<div class="refsect3"> -<a name="soup-request-file-get-file.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>file</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupRequestFile.html" title="SoupRequestFile"><span class="type">SoupRequestFile</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-request-file-get-file.returns"></a><h4>Returns</h4> -<p>a <span class="type">GFile</span> corresponding to <em class="parameter"><code>file</code></em> -. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.40</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupRequestFile.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupRequestFile-struct"></a><h3>SoupRequestFile</h3> -<pre class="programlisting">typedef struct _SoupRequestFile SoupRequestFile;</pre> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/SoupRequestHTTP.html b/docs/reference/html/SoupRequestHTTP.html deleted file mode 100644 index b30d1268..00000000 --- a/docs/reference/html/SoupRequestHTTP.html +++ /dev/null @@ -1,133 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SoupRequestHTTP: 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="ch02.html" title="Core API"> -<link rel="prev" href="SoupRequest.html" title="SoupRequest"> -<link rel="next" href="SoupRequestFile.html" title="SoupRequestFile"> -<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="#SoupRequestHTTP.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupRequestHTTP.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> - <a href="#SoupRequestHTTP.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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="SoupRequest.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="SoupRequestFile.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="SoupRequestHTTP"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="SoupRequestHTTP.top_of_page"></a>SoupRequestHTTP</span></h2> -<p>SoupRequestHTTP — SoupRequest support for "http" and "https" URIs</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="SoupRequestHTTP.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="SoupMessage.html" title="SoupMessage"><span class="returnvalue">SoupMessage</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupRequestHTTP.html#soup-request-http-get-message" title="soup_request_http_get_message ()">soup_request_http_get_message</a> <span class="c_punctuation">()</span> -</td> -</tr></tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupRequestHTTP.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="SoupRequestHTTP.html#SoupRequestHTTP-struct" title="SoupRequestHTTP">SoupRequestHTTP</a></td> -</tr></tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupRequestHTTP.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> GObject - <span class="lineart">╰──</span> <a class="link" href="SoupRequest.html" title="SoupRequest">SoupRequest</a> - <span class="lineart">╰──</span> SoupRequestHTTP -</pre> -</div> -<div class="refsect1"> -<a name="SoupRequestHTTP.implemented-interfaces"></a><h2>Implemented Interfaces</h2> -<p> -SoupRequestHTTP implements - GInitable.</p> -</div> -<div class="refsect1"> -<a name="SoupRequestHTTP.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="SoupRequestHTTP.description"></a><h2>Description</h2> -<p><a class="link" href="SoupRequestHTTP.html" title="SoupRequestHTTP"><span class="type">SoupRequestHTTP</span></a> implements <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a> for "http" and "https" -URIs.</p> -<p>To do more complicated HTTP operations using the <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a> APIs, -call <a class="link" href="SoupRequestHTTP.html#soup-request-http-get-message" title="soup_request_http_get_message ()"><code class="function">soup_request_http_get_message()</code></a> to get the request's -<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>.</p> -</div> -<div class="refsect1"> -<a name="SoupRequestHTTP.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="soup-request-http-get-message"></a><h3>soup_request_http_get_message ()</h3> -<pre class="programlisting"><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="returnvalue">SoupMessage</span></a> * -soup_request_http_get_message (<em class="parameter"><code><a class="link" href="SoupRequestHTTP.html" title="SoupRequestHTTP"><span class="type">SoupRequestHTTP</span></a> *http</code></em>);</pre> -<p>Gets a new reference to the <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> associated to this SoupRequest</p> -<div class="refsect3"> -<a name="soup-request-http-get-message.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>http</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupRequestHTTP.html" title="SoupRequestHTTP"><span class="type">SoupRequestHTTP</span></a> object</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-request-http-get-message.returns"></a><h4>Returns</h4> -<p>a new reference to the <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.40</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupRequestHTTP.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupRequestHTTP-struct"></a><h3>SoupRequestHTTP</h3> -<pre class="programlisting">typedef struct _SoupRequestHTTP SoupRequestHTTP;</pre> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/SoupServer.html b/docs/reference/html/SoupServer.html deleted file mode 100644 index fcfbca2d..00000000 --- a/docs/reference/html/SoupServer.html +++ /dev/null @@ -1,2407 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SoupServer: 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="ch02.html" title="Core API"> -<link rel="prev" href="SoupRequestData.html" title="SoupRequestData"> -<link rel="next" href="libsoup-2.4-SoupServer-deprecated-API.html" title="SoupServer deprecated API"> -<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="#SoupServer.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupServer.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> - <a href="#SoupServer.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> - <a href="#SoupServer.signals" class="shortcut">Signals</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="SoupRequestData.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="libsoup-2.4-SoupServer-deprecated-API.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="SoupServer"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="SoupServer.top_of_page"></a>SoupServer</span></h2> -<p>SoupServer — HTTP server</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="SoupServer.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="SoupServer.html" title="SoupServer"><span class="returnvalue">SoupServer</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupServer.html#soup-server-new" title="soup_server_new ()">soup_server_new</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupServer.html#soup-server-set-ssl-cert-file" title="soup_server_set_ssl_cert_file ()">soup_server_set_ssl_cert_file</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupServer.html#soup-server-listen" title="soup_server_listen ()">soup_server_listen</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupServer.html#soup-server-listen-all" title="soup_server_listen_all ()">soup_server_listen_all</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupServer.html#soup-server-listen-local" title="soup_server_listen_local ()">soup_server_listen_local</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupServer.html#soup-server-listen-socket" title="soup_server_listen_socket ()">soup_server_listen_socket</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupServer.html#soup-server-listen-fd" title="soup_server_listen_fd ()">soup_server_listen_fd</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GSList</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupServer.html#soup-server-get-listeners" title="soup_server_get_listeners ()">soup_server_get_listeners</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GSList</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupServer.html#soup-server-get-uris" title="soup_server_get_uris ()">soup_server_get_uris</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupServer.html#soup-server-disconnect" title="soup_server_disconnect ()">soup_server_disconnect</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupServer.html#soup-server-is-https" title="soup_server_is_https ()">soup_server_is_https</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupServer.html#soup-server-accept-iostream" title="soup_server_accept_iostream ()">soup_server_accept_iostream</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<span class="c_punctuation">(</span><a class="link" href="SoupServer.html#SoupServerCallback" title="SoupServerCallback ()">*SoupServerCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupServer.html#soup-server-add-handler" title="soup_server_add_handler ()">soup_server_add_handler</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupServer.html#soup-server-add-early-handler" title="soup_server_add_early_handler ()">soup_server_add_early_handler</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupServer.html#soup-server-remove-handler" title="soup_server_remove_handler ()">soup_server_remove_handler</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<span class="c_punctuation">(</span><a class="link" href="SoupServer.html#SoupServerWebsocketCallback" title="SoupServerWebsocketCallback ()">*SoupServerWebsocketCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupServer.html#soup-server-add-websocket-handler" title="soup_server_add_websocket_handler ()">soup_server_add_websocket_handler</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GSocketAddress</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupServer.html#soup-client-context-get-local-address" title="soup_client_context_get_local_address ()">soup_client_context_get_local_address</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GSocketAddress</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupServer.html#soup-client-context-get-remote-address" title="soup_client_context_get_remote_address ()">soup_client_context_get_remote_address</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupServer.html#soup-client-context-get-host" title="soup_client_context_get_host ()">soup_client_context_get_host</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="returnvalue">SoupAuthDomain</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupServer.html#soup-client-context-get-auth-domain" title="soup_client_context_get_auth_domain ()">soup_client_context_get_auth_domain</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupServer.html#soup-client-context-get-auth-user" title="soup_client_context_get_auth_user ()">soup_client_context_get_auth_user</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GSocket</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupServer.html#soup-client-context-get-gsocket" title="soup_client_context_get_gsocket ()">soup_client_context_get_gsocket</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GIOStream</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupServer.html#soup-client-context-steal-connection" title="soup_client_context_steal_connection ()">soup_client_context_steal_connection</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupServer.html#soup-server-add-auth-domain" title="soup_server_add_auth_domain ()">soup_server_add_auth_domain</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupServer.html#soup-server-remove-auth-domain" title="soup_server_remove_auth_domain ()">soup_server_remove_auth_domain</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupServer.html#soup-server-pause-message" title="soup_server_pause_message ()">soup_server_pause_message</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupServer.html#soup-server-unpause-message" title="soup_server_unpause_message ()">soup_server_unpause_message</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupServer.properties"></a><h2>Properties</h2> -<div class="informaltable"><table class="informaltable" border="0"> -<colgroup> -<col width="150px" class="properties_type"> -<col width="300px" class="properties_name"> -<col width="200px" class="properties_flags"> -</colgroup> -<tbody> -<tr> -<td class="property_type"><span class="type">gpointer</span></td> -<td class="property_name"><a class="link" href="SoupServer.html#SoupServer--async-context" title="The “async-context” property">async-context</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -<tr> -<td class="property_type"><span class="type">GStrv</span></td> -<td class="property_name"><a class="link" href="SoupServer.html#SoupServer--http-aliases" title="The “http-aliases” property">http-aliases</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><span class="type">GStrv</span></td> -<td class="property_name"><a class="link" href="SoupServer.html#SoupServer--https-aliases" title="The “https-aliases” property">https-aliases</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> *</td> -<td class="property_name"><a class="link" href="SoupServer.html#SoupServer--interface" title="The “interface” property">interface</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -<tr> -<td class="property_type"><span class="type">guint</span></td> -<td class="property_name"><a class="link" href="SoupServer.html#SoupServer--port" title="The “port” property">port</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -<tr> -<td class="property_type"><span class="type">gboolean</span></td> -<td class="property_name"><a class="link" href="SoupServer.html#SoupServer--raw-paths" title="The “raw-paths” property">raw-paths</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">gchar</span> *</td> -<td class="property_name"><a class="link" href="SoupServer.html#SoupServer--server-header" title="The “server-header” property">server-header</a></td> -<td class="property_flags">Read / Write / Construct</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">gchar</span> *</td> -<td class="property_name"><a class="link" href="SoupServer.html#SoupServer--ssl-cert-file" title="The “ssl-cert-file” property">ssl-cert-file</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">gchar</span> *</td> -<td class="property_name"><a class="link" href="SoupServer.html#SoupServer--ssl-key-file" title="The “ssl-key-file” property">ssl-key-file</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">GTlsCertificate</span> *</td> -<td class="property_name"><a class="link" href="SoupServer.html#SoupServer--tls-certificate" title="The “tls-certificate” property">tls-certificate</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupServer.signals"></a><h2>Signals</h2> -<div class="informaltable"><table class="informaltable" border="0"> -<colgroup> -<col width="150px" class="signals_return"> -<col width="300px" class="signals_name"> -<col width="200px" class="signals_flags"> -</colgroup> -<tbody> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="SoupServer.html#SoupServer-request-aborted" title="The “request-aborted” signal">request-aborted</a></td> -<td class="signal_flags">Run First</td> -</tr> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="SoupServer.html#SoupServer-request-finished" title="The “request-finished” signal">request-finished</a></td> -<td class="signal_flags">Run First</td> -</tr> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="SoupServer.html#SoupServer-request-read" title="The “request-read” signal">request-read</a></td> -<td class="signal_flags">Run First</td> -</tr> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="SoupServer.html#SoupServer-request-started" title="The “request-started” signal">request-started</a></td> -<td class="signal_flags">Run First</td> -</tr> -</tbody> -</table></div> -</div> -<a name="SoupClientContext"></a><div class="refsect1"> -<a name="SoupServer.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="SoupServer.html#SoupServer-struct" title="SoupServer">SoupServer</a></td> -</tr> -<tr> -<td class="datatype_keyword">enum</td> -<td class="function_name"><a class="link" href="SoupServer.html#SoupServerListenOptions" title="enum SoupServerListenOptions">SoupServerListenOptions</a></td> -</tr> -<tr> -<td class="typedef_keyword">typedef</td> -<td class="function_name"><a class="link" href="SoupServer.html#SoupClientContext">SoupClientContext</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupServer.html#SOUP-SERVER-TLS-CERTIFICATE:CAPS" title="SOUP_SERVER_TLS_CERTIFICATE">SOUP_SERVER_TLS_CERTIFICATE</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupServer.html#SOUP-SERVER-RAW-PATHS:CAPS" title="SOUP_SERVER_RAW_PATHS">SOUP_SERVER_RAW_PATHS</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupServer.html#SOUP-SERVER-SERVER-HEADER:CAPS" title="SOUP_SERVER_SERVER_HEADER">SOUP_SERVER_SERVER_HEADER</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupServer.html#SOUP-SERVER-HTTP-ALIASES:CAPS" title="SOUP_SERVER_HTTP_ALIASES">SOUP_SERVER_HTTP_ALIASES</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupServer.html#SOUP-SERVER-HTTPS-ALIASES:CAPS" title="SOUP_SERVER_HTTPS_ALIASES">SOUP_SERVER_HTTPS_ALIASES</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupServer.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> <a href="/home/claudio/gnome3/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a> - <span class="lineart">╰──</span> SoupClientContext - GObject - <span class="lineart">╰──</span> SoupServer -</pre> -</div> -<div class="refsect1"> -<a name="SoupServer.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="SoupServer.description"></a><h2>Description</h2> -<p><a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> implements a simple HTTP server.</p> -<p>(The following documentation describes the current <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> API, -available in <span class="application">libsoup</span> 2.48 and later. See -the section "<a class="link" href="libsoup-server-howto.html#soup-server-old-api" title="The Old SoupServer Listening API">The Old SoupServer -Listening API</a>" in the server how-to documentation for -details on the older <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> API.)</p> -<p>To begin, create a server using <a class="link" href="SoupServer.html#soup-server-new" title="soup_server_new ()"><code class="function">soup_server_new()</code></a>. Add at least one -handler by calling <a class="link" href="SoupServer.html#soup-server-add-handler" title="soup_server_add_handler ()"><code class="function">soup_server_add_handler()</code></a> or -<a class="link" href="SoupServer.html#soup-server-add-early-handler" title="soup_server_add_early_handler ()"><code class="function">soup_server_add_early_handler()</code></a>; the handler will be called to -process any requests underneath the path you pass. (If you want all -requests to go to the same handler, just pass "/" (or <code class="literal">NULL</code>) for -the path.)</p> -<p>When a new connection is accepted (or a new request is started on -an existing persistent connection), the <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> will emit -<a class="link" href="SoupServer.html#SoupServer-request-started" title="The “request-started” signal"><span class="type">“request-started”</span></a> and then begin processing the request -as described below, but note that once the message is assigned a -<a class="link" href="SoupMessage.html#SoupMessage--status-code" title="The “status-code” property"><span class="type">“status-code”</span></a>, then callbacks after that point will be -skipped. Note also that it is not defined when the callbacks happen -relative to various <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> signals.</p> -<p>Once the headers have been read, <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> will check if there is -a <a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a> (qv) covering the Request-URI; if so, and if the -message does not contain suitable authorization, then the -<a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a> will set a status of <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-UNAUTHORIZED:CAPS"><code class="literal">SOUP_STATUS_UNAUTHORIZED</code></a> on -the message.</p> -<p>After checking for authorization, <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> will look for "early" -handlers (added with <a class="link" href="SoupServer.html#soup-server-add-early-handler" title="soup_server_add_early_handler ()"><code class="function">soup_server_add_early_handler()</code></a>) matching the -Request-URI. If one is found, it will be run; in particular, this -can be used to connect to signals to do a streaming read of the -request body.</p> -<p>(At this point, if the request headers contain "<code class="literal">Expect: -100-continue</code>", and a status code has been set, then -<a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> will skip the remaining steps and return the response. -If the request headers contain "<code class="literal">Expect: -100-continue</code>" and no status code has been set, -<a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> will return a <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-CONTINUE:CAPS"><code class="literal">SOUP_STATUS_CONTINUE</code></a> status before -continuing.)</p> -<p>The server will then read in the response body (if present). At -this point, if there are no handlers at all defined for the -Request-URI, then the server will return <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-NOT-FOUND:CAPS"><code class="literal">SOUP_STATUS_NOT_FOUND</code></a> to -the client.</p> -<p>Otherwise (assuming no previous step assigned a status to the -message) any "normal" handlers (added with -<a class="link" href="SoupServer.html#soup-server-add-handler" title="soup_server_add_handler ()"><code class="function">soup_server_add_handler()</code></a>) for the message's Request-URI will be -run.</p> -<p>Then, if the path has a WebSocket handler registered (and has -not yet been assigned a status), <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> will attempt to -validate the WebSocket handshake, filling in the response and -setting a status of <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-SWITCHING-PROTOCOLS:CAPS"><code class="literal">SOUP_STATUS_SWITCHING_PROTOCOLS</code></a> or -<a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-BAD-REQUEST:CAPS"><code class="literal">SOUP_STATUS_BAD_REQUEST</code></a> accordingly.</p> -<p>If the message still has no status code at this point (and has not -been paused with <a class="link" href="SoupServer.html#soup-server-pause-message" title="soup_server_pause_message ()"><code class="function">soup_server_pause_message()</code></a>), then it will be -given a status of <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-INTERNAL-SERVER-ERROR:CAPS"><code class="literal">SOUP_STATUS_INTERNAL_SERVER_ERROR</code></a> (because at -least one handler ran, but returned without assigning a status).</p> -<p>Finally, the server will emit <a class="link" href="SoupServer.html#SoupServer-request-finished" title="The “request-finished” signal"><span class="type">“request-finished”</span></a> (or -<a class="link" href="SoupServer.html#SoupServer-request-aborted" title="The “request-aborted” signal"><span class="type">“request-aborted”</span></a> if an I/O error occurred before -handling was completed).</p> -<p>If you want to handle the special "*" URI (eg, "OPTIONS *"), you -must explicitly register a handler for "*"; the default handler -will not be used for that case.</p> -<p>If you want to process https connections in addition to (or instead -of) http connections, you can either set the -<a class="link" href="SoupServer.html#SOUP-SERVER-TLS-CERTIFICATE:CAPS" title="SOUP_SERVER_TLS_CERTIFICATE"><code class="literal">SOUP_SERVER_TLS_CERTIFICATE</code></a> property when creating the server, or -else call <code class="function">soup_server_set_ssl_certificate()</code> after creating it.</p> -<p>Once the server is set up, make one or more calls to -<a class="link" href="SoupServer.html#soup-server-listen" title="soup_server_listen ()"><code class="function">soup_server_listen()</code></a>, <a class="link" href="SoupServer.html#soup-server-listen-local" title="soup_server_listen_local ()"><code class="function">soup_server_listen_local()</code></a>, or -<a class="link" href="SoupServer.html#soup-server-listen-all" title="soup_server_listen_all ()"><code class="function">soup_server_listen_all()</code></a> to tell it where to listen for -connections. (All ports on a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> use the same handlers; if -you need to handle some ports differently, such as returning -different data for http and https, you'll need to create multiple -<a href="SoupServer.html#SoupServer-struct"><span class="type">SoupServers</span></a>, or else check the passed-in URI in the handler -function.).</p> -<p><a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> will begin processing connections as soon as you return -to (or start) the main loop for the current thread-default -<span class="type">GMainContext</span>.</p> -</div> -<div class="refsect1"> -<a name="SoupServer.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="soup-server-new"></a><h3>soup_server_new ()</h3> -<pre class="programlisting"><a class="link" href="SoupServer.html" title="SoupServer"><span class="returnvalue">SoupServer</span></a> * -soup_server_new (<em class="parameter"><code>const <span class="type">char</span> *optname1</code></em>, - <em class="parameter"><code>...</code></em>);</pre> -<p>Creates a new <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a>. This is exactly equivalent to calling -<code class="function">g_object_new()</code> and specifying <code class="literal">SOUP_TYPE_SERVER</code> as the type.</p> -<div class="refsect3"> -<a name="soup-server-new.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>optname1</p></td> -<td class="parameter_description"><p>name of first property to set</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>...</p></td> -<td class="parameter_description"><p>value of <em class="parameter"><code>optname1</code></em> -, followed by additional property/value pairs</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-server-new.returns"></a><h4>Returns</h4> -<p>a new <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a>. If you are using -certain legacy properties, this may also return <code class="literal">NULL</code> if an error -occurs. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-server-set-ssl-cert-file"></a><h3>soup_server_set_ssl_cert_file ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_server_set_ssl_cert_file (<em class="parameter"><code><a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> *server</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *ssl_cert_file</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *ssl_key_file</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>Sets <em class="parameter"><code>server</code></em> - up to do https, using the SSL/TLS certificate -specified by <em class="parameter"><code>ssl_cert_file</code></em> - and <em class="parameter"><code>ssl_key_file</code></em> - (which may point to -the same file).</p> -<p>Alternatively, you can set the <a class="link" href="SoupServer.html#SoupServer--tls-certificate" title="The “tls-certificate” property"><span class="type">“tls-certificate”</span></a> property -at construction time, if you already have a <span class="type">GTlsCertificate</span>.</p> -<div class="refsect3"> -<a name="soup-server-set-ssl-cert-file.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>server</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>ssl_cert_file</p></td> -<td class="parameter_description"><p>path to a file containing a PEM-encoded SSL/TLS -certificate.</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>ssl_key_file</p></td> -<td class="parameter_description"><p>path to a file containing a PEM-encoded private key.</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>return location for a <span class="type">GError</span></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-server-set-ssl-cert-file.returns"></a><h4>Returns</h4> -<p> success or failure.</p> -</div> -<p class="since">Since: 2.48</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-server-listen"></a><h3>soup_server_listen ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_server_listen (<em class="parameter"><code><a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> *server</code></em>, - <em class="parameter"><code><span class="type">GSocketAddress</span> *address</code></em>, - <em class="parameter"><code><a class="link" href="SoupServer.html#SoupServerListenOptions" title="enum SoupServerListenOptions"><span class="type">SoupServerListenOptions</span></a> options</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>This attempts to set up <em class="parameter"><code>server</code></em> - to listen for connections on -<em class="parameter"><code>address</code></em> -.</p> -<p>If <em class="parameter"><code>options</code></em> - includes <a class="link" href="SoupServer.html#SOUP-SERVER-LISTEN-HTTPS:CAPS"><code class="literal">SOUP_SERVER_LISTEN_HTTPS</code></a>, and <em class="parameter"><code>server</code></em> - has -been configured for TLS, then <em class="parameter"><code>server</code></em> - will listen for https -connections on this port. Otherwise it will listen for plain http.</p> -<p>You may call this method (along with the other "listen" methods) -any number of times on a server, if you want to listen on multiple -ports, or set up both http and https service.</p> -<p>After calling this method, <em class="parameter"><code>server</code></em> - will begin accepting and -processing connections as soon as the appropriate <span class="type">GMainContext</span> is -run.</p> -<p>Note that <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> never makes use of dual IPv4/IPv6 sockets; if -<em class="parameter"><code>address</code></em> - is an IPv6 address, it will only accept IPv6 connections. -You must configure IPv4 listening separately.</p> -<div class="refsect3"> -<a name="soup-server-listen.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>server</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>address</p></td> -<td class="parameter_description"><p>the address of the interface to listen on</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>options</p></td> -<td class="parameter_description"><p>listening options for this server</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>return location for a <span class="type">GError</span></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-server-listen.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> if <em class="parameter"><code>address</code></em> -could not be -bound or any other error occurred (in which case <em class="parameter"><code>error</code></em> -will be -set).</p> -</div> -<p class="since">Since: 2.48</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-server-listen-all"></a><h3>soup_server_listen_all ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_server_listen_all (<em class="parameter"><code><a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> *server</code></em>, - <em class="parameter"><code><span class="type">guint</span> port</code></em>, - <em class="parameter"><code><a class="link" href="SoupServer.html#SoupServerListenOptions" title="enum SoupServerListenOptions"><span class="type">SoupServerListenOptions</span></a> options</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>This attempts to set up <em class="parameter"><code>server</code></em> - to listen for connections on all -interfaces on the system. (That is, it listens on the addresses -<code class="literal">0.0.0.0</code> and/or <code class="literal">::</code>, depending -on whether <em class="parameter"><code>options</code></em> - includes <a class="link" href="SoupServer.html#SOUP-SERVER-LISTEN-IPV4-ONLY:CAPS"><code class="literal">SOUP_SERVER_LISTEN_IPV4_ONLY</code></a>, -<a class="link" href="SoupServer.html#SOUP-SERVER-LISTEN-IPV6-ONLY:CAPS"><code class="literal">SOUP_SERVER_LISTEN_IPV6_ONLY</code></a>, or neither.) If <em class="parameter"><code>port</code></em> - is specified, -<em class="parameter"><code>server</code></em> - will listen on that port. If it is 0, <em class="parameter"><code>server</code></em> - will find an -unused port to listen on. (In that case, you can use -<a class="link" href="SoupServer.html#soup-server-get-uris" title="soup_server_get_uris ()"><code class="function">soup_server_get_uris()</code></a> to find out what port it ended up choosing.)</p> -<p>See <a class="link" href="SoupServer.html#soup-server-listen" title="soup_server_listen ()"><code class="function">soup_server_listen()</code></a> for more details.</p> -<div class="refsect3"> -<a name="soup-server-listen-all.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>server</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>port</p></td> -<td class="parameter_description"><p>the port to listen on, or 0</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>options</p></td> -<td class="parameter_description"><p>listening options for this server</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>return location for a <span class="type">GError</span></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-server-listen-all.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> if <em class="parameter"><code>port</code></em> -could not be bound -or any other error occurred (in which case <em class="parameter"><code>error</code></em> -will be set).</p> -</div> -<p class="since">Since: 2.48</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-server-listen-local"></a><h3>soup_server_listen_local ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_server_listen_local (<em class="parameter"><code><a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> *server</code></em>, - <em class="parameter"><code><span class="type">guint</span> port</code></em>, - <em class="parameter"><code><a class="link" href="SoupServer.html#SoupServerListenOptions" title="enum SoupServerListenOptions"><span class="type">SoupServerListenOptions</span></a> options</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>This attempts to set up <em class="parameter"><code>server</code></em> - to listen for connections on -"localhost" (that is, <code class="literal">127.0.0.1</code> and/or -<code class="literal">::1</code>, depending on whether <em class="parameter"><code>options</code></em> - includes -<a class="link" href="SoupServer.html#SOUP-SERVER-LISTEN-IPV4-ONLY:CAPS"><code class="literal">SOUP_SERVER_LISTEN_IPV4_ONLY</code></a>, <a class="link" href="SoupServer.html#SOUP-SERVER-LISTEN-IPV6-ONLY:CAPS"><code class="literal">SOUP_SERVER_LISTEN_IPV6_ONLY</code></a>, or -neither). If <em class="parameter"><code>port</code></em> - is specified, <em class="parameter"><code>server</code></em> - will listen on that port. -If it is 0, <em class="parameter"><code>server</code></em> - will find an unused port to listen on. (In that -case, you can use <a class="link" href="SoupServer.html#soup-server-get-uris" title="soup_server_get_uris ()"><code class="function">soup_server_get_uris()</code></a> to find out what port it -ended up choosing.)</p> -<p>See <a class="link" href="SoupServer.html#soup-server-listen" title="soup_server_listen ()"><code class="function">soup_server_listen()</code></a> for more details.</p> -<div class="refsect3"> -<a name="soup-server-listen-local.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>server</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>port</p></td> -<td class="parameter_description"><p>the port to listen on, or 0</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>options</p></td> -<td class="parameter_description"><p>listening options for this server</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>return location for a <span class="type">GError</span></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-server-listen-local.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> if <em class="parameter"><code>port</code></em> -could not be bound -or any other error occurred (in which case <em class="parameter"><code>error</code></em> -will be set).</p> -</div> -<p class="since">Since: 2.48</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-server-listen-socket"></a><h3>soup_server_listen_socket ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_server_listen_socket (<em class="parameter"><code><a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> *server</code></em>, - <em class="parameter"><code><span class="type">GSocket</span> *socket</code></em>, - <em class="parameter"><code><a class="link" href="SoupServer.html#SoupServerListenOptions" title="enum SoupServerListenOptions"><span class="type">SoupServerListenOptions</span></a> options</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>This attempts to set up <em class="parameter"><code>server</code></em> - to listen for connections on -<em class="parameter"><code>socket</code></em> -.</p> -<p>See <a class="link" href="SoupServer.html#soup-server-listen" title="soup_server_listen ()"><code class="function">soup_server_listen()</code></a> for more details.</p> -<div class="refsect3"> -<a name="soup-server-listen-socket.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>server</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>socket</p></td> -<td class="parameter_description"><p>a listening <span class="type">GSocket</span></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>options</p></td> -<td class="parameter_description"><p>listening options for this server</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>return location for a <span class="type">GError</span></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-server-listen-socket.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> if an error occurred (in -which case <em class="parameter"><code>error</code></em> -will be set).</p> -</div> -<p class="since">Since: 2.48</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-server-listen-fd"></a><h3>soup_server_listen_fd ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_server_listen_fd (<em class="parameter"><code><a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> *server</code></em>, - <em class="parameter"><code><span class="type">int</span> fd</code></em>, - <em class="parameter"><code><a class="link" href="SoupServer.html#SoupServerListenOptions" title="enum SoupServerListenOptions"><span class="type">SoupServerListenOptions</span></a> options</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>This attempts to set up <em class="parameter"><code>server</code></em> - to listen for connections on -<em class="parameter"><code>fd</code></em> -.</p> -<p>See <a class="link" href="SoupServer.html#soup-server-listen" title="soup_server_listen ()"><code class="function">soup_server_listen()</code></a> for more details.</p> -<p>Note that <em class="parameter"><code>server</code></em> - will close <em class="parameter"><code>fd</code></em> - when you free it or call -<a class="link" href="SoupServer.html#soup-server-disconnect" title="soup_server_disconnect ()"><code class="function">soup_server_disconnect()</code></a>.</p> -<div class="refsect3"> -<a name="soup-server-listen-fd.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>server</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>fd</p></td> -<td class="parameter_description"><p>the file descriptor of a listening socket</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>options</p></td> -<td class="parameter_description"><p>listening options for this server</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>return location for a <span class="type">GError</span></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-server-listen-fd.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> if an error occurred (in -which case <em class="parameter"><code>error</code></em> -will be set).</p> -</div> -<p class="since">Since: 2.48</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-server-get-listeners"></a><h3>soup_server_get_listeners ()</h3> -<pre class="programlisting"><span class="returnvalue">GSList</span> * -soup_server_get_listeners (<em class="parameter"><code><a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> *server</code></em>);</pre> -<p>Gets <em class="parameter"><code>server</code></em> -'s list of listening sockets.</p> -<p>You should treat these sockets as read-only; writing to or -modifiying any of these sockets may cause <em class="parameter"><code>server</code></em> - to malfunction.</p> -<p>(Beware that in contrast to the old <a class="link" href="libsoup-2.4-SoupServer-deprecated-API.html#soup-server-get-listener" title="soup_server_get_listener ()"><code class="function">soup_server_get_listener()</code></a>, this -function returns <span class="type">GSockets</span>, not <a href="SoupSocket.html#SoupSocket-struct"><span class="type">SoupSockets</span></a>.)</p> -<div class="refsect3"> -<a name="soup-server-get-listeners.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>server</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-server-get-listeners.returns"></a><h4>Returns</h4> -<p>a -list of listening sockets. </p> -<p><span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> Gio.Socket]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-server-get-uris"></a><h3>soup_server_get_uris ()</h3> -<pre class="programlisting"><span class="returnvalue">GSList</span> * -soup_server_get_uris (<em class="parameter"><code><a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> *server</code></em>);</pre> -<p>Gets a list of URIs corresponding to the interfaces <em class="parameter"><code>server</code></em> - is -listening on. These will contain IP addresses, not hostnames, and -will also indicate whether the given listener is http or https.</p> -<p>Note that if you used <a class="link" href="SoupServer.html#soup-server-listen-all" title="soup_server_listen_all ()"><code class="function">soup_server_listen_all()</code></a>, the returned URIs -will use the addresses <code class="literal">0.0.0.0</code> and -<code class="literal">::</code>, rather than actually returning separate URIs -for each interface on the system.</p> -<div class="refsect3"> -<a name="soup-server-get-uris.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>server</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-server-get-uris.returns"></a><h4>Returns</h4> -<p>a list of -<a href="SoupURI.html#SoupURI-struct"><span class="type">SoupURIs</span></a>, which you must free when you are done with it. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> Soup.URI]</span></p> -</div> -<p class="since">Since: 2.48</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-server-disconnect"></a><h3>soup_server_disconnect ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_server_disconnect (<em class="parameter"><code><a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> *server</code></em>);</pre> -<p>Closes and frees <em class="parameter"><code>server</code></em> -'s listening sockets. If you are using the -old <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> APIs, this also includes the effect of -<a class="link" href="libsoup-2.4-SoupServer-deprecated-API.html#soup-server-quit" title="soup_server_quit ()"><code class="function">soup_server_quit()</code></a>.</p> -<p>Note that if there are currently requests in progress on <em class="parameter"><code>server</code></em> -, -that they will continue to be processed if <em class="parameter"><code>server</code></em> -'s <span class="type">GMainContext</span> -is still running.</p> -<p>You can call <a class="link" href="SoupServer.html#soup-server-listen" title="soup_server_listen ()"><code class="function">soup_server_listen()</code></a>, etc, after calling this function -if you want to start listening again.</p> -<div class="refsect3"> -<a name="soup-server-disconnect.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>server</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-server-is-https"></a><h3>soup_server_is_https ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_server_is_https (<em class="parameter"><code><a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> *server</code></em>);</pre> -<p>Checks whether <em class="parameter"><code>server</code></em> - is capable of https.</p> -<p>In order for a server to run https, you must call -<a class="link" href="SoupServer.html#soup-server-set-ssl-cert-file" title="soup_server_set_ssl_cert_file ()"><code class="function">soup_server_set_ssl_cert_file()</code></a>, or set the -<a class="link" href="SoupServer.html#SoupServer--tls-certificate" title="The “tls-certificate” property"><span class="type">“tls-certificate”</span></a> property, to provide it with a -certificate to use.</p> -<p>If you are using the deprecated single-listener APIs, then a return -value of <code class="literal">TRUE</code> indicates that the <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> serves https -exclusively. If you are using <a class="link" href="SoupServer.html#soup-server-listen" title="soup_server_listen ()"><code class="function">soup_server_listen()</code></a>, etc, then a -<code class="literal">TRUE</code> return value merely indicates that the server is -<span class="emphasis"><em>able</em></span> to do https, regardless of whether it -actually currently is or not. Use <a class="link" href="SoupServer.html#soup-server-get-uris" title="soup_server_get_uris ()"><code class="function">soup_server_get_uris()</code></a> to see if -it currently has any https listeners.</p> -<div class="refsect3"> -<a name="soup-server-is-https.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>server</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-server-is-https.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if <em class="parameter"><code>server</code></em> -is configured to serve https.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-server-accept-iostream"></a><h3>soup_server_accept_iostream ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_server_accept_iostream (<em class="parameter"><code><a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> *server</code></em>, - <em class="parameter"><code><span class="type">GIOStream</span> *stream</code></em>, - <em class="parameter"><code><span class="type">GSocketAddress</span> *local_addr</code></em>, - <em class="parameter"><code><span class="type">GSocketAddress</span> *remote_addr</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>Add a new client stream to the <em class="parameter"><code>server</code></em> -.</p> -<div class="refsect3"> -<a name="soup-server-accept-iostream.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>server</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>stream</p></td> -<td class="parameter_description"><p>a <span class="type">GIOStream</span></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>local_addr</p></td> -<td class="parameter_description"><p>the local <span class="type">GSocketAddress</span> associated with the <em class="parameter"><code>stream</code></em> -. </p></td> -<td class="parameter_annotations"><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 class="parameter_name"><p>remote_addr</p></td> -<td class="parameter_description"><p>the remote <span class="type">GSocketAddress</span> associated with the <em class="parameter"><code>stream</code></em> -. </p></td> -<td class="parameter_annotations"><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 class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>return location for a <span class="type">GError</span></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-server-accept-iostream.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> if the stream could not be -accepted or any other error occurred (in which case <em class="parameter"><code>error</code></em> -will be -set).</p> -</div> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupServerCallback"></a><h3>SoupServerCallback ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -<span class="c_punctuation">(</span>*SoupServerCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> *server</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>const <span class="type">char</span> *path</code></em>, - <em class="parameter"><code><span class="type">GHashTable</span> *query</code></em>, - <em class="parameter"><code><a class="link" href="SoupServer.html#SoupClientContext"><span class="type">SoupClientContext</span></a> *client</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> -<p>A callback used to handle requests to a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a>.</p> -<p><em class="parameter"><code>path</code></em> - and <em class="parameter"><code>query</code></em> - contain the likewise-named components of the -Request-URI, subject to certain assumptions. By default, -<a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> decodes all percent-encoding in the URI path, such that -"/foo%2Fbar" is treated the same as "/foo/bar". If your -server is serving resources in some non-POSIX-filesystem namespace, -you may want to distinguish those as two distinct paths. In that -case, you can set the <a class="link" href="SoupServer.html#SOUP-SERVER-RAW-PATHS:CAPS" title="SOUP_SERVER_RAW_PATHS"><code class="literal">SOUP_SERVER_RAW_PATHS</code></a> property when creating -the <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a>, and it will leave those characters undecoded. (You -may want to call <a class="link" href="SoupURI.html#soup-uri-normalize" title="soup_uri_normalize ()"><code class="function">soup_uri_normalize()</code></a> to decode any percent-encoded -characters that you aren't handling specially.)</p> -<p><em class="parameter"><code>query</code></em> - contains the query component of the Request-URI parsed -according to the rules for HTML form handling. Although this is the -only commonly-used query string format in HTTP, there is nothing -that actually requires that HTTP URIs use that format; if your -server needs to use some other format, you can just ignore <em class="parameter"><code>query</code></em> -, -and call <a class="link" href="SoupMessage.html#soup-message-get-uri" title="soup_message_get_uri ()"><code class="function">soup_message_get_uri()</code></a> and parse the URI's query field -yourself.</p> -<p>See <a class="link" href="SoupServer.html#soup-server-add-handler" title="soup_server_add_handler ()"><code class="function">soup_server_add_handler()</code></a> and <a class="link" href="SoupServer.html#soup-server-add-early-handler" title="soup_server_add_early_handler ()"><code class="function">soup_server_add_early_handler()</code></a> -for details of what handlers can/should do.</p> -<div class="refsect3"> -<a name="SoupServerCallback.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>server</p></td> -<td class="parameter_description"><p>the <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</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 being processed</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>path</p></td> -<td class="parameter_description"><p>the path component of <em class="parameter"><code>msg</code></em> -'s Request-URI</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>query</p></td> -<td class="parameter_description"><p>the parsed query -component of <em class="parameter"><code>msg</code></em> -'s Request-URI. </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="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>client</p></td> -<td class="parameter_description"><p>additional contextual information about the client</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>the data passed to <a class="link" href="SoupServer.html#soup-server-add-handler" title="soup_server_add_handler ()"><code class="function">soup_server_add_handler()</code></a> or -<a class="link" href="SoupServer.html#soup-server-add-early-handler" title="soup_server_add_early_handler ()"><code class="function">soup_server_add_early_handler()</code></a>.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-server-add-handler"></a><h3>soup_server_add_handler ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_server_add_handler (<em class="parameter"><code><a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> *server</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *path</code></em>, - <em class="parameter"><code><a class="link" href="SoupServer.html#SoupServerCallback" title="SoupServerCallback ()"><span class="type">SoupServerCallback</span></a> callback</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>, - <em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>);</pre> -<p>Adds a handler to <em class="parameter"><code>server</code></em> - for requests under <em class="parameter"><code>path</code></em> -. If <em class="parameter"><code>path</code></em> - is -<code class="literal">NULL</code> or "/", then this will be the default handler for all -requests that don't have a more specific handler. (Note though that -if you want to handle requests to the special "*" URI, you must -explicitly register a handler for "*"; the default handler will not -be used for that case.)</p> -<p>For requests under <em class="parameter"><code>path</code></em> - (that have not already been assigned a -status code by a <a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a>, an early <span class="type">SoupServerHandler</span>, or a -signal handler), <em class="parameter"><code>callback</code></em> - will be invoked after receiving the -request body; the message's <a class="link" href="SoupMessage.html#SoupMessage--method" title="The “method” property"><span class="type">“method”</span></a>, -<a class="link" href="SoupMessage.html#SoupMessage--request-headers" title="The “request-headers” property"><span class="type">“request-headers”</span></a>, and <a class="link" href="SoupMessage.html#SoupMessage--request-body" title="The “request-body” property"><span class="type">“request-body”</span></a> fields -will be filled in.</p> -<p>After determining what to do with the request, the callback must at -a minimum call <a class="link" href="SoupMessage.html#soup-message-set-status" title="soup_message_set_status ()"><code class="function">soup_message_set_status()</code></a> (or -<a class="link" href="SoupMessage.html#soup-message-set-status-full" title="soup_message_set_status_full ()"><code class="function">soup_message_set_status_full()</code></a>) on the message to set the response -status code. Additionally, it may set response headers and/or fill -in the response body.</p> -<p>If the callback cannot fully fill in the response before returning -(eg, if it needs to wait for information from a database, or -another network server), it should call <a class="link" href="SoupServer.html#soup-server-pause-message" title="soup_server_pause_message ()"><code class="function">soup_server_pause_message()</code></a> -to tell <em class="parameter"><code>server</code></em> - to not send the response right away. When the -response is ready, call <a class="link" href="SoupServer.html#soup-server-unpause-message" title="soup_server_unpause_message ()"><code class="function">soup_server_unpause_message()</code></a> to cause it -to be sent.</p> -<p>To send the response body a bit at a time using "chunked" encoding, -first call <a class="link" href="SoupMessageHeaders.html#soup-message-headers-set-encoding" title="soup_message_headers_set_encoding ()"><code class="function">soup_message_headers_set_encoding()</code></a> to set -<a class="link" href="SoupMessageHeaders.html#SOUP-ENCODING-CHUNKED:CAPS"><code class="literal">SOUP_ENCODING_CHUNKED</code></a> on the <a class="link" href="SoupMessage.html#SoupMessage--response-headers" title="The “response-headers” property"><span class="type">“response-headers”</span></a>. Then call -<a class="link" href="SoupMessageBody.html#soup-message-body-append" title="soup_message_body_append ()"><code class="function">soup_message_body_append()</code></a> (or <a class="link" href="SoupMessageBody.html#soup-message-body-append-buffer" title="soup_message_body_append_buffer ()"><code class="function">soup_message_body_append_buffer()</code></a>) -to append each chunk as it becomes ready, and -<a class="link" href="SoupServer.html#soup-server-unpause-message" title="soup_server_unpause_message ()"><code class="function">soup_server_unpause_message()</code></a> to make sure it's running. (The -server will automatically pause the message if it is using chunked -encoding but no more chunks are available.) When you are done, call -<a class="link" href="SoupMessageBody.html#soup-message-body-complete" title="soup_message_body_complete ()"><code class="function">soup_message_body_complete()</code></a> to indicate that no more chunks are -coming.</p> -<div class="refsect3"> -<a name="soup-server-add-handler.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>server</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>path</p></td> -<td class="parameter_description"><p>the toplevel path for the handler. </p></td> -<td class="parameter_annotations"><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 class="parameter_name"><p>callback</p></td> -<td class="parameter_description"><p>callback to invoke for requests under <em class="parameter"><code>path</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>data for <em class="parameter"><code>callback</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>destroy</p></td> -<td class="parameter_description"><p>destroy notifier to free <em class="parameter"><code>user_data</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-server-add-early-handler"></a><h3>soup_server_add_early_handler ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_server_add_early_handler (<em class="parameter"><code><a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> *server</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *path</code></em>, - <em class="parameter"><code><a class="link" href="SoupServer.html#SoupServerCallback" title="SoupServerCallback ()"><span class="type">SoupServerCallback</span></a> callback</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>, - <em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>);</pre> -<p>Adds an "early" handler to <em class="parameter"><code>server</code></em> - for requests under <em class="parameter"><code>path</code></em> -. Note -that "normal" and "early" handlers are matched up together, so if -you add a normal handler for "/foo" and an early handler for -"/foo/bar", then a request to "/foo/bar" (or any path below it) -will run only the early handler. (But if you add both handlers at -the same path, then both will get run.)</p> -<p>For requests under <em class="parameter"><code>path</code></em> - (that have not already been assigned a -status code by a <a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a> or a signal handler), <em class="parameter"><code>callback</code></em> - -will be invoked after receiving the request headers, but before -receiving the request body; the message's <a class="link" href="SoupMessage.html#SoupMessage--method" title="The “method” property"><span class="type">“method”</span></a> and -<a class="link" href="SoupMessage.html#SoupMessage--request-headers" title="The “request-headers” property"><span class="type">“request-headers”</span></a> fields will be filled in.</p> -<p>Early handlers are generally used for processing requests with -request bodies in a streaming fashion. If you determine that the -request will contain a message body, normally you would call -<a class="link" href="SoupMessageBody.html#soup-message-body-set-accumulate" title="soup_message_body_set_accumulate ()"><code class="function">soup_message_body_set_accumulate()</code></a> on the message's -<a class="link" href="SoupMessage.html#SoupMessage--request-body" title="The “request-body” property"><span class="type">“request-body”</span></a> to turn off request-body accumulation, -and connect to the message's <a class="link" href="SoupMessage.html#SoupMessage-got-chunk" title="The “got-chunk” signal"><span class="type">“got-chunk”</span></a> signal to -process each chunk as it comes in.</p> -<p>To complete the message processing after the full message body has -been read, you can either also connect to <a class="link" href="SoupMessage.html#SoupMessage-got-body" title="The “got-body” signal"><span class="type">“got-body”</span></a>, -or else you can register a non-early handler for <em class="parameter"><code>path</code></em> - as well. As -long as you have not set the <a class="link" href="SoupMessage.html#SoupMessage--status-code" title="The “status-code” property"><span class="type">“status-code”</span></a> by the time -<a class="link" href="SoupMessage.html#SoupMessage-got-body" title="The “got-body” signal"><span class="type">“got-body”</span></a> is emitted, the non-early handler will be -run as well.</p> -<div class="refsect3"> -<a name="soup-server-add-early-handler.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>server</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>path</p></td> -<td class="parameter_description"><p>the toplevel path for the handler. </p></td> -<td class="parameter_annotations"><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 class="parameter_name"><p>callback</p></td> -<td class="parameter_description"><p>callback to invoke for requests under <em class="parameter"><code>path</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>data for <em class="parameter"><code>callback</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>destroy</p></td> -<td class="parameter_description"><p>destroy notifier to free <em class="parameter"><code>user_data</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-server-remove-handler"></a><h3>soup_server_remove_handler ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_server_remove_handler (<em class="parameter"><code><a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> *server</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *path</code></em>);</pre> -<p>Removes all handlers (early and normal) registered at <em class="parameter"><code>path</code></em> -.</p> -<div class="refsect3"> -<a name="soup-server-remove-handler.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>server</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>path</p></td> -<td class="parameter_description"><p>the toplevel path for the handler</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SoupServerWebsocketCallback"></a><h3>SoupServerWebsocketCallback ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -<span class="c_punctuation">(</span>*SoupServerWebsocketCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> *server</code></em>, - <em class="parameter"><code><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="type">SoupWebsocketConnection</span></a> *connection</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *path</code></em>, - <em class="parameter"><code><a class="link" href="SoupServer.html#SoupClientContext"><span class="type">SoupClientContext</span></a> *client</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> -<p>A callback used to handle WebSocket requests to a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a>. The -callback will be invoked after sending the handshake response back -to the client (and is only invoked if the handshake was -successful).</p> -<p><em class="parameter"><code>path</code></em> - contains the path of the Request-URI, subject to the same -rules as <a class="link" href="SoupServer.html#SoupServerCallback" title="SoupServerCallback ()"><span class="type">SoupServerCallback</span></a> (qv).</p> -<div class="refsect3"> -<a name="SoupServerWebsocketCallback.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>server</p></td> -<td class="parameter_description"><p>the <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>path</p></td> -<td class="parameter_description"><p>the path component of <em class="parameter"><code>msg</code></em> -'s Request-URI</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>connection</p></td> -<td class="parameter_description"><p>the newly created WebSocket connection</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>client</p></td> -<td class="parameter_description"><p>additional contextual information about the client</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>the data passed to <em class="parameter"><code>soup_server_add_handler</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-server-add-websocket-handler"></a><h3>soup_server_add_websocket_handler ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_server_add_websocket_handler (<em class="parameter"><code><a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> *server</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *path</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *origin</code></em>, - <em class="parameter"><code><span class="type">char</span> **protocols</code></em>, - <em class="parameter"><code><a class="link" href="SoupServer.html#SoupServerWebsocketCallback" title="SoupServerWebsocketCallback ()"><span class="type">SoupServerWebsocketCallback</span></a> callback</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>, - <em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>);</pre> -<p>Adds a WebSocket handler to <em class="parameter"><code>server</code></em> - for requests under <em class="parameter"><code>path</code></em> -. (If -<em class="parameter"><code>path</code></em> - is <code class="literal">NULL</code> or "/", then this will be the default handler for -all requests that don't have a more specific handler.)</p> -<p>When a path has a WebSocket handler registered, <em class="parameter"><code>server</code></em> - will check -incoming requests for WebSocket handshakes after all other handlers -have run (unless some earlier handler has already set a status code -on the message), and update the request's status, response headers, -and response body accordingly.</p> -<p>If <em class="parameter"><code>origin</code></em> - is non-<code class="literal">NULL</code>, then only requests containing a matching -"Origin" header will be accepted. If <em class="parameter"><code>protocols</code></em> - is non-<code class="literal">NULL</code>, then -only requests containing a compatible "Sec-WebSocket-Protocols" -header will be accepted. More complicated requirements can be -handled by adding a normal handler to <em class="parameter"><code>path</code></em> -, and having it perform -whatever checks are needed (possibly calling -<code class="function">soup_server_check_websocket_handshake()</code> one or more times), and -setting a failure status code if the handshake should be rejected.</p> -<div class="refsect3"> -<a name="soup-server-add-websocket-handler.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>server</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>path</p></td> -<td class="parameter_description"><p>the toplevel path for the handler. </p></td> -<td class="parameter_annotations"><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 class="parameter_name"><p>origin</p></td> -<td class="parameter_description"><p>the origin of the connection. </p></td> -<td class="parameter_annotations"><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 class="parameter_name"><p>protocols</p></td> -<td class="parameter_description"><p>the protocols -supported by this handler. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>callback</p></td> -<td class="parameter_description"><p>callback to invoke for successful WebSocket requests under <em class="parameter"><code>path</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>data for <em class="parameter"><code>callback</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>destroy</p></td> -<td class="parameter_description"><p>destroy notifier to free <em class="parameter"><code>user_data</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-client-context-get-local-address"></a><h3>soup_client_context_get_local_address ()</h3> -<pre class="programlisting"><span class="returnvalue">GSocketAddress</span> * -soup_client_context_get_local_address (<em class="parameter"><code><a class="link" href="SoupServer.html#SoupClientContext"><span class="type">SoupClientContext</span></a> *client</code></em>);</pre> -<p>Retrieves the <span class="type">GSocketAddress</span> associated with the local end -of a connection.</p> -<div class="refsect3"> -<a name="soup-client-context-get-local-address.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>client</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html#SoupClientContext"><span class="type">SoupClientContext</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-client-context-get-local-address.returns"></a><h4>Returns</h4> -<p>the <span class="type">GSocketAddress</span> -associated with the local end of a connection, it may be -<code class="literal">NULL</code> if you used <a class="link" href="SoupServer.html#soup-server-accept-iostream" title="soup_server_accept_iostream ()"><code class="function">soup_server_accept_iostream()</code></a>. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.48</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-client-context-get-remote-address"></a><h3>soup_client_context_get_remote_address ()</h3> -<pre class="programlisting"><span class="returnvalue">GSocketAddress</span> * -soup_client_context_get_remote_address - (<em class="parameter"><code><a class="link" href="SoupServer.html#SoupClientContext"><span class="type">SoupClientContext</span></a> *client</code></em>);</pre> -<p>Retrieves the <span class="type">GSocketAddress</span> associated with the remote end -of a connection.</p> -<div class="refsect3"> -<a name="soup-client-context-get-remote-address.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>client</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html#SoupClientContext"><span class="type">SoupClientContext</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-client-context-get-remote-address.returns"></a><h4>Returns</h4> -<p>the <span class="type">GSocketAddress</span> -associated with the remote end of a connection, it may be -<code class="literal">NULL</code> if you used <a class="link" href="SoupServer.html#soup-server-accept-iostream" title="soup_server_accept_iostream ()"><code class="function">soup_server_accept_iostream()</code></a>. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.48</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-client-context-get-host"></a><h3>soup_client_context_get_host ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -soup_client_context_get_host (<em class="parameter"><code><a class="link" href="SoupServer.html#SoupClientContext"><span class="type">SoupClientContext</span></a> *client</code></em>);</pre> -<p>Retrieves the IP address associated with the remote end of a -connection.</p> -<div class="refsect3"> -<a name="soup-client-context-get-host.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>client</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html#SoupClientContext"><span class="type">SoupClientContext</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-client-context-get-host.returns"></a><h4>Returns</h4> -<p>the IP address associated with the remote -end of a connection, it may be <code class="literal">NULL</code> if you used -<a class="link" href="SoupServer.html#soup-server-accept-iostream" title="soup_server_accept_iostream ()"><code class="function">soup_server_accept_iostream()</code></a>. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-client-context-get-auth-domain"></a><h3>soup_client_context_get_auth_domain ()</h3> -<pre class="programlisting"><a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="returnvalue">SoupAuthDomain</span></a> * -soup_client_context_get_auth_domain (<em class="parameter"><code><a class="link" href="SoupServer.html#SoupClientContext"><span class="type">SoupClientContext</span></a> *client</code></em>);</pre> -<p>Checks whether the request associated with <em class="parameter"><code>client</code></em> - has been -authenticated, and if so returns the <a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a> that -authenticated it.</p> -<div class="refsect3"> -<a name="soup-client-context-get-auth-domain.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>client</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html#SoupClientContext"><span class="type">SoupClientContext</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-client-context-get-auth-domain.returns"></a><h4>Returns</h4> -<p>a <a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a>, or -<code class="literal">NULL</code> if the request was not authenticated. </p> -<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-client-context-get-auth-user"></a><h3>soup_client_context_get_auth_user ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -soup_client_context_get_auth_user (<em class="parameter"><code><a class="link" href="SoupServer.html#SoupClientContext"><span class="type">SoupClientContext</span></a> *client</code></em>);</pre> -<p>Checks whether the request associated with <em class="parameter"><code>client</code></em> - has been -authenticated, and if so returns the username that the client -authenticated as.</p> -<div class="refsect3"> -<a name="soup-client-context-get-auth-user.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>client</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html#SoupClientContext"><span class="type">SoupClientContext</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-client-context-get-auth-user.returns"></a><h4>Returns</h4> -<p>the authenticated-as user, or <code class="literal">NULL</code> if -the request was not authenticated. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-client-context-get-gsocket"></a><h3>soup_client_context_get_gsocket ()</h3> -<pre class="programlisting"><span class="returnvalue">GSocket</span> * -soup_client_context_get_gsocket (<em class="parameter"><code><a class="link" href="SoupServer.html#SoupClientContext"><span class="type">SoupClientContext</span></a> *client</code></em>);</pre> -<p>Retrieves the <span class="type">GSocket</span> that <em class="parameter"><code>client</code></em> - is associated with.</p> -<p>If you are using this method to observe when multiple requests are -made on the same persistent HTTP connection (eg, as the ntlm-test -test program does), you will need to pay attention to socket -destruction as well (eg, by using weak references), so that you do -not get fooled when the allocator reuses the memory address of a -previously-destroyed socket to represent a new socket.</p> -<div class="refsect3"> -<a name="soup-client-context-get-gsocket.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>client</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html#SoupClientContext"><span class="type">SoupClientContext</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-client-context-get-gsocket.returns"></a><h4>Returns</h4> -<p>the <span class="type">GSocket</span> that <em class="parameter"><code>client</code></em> -is -associated with, <code class="literal">NULL</code> if you used <a class="link" href="SoupServer.html#soup-server-accept-iostream" title="soup_server_accept_iostream ()"><code class="function">soup_server_accept_iostream()</code></a>. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.48</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-client-context-steal-connection"></a><h3>soup_client_context_steal_connection ()</h3> -<pre class="programlisting"><span class="returnvalue">GIOStream</span> * -soup_client_context_steal_connection (<em class="parameter"><code><a class="link" href="SoupServer.html#SoupClientContext"><span class="type">SoupClientContext</span></a> *client</code></em>);</pre> -<p>"Steals" the HTTP connection associated with <em class="parameter"><code>client</code></em> - from its -<a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a>. This happens immediately, regardless of the current -state of the connection; if the response to the current -<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> has not yet finished being sent, then it will be -discarded; you can steal the connection from a -<span class="type">“wrote-informational”</span> or <span class="type">“wrote-body”</span> signal -handler if you need to wait for part or all of the response to be -sent.</p> -<p>Note that when calling this function from C, <em class="parameter"><code>client</code></em> - will most -likely be freed as a side effect.</p> -<div class="refsect3"> -<a name="soup-client-context-steal-connection.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>client</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html#SoupClientContext"><span class="type">SoupClientContext</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-client-context-steal-connection.returns"></a><h4>Returns</h4> -<p>the <span class="type">GIOStream</span> formerly associated -with <em class="parameter"><code>client</code></em> -(or <code class="literal">NULL</code> if <em class="parameter"><code>client</code></em> -was no longer associated with a -connection). No guarantees are made about what kind of <span class="type">GIOStream</span> -is returned. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-server-add-auth-domain"></a><h3>soup_server_add_auth_domain ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_server_add_auth_domain (<em class="parameter"><code><a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> *server</code></em>, - <em class="parameter"><code><a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a> *auth_domain</code></em>);</pre> -<p>Adds an authentication domain to <em class="parameter"><code>server</code></em> -. Each auth domain will -have the chance to require authentication for each request that -comes in; normally auth domains will require authentication for -requests on certain paths that they have been set up to watch, or -that meet other criteria set by the caller. If an auth domain -determines that a request requires authentication (and the request -doesn't contain authentication), <em class="parameter"><code>server</code></em> - will automatically reject -the request with an appropriate status (401 Unauthorized or 407 -Proxy Authentication Required). If the request used the -"100-continue" Expectation, <em class="parameter"><code>server</code></em> - will reject it before the -request body is sent.</p> -<div class="refsect3"> -<a name="soup-server-add-auth-domain.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>server</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>auth_domain</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-server-remove-auth-domain"></a><h3>soup_server_remove_auth_domain ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_server_remove_auth_domain (<em class="parameter"><code><a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> *server</code></em>, - <em class="parameter"><code><a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a> *auth_domain</code></em>);</pre> -<p>Removes <em class="parameter"><code>auth_domain</code></em> - from <em class="parameter"><code>server</code></em> -.</p> -<div class="refsect3"> -<a name="soup-server-remove-auth-domain.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>server</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>auth_domain</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-server-pause-message"></a><h3>soup_server_pause_message ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_server_pause_message (<em class="parameter"><code><a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> *server</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>);</pre> -<p>Pauses I/O on <em class="parameter"><code>msg</code></em> -. This can be used when you need to return from -the server handler without having the full response ready yet. Use -<a class="link" href="SoupServer.html#soup-server-unpause-message" title="soup_server_unpause_message ()"><code class="function">soup_server_unpause_message()</code></a> to resume I/O.</p> -<p>This must only be called on <a href="SoupMessage.html#SoupMessage-struct"><span class="type">SoupMessages</span></a> which were created by the -<a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> and are currently doing I/O, such as those passed into a -<a class="link" href="SoupServer.html#SoupServerCallback" title="SoupServerCallback ()"><span class="type">SoupServerCallback</span></a> or emitted in a <a class="link" href="SoupServer.html#SoupServer-request-read" title="The “request-read” signal"><span class="type">“request-read”</span></a> signal.</p> -<div class="refsect3"> -<a name="soup-server-pause-message.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>server</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> associated with <em class="parameter"><code>server</code></em> -.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-server-unpause-message"></a><h3>soup_server_unpause_message ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_server_unpause_message (<em class="parameter"><code><a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> *server</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>);</pre> -<p>Resumes I/O on <em class="parameter"><code>msg</code></em> -. Use this to resume after calling -<a class="link" href="SoupServer.html#soup-server-pause-message" title="soup_server_pause_message ()"><code class="function">soup_server_pause_message()</code></a>, or after adding a new chunk to a -chunked response.</p> -<p>I/O won't actually resume until you return to the main loop.</p> -<p>This must only be called on <a href="SoupMessage.html#SoupMessage-struct"><span class="type">SoupMessages</span></a> which were created by the -<a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> and are currently doing I/O, such as those passed into a -<a class="link" href="SoupServer.html#SoupServerCallback" title="SoupServerCallback ()"><span class="type">SoupServerCallback</span></a> or emitted in a <a class="link" href="SoupServer.html#SoupServer-request-read" title="The “request-read” signal"><span class="type">“request-read”</span></a> signal.</p> -<div class="refsect3"> -<a name="soup-server-unpause-message.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>server</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> associated with <em class="parameter"><code>server</code></em> -.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -</div> -<div class="refsect1"> -<a name="SoupServer.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupServer-struct"></a><h3>SoupServer</h3> -<pre class="programlisting">typedef struct _SoupServer SoupServer;</pre> -</div> -<hr> -<div class="refsect2"> -<a name="SoupServerListenOptions"></a><h3>enum SoupServerListenOptions</h3> -<p>Options to pass to <a class="link" href="SoupServer.html#soup-server-listen" title="soup_server_listen ()"><code class="function">soup_server_listen()</code></a>, etc.</p> -<p><a class="link" href="SoupServer.html#SOUP-SERVER-LISTEN-IPV4-ONLY:CAPS"><code class="literal">SOUP_SERVER_LISTEN_IPV4_ONLY</code></a> and <a class="link" href="SoupServer.html#SOUP-SERVER-LISTEN-IPV6-ONLY:CAPS"><code class="literal">SOUP_SERVER_LISTEN_IPV6_ONLY</code></a> -only make sense with <a class="link" href="SoupServer.html#soup-server-listen-all" title="soup_server_listen_all ()"><code class="function">soup_server_listen_all()</code></a> and -<a class="link" href="SoupServer.html#soup-server-listen-local" title="soup_server_listen_local ()"><code class="function">soup_server_listen_local()</code></a>, not plain <a class="link" href="SoupServer.html#soup-server-listen" title="soup_server_listen ()"><code class="function">soup_server_listen()</code></a> (which -simply listens on whatever kind of socket you give it). And you -cannot specify both of them in a single call.</p> -<div class="refsect3"> -<a name="SoupServerListenOptions.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="enum_members_name"> -<col class="enum_members_description"> -<col width="200px" class="enum_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="enum_member_name"><p><a name="SOUP-SERVER-LISTEN-HTTPS:CAPS"></a>SOUP_SERVER_LISTEN_HTTPS</p></td> -<td class="enum_member_description"> -<p>Listen for https connections rather - than plain http.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-SERVER-LISTEN-IPV4-ONLY:CAPS"></a>SOUP_SERVER_LISTEN_IPV4_ONLY</p></td> -<td class="enum_member_description"> -<p>Only listen on IPv4 interfaces.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-SERVER-LISTEN-IPV6-ONLY:CAPS"></a>SOUP_SERVER_LISTEN_IPV6_ONLY</p></td> -<td class="enum_member_description"> -<p>Only listen on IPv6 interfaces.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.48</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupClientContext"></a><h3>SoupClientContext</h3> -<pre class="programlisting">typedef struct SoupClientContext SoupClientContext; -</pre> -<p>A <a class="link" href="SoupServer.html#SoupClientContext"><span class="type">SoupClientContext</span></a> provides additional information about the -client making a particular request. In particular, you can use -<a class="link" href="SoupServer.html#soup-client-context-get-auth-domain" title="soup_client_context_get_auth_domain ()"><code class="function">soup_client_context_get_auth_domain()</code></a> and -<a class="link" href="SoupServer.html#soup-client-context-get-auth-user" title="soup_client_context_get_auth_user ()"><code class="function">soup_client_context_get_auth_user()</code></a> to determine if HTTP -authentication was used successfully.</p> -<p>soup_client_context_get_remote_address() and/or -<a class="link" href="SoupServer.html#soup-client-context-get-host" title="soup_client_context_get_host ()"><code class="function">soup_client_context_get_host()</code></a> can be used to get information for -logging or debugging purposes. <a class="link" href="SoupServer.html#soup-client-context-get-gsocket" title="soup_client_context_get_gsocket ()"><code class="function">soup_client_context_get_gsocket()</code></a> may -also be of use in some situations (eg, tracking when multiple -requests are made on the same connection).</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SERVER-TLS-CERTIFICATE:CAPS"></a><h3>SOUP_SERVER_TLS_CERTIFICATE</h3> -<pre class="programlisting">#define SOUP_SERVER_TLS_CERTIFICATE "tls-certificate" -</pre> -<p>Alias for the <a class="link" href="SoupServer.html#SoupServer--tls-certificate" title="The “tls-certificate” property"><span class="type">“tls-certificate”</span></a> property, qv.</p> -<p class="since">Since: 2.38</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SERVER-RAW-PATHS:CAPS"></a><h3>SOUP_SERVER_RAW_PATHS</h3> -<pre class="programlisting">#define SOUP_SERVER_RAW_PATHS "raw-paths" -</pre> -<p>Alias for the <a class="link" href="SoupServer.html#SoupServer--raw-paths" title="The “raw-paths” property"><span class="type">“raw-paths”</span></a> property. (If <code class="literal">TRUE</code>, -percent-encoding in the Request-URI path will not be -automatically decoded.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SERVER-SERVER-HEADER:CAPS"></a><h3>SOUP_SERVER_SERVER_HEADER</h3> -<pre class="programlisting">#define SOUP_SERVER_SERVER_HEADER "server-header" -</pre> -<p>Alias for the <a class="link" href="SoupServer.html#SoupServer--server-header" title="The “server-header” property"><span class="type">“server-header”</span></a> property, qv.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SERVER-HTTP-ALIASES:CAPS"></a><h3>SOUP_SERVER_HTTP_ALIASES</h3> -<pre class="programlisting">#define SOUP_SERVER_HTTP_ALIASES "http-aliases" -</pre> -<p>Alias for the <a class="link" href="SoupServer.html#SoupServer--http-aliases" title="The “http-aliases” property"><span class="type">“http-aliases”</span></a> property, qv.</p> -<p class="since">Since: 2.44</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SERVER-HTTPS-ALIASES:CAPS"></a><h3>SOUP_SERVER_HTTPS_ALIASES</h3> -<pre class="programlisting">#define SOUP_SERVER_HTTPS_ALIASES "https-aliases" -</pre> -<p>Alias for the <a class="link" href="SoupServer.html#SoupServer--https-aliases" title="The “https-aliases” property"><span class="type">“https-aliases”</span></a> property, qv.</p> -<p class="since">Since: 2.44</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupServer.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> -<a name="SoupServer--async-context"></a><h3>The <code class="literal">“async-context”</code> property</h3> -<pre class="programlisting"> “async-context” <span class="type">gpointer</span></pre> -<p>The server's <span class="type">GMainContext</span>, if you are using the old API. -Servers created using <a class="link" href="SoupServer.html#soup-server-listen" title="soup_server_listen ()"><code class="function">soup_server_listen()</code></a> will listen on -the <span class="type">GMainContext</span> that was the thread-default context at -the time <a class="link" href="SoupServer.html#soup-server-listen" title="soup_server_listen ()"><code class="function">soup_server_listen()</code></a> was called.</p> -<div class="warning"> -<p><code class="literal">SoupServer:async-context</code> is deprecated and should not be used in newly-written code.</p> -<p>The new API uses the thread-default <span class="type">GMainContext</span> -rather than having an explicitly-specified one.</p> -</div> -<p>Flags: Read / Write / Construct Only</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupServer--http-aliases"></a><h3>The <code class="literal">“http-aliases”</code> property</h3> -<pre class="programlisting"> “http-aliases” <span class="type">GStrv</span></pre> -<p>A <code class="literal">NULL</code>-terminated array of URI schemes that should be -considered to be aliases for "http". Eg, if this included -<code class="literal">"dav"</code>, than a URI of -<code class="literal">dav://example.com/path</code> would be treated -identically to <code class="literal">http://example.com/path</code>. -In particular, this is needed in cases where a client -sends requests with absolute URIs, where those URIs do -not use "http:".</p> -<p>The default value is an array containing the single element -<code class="literal">"*"</code>, a special value which means that -any scheme except "https" is considered to be an alias for -"http".</p> -<p>See also <a class="link" href="SoupServer.html#SoupServer--https-aliases" title="The “https-aliases” property"><span class="type">“https-aliases”</span></a>.</p> -<p>Flags: Read / Write</p> -<p class="since">Since: 2.44</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupServer--https-aliases"></a><h3>The <code class="literal">“https-aliases”</code> property</h3> -<pre class="programlisting"> “https-aliases” <span class="type">GStrv</span></pre> -<p>A comma-delimited list of URI schemes that should be -considered to be aliases for "https". See -<a class="link" href="SoupServer.html#SoupServer--http-aliases" title="The “http-aliases” property"><span class="type">“http-aliases”</span></a> for more information.</p> -<p>The default value is <code class="literal">NULL</code>, meaning that no URI schemes -are considered aliases for "https".</p> -<p>Flags: Read / Write</p> -<p class="since">Since: 2.44</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupServer--interface"></a><h3>The <code class="literal">“interface”</code> property</h3> -<pre class="programlisting"> “interface” <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> *</pre> -<p>The address of the network interface the server is -listening on, if you are using the old <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> API. -(This will not be set if you use <a class="link" href="SoupServer.html#soup-server-listen" title="soup_server_listen ()"><code class="function">soup_server_listen()</code></a>, -etc.)</p> -<div class="warning"> -<p><code class="literal">SoupServer:interface</code> is deprecated and should not be used in newly-written code.</p> -<p><a href="SoupServer.html#SoupServer-struct"><span class="type">SoupServers</span></a> can listen on multiple interfaces -at once now. Use <a class="link" href="SoupServer.html#soup-server-listen" title="soup_server_listen ()"><code class="function">soup_server_listen()</code></a>, etc, to listen on an -interface, and <a class="link" href="SoupServer.html#soup-server-get-uris" title="soup_server_get_uris ()"><code class="function">soup_server_get_uris()</code></a> to see what addresses -are being listened on.</p> -</div> -<p>Flags: Read / Write / Construct Only</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupServer--port"></a><h3>The <code class="literal">“port”</code> property</h3> -<pre class="programlisting"> “port” <span class="type">guint</span></pre> -<p>The port the server is listening on, if you are using the -old <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> API. (This will not be set if you use -<a class="link" href="SoupServer.html#soup-server-listen" title="soup_server_listen ()"><code class="function">soup_server_listen()</code></a>, etc.)</p> -<div class="warning"> -<p><code class="literal">SoupServer:port</code> is deprecated and should not be used in newly-written code.</p> -<p><a href="SoupServer.html#SoupServer-struct"><span class="type">SoupServers</span></a> can listen on multiple interfaces -at once now. Use <a class="link" href="SoupServer.html#soup-server-listen" title="soup_server_listen ()"><code class="function">soup_server_listen()</code></a>, etc, to listen on a -port, and <a class="link" href="SoupServer.html#soup-server-get-uris" title="soup_server_get_uris ()"><code class="function">soup_server_get_uris()</code></a> to see what ports are -being listened on.</p> -</div> -<p>Flags: Read / Write / Construct Only</p> -<p>Allowed values: <= 65536</p> -<p>Default value: 0</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupServer--raw-paths"></a><h3>The <code class="literal">“raw-paths”</code> property</h3> -<pre class="programlisting"> “raw-paths” <span class="type">gboolean</span></pre> -<p>If %TRUE, percent-encoding in the Request-URI path will not be automatically decoded.</p> -<p>Flags: Read / Write / Construct Only</p> -<p>Default value: FALSE</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupServer--server-header"></a><h3>The <code class="literal">“server-header”</code> property</h3> -<pre class="programlisting"> “server-header” <span class="type">gchar</span> *</pre> -<p>If non-<code class="literal">NULL</code>, the value to use for the "Server" header on -<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>s processed by this server.</p> -<p>The Server header is the server equivalent of the -User-Agent header, and provides information about the -server and its components. It contains a list of one or -more product tokens, separated by whitespace, with the most -significant product token coming first. The tokens must be -brief, ASCII, and mostly alphanumeric (although "-", "_", -and "." are also allowed), and may optionally include a "/" -followed by a version string. You may also put comments, -enclosed in parentheses, between or after the tokens.</p> -<p>Some HTTP server implementations intentionally do not use -version numbers in their Server header, so that -installations running older versions of the server don't -end up advertising their vulnerability to specific security -holes.</p> -<p>As with <a class="link" href="SoupSession.html#SoupSession--user-agent" title="The “user-agent” property"><span class="type">“user_agent”</span></a>, if you set a -<a class="link" href="SoupServer.html#SoupServer--server-header" title="The “server-header” property"><span class="type">“server_header”</span></a> property that has trailing whitespace, -<a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> will append its own product token (eg, -"<code class="literal">libsoup/2.3.2</code>") to the end of the -header for you.</p> -<p>Flags: Read / Write / Construct</p> -<p>Default value: NULL</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupServer--ssl-cert-file"></a><h3>The <code class="literal">“ssl-cert-file”</code> property</h3> -<pre class="programlisting"> “ssl-cert-file” <span class="type">gchar</span> *</pre> -<p>Path to a file containing a PEM-encoded certificate.</p> -<p>If you set this property and <a class="link" href="SoupServer.html#SoupServer--ssl-key-file" title="The “ssl-key-file” property"><span class="type">“ssl-key-file”</span></a> at -construct time, then <a class="link" href="SoupServer.html#soup-server-new" title="soup_server_new ()"><code class="function">soup_server_new()</code></a> will try to read the -files; if it cannot, it will return <code class="literal">NULL</code>, with no explicit -indication of what went wrong (and logging a warning with -newer versions of glib, since returning <code class="literal">NULL</code> from a -constructor is illegal).</p> -<div class="warning"> -<p><code class="literal">SoupServer:ssl-cert-file</code> is deprecated and should not be used in newly-written code.</p> -<p>use <a class="link" href="SoupServer.html#SoupServer--tls-certificate" title="The “tls-certificate” property"><span class="type">“tls-certificate”</span></a> or -<code class="function">soup_server_set_ssl_certificate()</code>.</p> -</div> -<p>Flags: Read / Write / Construct Only</p> -<p>Default value: NULL</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupServer--ssl-key-file"></a><h3>The <code class="literal">“ssl-key-file”</code> property</h3> -<pre class="programlisting"> “ssl-key-file” <span class="type">gchar</span> *</pre> -<p>Path to a file containing a PEM-encoded private key. See -<a class="link" href="SoupServer.html#SoupServer--ssl-cert-file" title="The “ssl-cert-file” property"><span class="type">“ssl-cert-file”</span></a> for more information about how this -is used.</p> -<div class="warning"> -<p><code class="literal">SoupServer:ssl-key-file</code> is deprecated and should not be used in newly-written code.</p> -<p>use <a class="link" href="SoupServer.html#SoupServer--tls-certificate" title="The “tls-certificate” property"><span class="type">“tls-certificate”</span></a> or -<code class="function">soup_server_set_ssl_certificate()</code>.</p> -</div> -<p>Flags: Read / Write / Construct Only</p> -<p>Default value: NULL</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupServer--tls-certificate"></a><h3>The <code class="literal">“tls-certificate”</code> property</h3> -<pre class="programlisting"> “tls-certificate” <span class="type">GTlsCertificate</span> *</pre> -<p>A <span class="type">GTlsCertificate</span> that has a <span class="type">“private-key”</span> -set. If this is set, then the server will be able to speak -https in addition to (or instead of) plain http.</p> -<p>Alternatively, you can call <a class="link" href="SoupServer.html#soup-server-set-ssl-cert-file" title="soup_server_set_ssl_cert_file ()"><code class="function">soup_server_set_ssl_cert_file()</code></a> -to have <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> read in a a certificate from a file.</p> -<p>Flags: Read / Write / Construct Only</p> -<p class="since">Since: 2.38</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupServer.signal-details"></a><h2>Signal Details</h2> -<div class="refsect2"> -<a name="SoupServer-request-aborted"></a><h3>The <code class="literal">“request-aborted”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> *server, - <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *message, - <a class="link" href="SoupServer.html#SoupClientContext"><span class="type">SoupClientContext</span></a> *client, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted when processing has failed for a message; this -could mean either that it could not be read (if -<a class="link" href="SoupServer.html#SoupServer-request-read" title="The “request-read” signal"><span class="type">“request_read”</span></a> has not been emitted for it yet), -or that the response could not be written back (if -<a class="link" href="SoupServer.html#SoupServer-request-read" title="The “request-read” signal"><span class="type">“request_read”</span></a> has been emitted but -<a class="link" href="SoupServer.html#SoupServer-request-finished" title="The “request-finished” signal"><span class="type">“request_finished”</span></a> has not been).</p> -<p><em class="parameter"><code>message</code></em> - is in an undefined state when this signal is -emitted; the signal exists primarily to allow the server to -free any state that it may have allocated in -<a class="link" href="SoupServer.html#SoupServer-request-started" title="The “request-started” signal"><span class="type">“request_started”</span></a>.</p> -<div class="refsect3"> -<a name="SoupServer-request-aborted.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>server</p></td> -<td class="parameter_description"><p>the server</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>message</p></td> -<td class="parameter_description"><p>the message</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>client</p></td> -<td class="parameter_description"><p>the client context</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run First</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupServer-request-finished"></a><h3>The <code class="literal">“request-finished”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> *server, - <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *message, - <a class="link" href="SoupServer.html#SoupClientContext"><span class="type">SoupClientContext</span></a> *client, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted when the server has finished writing a response to -a request.</p> -<div class="refsect3"> -<a name="SoupServer-request-finished.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>server</p></td> -<td class="parameter_description"><p>the server</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>message</p></td> -<td class="parameter_description"><p>the message</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>client</p></td> -<td class="parameter_description"><p>the client context</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run First</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupServer-request-read"></a><h3>The <code class="literal">“request-read”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> *server, - <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *message, - <a class="link" href="SoupServer.html#SoupClientContext"><span class="type">SoupClientContext</span></a> *client, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted when the server has successfully read a request. -<em class="parameter"><code>message</code></em> - will have all of its request-side information -filled in, and if the message was authenticated, <em class="parameter"><code>client</code></em> - -will have information about that. This signal is emitted -before any (non-early) handlers are called for the message, -and if it sets the message's <span class="type">status_code</span>, then normal -handler processing will be skipped.</p> -<div class="refsect3"> -<a name="SoupServer-request-read.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>server</p></td> -<td class="parameter_description"><p>the server</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>message</p></td> -<td class="parameter_description"><p>the message</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>client</p></td> -<td class="parameter_description"><p>the client context</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run First</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupServer-request-started"></a><h3>The <code class="literal">“request-started”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> *server, - <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *message, - <a class="link" href="SoupServer.html#SoupClientContext"><span class="type">SoupClientContext</span></a> *client, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted when the server has started reading a new request. -<em class="parameter"><code>message</code></em> - will be completely blank; not even the -Request-Line will have been read yet. About the only thing -you can usefully do with it is connect to its signals.</p> -<p>If the request is read successfully, this will eventually -be followed by a <a class="link" href="SoupServer.html#SoupServer-request-read" title="The “request-read” signal"><span class="type">“request_read”</span></a> signal. If a -response is then sent, the request processing will end with -a <a class="link" href="SoupServer.html#SoupServer-request-finished" title="The “request-finished” signal"><span class="type">“request_finished”</span></a> signal. If a network error -occurs, the processing will instead end with -<a class="link" href="SoupServer.html#SoupServer-request-aborted" title="The “request-aborted” signal"><span class="type">“request_aborted”</span></a>.</p> -<div class="refsect3"> -<a name="SoupServer-request-started.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>server</p></td> -<td class="parameter_description"><p>the server</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>message</p></td> -<td class="parameter_description"><p>the new message</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>client</p></td> -<td class="parameter_description"><p>the client context</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run First</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupServer.see-also"></a><h2>See Also</h2> -<p><a class="link" href="SoupAuthDomain.html" title="SoupAuthDomain"><span class="type">SoupAuthDomain</span></a></p> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/SoupSession.html b/docs/reference/html/SoupSession.html deleted file mode 100644 index 29bb00a7..00000000 --- a/docs/reference/html/SoupSession.html +++ /dev/null @@ -1,3208 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SoupSession: 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="ch02.html" title="Core API"> -<link rel="prev" href="libsoup-2.4-SoupServer-deprecated-API.html" title="SoupServer deprecated API"> -<link rel="next" href="SoupSessionAsync.html" title="SoupSessionAsync"> -<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="#SoupSession.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupSession.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> - <a href="#SoupSession.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> - <a href="#SoupSession.signals" class="shortcut">Signals</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="libsoup-2.4-SoupServer-deprecated-API.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="SoupSessionAsync.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="SoupSession"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="SoupSession.top_of_page"></a>SoupSession</span></h2> -<p>SoupSession — Soup session state object</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="SoupSession.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="SoupSession.html" title="SoupSession"><span class="returnvalue">SoupSession</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-new" title="soup_session_new ()">soup_session_new</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupSession.html" title="SoupSession"><span class="returnvalue">SoupSession</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-new-with-options" title="soup_session_new_with_options ()">soup_session_new_with_options</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupRequest.html" title="SoupRequest"><span class="returnvalue">SoupRequest</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-request" title="soup_session_request ()">soup_session_request</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupRequest.html" title="SoupRequest"><span class="returnvalue">SoupRequest</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-request-uri" title="soup_session_request_uri ()">soup_session_request_uri</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupRequestHTTP.html" title="SoupRequestHTTP"><span class="returnvalue">SoupRequestHTTP</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-request-http" title="soup_session_request_http ()">soup_session_request_http</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupRequestHTTP.html" title="SoupRequestHTTP"><span class="returnvalue">SoupRequestHTTP</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-request-http-uri" title="soup_session_request_http_uri ()">soup_session_request_http_uri</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<span class="c_punctuation">(</span><a class="link" href="SoupSession.html#SoupSessionCallback" title="SoupSessionCallback ()">*SoupSessionCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-queue-message" title="soup_session_queue_message ()">soup_session_queue_message</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-requeue-message" title="soup_session_requeue_message ()">soup_session_requeue_message</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">guint</span> -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-send-message" title="soup_session_send_message ()">soup_session_send_message</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-cancel-message" title="soup_session_cancel_message ()">soup_session_cancel_message</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GInputStream</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-send" title="soup_session_send ()">soup_session_send</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-send-async" title="soup_session_send_async ()">soup_session_send_async</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GInputStream</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-send-finish" title="soup_session_send_finish ()">soup_session_send_finish</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-websocket-connect-async" title="soup_session_websocket_connect_async ()">soup_session_websocket_connect_async</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="returnvalue">SoupWebsocketConnection</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-websocket-connect-finish" title="soup_session_websocket_connect_finish ()">soup_session_websocket_connect_finish</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-prefetch-dns" title="soup_session_prefetch_dns ()">soup_session_prefetch_dns</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-abort" title="soup_session_abort ()">soup_session_abort</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-would-redirect" title="soup_session_would_redirect ()">soup_session_would_redirect</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-redirect-message" title="soup_session_redirect_message ()">soup_session_redirect_message</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-pause-message" title="soup_session_pause_message ()">soup_session_pause_message</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-unpause-message" title="soup_session_unpause_message ()">soup_session_unpause_message</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GMainContext</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-get-async-context" title="soup_session_get_async_context ()">soup_session_get_async_context</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-add-feature" title="soup_session_add_feature ()">soup_session_add_feature</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-add-feature-by-type" title="soup_session_add_feature_by_type ()">soup_session_add_feature_by_type</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-remove-feature" title="soup_session_remove_feature ()">soup_session_remove_feature</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-remove-feature-by-type" title="soup_session_remove_feature_by_type ()">soup_session_remove_feature_by_type</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GSList</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-get-features" title="soup_session_get_features ()">soup_session_get_features</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature"><span class="returnvalue">SoupSessionFeature</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-get-feature" title="soup_session_get_feature ()">soup_session_get_feature</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature"><span class="returnvalue">SoupSessionFeature</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-get-feature-for-message" title="soup_session_get_feature_for_message ()">soup_session_get_feature_for_message</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-has-feature" title="soup_session_has_feature ()">soup_session_has_feature</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GIOStream</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-steal-connection" title="soup_session_steal_connection ()">soup_session_steal_connection</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<span class="c_punctuation">(</span><a class="link" href="SoupSession.html#SoupSessionConnectProgressCallback" title="SoupSessionConnectProgressCallback ()">*SoupSessionConnectProgressCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-connect-async" title="soup_session_connect_async ()">soup_session_connect_async</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GIOStream</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupSession.html#soup-session-connect-finish" title="soup_session_connect_finish ()">soup_session_connect_finish</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupSession.properties"></a><h2>Properties</h2> -<div class="informaltable"><table class="informaltable" border="0"> -<colgroup> -<col width="150px" class="properties_type"> -<col width="300px" class="properties_name"> -<col width="200px" class="properties_flags"> -</colgroup> -<tbody> -<tr> -<td class="property_type"> -<span class="type">gchar</span> *</td> -<td class="property_name"><a class="link" href="SoupSession.html#SoupSession--accept-language" title="The “accept-language” property">accept-language</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><span class="type">gboolean</span></td> -<td class="property_name"><a class="link" href="SoupSession.html#SoupSession--accept-language-auto" title="The “accept-language-auto” property">accept-language-auto</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature"><span class="type">SoupSessionFeature</span></a> *</td> -<td class="property_name"><a class="link" href="SoupSession.html#SoupSession--add-feature" title="The “add-feature” property">add-feature</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">GType</span> *</td> -<td class="property_name"><a class="link" href="SoupSession.html#SoupSession--add-feature-by-type" title="The “add-feature-by-type” property">add-feature-by-type</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><span class="type">gpointer</span></td> -<td class="property_name"><a class="link" href="SoupSession.html#SoupSession--async-context" title="The “async-context” property">async-context</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -<tr> -<td class="property_type"><span class="type">GStrv</span></td> -<td class="property_name"><a class="link" href="SoupSession.html#SoupSession--http-aliases" title="The “http-aliases” property">http-aliases</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><span class="type">GStrv</span></td> -<td class="property_name"><a class="link" href="SoupSession.html#SoupSession--https-aliases" title="The “https-aliases” property">https-aliases</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><span class="type">guint</span></td> -<td class="property_name"><a class="link" href="SoupSession.html#SoupSession--idle-timeout" title="The “idle-timeout” property">idle-timeout</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> *</td> -<td class="property_name"><a class="link" href="SoupSession.html#SoupSession--local-address" title="The “local-address” property">local-address</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -<tr> -<td class="property_type"><span class="type">gint</span></td> -<td class="property_name"><a class="link" href="SoupSession.html#SoupSession--max-conns" title="The “max-conns” property">max-conns</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><span class="type">gint</span></td> -<td class="property_name"><a class="link" href="SoupSession.html#SoupSession--max-conns-per-host" title="The “max-conns-per-host” property">max-conns-per-host</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">GProxyResolver</span> *</td> -<td class="property_name"><a class="link" href="SoupSession.html#SoupSession--proxy-resolver" title="The “proxy-resolver” property">proxy-resolver</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *</td> -<td class="property_name"><a class="link" href="SoupSession.html#SoupSession--proxy-uri" title="The “proxy-uri” property">proxy-uri</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">GType</span> *</td> -<td class="property_name"><a class="link" href="SoupSession.html#SoupSession--remove-feature-by-type" title="The “remove-feature-by-type” property">remove-feature-by-type</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">gchar</span> *</td> -<td class="property_name"><a class="link" href="SoupSession.html#SoupSession--ssl-ca-file" title="The “ssl-ca-file” property">ssl-ca-file</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><span class="type">gboolean</span></td> -<td class="property_name"><a class="link" href="SoupSession.html#SoupSession--ssl-strict" title="The “ssl-strict” property">ssl-strict</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><span class="type">gboolean</span></td> -<td class="property_name"><a class="link" href="SoupSession.html#SoupSession--ssl-use-system-ca-file" title="The “ssl-use-system-ca-file” property">ssl-use-system-ca-file</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><span class="type">guint</span></td> -<td class="property_name"><a class="link" href="SoupSession.html#SoupSession--timeout" title="The “timeout” property">timeout</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">GTlsDatabase</span> *</td> -<td class="property_name"><a class="link" href="SoupSession.html#SoupSession--tls-database" title="The “tls-database” property">tls-database</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">GTlsInteraction</span> *</td> -<td class="property_name"><a class="link" href="SoupSession.html#SoupSession--tls-interaction" title="The “tls-interaction” property">tls-interaction</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><span class="type">gboolean</span></td> -<td class="property_name"><a class="link" href="SoupSession.html#SoupSession--use-ntlm" title="The “use-ntlm” property">use-ntlm</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><span class="type">gboolean</span></td> -<td class="property_name"><a class="link" href="SoupSession.html#SoupSession--use-thread-context" title="The “use-thread-context” property">use-thread-context</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">gchar</span> *</td> -<td class="property_name"><a class="link" href="SoupSession.html#SoupSession--user-agent" title="The “user-agent” property">user-agent</a></td> -<td class="property_flags">Read / Write</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupSession.signals"></a><h2>Signals</h2> -<div class="informaltable"><table class="informaltable" border="0"> -<colgroup> -<col width="150px" class="signals_return"> -<col width="300px" class="signals_name"> -<col width="200px" class="signals_flags"> -</colgroup> -<tbody> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="SoupSession.html#SoupSession-authenticate" title="The “authenticate” signal">authenticate</a></td> -<td class="signal_flags">Run First</td> -</tr> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="SoupSession.html#SoupSession-connection-created" title="The “connection-created” signal">connection-created</a></td> -<td class="signal_flags">Run First</td> -</tr> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="SoupSession.html#SoupSession-request-queued" title="The “request-queued” signal">request-queued</a></td> -<td class="signal_flags">Run First</td> -</tr> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="SoupSession.html#SoupSession-request-started" title="The “request-started” signal">request-started</a></td> -<td class="signal_flags">Run First</td> -</tr> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="SoupSession.html#SoupSession-request-unqueued" title="The “request-unqueued” signal">request-unqueued</a></td> -<td class="signal_flags">Run First</td> -</tr> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="SoupSession.html#SoupSession-tunneling" title="The “tunneling” signal">tunneling</a></td> -<td class="signal_flags">Run First</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupSession.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="SoupSession.html#SoupSession-struct" title="SoupSession">SoupSession</a></td> -</tr> -<tr> -<td class="datatype_keyword">enum</td> -<td class="function_name"><a class="link" href="SoupSession.html#SoupRequestError" title="enum SoupRequestError">SoupRequestError</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSession.html#SOUP-REQUEST-ERROR:CAPS" title="SOUP_REQUEST_ERROR">SOUP_REQUEST_ERROR</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSession.html#SOUP-SESSION-PROXY-URI:CAPS" title="SOUP_SESSION_PROXY_URI">SOUP_SESSION_PROXY_URI</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSession.html#SOUP-SESSION-PROXY-RESOLVER:CAPS" title="SOUP_SESSION_PROXY_RESOLVER">SOUP_SESSION_PROXY_RESOLVER</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSession.html#SOUP-SESSION-MAX-CONNS:CAPS" title="SOUP_SESSION_MAX_CONNS">SOUP_SESSION_MAX_CONNS</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSession.html#SOUP-SESSION-MAX-CONNS-PER-HOST:CAPS" title="SOUP_SESSION_MAX_CONNS_PER_HOST">SOUP_SESSION_MAX_CONNS_PER_HOST</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSession.html#SOUP-SESSION-TLS-DATABASE:CAPS" title="SOUP_SESSION_TLS_DATABASE">SOUP_SESSION_TLS_DATABASE</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSession.html#SOUP-SESSION-SSL-USE-SYSTEM-CA-FILE:CAPS" title="SOUP_SESSION_SSL_USE_SYSTEM_CA_FILE">SOUP_SESSION_SSL_USE_SYSTEM_CA_FILE</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSession.html#SOUP-SESSION-SSL-CA-FILE:CAPS" title="SOUP_SESSION_SSL_CA_FILE">SOUP_SESSION_SSL_CA_FILE</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSession.html#SOUP-SESSION-SSL-STRICT:CAPS" title="SOUP_SESSION_SSL_STRICT">SOUP_SESSION_SSL_STRICT</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSession.html#SOUP-SESSION-TLS-INTERACTION:CAPS" title="SOUP_SESSION_TLS_INTERACTION">SOUP_SESSION_TLS_INTERACTION</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSession.html#SOUP-SESSION-ASYNC-CONTEXT:CAPS" title="SOUP_SESSION_ASYNC_CONTEXT">SOUP_SESSION_ASYNC_CONTEXT</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSession.html#SOUP-SESSION-USE-THREAD-CONTEXT:CAPS" title="SOUP_SESSION_USE_THREAD_CONTEXT">SOUP_SESSION_USE_THREAD_CONTEXT</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSession.html#SOUP-SESSION-TIMEOUT:CAPS" title="SOUP_SESSION_TIMEOUT">SOUP_SESSION_TIMEOUT</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSession.html#SOUP-SESSION-IDLE-TIMEOUT:CAPS" title="SOUP_SESSION_IDLE_TIMEOUT">SOUP_SESSION_IDLE_TIMEOUT</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSession.html#SOUP-SESSION-USER-AGENT:CAPS" title="SOUP_SESSION_USER_AGENT">SOUP_SESSION_USER_AGENT</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSession.html#SOUP-SESSION-ADD-FEATURE:CAPS" title="SOUP_SESSION_ADD_FEATURE">SOUP_SESSION_ADD_FEATURE</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSession.html#SOUP-SESSION-ADD-FEATURE-BY-TYPE:CAPS" title="SOUP_SESSION_ADD_FEATURE_BY_TYPE">SOUP_SESSION_ADD_FEATURE_BY_TYPE</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSession.html#SOUP-SESSION-REMOVE-FEATURE-BY-TYPE:CAPS" title="SOUP_SESSION_REMOVE_FEATURE_BY_TYPE">SOUP_SESSION_REMOVE_FEATURE_BY_TYPE</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSession.html#SOUP-SESSION-ACCEPT-LANGUAGE:CAPS" title="SOUP_SESSION_ACCEPT_LANGUAGE">SOUP_SESSION_ACCEPT_LANGUAGE</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSession.html#SOUP-SESSION-ACCEPT-LANGUAGE-AUTO:CAPS" title="SOUP_SESSION_ACCEPT_LANGUAGE_AUTO">SOUP_SESSION_ACCEPT_LANGUAGE_AUTO</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSession.html#SOUP-SESSION-HTTP-ALIASES:CAPS" title="SOUP_SESSION_HTTP_ALIASES">SOUP_SESSION_HTTP_ALIASES</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSession.html#SOUP-SESSION-HTTPS-ALIASES:CAPS" title="SOUP_SESSION_HTTPS_ALIASES">SOUP_SESSION_HTTPS_ALIASES</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSession.html#SOUP-SESSION-LOCAL-ADDRESS:CAPS" title="SOUP_SESSION_LOCAL_ADDRESS">SOUP_SESSION_LOCAL_ADDRESS</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupSession.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> GObject - <span class="lineart">╰──</span> SoupSession - <span class="lineart">├──</span> <a class="link" href="SoupSessionAsync.html" title="SoupSessionAsync">SoupSessionAsync</a> - <span class="lineart">╰──</span> <a class="link" href="SoupSessionSync.html" title="SoupSessionSync">SoupSessionSync</a> -</pre> -</div> -<div class="refsect1"> -<a name="SoupSession.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="SoupSession.description"></a><h2>Description</h2> -<p><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> is the object that controls client-side HTTP. A -<a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> encapsulates all of the state that libsoup is keeping -on behalf of your program; cached HTTP connections, authentication -information, etc. It also keeps track of various global options -and features that you are using.</p> -<p>Most applications will only need a single <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a>; the primary -reason you might need multiple sessions is if you need to have -multiple independent authentication contexts. (Eg, you are -connecting to a server and authenticating as two different users at -different times; the easiest way to ensure that each <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> -is sent with the authentication information you intended is to use -one session for the first user, and a second session for the other -user.)</p> -<p>In the past, <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> was an abstract class, and users needed -to choose between <a class="link" href="SoupSessionAsync.html" title="SoupSessionAsync"><span class="type">SoupSessionAsync</span></a> (which always uses -<span class="type">GMainLoop</span>-based I/O), or <a class="link" href="SoupSessionSync.html" title="SoupSessionSync"><span class="type">SoupSessionSync</span></a> (which always uses -blocking I/O and can be used from multiple threads simultaneously). -This is no longer necessary; you can (and should) use a plain -<a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a>, which supports both synchronous and asynchronous use. -(When using a plain <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a>, <a class="link" href="SoupSession.html#soup-session-queue-message" title="soup_session_queue_message ()"><code class="function">soup_session_queue_message()</code></a> -behaves like it traditionally did on a <a class="link" href="SoupSessionAsync.html" title="SoupSessionAsync"><span class="type">SoupSessionAsync</span></a>, and -<a class="link" href="SoupSession.html#soup-session-send-message" title="soup_session_send_message ()"><code class="function">soup_session_send_message()</code></a> behaves like it traditionally did on a -<a class="link" href="SoupSessionSync.html" title="SoupSessionSync"><span class="type">SoupSessionSync</span></a>.)</p> -<p>Additional <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> functionality is provided by -<a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature"><span class="type">SoupSessionFeature</span></a> objects, which can be added 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> -(or at construct time with the <a class="link" href="SoupSession.html#SOUP-SESSION-ADD-FEATURE-BY-TYPE:CAPS" title="SOUP_SESSION_ADD_FEATURE_BY_TYPE"><code class="literal">SOUP_SESSION_ADD_FEATURE_BY_TYPE</code></a> -pseudo-property). For example, <a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a> provides support for -logging HTTP traffic, <a class="link" href="SoupContentDecoder.html" title="SoupContentDecoder"><span class="type">SoupContentDecoder</span></a> provides support for -compressed response handling, and <a class="link" href="SoupContentSniffer.html" title="SoupContentSniffer"><span class="type">SoupContentSniffer</span></a> provides -support for HTML5-style response body content sniffing. -Additionally, subtypes of <a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a> and <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a> can be added -as features, to add support for additional authentication and URI -types.</p> -<p>All <a href="SoupSession.html#SoupSession-struct"><span class="type">SoupSessions</span></a> are created with a <a class="link" href="SoupAuthManager.html" title="SoupAuthManager"><span class="type">SoupAuthManager</span></a>, and support -for <a class="link" href="SoupAuth.html#SOUP-TYPE-AUTH-BASIC:CAPS" title="SOUP_TYPE_AUTH_BASIC"><code class="literal">SOUP_TYPE_AUTH_BASIC</code></a> and <a class="link" href="SoupAuth.html#SOUP-TYPE-AUTH-DIGEST:CAPS" title="SOUP_TYPE_AUTH_DIGEST"><code class="literal">SOUP_TYPE_AUTH_DIGEST</code></a>. For -<a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a> types, <a class="link" href="SoupRequestHTTP.html" title="SoupRequestHTTP"><span class="type">SoupRequestHTTP</span></a>, <a class="link" href="SoupRequestFile.html" title="SoupRequestFile"><span class="type">SoupRequestFile</span></a>, and -<a class="link" href="SoupRequestData.html" title="SoupRequestData"><span class="type">SoupRequestData</span></a> are supported. Additionally, sessions using the -plain <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> class (rather than one of its deprecated -subtypes) have a <a class="link" href="SoupContentDecoder.html" title="SoupContentDecoder"><span class="type">SoupContentDecoder</span></a> by default.</p> -</div> -<div class="refsect1"> -<a name="SoupSession.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="soup-session-new"></a><h3>soup_session_new ()</h3> -<pre class="programlisting"><a class="link" href="SoupSession.html" title="SoupSession"><span class="returnvalue">SoupSession</span></a> * -soup_session_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> -<p>Creates a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> with the default options.</p> -<div class="refsect3"> -<a name="soup-session-new.returns"></a><h4>Returns</h4> -<p> the new session.</p> -</div> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-session-new-with-options"></a><h3>soup_session_new_with_options ()</h3> -<pre class="programlisting"><a class="link" href="SoupSession.html" title="SoupSession"><span class="returnvalue">SoupSession</span></a> * -soup_session_new_with_options (<em class="parameter"><code>const <span class="type">char</span> *optname1</code></em>, - <em class="parameter"><code>...</code></em>);</pre> -<p>Creates a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> with the specified options.</p> -<div class="refsect3"> -<a name="soup-session-new-with-options.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>optname1</p></td> -<td class="parameter_description"><p>name of first property to set</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>...</p></td> -<td class="parameter_description"><p>value of <em class="parameter"><code>optname1</code></em> -, followed by additional property/value pairs</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-session-new-with-options.returns"></a><h4>Returns</h4> -<p> the new session.</p> -</div> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-session-request"></a><h3>soup_session_request ()</h3> -<pre class="programlisting"><a class="link" href="SoupRequest.html" title="SoupRequest"><span class="returnvalue">SoupRequest</span></a> * -soup_session_request (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *uri_string</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>Creates a <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a> for retrieving <em class="parameter"><code>uri_string</code></em> -.</p> -<div class="refsect3"> -<a name="soup-session-request.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>session</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>uri_string</p></td> -<td class="parameter_description"><p>a URI, in string form</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-session-request.returns"></a><h4>Returns</h4> -<p>a new <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a>, or -<code class="literal">NULL</code> on error. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-session-request-uri"></a><h3>soup_session_request_uri ()</h3> -<pre class="programlisting"><a class="link" href="SoupRequest.html" title="SoupRequest"><span class="returnvalue">SoupRequest</span></a> * -soup_session_request_uri (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</code></em>, - <em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>Creates a <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a> for retrieving <em class="parameter"><code>uri</code></em> -.</p> -<div class="refsect3"> -<a name="soup-session-request-uri.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>session</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>uri</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> representing the URI to retrieve</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-session-request-uri.returns"></a><h4>Returns</h4> -<p>a new <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a>, or -<code class="literal">NULL</code> on error. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-session-request-http"></a><h3>soup_session_request_http ()</h3> -<pre class="programlisting"><a class="link" href="SoupRequestHTTP.html" title="SoupRequestHTTP"><span class="returnvalue">SoupRequestHTTP</span></a> * -soup_session_request_http (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *method</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *uri_string</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>Creates a <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a> for retrieving <em class="parameter"><code>uri_string</code></em> -, which must be an -"http" or "https" URI (or another protocol listed in <em class="parameter"><code>session</code></em> -'s -<a class="link" href="SoupSession.html#SoupSession--http-aliases" title="The “http-aliases” property"><span class="type">“http-aliases”</span></a> or <a class="link" href="SoupSession.html#SoupSession--https-aliases" title="The “https-aliases” property"><span class="type">“https-aliases”</span></a>).</p> -<div class="refsect3"> -<a name="soup-session-request-http.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>session</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>method</p></td> -<td class="parameter_description"><p>an HTTP method</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>uri_string</p></td> -<td class="parameter_description"><p>a URI, in string form</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-session-request-http.returns"></a><h4>Returns</h4> -<p>a new <a class="link" href="SoupRequestHTTP.html" title="SoupRequestHTTP"><span class="type">SoupRequestHTTP</span></a>, or -<code class="literal">NULL</code> on error. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-session-request-http-uri"></a><h3>soup_session_request_http_uri ()</h3> -<pre class="programlisting"><a class="link" href="SoupRequestHTTP.html" title="SoupRequestHTTP"><span class="returnvalue">SoupRequestHTTP</span></a> * -soup_session_request_http_uri (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *method</code></em>, - <em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>Creates a <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a> for retrieving <em class="parameter"><code>uri</code></em> -, which must be an -"http" or "https" URI (or another protocol listed in <em class="parameter"><code>session</code></em> -'s -<a class="link" href="SoupSession.html#SoupSession--http-aliases" title="The “http-aliases” property"><span class="type">“http-aliases”</span></a> or <a class="link" href="SoupSession.html#SoupSession--https-aliases" title="The “https-aliases” property"><span class="type">“https-aliases”</span></a>).</p> -<div class="refsect3"> -<a name="soup-session-request-http-uri.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>session</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>method</p></td> -<td class="parameter_description"><p>an HTTP method</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>uri</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> representing the URI to retrieve</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-session-request-http-uri.returns"></a><h4>Returns</h4> -<p>a new <a class="link" href="SoupRequestHTTP.html" title="SoupRequestHTTP"><span class="type">SoupRequestHTTP</span></a>, or -<code class="literal">NULL</code> on error. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSessionCallback"></a><h3>SoupSessionCallback ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -<span class="c_punctuation">(</span>*SoupSessionCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</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><span class="type">gpointer</span> user_data</code></em>);</pre> -<p>Prototype for the callback passed to <a class="link" href="SoupSession.html#soup-session-queue-message" title="soup_session_queue_message ()"><code class="function">soup_session_queue_message()</code></a>, -qv.</p> -<div class="refsect3"> -<a name="SoupSessionCallback.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>session</p></td> -<td class="parameter_description"><p>the session</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>msg</p></td> -<td class="parameter_description"><p>the message that has finished</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>the data passed to soup_session_queue_message</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-session-queue-message"></a><h3>soup_session_queue_message ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_session_queue_message (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</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="SoupSession.html#SoupSessionCallback" title="SoupSessionCallback ()"><span class="type">SoupSessionCallback</span></a> callback</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> -<p>Queues the message <em class="parameter"><code>msg</code></em> - for asynchronously sending the request and -receiving a response in the current thread-default <span class="type">GMainContext</span>. -If <em class="parameter"><code>msg</code></em> - has been processed before, any resources related to the -time it was last sent are freed.</p> -<p>Upon message completion, the callback specified in <em class="parameter"><code>callback</code></em> - will -be invoked. If after returning from this callback the message has not -been requeued, <em class="parameter"><code>msg</code></em> - will be unreffed.</p> -<p>(The behavior above applies to a plain <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a>; if you are -using <a class="link" href="SoupSessionAsync.html" title="SoupSessionAsync"><span class="type">SoupSessionAsync</span></a> or <a class="link" href="SoupSessionSync.html" title="SoupSessionSync"><span class="type">SoupSessionSync</span></a>, then the <span class="type">GMainContext</span> -that is used depends on the settings of <a class="link" href="SoupSession.html#SoupSession--async-context" title="The “async-context” property"><span class="type">“async-context”</span></a> -and <a class="link" href="SoupSession.html#SoupSession--use-thread-context" title="The “use-thread-context” property"><span class="type">“use-thread-context”</span></a>, and for <a class="link" href="SoupSessionSync.html" title="SoupSessionSync"><span class="type">SoupSessionSync</span></a>, the -message will actually be sent and processed in another thread, with -only the final callback occurring in the indicated <span class="type">GMainContext</span>.)</p> -<p>Contrast this method with <a class="link" href="SoupSession.html#soup-session-send-async" title="soup_session_send_async ()"><code class="function">soup_session_send_async()</code></a>, which also -asynchronously sends a message, but returns before reading the -response body, and allows you to read the response via a -<span class="type">GInputStream</span>.</p> -<div class="refsect3"> -<a name="soup-session-queue-message.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>session</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</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 queue. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>callback</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSession.html#SoupSessionCallback" title="SoupSessionCallback ()"><span class="type">SoupSessionCallback</span></a> which will -be called after the message completes or when an unrecoverable error occurs. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>a pointer passed to <em class="parameter"><code>callback</code></em> -. </p></td> -<td class="parameter_annotations"><span class="annotation">[<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> -<hr> -<div class="refsect2"> -<a name="soup-session-requeue-message"></a><h3>soup_session_requeue_message ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_session_requeue_message (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>);</pre> -<p>This causes <em class="parameter"><code>msg</code></em> - to be placed back on the queue to be attempted -again.</p> -<div class="refsect3"> -<a name="soup-session-requeue-message.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>session</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</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 requeue</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-session-send-message"></a><h3>soup_session_send_message ()</h3> -<pre class="programlisting"><span class="returnvalue">guint</span> -soup_session_send_message (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>);</pre> -<p>Synchronously send <em class="parameter"><code>msg</code></em> -. This call will not return until the -transfer is finished successfully or there is an unrecoverable -error.</p> -<p>Unlike with <a class="link" href="SoupSession.html#soup-session-queue-message" title="soup_session_queue_message ()"><code class="function">soup_session_queue_message()</code></a>, <em class="parameter"><code>msg</code></em> - is not freed upon -return.</p> -<p>(Note that if you call this method on a <a class="link" href="SoupSessionAsync.html" title="SoupSessionAsync"><span class="type">SoupSessionAsync</span></a>, it will -still use asynchronous I/O internally, running the glib main loop -to process the message, which may also cause other events to be -processed.)</p> -<p>Contrast this method with <a class="link" href="SoupSession.html#soup-session-send" title="soup_session_send ()"><code class="function">soup_session_send()</code></a>, which also -synchronously sends a message, but returns before reading the -response body, and allows you to read the response via a -<span class="type">GInputStream</span>.</p> -<div class="refsect3"> -<a name="soup-session-send-message.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>session</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</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 send</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-session-send-message.returns"></a><h4>Returns</h4> -<p> the HTTP status code of the response</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-session-cancel-message"></a><h3>soup_session_cancel_message ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_session_cancel_message (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</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><span class="type">guint</span> status_code</code></em>);</pre> -<p>Causes <em class="parameter"><code>session</code></em> - to immediately finish processing <em class="parameter"><code>msg</code></em> - (regardless -of its current state) with a final status_code of <em class="parameter"><code>status_code</code></em> -. You -may call this at any time after handing <em class="parameter"><code>msg</code></em> - off to <em class="parameter"><code>session</code></em> -; if -<em class="parameter"><code>session</code></em> - has started sending the request but has not yet received -the complete response, then it will close the request's connection. -Note that with requests that have side effects (eg, -<code class="literal">POST</code>, <code class="literal">PUT</code>, -<code class="literal">DELETE</code>) it is possible that you might cancel the -request after the server acts on it, but before it returns a -response, leaving the remote resource in an unknown state.</p> -<p>If the message is cancelled while its response body is being read, -then the response body in <em class="parameter"><code>msg</code></em> - will be left partially-filled-in. -The response headers, on the other hand, will always be either -empty or complete.</p> -<p>Beware that with the deprecated <a class="link" href="SoupSessionAsync.html" title="SoupSessionAsync"><span class="type">SoupSessionAsync</span></a>, messages queued -with <a class="link" href="SoupSession.html#soup-session-queue-message" title="soup_session_queue_message ()"><code class="function">soup_session_queue_message()</code></a> will have their callbacks invoked -before <a class="link" href="SoupSession.html#soup-session-cancel-message" title="soup_session_cancel_message ()"><code class="function">soup_session_cancel_message()</code></a> returns. The plain -<a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> does not have this behavior; cancelling an -asynchronous message will merely queue its callback to be run after -returning to the main loop.</p> -<div class="refsect3"> -<a name="soup-session-cancel-message.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>session</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</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 cancel</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>status_code</p></td> -<td class="parameter_description"><p>status code to set on <em class="parameter"><code>msg</code></em> -(generally -<a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-CANCELLED:CAPS"><code class="literal">SOUP_STATUS_CANCELLED</code></a>)</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-session-send"></a><h3>soup_session_send ()</h3> -<pre class="programlisting"><span class="returnvalue">GInputStream</span> * -soup_session_send (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</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><span class="type">GCancellable</span> *cancellable</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>Synchronously sends <em class="parameter"><code>msg</code></em> - and waits for the beginning of a response. -On success, a <span class="type">GInputStream</span> will be returned which you can use to -read the response body. ("Success" here means only that an HTTP -response was received and understood; it does not necessarily mean -that a 2xx class status code was received.)</p> -<p>If non-<code class="literal">NULL</code>, <em class="parameter"><code>cancellable</code></em> - can be used to cancel the request; -<a class="link" href="SoupSession.html#soup-session-send" title="soup_session_send ()"><code class="function">soup_session_send()</code></a> will return a <code class="literal">G_IO_ERROR_CANCELLED</code> error. Note -that with requests that have side effects (eg, -<code class="literal">POST</code>, <code class="literal">PUT</code>, -<code class="literal">DELETE</code>) it is possible that you might cancel the -request after the server acts on it, but before it returns a -response, leaving the remote resource in an unknown state.</p> -<p>If <em class="parameter"><code>msg</code></em> - is requeued due to a redirect or authentication, the -initial (3xx/401/407) response body will be suppressed, and -<a class="link" href="SoupSession.html#soup-session-send" title="soup_session_send ()"><code class="function">soup_session_send()</code></a> will only return once a final response has been -received.</p> -<p>Contrast this method with <a class="link" href="SoupSession.html#soup-session-send-message" title="soup_session_send_message ()"><code class="function">soup_session_send_message()</code></a>, which also -synchronously sends a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>, but doesn't return until the -response has been completely read.</p> -<p>(Note that this method cannot be called on the deprecated -<a class="link" href="SoupSessionAsync.html" title="SoupSessionAsync"><span class="type">SoupSessionAsync</span></a> subclass.)</p> -<div class="refsect3"> -<a name="soup-session-send.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>session</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>cancellable</p></td> -<td class="parameter_description"><p>a <span class="type">GCancellable</span></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-session-send.returns"></a><h4>Returns</h4> -<p>a <span class="type">GInputStream</span> for reading the -response body, or <code class="literal">NULL</code> on error. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-session-send-async"></a><h3>soup_session_send_async ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_session_send_async (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</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><span class="type">GCancellable</span> *cancellable</code></em>, - <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> -<p>Asynchronously sends <em class="parameter"><code>msg</code></em> - and waits for the beginning of a -response. When <em class="parameter"><code>callback</code></em> - is called, then either <em class="parameter"><code>msg</code></em> - has been sent, -and its response headers received, or else an error has occurred. -Call <a class="link" href="SoupSession.html#soup-session-send-finish" title="soup_session_send_finish ()"><code class="function">soup_session_send_finish()</code></a> to get a <span class="type">GInputStream</span> for reading -the response body.</p> -<p>See <a class="link" href="SoupSession.html#soup-session-send" title="soup_session_send ()"><code class="function">soup_session_send()</code></a> for more details on the general semantics.</p> -<p>Contrast this method with <a class="link" href="SoupSession.html#soup-session-queue-message" title="soup_session_queue_message ()"><code class="function">soup_session_queue_message()</code></a>, which also -asynchronously sends a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>, but doesn't invoke its -callback until the response has been completely read.</p> -<p>(Note that this method cannot be called on the deprecated -<a class="link" href="SoupSessionSync.html" title="SoupSessionSync"><span class="type">SoupSessionSync</span></a> subclass, and can only be called on -<a class="link" href="SoupSessionAsync.html" title="SoupSessionAsync"><span class="type">SoupSessionAsync</span></a> if you have set the -<a class="link" href="SoupSession.html#SoupSession--use-thread-context" title="The “use-thread-context” property"><span class="type">“use-thread-context”</span></a> property.)</p> -<div class="refsect3"> -<a name="soup-session-send-async.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>session</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>cancellable</p></td> -<td class="parameter_description"><p>a <span class="type">GCancellable</span></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>callback</p></td> -<td class="parameter_description"><p>the callback to invoke</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>data for <em class="parameter"><code>callback</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-session-send-finish"></a><h3>soup_session_send_finish ()</h3> -<pre class="programlisting"><span class="returnvalue">GInputStream</span> * -soup_session_send_finish (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</code></em>, - <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>Gets the response to a <a class="link" href="SoupSession.html#soup-session-send-async" title="soup_session_send_async ()"><code class="function">soup_session_send_async()</code></a> call and (if -successful), returns a <span class="type">GInputStream</span> that can be used to read the -response body.</p> -<div class="refsect3"> -<a name="soup-session-send-finish.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>session</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>result</p></td> -<td class="parameter_description"><p>the <span class="type">GAsyncResult</span> passed to your callback</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-session-send-finish.returns"></a><h4>Returns</h4> -<p>a <span class="type">GInputStream</span> for reading the -response body, or <code class="literal">NULL</code> on error. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-session-websocket-connect-async"></a><h3>soup_session_websocket_connect_async ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_session_websocket_connect_async (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</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>const <span class="type">char</span> *origin</code></em>, - <em class="parameter"><code><span class="type">char</span> **protocols</code></em>, - <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>, - <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> -<p>Asynchronously creates a <a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="type">SoupWebsocketConnection</span></a> to communicate -with a remote server.</p> -<p>All necessary WebSocket-related headers will be added to <em class="parameter"><code>msg</code></em> -, and -it will then be sent and asynchronously processed normally -(including handling of redirection and HTTP authentication).</p> -<p>If the server returns "101 Switching Protocols", then <em class="parameter"><code>msg</code></em> -'s status -code and response headers will be updated, and then the WebSocket -handshake will be completed. On success, -<a class="link" href="SoupSession.html#soup-session-websocket-connect-finish" title="soup_session_websocket_connect_finish ()"><code class="function">soup_session_websocket_connect_finish()</code></a> will return a new -<a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="type">SoupWebsocketConnection</span></a>. On failure it will return a <span class="type">GError</span>.</p> -<p>If the server returns a status other than "101 Switching -Protocols", then <em class="parameter"><code>msg</code></em> - will contain the complete response headers -and body from the server's response, and -<a class="link" href="SoupSession.html#soup-session-websocket-connect-finish" title="soup_session_websocket_connect_finish ()"><code class="function">soup_session_websocket_connect_finish()</code></a> will return -<a class="link" href="libsoup-2.4-WebSockets.html#SOUP-WEBSOCKET-ERROR-NOT-WEBSOCKET:CAPS"><code class="literal">SOUP_WEBSOCKET_ERROR_NOT_WEBSOCKET</code></a>.</p> -<div class="refsect3"> -<a name="soup-session-websocket-connect-async.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>session</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>msg</p></td> -<td class="parameter_description"><p><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> indicating the WebSocket server to connect to</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>origin</p></td> -<td class="parameter_description"><p>origin of the connection. </p></td> -<td class="parameter_annotations"><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 class="parameter_name"><p>protocols</p></td> -<td class="parameter_description"><p>a -<code class="literal">NULL</code>-terminated array of protocols supported. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>cancellable</p></td> -<td class="parameter_description"><p>a <span class="type">GCancellable</span></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>callback</p></td> -<td class="parameter_description"><p>the callback to invoke</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>data for <em class="parameter"><code>callback</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-session-websocket-connect-finish"></a><h3>soup_session_websocket_connect_finish ()</h3> -<pre class="programlisting"><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="returnvalue">SoupWebsocketConnection</span></a> * -soup_session_websocket_connect_finish (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</code></em>, - <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>Gets the <a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="type">SoupWebsocketConnection</span></a> response to a -<a class="link" href="SoupSession.html#soup-session-websocket-connect-async" title="soup_session_websocket_connect_async ()"><code class="function">soup_session_websocket_connect_async()</code></a> call and (if successful), -returns a <a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="type">SoupWebsocketConnection</span></a> that can be used to communicate -with the server.</p> -<div class="refsect3"> -<a name="soup-session-websocket-connect-finish.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>session</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>result</p></td> -<td class="parameter_description"><p>the <span class="type">GAsyncResult</span> passed to your callback</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-session-websocket-connect-finish.returns"></a><h4>Returns</h4> -<p>a new <a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="type">SoupWebsocketConnection</span></a>, or -<code class="literal">NULL</code> on error. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-session-prefetch-dns"></a><h3>soup_session_prefetch_dns ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_session_prefetch_dns (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *hostname</code></em>, - <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>, - <em class="parameter"><code><a class="link" href="SoupAddress.html#SoupAddressCallback" title="SoupAddressCallback ()"><span class="type">SoupAddressCallback</span></a> callback</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> -<p>Tells <em class="parameter"><code>session</code></em> - that an URI from the given <em class="parameter"><code>hostname</code></em> - may be requested -shortly, and so the session can try to prepare by resolving the -domain name in advance, in order to work more quickly once the URI -is actually requested.</p> -<p>If <em class="parameter"><code>cancellable</code></em> - is non-<code class="literal">NULL</code>, it can be used to cancel the -resolution. <em class="parameter"><code>callback</code></em> - will still be invoked in this case, with a -status of <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-CANCELLED:CAPS"><code class="literal">SOUP_STATUS_CANCELLED</code></a>.</p> -<div class="refsect3"> -<a name="soup-session-prefetch-dns.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>session</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>hostname</p></td> -<td class="parameter_description"><p>a hostname to be resolved</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>cancellable</p></td> -<td class="parameter_description"><p>a <span class="type">GCancellable</span> object, or <code class="literal">NULL</code>. </p></td> -<td class="parameter_annotations"><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 class="parameter_name"><p>callback</p></td> -<td class="parameter_description"><p>callback to call with the -result, or <code class="literal">NULL</code>. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>data for <em class="parameter"><code>callback</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.38</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-session-abort"></a><h3>soup_session_abort ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_session_abort (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</code></em>);</pre> -<p>Cancels all pending requests in <em class="parameter"><code>session</code></em> - and closes all idle -persistent connections.</p> -<p>The message cancellation has the same semantics as with -<a class="link" href="SoupSession.html#soup-session-cancel-message" title="soup_session_cancel_message ()"><code class="function">soup_session_cancel_message()</code></a>; asynchronous requests on a -<a class="link" href="SoupSessionAsync.html" title="SoupSessionAsync"><span class="type">SoupSessionAsync</span></a> will have their callback called before -<a class="link" href="SoupSession.html#soup-session-abort" title="soup_session_abort ()"><code class="function">soup_session_abort()</code></a> returns. Requests on a plain <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> will -not.</p> -<div class="refsect3"> -<a name="soup-session-abort.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>session</p></td> -<td class="parameter_description"><p>the session</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-session-would-redirect"></a><h3>soup_session_would_redirect ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_session_would_redirect (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>);</pre> -<p>Checks if <em class="parameter"><code>msg</code></em> - contains a response that would cause <em class="parameter"><code>session</code></em> - to -redirect it to a new URL (ignoring <em class="parameter"><code>msg</code></em> -'s <a class="link" href="SoupMessage.html#SOUP-MESSAGE-NO-REDIRECT:CAPS"><code class="literal">SOUP_MESSAGE_NO_REDIRECT</code></a> -flag, and the number of times it has already been redirected).</p> -<div class="refsect3"> -<a name="soup-session-would-redirect.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>session</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> that has response headers</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-session-would-redirect.returns"></a><h4>Returns</h4> -<p> whether <em class="parameter"><code>msg</code></em> -would be redirected</p> -</div> -<p class="since">Since: 2.38</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-session-redirect-message"></a><h3>soup_session_redirect_message ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_session_redirect_message (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>);</pre> -<p>Updates <em class="parameter"><code>msg</code></em> -'s URI according to its status code and "Location" -header, and requeues it on <em class="parameter"><code>session</code></em> -. Use this when you have set -<a class="link" href="SoupMessage.html#SOUP-MESSAGE-NO-REDIRECT:CAPS"><code class="literal">SOUP_MESSAGE_NO_REDIRECT</code></a> on a message, but have decided to allow a -particular redirection to occur, or if you want to allow a -redirection that <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> will not perform automatically (eg, -redirecting a non-safe method such as DELETE).</p> -<p>If <em class="parameter"><code>msg</code></em> -'s status code indicates that it should be retried as a GET -request, then <em class="parameter"><code>msg</code></em> - will be modified accordingly.</p> -<p>If <em class="parameter"><code>msg</code></em> - has already been redirected too many times, this will -cause it to fail with <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-TOO-MANY-REDIRECTS:CAPS"><code class="literal">SOUP_STATUS_TOO_MANY_REDIRECTS</code></a>.</p> -<div class="refsect3"> -<a name="soup-session-redirect-message.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>session</p></td> -<td class="parameter_description"><p>the session</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> that has received a 3xx response</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-session-redirect-message.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if a redirection was applied, <code class="literal">FALSE</code> if not -(eg, because there was no Location header, or it could not be -parsed).</p> -</div> -<p class="since">Since: 2.38</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-session-pause-message"></a><h3>soup_session_pause_message ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_session_pause_message (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>);</pre> -<p>Pauses HTTP I/O on <em class="parameter"><code>msg</code></em> -. Call <a class="link" href="SoupSession.html#soup-session-unpause-message" title="soup_session_unpause_message ()"><code class="function">soup_session_unpause_message()</code></a> to -resume I/O.</p> -<p>This may only be called for asynchronous messages (those sent on a -<a class="link" href="SoupSessionAsync.html" title="SoupSessionAsync"><span class="type">SoupSessionAsync</span></a> or using <a class="link" href="SoupSession.html#soup-session-queue-message" title="soup_session_queue_message ()"><code class="function">soup_session_queue_message()</code></a>).</p> -<div class="refsect3"> -<a name="soup-session-pause-message.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>session</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> currently running on <em class="parameter"><code>session</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-session-unpause-message"></a><h3>soup_session_unpause_message ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_session_unpause_message (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>);</pre> -<p>Resumes HTTP I/O on <em class="parameter"><code>msg</code></em> -. Use this to resume after calling -<a class="link" href="SoupSession.html#soup-session-pause-message" title="soup_session_pause_message ()"><code class="function">soup_session_pause_message()</code></a>.</p> -<p>If <em class="parameter"><code>msg</code></em> - is being sent via blocking I/O, this will resume reading or -writing immediately. If <em class="parameter"><code>msg</code></em> - is using non-blocking I/O, then -reading or writing won't resume until you return to the main loop.</p> -<p>This may only be called for asynchronous messages (those sent on a -<a class="link" href="SoupSessionAsync.html" title="SoupSessionAsync"><span class="type">SoupSessionAsync</span></a> or using <a class="link" href="SoupSession.html#soup-session-queue-message" title="soup_session_queue_message ()"><code class="function">soup_session_queue_message()</code></a>).</p> -<div class="refsect3"> -<a name="soup-session-unpause-message.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>session</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> currently running on <em class="parameter"><code>session</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-session-get-async-context"></a><h3>soup_session_get_async_context ()</h3> -<pre class="programlisting"><span class="returnvalue">GMainContext</span> * -soup_session_get_async_context (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</code></em>);</pre> -<p>Gets <em class="parameter"><code>session</code></em> -'s <a class="link" href="SoupSession.html#SoupSession--async-context" title="The “async-context” property"><span class="type">“async-context”</span></a>. This does not add a ref -to the context, so you will need to ref it yourself if you want it -to outlive its session.</p> -<p>For a modern <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a>, this will always just return the -thread-default <span class="type">GMainContext</span>, and so is not especially useful.</p> -<div class="refsect3"> -<a name="soup-session-get-async-context.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>session</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-session-get-async-context.returns"></a><h4>Returns</h4> -<p><em class="parameter"><code>session</code></em> -'s <span class="type">GMainContext</span>, -which may be <code class="literal">NULL</code>. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-session-add-feature"></a><h3>soup_session_add_feature ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_session_add_feature (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</code></em>, - <em class="parameter"><code><a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature"><span class="type">SoupSessionFeature</span></a> *feature</code></em>);</pre> -<p>Adds <em class="parameter"><code>feature</code></em> -'s functionality to <em class="parameter"><code>session</code></em> -. You can also add a -feature to the session at construct time by using the -<a class="link" href="SoupSession.html#SOUP-SESSION-ADD-FEATURE:CAPS" title="SOUP_SESSION_ADD_FEATURE"><code class="literal">SOUP_SESSION_ADD_FEATURE</code></a> property.</p> -<p>See the main <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> documentation for information on what -features are present in sessions by default.</p> -<div class="refsect3"> -<a name="soup-session-add-feature.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>session</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>feature</p></td> -<td class="parameter_description"><p>an object that implements <a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature"><span class="type">SoupSessionFeature</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-session-add-feature-by-type"></a><h3>soup_session_add_feature_by_type ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_session_add_feature_by_type (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</code></em>, - <em class="parameter"><code><span class="type">GType</span> feature_type</code></em>);</pre> -<p>If <em class="parameter"><code>feature_type</code></em> - is the type of a class that implements -<a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature"><span class="type">SoupSessionFeature</span></a>, this creates a new feature of that type and -adds it to <em class="parameter"><code>session</code></em> - as 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>. You can use -this when you don't need to customize the new feature in any way.</p> -<p>If <em class="parameter"><code>feature_type</code></em> - is not a <a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature"><span class="type">SoupSessionFeature</span></a> type, this gives each -existing feature on <em class="parameter"><code>session</code></em> - the chance to accept <em class="parameter"><code>feature_type</code></em> - as -a "subfeature". This can be used to add new <a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a> or -<a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a> types, for instance.</p> -<p>You can also add a feature to the session at construct time by -using the <a class="link" href="SoupSession.html#SOUP-SESSION-ADD-FEATURE-BY-TYPE:CAPS" title="SOUP_SESSION_ADD_FEATURE_BY_TYPE"><code class="literal">SOUP_SESSION_ADD_FEATURE_BY_TYPE</code></a> property.</p> -<p>See the main <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> documentation for information on what -features are present in sessions by default.</p> -<div class="refsect3"> -<a name="soup-session-add-feature-by-type.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>session</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>feature_type</p></td> -<td class="parameter_description"><p>a <span class="type">GType</span></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-session-remove-feature"></a><h3>soup_session_remove_feature ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_session_remove_feature (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</code></em>, - <em class="parameter"><code><a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature"><span class="type">SoupSessionFeature</span></a> *feature</code></em>);</pre> -<p>Removes <em class="parameter"><code>feature</code></em> -'s functionality from <em class="parameter"><code>session</code></em> -.</p> -<div class="refsect3"> -<a name="soup-session-remove-feature.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>session</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>feature</p></td> -<td class="parameter_description"><p>a feature that has previously been added to <em class="parameter"><code>session</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-session-remove-feature-by-type"></a><h3>soup_session_remove_feature_by_type ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_session_remove_feature_by_type (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</code></em>, - <em class="parameter"><code><span class="type">GType</span> feature_type</code></em>);</pre> -<p>Removes all features of type <em class="parameter"><code>feature_type</code></em> - (or any subclass of -<em class="parameter"><code>feature_type</code></em> -) from <em class="parameter"><code>session</code></em> -. You can also remove standard features -from the session at construct time by using the -<a class="link" href="SoupSession.html#SOUP-SESSION-REMOVE-FEATURE-BY-TYPE:CAPS" title="SOUP_SESSION_REMOVE_FEATURE_BY_TYPE"><code class="literal">SOUP_SESSION_REMOVE_FEATURE_BY_TYPE</code></a> property.</p> -<div class="refsect3"> -<a name="soup-session-remove-feature-by-type.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>session</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>feature_type</p></td> -<td class="parameter_description"><p>a <span class="type">GType</span></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-session-get-features"></a><h3>soup_session_get_features ()</h3> -<pre class="programlisting"><span class="returnvalue">GSList</span> * -soup_session_get_features (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</code></em>, - <em class="parameter"><code><span class="type">GType</span> feature_type</code></em>);</pre> -<p>Generates a list of <em class="parameter"><code>session</code></em> -'s features of type <em class="parameter"><code>feature_type</code></em> -. (If -you want to see all features, you can pass <code class="literal">SOUP_TYPE_SESSION_FEATURE</code> -for <em class="parameter"><code>feature_type</code></em> -.)</p> -<div class="refsect3"> -<a name="soup-session-get-features.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>session</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>feature_type</p></td> -<td class="parameter_description"><p>the <span class="type">GType</span> of the class of features to get</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-session-get-features.returns"></a><h4>Returns</h4> -<p>a list of features. You must free the list, but not its contents. </p> -<p><span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> Soup.SessionFeature]</span></p> -</div> -<p class="since">Since: 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-session-get-feature"></a><h3>soup_session_get_feature ()</h3> -<pre class="programlisting"><a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature"><span class="returnvalue">SoupSessionFeature</span></a> * -soup_session_get_feature (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</code></em>, - <em class="parameter"><code><span class="type">GType</span> feature_type</code></em>);</pre> -<p>Gets the first feature in <em class="parameter"><code>session</code></em> - of type <em class="parameter"><code>feature_type</code></em> -. For -features where there may be more than one feature of a given type, -use <a class="link" href="SoupSession.html#soup-session-get-features" title="soup_session_get_features ()"><code class="function">soup_session_get_features()</code></a>.</p> -<div class="refsect3"> -<a name="soup-session-get-feature.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>session</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>feature_type</p></td> -<td class="parameter_description"><p>the <span class="type">GType</span> of the feature to get</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-session-get-feature.returns"></a><h4>Returns</h4> -<p>a <a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature"><span class="type">SoupSessionFeature</span></a>, or -<code class="literal">NULL</code>. The feature is owned by <em class="parameter"><code>session</code></em> -. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-session-get-feature-for-message"></a><h3>soup_session_get_feature_for_message ()</h3> -<pre class="programlisting"><a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature"><span class="returnvalue">SoupSessionFeature</span></a> * -soup_session_get_feature_for_message (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</code></em>, - <em class="parameter"><code><span class="type">GType</span> feature_type</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>);</pre> -<p>Gets the first feature in <em class="parameter"><code>session</code></em> - of type <em class="parameter"><code>feature_type</code></em> -, provided -that it is not disabled for <em class="parameter"><code>msg</code></em> -. As with -<a class="link" href="SoupSession.html#soup-session-get-feature" title="soup_session_get_feature ()"><code class="function">soup_session_get_feature()</code></a>, this should only be used for features -where <em class="parameter"><code>feature_type</code></em> - is only expected to match a single feature. In -particular, if there are two matching features, and the first is -disabled on <em class="parameter"><code>msg</code></em> -, and the second is not, then this will return -<code class="literal">NULL</code>, not the second feature.</p> -<div class="refsect3"> -<a name="soup-session-get-feature-for-message.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>session</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>feature_type</p></td> -<td class="parameter_description"><p>the <span class="type">GType</span> of the feature to get</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-session-get-feature-for-message.returns"></a><h4>Returns</h4> -<p>a <a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature"><span class="type">SoupSessionFeature</span></a>, or <code class="literal">NULL</code>. The -feature is owned by <em class="parameter"><code>session</code></em> -. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.28</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-session-has-feature"></a><h3>soup_session_has_feature ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_session_has_feature (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</code></em>, - <em class="parameter"><code><span class="type">GType</span> feature_type</code></em>);</pre> -<p>Tests if <em class="parameter"><code>session</code></em> - has at a feature of type <em class="parameter"><code>feature_type</code></em> - (which can -be the type of either a <a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature"><span class="type">SoupSessionFeature</span></a>, or else a subtype of -some class managed by another feature, such as <a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a> or -<a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a>).</p> -<div class="refsect3"> -<a name="soup-session-has-feature.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>session</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>feature_type</p></td> -<td class="parameter_description"><p>the <span class="type">GType</span> of the class of features to check for</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-session-has-feature.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> or <code class="literal">FALSE</code></p> -</div> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-session-steal-connection"></a><h3>soup_session_steal_connection ()</h3> -<pre class="programlisting"><span class="returnvalue">GIOStream</span> * -soup_session_steal_connection (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>);</pre> -<p>"Steals" the HTTP connection associated with <em class="parameter"><code>msg</code></em> - from <em class="parameter"><code>session</code></em> -. -This happens immediately, regardless of the current state of the -connection, and <em class="parameter"><code>msg</code></em> -'s callback will not be called. You can steal -the connection from a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> signal handler if you need to -wait for part or all of the response to be received first.</p> -<p>Calling this function may cause <em class="parameter"><code>msg</code></em> - to be freed if you are not -holding any other reference to it.</p> -<div class="refsect3"> -<a name="soup-session-steal-connection.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>session</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</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 whose connection is to be stolen</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-session-steal-connection.returns"></a><h4>Returns</h4> -<p>the <span class="type">GIOStream</span> formerly associated -with <em class="parameter"><code>msg</code></em> -(or <code class="literal">NULL</code> if <em class="parameter"><code>msg</code></em> -was no longer associated with a -connection). No guarantees are made about what kind of <span class="type">GIOStream</span> -is returned. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSessionConnectProgressCallback"></a><h3>SoupSessionConnectProgressCallback ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -<span class="c_punctuation">(</span>*SoupSessionConnectProgressCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</code></em>, - <em class="parameter"><code><span class="type">GSocketClientEvent</span> event</code></em>, - <em class="parameter"><code><span class="type">GIOStream</span> *connection</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> -<p>Prototype for the progress callback passed to <a class="link" href="SoupSession.html#soup-session-connect-async" title="soup_session_connect_async ()"><code class="function">soup_session_connect_async()</code></a>.</p> -<div class="refsect3"> -<a name="SoupSessionConnectProgressCallback.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>session</p></td> -<td class="parameter_description"><p>the <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>event</p></td> -<td class="parameter_description"><p>a <span class="type">GSocketClientEvent</span></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>connection</p></td> -<td class="parameter_description"><p>the current state of the network connection</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>the data passed to <a class="link" href="SoupSession.html#soup-session-connect-async" title="soup_session_connect_async ()"><code class="function">soup_session_connect_async()</code></a>.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.62</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-session-connect-async"></a><h3>soup_session_connect_async ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_session_connect_async (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</code></em>, - <em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>, - <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>, - <em class="parameter"><code><a class="link" href="SoupSession.html#SoupSessionConnectProgressCallback" title="SoupSessionConnectProgressCallback ()"><span class="type">SoupSessionConnectProgressCallback</span></a> progress_callback</code></em>, - <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> -<p>Start a connection to <em class="parameter"><code>uri</code></em> -. The operation can be monitored by providing a <em class="parameter"><code>progress_callback</code></em> - -and finishes when the connection is done or an error ocurred.</p> -<p>Call <a class="link" href="SoupSession.html#soup-session-connect-finish" title="soup_session_connect_finish ()"><code class="function">soup_session_connect_finish()</code></a> to get the <span class="type">GIOStream</span> to communicate with the server.</p> -<div class="refsect3"> -<a name="soup-session-connect-async.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>session</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>uri</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> to connect to</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>cancellable</p></td> -<td class="parameter_description"><p>a <span class="type">GCancellable</span></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>progress_callback</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSession.html#SoupSessionConnectProgressCallback" title="SoupSessionConnectProgressCallback ()"><span class="type">SoupSessionConnectProgressCallback</span></a> which -will be called for every network event that occurs during the connection. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>callback</p></td> -<td class="parameter_description"><p>the callback to invoke when the operation finishes. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>data for <em class="parameter"><code>progress_callback</code></em> -and <em class="parameter"><code>callback</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.62</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-session-connect-finish"></a><h3>soup_session_connect_finish ()</h3> -<pre class="programlisting"><span class="returnvalue">GIOStream</span> * -soup_session_connect_finish (<em class="parameter"><code><a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session</code></em>, - <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>Gets the <span class="type">GIOStream</span> created for the connection to communicate with the server.</p> -<div class="refsect3"> -<a name="soup-session-connect-finish.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>session</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>result</p></td> -<td class="parameter_description"><p>the <span class="type">GAsyncResult</span> passed to your callback</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-session-connect-finish.returns"></a><h4>Returns</h4> -<p>a new <span class="type">GIOStream</span>, or <code class="literal">NULL</code> on error. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.62</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupSession.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupSession-struct"></a><h3>SoupSession</h3> -<pre class="programlisting">typedef struct _SoupSession SoupSession;</pre> -</div> -<hr> -<div class="refsect2"> -<a name="SoupRequestError"></a><h3>enum SoupRequestError</h3> -<p>A <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a> error.</p> -<div class="refsect3"> -<a name="SoupRequestError.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="enum_members_name"> -<col class="enum_members_description"> -<col width="200px" class="enum_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="enum_member_name"><p><a name="SOUP-REQUEST-ERROR-BAD-URI:CAPS"></a>SOUP_REQUEST_ERROR_BAD_URI</p></td> -<td class="enum_member_description"> -<p>the URI could not be parsed</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-REQUEST-ERROR-UNSUPPORTED-URI-SCHEME:CAPS"></a>SOUP_REQUEST_ERROR_UNSUPPORTED_URI_SCHEME</p></td> -<td class="enum_member_description"> -<p>the URI scheme is not - supported by this <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a></p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-REQUEST-ERROR-PARSING:CAPS"></a>SOUP_REQUEST_ERROR_PARSING</p></td> -<td class="enum_member_description"> -<p>the server's response could not - be parsed</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-REQUEST-ERROR-ENCODING:CAPS"></a>SOUP_REQUEST_ERROR_ENCODING</p></td> -<td class="enum_member_description"> -<p>the server's response was in an - unsupported format</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-REQUEST-ERROR:CAPS"></a><h3>SOUP_REQUEST_ERROR</h3> -<pre class="programlisting">#define SOUP_REQUEST_ERROR soup_request_error_quark () -</pre> -<p>A <span class="type">GError</span> domain for <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a>-related errors. Used with -<a class="link" href="SoupSession.html#SoupRequestError" title="enum SoupRequestError"><span class="type">SoupRequestError</span></a>.</p> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SESSION-PROXY-URI:CAPS"></a><h3>SOUP_SESSION_PROXY_URI</h3> -<pre class="programlisting">#define SOUP_SESSION_PROXY_URI "proxy-uri" -</pre> -<p>Alias for the <a class="link" href="SoupSession.html#SoupSession--proxy-uri" title="The “proxy-uri” property"><span class="type">“proxy-uri”</span></a> property, qv.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SESSION-PROXY-RESOLVER:CAPS"></a><h3>SOUP_SESSION_PROXY_RESOLVER</h3> -<pre class="programlisting">#define SOUP_SESSION_PROXY_RESOLVER "proxy-resolver" -</pre> -<p>Alias for the <a class="link" href="SoupSession.html#SoupSession--proxy-resolver" title="The “proxy-resolver” property"><span class="type">“proxy-resolver”</span></a> property, qv.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SESSION-MAX-CONNS:CAPS"></a><h3>SOUP_SESSION_MAX_CONNS</h3> -<pre class="programlisting">#define SOUP_SESSION_MAX_CONNS "max-conns" -</pre> -<p>Alias for the <a class="link" href="SoupSession.html#SoupSession--max-conns" title="The “max-conns” property"><span class="type">“max-conns”</span></a> property, qv.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SESSION-MAX-CONNS-PER-HOST:CAPS"></a><h3>SOUP_SESSION_MAX_CONNS_PER_HOST</h3> -<pre class="programlisting">#define SOUP_SESSION_MAX_CONNS_PER_HOST "max-conns-per-host" -</pre> -<p>Alias for the <a class="link" href="SoupSession.html#SoupSession--max-conns-per-host" title="The “max-conns-per-host” property"><span class="type">“max-conns-per-host”</span></a> property, qv.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SESSION-TLS-DATABASE:CAPS"></a><h3>SOUP_SESSION_TLS_DATABASE</h3> -<pre class="programlisting">#define SOUP_SESSION_TLS_DATABASE "tls-database" -</pre> -<p>Alias for the <a class="link" href="SoupSession.html#SoupSession--tls-database" title="The “tls-database” property"><span class="type">“tls-database”</span></a> property, qv.</p> -<p class="since">Since: 2.38</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SESSION-SSL-USE-SYSTEM-CA-FILE:CAPS"></a><h3>SOUP_SESSION_SSL_USE_SYSTEM_CA_FILE</h3> -<pre class="programlisting">#define SOUP_SESSION_SSL_USE_SYSTEM_CA_FILE "ssl-use-system-ca-file" -</pre> -<p>Alias for the <a class="link" href="SoupSession.html#SoupSession--ssl-use-system-ca-file" title="The “ssl-use-system-ca-file” property"><span class="type">“ssl-use-system-ca-file”</span></a> property, -qv.</p> -<p class="since">Since: 2.38</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SESSION-SSL-CA-FILE:CAPS"></a><h3>SOUP_SESSION_SSL_CA_FILE</h3> -<pre class="programlisting">#define SOUP_SESSION_SSL_CA_FILE "ssl-ca-file" -</pre> -<p>Alias for the <a class="link" href="SoupSession.html#SoupSession--ssl-ca-file" title="The “ssl-ca-file” property"><span class="type">“ssl-ca-file”</span></a> property, qv.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SESSION-SSL-STRICT:CAPS"></a><h3>SOUP_SESSION_SSL_STRICT</h3> -<pre class="programlisting">#define SOUP_SESSION_SSL_STRICT "ssl-strict" -</pre> -<p>Alias for the <a class="link" href="SoupSession.html#SoupSession--ssl-strict" title="The “ssl-strict” property"><span class="type">“ssl-strict”</span></a> property, qv.</p> -<p class="since">Since: 2.30</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SESSION-TLS-INTERACTION:CAPS"></a><h3>SOUP_SESSION_TLS_INTERACTION</h3> -<pre class="programlisting">#define SOUP_SESSION_TLS_INTERACTION "tls-interaction" -</pre> -<p>Alias for the <a class="link" href="SoupSession.html#SoupSession--tls-interaction" title="The “tls-interaction” property"><span class="type">“tls-interaction”</span></a> property, qv.</p> -<p class="since">Since: 2.48</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SESSION-ASYNC-CONTEXT:CAPS"></a><h3>SOUP_SESSION_ASYNC_CONTEXT</h3> -<pre class="programlisting">#define SOUP_SESSION_ASYNC_CONTEXT "async-context" -</pre> -<p>Alias for the <a class="link" href="SoupSession.html#SoupSession--async-context" title="The “async-context” property"><span class="type">“async-context”</span></a> property, qv.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SESSION-USE-THREAD-CONTEXT:CAPS"></a><h3>SOUP_SESSION_USE_THREAD_CONTEXT</h3> -<pre class="programlisting">#define SOUP_SESSION_USE_THREAD_CONTEXT "use-thread-context" -</pre> -<p>Alias for the <a class="link" href="SoupSession.html#SoupSession--use-thread-context" title="The “use-thread-context” property"><span class="type">“use-thread-context”</span></a> property, qv.</p> -<p class="since">Since: 2.38</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SESSION-TIMEOUT:CAPS"></a><h3>SOUP_SESSION_TIMEOUT</h3> -<pre class="programlisting">#define SOUP_SESSION_TIMEOUT "timeout" -</pre> -<p>Alias for the <a class="link" href="SoupSession.html#SoupSession--timeout" title="The “timeout” property"><span class="type">“timeout”</span></a> property, qv.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SESSION-IDLE-TIMEOUT:CAPS"></a><h3>SOUP_SESSION_IDLE_TIMEOUT</h3> -<pre class="programlisting">#define SOUP_SESSION_IDLE_TIMEOUT "idle-timeout" -</pre> -<p>Alias for the <a class="link" href="SoupSession.html#SoupSession--idle-timeout" title="The “idle-timeout” property"><span class="type">“idle-timeout”</span></a> property, qv.</p> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SESSION-USER-AGENT:CAPS"></a><h3>SOUP_SESSION_USER_AGENT</h3> -<pre class="programlisting">#define SOUP_SESSION_USER_AGENT "user-agent" -</pre> -<p>Alias for the <a class="link" href="SoupSession.html#SoupSession--user-agent" title="The “user-agent” property"><span class="type">“user-agent”</span></a> property, qv.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SESSION-ADD-FEATURE:CAPS"></a><h3>SOUP_SESSION_ADD_FEATURE</h3> -<pre class="programlisting">#define SOUP_SESSION_ADD_FEATURE "add-feature" -</pre> -<p>Alias for the <a class="link" href="SoupSession.html#SoupSession--add-feature" title="The “add-feature” property"><span class="type">“add-feature”</span></a> property, qv.</p> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SESSION-ADD-FEATURE-BY-TYPE:CAPS"></a><h3>SOUP_SESSION_ADD_FEATURE_BY_TYPE</h3> -<pre class="programlisting">#define SOUP_SESSION_ADD_FEATURE_BY_TYPE "add-feature-by-type" -</pre> -<p>Alias for the <a class="link" href="SoupSession.html#SoupSession--add-feature-by-type" title="The “add-feature-by-type” property"><span class="type">“add-feature-by-type”</span></a> property, qv.</p> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SESSION-REMOVE-FEATURE-BY-TYPE:CAPS"></a><h3>SOUP_SESSION_REMOVE_FEATURE_BY_TYPE</h3> -<pre class="programlisting">#define SOUP_SESSION_REMOVE_FEATURE_BY_TYPE "remove-feature-by-type" -</pre> -<p>Alias for the <a class="link" href="SoupSession.html#SoupSession--remove-feature-by-type" title="The “remove-feature-by-type” property"><span class="type">“remove-feature-by-type”</span></a> property, -qv.</p> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SESSION-ACCEPT-LANGUAGE:CAPS"></a><h3>SOUP_SESSION_ACCEPT_LANGUAGE</h3> -<pre class="programlisting">#define SOUP_SESSION_ACCEPT_LANGUAGE "accept-language" -</pre> -<p>Alias for the <a class="link" href="SoupSession.html#SoupSession--accept-language" title="The “accept-language” property"><span class="type">“accept-language”</span></a> property, qv.</p> -<p class="since">Since: 2.30</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SESSION-ACCEPT-LANGUAGE-AUTO:CAPS"></a><h3>SOUP_SESSION_ACCEPT_LANGUAGE_AUTO</h3> -<pre class="programlisting">#define SOUP_SESSION_ACCEPT_LANGUAGE_AUTO "accept-language-auto" -</pre> -<p>Alias for the <a class="link" href="SoupSession.html#SoupSession--accept-language-auto" title="The “accept-language-auto” property"><span class="type">“accept-language-auto”</span></a> property, qv.</p> -<p class="since">Since: 2.30</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SESSION-HTTP-ALIASES:CAPS"></a><h3>SOUP_SESSION_HTTP_ALIASES</h3> -<pre class="programlisting">#define SOUP_SESSION_HTTP_ALIASES "http-aliases" -</pre> -<p>Alias for the <a class="link" href="SoupSession.html#SoupSession--http-aliases" title="The “http-aliases” property"><span class="type">“http-aliases”</span></a> property, qv.</p> -<p class="since">Since: 2.38</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SESSION-HTTPS-ALIASES:CAPS"></a><h3>SOUP_SESSION_HTTPS_ALIASES</h3> -<pre class="programlisting">#define SOUP_SESSION_HTTPS_ALIASES "https-aliases" -</pre> -<p>Alias for the <a class="link" href="SoupSession.html#SoupSession--https-aliases" title="The “https-aliases” property"><span class="type">“https-aliases”</span></a> property, qv.</p> -<p class="since">Since: 2.38</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SESSION-LOCAL-ADDRESS:CAPS"></a><h3>SOUP_SESSION_LOCAL_ADDRESS</h3> -<pre class="programlisting">#define SOUP_SESSION_LOCAL_ADDRESS "local-address" -</pre> -<p>Alias for the <a class="link" href="SoupSession.html#SoupSession--local-address" title="The “local-address” property"><span class="type">“local-address”</span></a> property, qv.</p> -<p class="since">Since: 2.42</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupSession.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> -<a name="SoupSession--accept-language"></a><h3>The <code class="literal">“accept-language”</code> property</h3> -<pre class="programlisting"> “accept-language” <span class="type">gchar</span> *</pre> -<p>If non-<code class="literal">NULL</code>, the value to use for the "Accept-Language" header -on <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>s sent from this session.</p> -<p>Setting this will disable -<a class="link" href="SoupSession.html#SoupSession--accept-language-auto" title="The “accept-language-auto” property"><span class="type">“accept-language-auto”</span></a>.</p> -<p>Flags: Read / Write</p> -<p>Default value: NULL</p> -<p class="since">Since: 2.30</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSession--accept-language-auto"></a><h3>The <code class="literal">“accept-language-auto”</code> property</h3> -<pre class="programlisting"> “accept-language-auto” <span class="type">gboolean</span></pre> -<p>If <code class="literal">TRUE</code>, <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> will automatically set the string -for the "Accept-Language" header on every <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> -sent, based on the return value of <code class="function">g_get_language_names()</code>.</p> -<p>Setting this will override any previous value of -<a class="link" href="SoupSession.html#SoupSession--accept-language" title="The “accept-language” property"><span class="type">“accept-language”</span></a>.</p> -<p>Flags: Read / Write</p> -<p>Default value: FALSE</p> -<p class="since">Since: 2.30</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSession--add-feature"></a><h3>The <code class="literal">“add-feature”</code> property</h3> -<pre class="programlisting"> “add-feature” <a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature"><span class="type">SoupSessionFeature</span></a> *</pre> -<p>Add a feature object to the session. (Shortcut for calling -<a class="link" href="SoupSession.html#soup-session-add-feature" title="soup_session_add_feature ()"><code class="function">soup_session_add_feature()</code></a>.)</p> -<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> -<p>Flags: Read / Write</p> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSession--add-feature-by-type"></a><h3>The <code class="literal">“add-feature-by-type”</code> property</h3> -<pre class="programlisting"> “add-feature-by-type” <span class="type">GType</span> *</pre> -<p>Add a feature object of the given type to the session. -(Shortcut for calling <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> -<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> -<p>Flags: Read / Write</p> -<p>Allowed values: GObject</p> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSession--async-context"></a><h3>The <code class="literal">“async-context”</code> property</h3> -<pre class="programlisting"> “async-context” <span class="type">gpointer</span></pre> -<p>The <span class="type">GMainContext</span> that miscellaneous session-related -asynchronous callbacks are invoked on. (Eg, setting -<a class="link" href="SoupSession.html#SoupSession--idle-timeout" title="The “idle-timeout” property"><span class="type">“idle-timeout”</span></a> will add a timeout source on this -context.)</p> -<p>For a plain <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a>, this property is always set to -the <span class="type">GMainContext</span> that is the thread-default at the time -the session was created, and cannot be overridden. For the -deprecated <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> subclasses, the default value is -<code class="literal">NULL</code>, meaning to use the global default <span class="type">GMainContext</span>.</p> -<p>If <a class="link" href="SoupSession.html#SoupSession--use-thread-context" title="The “use-thread-context” property"><span class="type">“use-thread-context”</span></a> is <code class="literal">FALSE</code>, this context -will also be used for asynchronous HTTP I/O.</p> -<p>Flags: Read / Write / Construct Only</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSession--http-aliases"></a><h3>The <code class="literal">“http-aliases”</code> property</h3> -<pre class="programlisting"> “http-aliases” <span class="type">GStrv</span></pre> -<p>A <code class="literal">NULL</code>-terminated array of URI schemes that should be -considered to be aliases for "http". Eg, if this included -<code class="literal">"dav"</code>, than a URI of -<code class="literal">dav://example.com/path</code> would be treated -identically to <code class="literal">http://example.com/path</code>.</p> -<p>In a plain <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a>, the default value is <code class="literal">NULL</code>, -meaning that only "http" is recognized as meaning "http". -In <a class="link" href="SoupSessionAsync.html" title="SoupSessionAsync"><span class="type">SoupSessionAsync</span></a> and <a class="link" href="SoupSessionSync.html" title="SoupSessionSync"><span class="type">SoupSessionSync</span></a>, for backward -compatibility, the default value is an array containing the -single element <code class="literal">"*"</code>, a special value -which means that any scheme except "https" is considered to -be an alias for "http".</p> -<p>See also <a class="link" href="SoupSession.html#SoupSession--https-aliases" title="The “https-aliases” property"><span class="type">“https-aliases”</span></a>.</p> -<p>Flags: Read / Write</p> -<p class="since">Since: 2.38</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSession--https-aliases"></a><h3>The <code class="literal">“https-aliases”</code> property</h3> -<pre class="programlisting"> “https-aliases” <span class="type">GStrv</span></pre> -<p>A comma-delimited list of URI schemes that should be -considered to be aliases for "https". See -<a class="link" href="SoupSession.html#SoupSession--http-aliases" title="The “http-aliases” property"><span class="type">“http-aliases”</span></a> for more information.</p> -<p>The default value is <code class="literal">NULL</code>, meaning that no URI schemes -are considered aliases for "https".</p> -<p>Flags: Read / Write</p> -<p class="since">Since: 2.38</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSession--idle-timeout"></a><h3>The <code class="literal">“idle-timeout”</code> property</h3> -<pre class="programlisting"> “idle-timeout” <span class="type">guint</span></pre> -<p>Connection lifetime (in seconds) when idle. Any connection -left idle longer than this will be closed.</p> -<p>Although you can change this property at any time, it will -only affect newly-created connections, not currently-open -ones. You can call <a class="link" href="SoupSession.html#soup-session-abort" title="soup_session_abort ()"><code class="function">soup_session_abort()</code></a> after setting this -if you want to ensure that all future connections will have -this timeout value.</p> -<p>Note that the default value of 60 seconds only applies to -plain <a href="SoupSession.html#SoupSession-struct"><span class="type">SoupSessions</span></a>. If you are using <a class="link" href="SoupSessionAsync.html" title="SoupSessionAsync"><span class="type">SoupSessionAsync</span></a> or -<a class="link" href="SoupSessionSync.html" title="SoupSessionSync"><span class="type">SoupSessionSync</span></a>, the default value is 0 (meaning idle -connections will never time out).</p> -<p>Flags: Read / Write</p> -<p>Default value: 60</p> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSession--local-address"></a><h3>The <code class="literal">“local-address”</code> property</h3> -<pre class="programlisting"> “local-address” <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> *</pre> -<p>Sets the <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> to use for the client side of -the connection.</p> -<p>Use this property if you want for instance to bind the -local socket to a specific IP address.</p> -<p>Flags: Read / Write / Construct Only</p> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSession--max-conns"></a><h3>The <code class="literal">“max-conns”</code> property</h3> -<pre class="programlisting"> “max-conns” <span class="type">gint</span></pre> -<p>The maximum number of connections that the session can open at once.</p> -<p>Flags: Read / Write</p> -<p>Allowed values: >= 1</p> -<p>Default value: 10</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSession--max-conns-per-host"></a><h3>The <code class="literal">“max-conns-per-host”</code> property</h3> -<pre class="programlisting"> “max-conns-per-host” <span class="type">gint</span></pre> -<p>The maximum number of connections that the session can open at once to a given host.</p> -<p>Flags: Read / Write</p> -<p>Allowed values: >= 1</p> -<p>Default value: 2</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSession--proxy-resolver"></a><h3>The <code class="literal">“proxy-resolver”</code> property</h3> -<pre class="programlisting"> “proxy-resolver” <span class="type">GProxyResolver</span> *</pre> -<p>A <span class="type">GProxyResolver</span> to use with this session. Setting this -will clear the <a class="link" href="SoupSession.html#SoupSession--proxy-uri" title="The “proxy-uri” property"><span class="type">“proxy-uri”</span></a> property, and remove -any <span class="type">SoupProxyURIResolver</span> features that have -been added to the session.</p> -<p>By default, in a plain <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a>, this is set to the -default <span class="type">GProxyResolver</span>, but you can set it to <code class="literal">NULL</code> if you -don't want to use proxies, or set it to your own -<span class="type">GProxyResolver</span> if you want to control what proxies get -used.</p> -<p>Flags: Read / Write</p> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSession--proxy-uri"></a><h3>The <code class="literal">“proxy-uri”</code> property</h3> -<pre class="programlisting"> “proxy-uri” <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *</pre> -<p>A proxy to use for all http and https requests in this -session. Setting this will clear the -<a class="link" href="SoupSession.html#SoupSession--proxy-resolver" title="The “proxy-resolver” property"><span class="type">“proxy-resolver”</span></a> property, and remove any</p> -<span class="type">SoupProxyURIResolver</span> features that have been -<p>added to the session. Setting this property will also -cancel all currently pending messages.</p> -<p>Note that <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> will normally handle looking up the -user's proxy settings for you; you should only use -<a class="link" href="SoupSession.html#SoupSession--proxy-uri" title="The “proxy-uri” property"><span class="type">“proxy-uri”</span></a> if you need to override the user's -normal proxy settings.</p> -<p>Also note that this proxy will be used for -<span class="emphasis"><em>all</em></span> requests; even requests to -<code class="literal">localhost</code>. If you need more control over -proxies, you can create a <span class="type">GSimpleProxyResolver</span> and set the -<a class="link" href="SoupSession.html#SoupSession--proxy-resolver" title="The “proxy-resolver” property"><span class="type">“proxy-resolver”</span></a> property.</p> -<p>Flags: Read / Write</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSession--remove-feature-by-type"></a><h3>The <code class="literal">“remove-feature-by-type”</code> property</h3> -<pre class="programlisting"> “remove-feature-by-type” <span class="type">GType</span> *</pre> -<p>Remove feature objects from the session. (Shortcut for -calling <a class="link" href="SoupSession.html#soup-session-remove-feature-by-type" title="soup_session_remove_feature_by_type ()"><code class="function">soup_session_remove_feature_by_type()</code></a>.)</p> -<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> -<p>Flags: Read / Write</p> -<p>Allowed values: GObject</p> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSession--ssl-ca-file"></a><h3>The <code class="literal">“ssl-ca-file”</code> property</h3> -<pre class="programlisting"> “ssl-ca-file” <span class="type">gchar</span> *</pre> -<p>File containing SSL CA certificates.</p> -<p>If the specified file does not exist or cannot be read, -then libsoup will print a warning, and then behave as -though it had read in a empty CA file, meaning that all SSL -certificates will be considered invalid.</p> -<div class="warning"> -<p><code class="literal">SoupSession:ssl-ca-file</code> is deprecated and should not be used in newly-written code.</p> -<p>use <a class="link" href="SoupSession.html#SoupSession--ssl-use-system-ca-file" title="The “ssl-use-system-ca-file” property"><span class="type">“ssl-use-system-ca-file”</span></a>, or -else <a class="link" href="SoupSession.html#SoupSession--tls-database" title="The “tls-database” property"><span class="type">“tls-database”</span></a> with a <span class="type">GTlsFileDatabase</span> -(which allows you to do explicit error handling).</p> -</div> -<p>Flags: Read / Write</p> -<p>Default value: NULL</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSession--ssl-strict"></a><h3>The <code class="literal">“ssl-strict”</code> property</h3> -<pre class="programlisting"> “ssl-strict” <span class="type">gboolean</span></pre> -<p>Normally, if <a class="link" href="SoupSession.html#SoupSession--tls-database" title="The “tls-database” property"><span class="type">“tls-database”</span></a> is set (including if -it was set via <a class="link" href="SoupSession.html#SoupSession--ssl-use-system-ca-file" title="The “ssl-use-system-ca-file” property"><span class="type">“ssl-use-system-ca-file”</span></a> or -<a class="link" href="SoupSession.html#SoupSession--ssl-ca-file" title="The “ssl-ca-file” property"><span class="type">“ssl-ca-file”</span></a>), then libsoup will reject any -certificate that is invalid (ie, expired) or that is not -signed by one of the given CA certificates, and the -<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> will fail with the status -<a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-SSL-FAILED:CAPS"><code class="literal">SOUP_STATUS_SSL_FAILED</code></a>.</p> -<p>If you set <a class="link" href="SoupSession.html#SoupSession--ssl-strict" title="The “ssl-strict” property"><span class="type">“ssl-strict”</span></a> to <code class="literal">FALSE</code>, then all -certificates will be accepted, and you will need to call -<a class="link" href="SoupMessage.html#soup-message-get-https-status" title="soup_message_get_https_status ()"><code class="function">soup_message_get_https_status()</code></a> to distinguish valid from -invalid certificates. (This can be used, eg, if you want to -accept invalid certificates after giving some sort of -warning.)</p> -<p>For a plain <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a>, if the session has no CA file or -TLS database, and this property is <code class="literal">TRUE</code>, then all -certificates will be rejected. However, beware that the -deprecated <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> subclasses (<a class="link" href="SoupSessionAsync.html" title="SoupSessionAsync"><span class="type">SoupSessionAsync</span></a> and -<a class="link" href="SoupSessionSync.html" title="SoupSessionSync"><span class="type">SoupSessionSync</span></a>) have the opposite behavior: if there is -no CA file or TLS database, then all certificates are always -accepted, and this property has no effect.</p> -<p>Flags: Read / Write</p> -<p>Default value: TRUE</p> -<p class="since">Since: 2.30</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSession--ssl-use-system-ca-file"></a><h3>The <code class="literal">“ssl-use-system-ca-file”</code> property</h3> -<pre class="programlisting"> “ssl-use-system-ca-file” <span class="type">gboolean</span></pre> -<p>Setting this to <code class="literal">TRUE</code> is equivalent to setting -<a class="link" href="SoupSession.html#SoupSession--tls-database" title="The “tls-database” property"><span class="type">“tls-database”</span></a> to the default system CA database. -(and likewise, setting <a class="link" href="SoupSession.html#SoupSession--tls-database" title="The “tls-database” property"><span class="type">“tls-database”</span></a> to the -default database by hand will cause this property to -become <code class="literal">TRUE</code>).</p> -<p>Setting this to <code class="literal">FALSE</code> (when it was previously <code class="literal">TRUE</code>) will -clear the <a class="link" href="SoupSession.html#SoupSession--tls-database" title="The “tls-database” property"><span class="type">“tls-database”</span></a> field.</p> -<p>See <a class="link" href="SoupSession.html#SoupSession--ssl-strict" title="The “ssl-strict” property"><span class="type">“ssl-strict”</span></a> for more information on how -https certificate validation is handled.</p> -<p>Note that the default value of <code class="literal">TRUE</code> only applies to plain -<a href="SoupSession.html#SoupSession-struct"><span class="type">SoupSessions</span></a>. If you are using <a class="link" href="SoupSessionAsync.html" title="SoupSessionAsync"><span class="type">SoupSessionAsync</span></a> or -<a class="link" href="SoupSessionSync.html" title="SoupSessionSync"><span class="type">SoupSessionSync</span></a>, the default value is <code class="literal">FALSE</code>, for backward -compatibility.</p> -<p>Flags: Read / Write</p> -<p>Default value: TRUE</p> -<p class="since">Since: 2.38</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSession--timeout"></a><h3>The <code class="literal">“timeout”</code> property</h3> -<pre class="programlisting"> “timeout” <span class="type">guint</span></pre> -<p>The timeout (in seconds) for socket I/O operations -(including connecting to a server, and waiting for a reply -to an HTTP request).</p> -<p>Although you can change this property at any time, it will -only affect newly-created connections, not currently-open -ones. You can call <a class="link" href="SoupSession.html#soup-session-abort" title="soup_session_abort ()"><code class="function">soup_session_abort()</code></a> after setting this -if you want to ensure that all future connections will have -this timeout value.</p> -<p>Note that the default value of 60 seconds only applies to -plain <a href="SoupSession.html#SoupSession-struct"><span class="type">SoupSessions</span></a>. If you are using <a class="link" href="SoupSessionAsync.html" title="SoupSessionAsync"><span class="type">SoupSessionAsync</span></a> or -<a class="link" href="SoupSessionSync.html" title="SoupSessionSync"><span class="type">SoupSessionSync</span></a>, the default value is 0 (meaning socket I/O -will not time out).</p> -<p>Not to be confused with <a class="link" href="SoupSession.html#SoupSession--idle-timeout" title="The “idle-timeout” property"><span class="type">“idle-timeout”</span></a> (which is -the length of time that idle persistent connections will be -kept open).</p> -<p>Flags: Read / Write</p> -<p>Default value: 0</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSession--tls-database"></a><h3>The <code class="literal">“tls-database”</code> property</h3> -<pre class="programlisting"> “tls-database” <span class="type">GTlsDatabase</span> *</pre> -<p>Sets the <span class="type">GTlsDatabase</span> to use for validating SSL/TLS -certificates.</p> -<p>Note that setting the <a class="link" href="SoupSession.html#SoupSession--ssl-ca-file" title="The “ssl-ca-file” property"><span class="type">“ssl-ca-file”</span></a> or -<a class="link" href="SoupSession.html#SoupSession--ssl-use-system-ca-file" title="The “ssl-use-system-ca-file” property"><span class="type">“ssl-use-system-ca-file”</span></a> property will cause -this property to be set to a <span class="type">GTlsDatabase</span> corresponding to -the indicated file or system default.</p> -<p>See <a class="link" href="SoupSession.html#SoupSession--ssl-strict" title="The “ssl-strict” property"><span class="type">“ssl-strict”</span></a> for more information on how -https certificate validation is handled.</p> -<p>If you are using a plain <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> then -<a class="link" href="SoupSession.html#SoupSession--ssl-use-system-ca-file" title="The “ssl-use-system-ca-file” property"><span class="type">“ssl-use-system-ca-file”</span></a> will be <code class="literal">TRUE</code> by -default, and so this property will be a copy of the system -CA database. If you are using <a class="link" href="SoupSessionAsync.html" title="SoupSessionAsync"><span class="type">SoupSessionAsync</span></a> or -<a class="link" href="SoupSessionSync.html" title="SoupSessionSync"><span class="type">SoupSessionSync</span></a>, this property will be <code class="literal">NULL</code> by default.</p> -<p>Flags: Read / Write</p> -<p class="since">Since: 2.38</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSession--tls-interaction"></a><h3>The <code class="literal">“tls-interaction”</code> property</h3> -<pre class="programlisting"> “tls-interaction” <span class="type">GTlsInteraction</span> *</pre> -<p>A <span class="type">GTlsInteraction</span> object that will be passed on to any -<span class="type">GTlsConnections</span> created by the session. (This can be used to -provide client-side certificates, for example.)</p> -<p>Flags: Read / Write</p> -<p class="since">Since: 2.48</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSession--use-ntlm"></a><h3>The <code class="literal">“use-ntlm”</code> property</h3> -<pre class="programlisting"> “use-ntlm” <span class="type">gboolean</span></pre> -<p>Whether or not to use NTLM authentication.</p> -<div class="warning"> -<p><code class="literal">SoupSession:use-ntlm</code> is deprecated and should not be used in newly-written code.</p> -<p>use <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> with -<a class="link" href="SoupAuth.html#SOUP-TYPE-AUTH-NTLM:CAPS" title="SOUP_TYPE_AUTH_NTLM"><span class="type">SOUP_TYPE_AUTH_NTLM</span></a>.</p> -</div> -<p>Flags: Read / Write</p> -<p>Default value: FALSE</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSession--use-thread-context"></a><h3>The <code class="literal">“use-thread-context”</code> property</h3> -<pre class="programlisting"> “use-thread-context” <span class="type">gboolean</span></pre> -<p>If <code class="literal">TRUE</code> (which it always is on a plain <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a>), -asynchronous HTTP requests in this session will run in -whatever the thread-default <span class="type">GMainContext</span> is at the time -they are started, rather than always occurring in -<a class="link" href="SoupSession.html#SoupSession--async-context" title="The “async-context” property"><span class="type">“async-context”</span></a>.</p> -<p>Flags: Read / Write</p> -<p>Default value: FALSE</p> -<p class="since">Since: 2.38</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSession--user-agent"></a><h3>The <code class="literal">“user-agent”</code> property</h3> -<pre class="programlisting"> “user-agent” <span class="type">gchar</span> *</pre> -<p>If non-<code class="literal">NULL</code>, the value to use for the "User-Agent" header -on <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>s sent from this session.</p> -<p>RFC 2616 says: "The User-Agent request-header field -contains information about the user agent originating the -request. This is for statistical purposes, the tracing of -protocol violations, and automated recognition of user -agents for the sake of tailoring responses to avoid -particular user agent limitations. User agents SHOULD -include this field with requests."</p> -<p>The User-Agent header contains a list of one or more -product tokens, separated by whitespace, with the most -significant product token coming first. The tokens must be -brief, ASCII, and mostly alphanumeric (although "-", "_", -and "." are also allowed), and may optionally include a "/" -followed by a version string. You may also put comments, -enclosed in parentheses, between or after the tokens.</p> -<p>If you set a <a class="link" href="SoupSession.html#SoupSession--user-agent" title="The “user-agent” property"><span class="type">“user_agent”</span></a> property that has trailing -whitespace, <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> will append its own product token -(eg, "<code class="literal">libsoup/2.3.2</code>") to the end of the -header for you.</p> -<p>Flags: Read / Write</p> -<p>Default value: NULL</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupSession.signal-details"></a><h2>Signal Details</h2> -<div class="refsect2"> -<a name="SoupSession-authenticate"></a><h3>The <code class="literal">“authenticate”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session, - <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg, - <a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a> *auth, - <span class="type">gboolean</span> retrying, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted when the session requires authentication. If -credentials are available call <a class="link" href="SoupAuth.html#soup-auth-authenticate" title="soup_auth_authenticate ()"><code class="function">soup_auth_authenticate()</code></a> on -<em class="parameter"><code>auth</code></em> -. If these credentials fail, the signal will be -emitted again, with <em class="parameter"><code>retrying</code></em> - set to <code class="literal">TRUE</code>, which will -continue until you return without calling -<a class="link" href="SoupAuth.html#soup-auth-authenticate" title="soup_auth_authenticate ()"><code class="function">soup_auth_authenticate()</code></a> on <em class="parameter"><code>auth</code></em> -.</p> -<p>Note that this may be emitted before <em class="parameter"><code>msg</code></em> -'s body has been -fully read.</p> -<p>If you call <a class="link" href="SoupSession.html#soup-session-pause-message" title="soup_session_pause_message ()"><code class="function">soup_session_pause_message()</code></a> on <em class="parameter"><code>msg</code></em> - before -returning, then you can authenticate <em class="parameter"><code>auth</code></em> - asynchronously -(as long as you <code class="function">g_object_ref()</code> it to make sure it doesn't -get destroyed), and then unpause <em class="parameter"><code>msg</code></em> - when you are ready -for it to continue.</p> -<div class="refsect3"> -<a name="SoupSession-authenticate.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>session</p></td> -<td class="parameter_description"><p>the session</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>msg</p></td> -<td class="parameter_description"><p>the <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> being sent</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>auth</p></td> -<td class="parameter_description"><p>the <a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a> to authenticate</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>retrying</p></td> -<td class="parameter_description"><p><code class="literal">TRUE</code> if this is the second (or later) attempt</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run First</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSession-connection-created"></a><h3>The <code class="literal">“connection-created”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session, - <span class="type">GObject</span> *connection, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted when a new connection is created. This is an -internal signal intended only to be used for debugging -purposes, and may go away in the future.</p> -<div class="refsect3"> -<a name="SoupSession-connection-created.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>session</p></td> -<td class="parameter_description"><p>the <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>connection</p></td> -<td class="parameter_description"><p>the connection</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run First</p> -<p class="since">Since: 2.30</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSession-request-queued"></a><h3>The <code class="literal">“request-queued”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session, - <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted when a request is queued on <em class="parameter"><code>session</code></em> -. (Note that -"queued" doesn't just mean <a class="link" href="SoupSession.html#soup-session-queue-message" title="soup_session_queue_message ()"><code class="function">soup_session_queue_message()</code></a>; -<a class="link" href="SoupSession.html#soup-session-send-message" title="soup_session_send_message ()"><code class="function">soup_session_send_message()</code></a> implicitly queues the message -as well.)</p> -<p>When sending a request, first <a class="link" href="SoupSession.html#SoupSession-request-queued" title="The “request-queued” signal"><span class="type">“request_queued”</span></a> -is emitted, indicating that the session has become aware of -the request.</p> -<p>Once a connection is available to send the request on, the -session emits <a class="link" href="SoupSession.html#SoupSession-request-started" title="The “request-started” signal"><span class="type">“request_started”</span></a>. Then, various -<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> signals are emitted as the message is -processed. If the message is requeued, it will emit -<a class="link" href="SoupMessage.html#SoupMessage-restarted" title="The “restarted” signal"><span class="type">“restarted”</span></a>, which will then be followed by -another <a class="link" href="SoupSession.html#SoupSession-request-started" title="The “request-started” signal"><span class="type">“request_started”</span></a> and another set of -<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> signals when the message is re-sent.</p> -<p>Eventually, the message will emit <a class="link" href="SoupMessage.html#SoupMessage-finished" title="The “finished” signal"><span class="type">“finished”</span></a>. -Normally, this signals the completion of message -processing. However, it is possible that the application -will requeue the message from the "finished" handler (or -equivalently, from the <a class="link" href="SoupSession.html#soup-session-queue-message" title="soup_session_queue_message ()"><code class="function">soup_session_queue_message()</code></a> -callback). In that case, the process will loop back to -<a class="link" href="SoupSession.html#SoupSession-request-started" title="The “request-started” signal"><span class="type">“request_started”</span></a>.</p> -<p>Eventually, a message will reach "finished" and not be -requeued. At that point, the session will emit -<a class="link" href="SoupSession.html#SoupSession-request-unqueued" title="The “request-unqueued” signal"><span class="type">“request_unqueued”</span></a> to indicate that it is done -with the message.</p> -<p>To sum up: <a class="link" href="SoupSession.html#SoupSession-request-queued" title="The “request-queued” signal"><span class="type">“request_queued”</span></a> and -<a class="link" href="SoupSession.html#SoupSession-request-unqueued" title="The “request-unqueued” signal"><span class="type">“request_unqueued”</span></a> are guaranteed to be emitted -exactly once, but <a class="link" href="SoupSession.html#SoupSession-request-started" title="The “request-started” signal"><span class="type">“request_started”</span></a> and -<a class="link" href="SoupMessage.html#SoupMessage-finished" title="The “finished” signal"><span class="type">“finished”</span></a> (and all of the other <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> -signals) may be invoked multiple times for a given message.</p> -<div class="refsect3"> -<a name="SoupSession-request-queued.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>session</p></td> -<td class="parameter_description"><p>the session</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>msg</p></td> -<td class="parameter_description"><p>the request that was queued</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run First</p> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSession-request-started"></a><h3>The <code class="literal">“request-started”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session, - <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg, - <a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a> *socket, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted just before a request is sent. See -<a class="link" href="SoupSession.html#SoupSession-request-queued" title="The “request-queued” signal"><span class="type">“request_queued”</span></a> for a detailed description of -the message lifecycle within a session.</p> -<div class="warning"> -<p><code class="literal">SoupSession::request-started</code> has been deprecated since version 2.50. and should not be used in newly-written code.</p> -<p>Use <a class="link" href="SoupMessage.html#SoupMessage-starting" title="The “starting” signal"><span class="type">“starting”</span></a> instead.</p> -</div> -<div class="refsect3"> -<a name="SoupSession-request-started.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>session</p></td> -<td class="parameter_description"><p>the session</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>msg</p></td> -<td class="parameter_description"><p>the request being sent</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>socket</p></td> -<td class="parameter_description"><p>the socket the request is being sent on</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run First</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSession-request-unqueued"></a><h3>The <code class="literal">“request-unqueued”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session, - <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted when a request is removed from <em class="parameter"><code>session</code></em> -'s queue, -indicating that <em class="parameter"><code>session</code></em> - is done with it. See -<a class="link" href="SoupSession.html#SoupSession-request-queued" title="The “request-queued” signal"><span class="type">“request_queued”</span></a> for a detailed description of the -message lifecycle within a session.</p> -<div class="refsect3"> -<a name="SoupSession-request-unqueued.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>session</p></td> -<td class="parameter_description"><p>the session</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>msg</p></td> -<td class="parameter_description"><p>the request that was unqueued</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run First</p> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSession-tunneling"></a><h3>The <code class="literal">“tunneling”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> *session, - <span class="type">GObject</span> *connection, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted when an SSL tunnel is being created on a proxy -connection. This is an internal signal intended only to be -used for debugging purposes, and may go away in the future.</p> -<div class="refsect3"> -<a name="SoupSession-tunneling.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>session</p></td> -<td class="parameter_description"><p>the <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>connection</p></td> -<td class="parameter_description"><p>the connection</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run First</p> -<p class="since">Since: 2.30</p> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/SoupSessionAsync.html b/docs/reference/html/SoupSessionAsync.html deleted file mode 100644 index bf1ce9f5..00000000 --- a/docs/reference/html/SoupSessionAsync.html +++ /dev/null @@ -1,81 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SoupSessionAsync: 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="ch02.html" title="Core API"> -<link rel="prev" href="SoupSession.html" title="SoupSession"> -<link rel="next" href="SoupSessionSync.html" title="SoupSessionSync"> -<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="#SoupSessionAsync.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupSessionAsync.object-hierarchy" class="shortcut">Object Hierarchy</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="SoupSession.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="SoupSessionSync.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="SoupSessionAsync"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="SoupSessionAsync.top_of_page"></a>SoupSessionAsync</span></h2> -<p>SoupSessionAsync — SoupSession for asynchronous (main-loop-based) I/O -(deprecated).</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="SoupSessionAsync.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="SoupSessionAsync.html#SoupSessionAsync-struct" title="SoupSessionAsync">SoupSessionAsync</a></td> -</tr></tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupSessionAsync.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> GObject - <span class="lineart">╰──</span> <a class="link" href="SoupSession.html" title="SoupSession">SoupSession</a> - <span class="lineart">╰──</span> SoupSessionAsync -</pre> -</div> -<div class="refsect1"> -<a name="SoupSessionAsync.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="SoupSessionAsync.description"></a><h2>Description</h2> -<p><a class="link" href="SoupSessionAsync.html" title="SoupSessionAsync"><span class="type">SoupSessionAsync</span></a> is an implementation of <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> that uses -non-blocking I/O via the glib main loop for all I/O.</p> -</div> -<div class="refsect1"> -<a name="SoupSessionAsync.functions_details"></a><h2>Functions</h2> -<p></p> -</div> -<div class="refsect1"> -<a name="SoupSessionAsync.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupSessionAsync-struct"></a><h3>SoupSessionAsync</h3> -<pre class="programlisting">typedef struct _SoupSessionAsync SoupSessionAsync;</pre> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/SoupSessionFeature.html b/docs/reference/html/SoupSessionFeature.html deleted file mode 100644 index 01bd0087..00000000 --- a/docs/reference/html/SoupSessionFeature.html +++ /dev/null @@ -1,197 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SoupSessionFeature: 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="ch03.html" title="Additional Features"> -<link rel="next" href="SoupAuthManager.html" title="SoupAuthManager"> -<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="#SoupSessionFeature.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupSessionFeature.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites"> <span class="dim">|</span> - <a href="#SoupSessionFeature.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_implementations"> <span class="dim">|</span> - <a href="#SoupSessionFeature.implementations" class="shortcut">Known Implementations</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="ch03.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="SoupAuthManager.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="SoupSessionFeature"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="SoupSessionFeature.top_of_page"></a>SoupSessionFeature</span></h2> -<p>SoupSessionFeature — Interface for miscellaneous session features</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="SoupSessionFeature.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="SoupSessionFeature.html#SoupSessionFeature-struct" title="SoupSessionFeature">SoupSessionFeature</a></td> -</tr> -<tr> -<td class="datatype_keyword"> </td> -<td class="function_name"><a class="link" href="SoupSessionFeature.html#SoupSessionFeatureInterface" title="SoupSessionFeatureInterface">SoupSessionFeatureInterface</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupSessionFeature.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> <a href="/home/claudio/gnome3/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a> - <span class="lineart">╰──</span> SoupSessionFeature -</pre> -</div> -<div class="refsect1"> -<a name="SoupSessionFeature.prerequisites"></a><h2>Prerequisites</h2> -<p> -SoupSessionFeature requires - GObject.</p> -</div> -<div class="refsect1"> -<a name="SoupSessionFeature.implementations"></a><h2>Known Implementations</h2> -<p> -SoupSessionFeature is implemented by - <a class="link" href="SoupAuthManager.html" title="SoupAuthManager">SoupAuthManager</a>, <a class="link" href="SoupCache.html" title="SoupCache">SoupCache</a>, <a class="link" href="SoupContentDecoder.html" title="SoupContentDecoder">SoupContentDecoder</a>, <a class="link" href="SoupContentSniffer.html" title="SoupContentSniffer">SoupContentSniffer</a>, <a class="link" href="SoupCookieJar.html" title="SoupCookieJar">SoupCookieJar</a>, <a class="link" href="SoupCookieJarDB.html" title="SoupCookieJarDB">SoupCookieJarDB</a>, <a class="link" href="SoupCookieJarText.html" title="SoupCookieJarText">SoupCookieJarText</a>, <a class="link" href="SoupLogger.html" title="SoupLogger">SoupLogger</a> and <a class="link" href="SoupProxyResolverDefault.html" title="SoupProxyResolverDefault">SoupProxyResolverDefault</a>.</p> -</div> -<div class="refsect1"> -<a name="SoupSessionFeature.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="SoupSessionFeature.description"></a><h2>Description</h2> -<p><a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature"><span class="type">SoupSessionFeature</span></a> is the interface used by classes that extend -the functionality of a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a>. Some features like HTTP -authentication handling are implemented internally via -<a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature"><span class="type">SoupSessionFeature</span></a>s. Other features can be added to the session -by the application. (Eg, <a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a>, <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a>.)</p> -<p>See <a class="link" href="SoupSession.html#soup-session-add-feature" title="soup_session_add_feature ()"><code class="function">soup_session_add_feature()</code></a>, etc, to add a feature to a session.</p> -</div> -<div class="refsect1"> -<a name="SoupSessionFeature.functions_details"></a><h2>Functions</h2> -<p></p> -</div> -<div class="refsect1"> -<a name="SoupSessionFeature.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupSessionFeature-struct"></a><h3>SoupSessionFeature</h3> -<pre class="programlisting">typedef struct _SoupSessionFeature SoupSessionFeature;</pre> -<p>An object that implement some sort of optional feature for -<a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a>.</p> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSessionFeatureInterface"></a><h3>SoupSessionFeatureInterface</h3> -<pre class="programlisting">typedef struct { - GTypeInterface parent; - - /* methods */ - void (*attach) (SoupSessionFeature *feature, - SoupSession *session); - void (*detach) (SoupSessionFeature *feature, - SoupSession *session); - - void (*request_queued) (SoupSessionFeature *feature, - SoupSession *session, - SoupMessage *msg); - void (*request_started) (SoupSessionFeature *feature, - SoupSession *session, - SoupMessage *msg, - SoupSocket *socket); - void (*request_unqueued) (SoupSessionFeature *feature, - SoupSession *session, - SoupMessage *msg); - - gboolean (*add_feature) (SoupSessionFeature *feature, - GType type); - gboolean (*remove_feature) (SoupSessionFeature *feature, - GType type); - gboolean (*has_feature) (SoupSessionFeature *feature, - GType type); -} SoupSessionFeatureInterface; -</pre> -<p>The interface implemented by <a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature"><span class="type">SoupSessionFeature</span></a>s.</p> -<div class="refsect3"> -<a name="SoupSessionFeatureInterface.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="struct_members_name"> -<col class="struct_members_description"> -<col width="200px" class="struct_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="struct_member_name"><p><span class="type">GTypeInterface</span> <em class="structfield"><code><a name="SoupSessionFeatureInterface.parent"></a>parent</code></em>;</p></td> -<td class="struct_member_description"><p>The parent interface.</p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><em class="structfield"><code><a name="SoupSessionFeatureInterface.attach"></a>attach</code></em> ()</p></td> -<td class="struct_member_description"><p>Perform setup when a feature is added to a session</p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><em class="structfield"><code><a name="SoupSessionFeatureInterface.detach"></a>detach</code></em> ()</p></td> -<td class="struct_member_description"><p>Perform cleanup when a feature is removed from a session</p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><em class="structfield"><code><a name="SoupSessionFeatureInterface.request-queued"></a>request_queued</code></em> ()</p></td> -<td class="struct_member_description"><p>Proxies the session's <a class="link" href="SoupSession.html#SoupSession-request-queued" title="The “request-queued” signal"><span class="type">“request_queued”</span></a> signal</p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><em class="structfield"><code><a name="SoupSessionFeatureInterface.request-started"></a>request_started</code></em> ()</p></td> -<td class="struct_member_description"><p>Proxies the session's <a class="link" href="SoupSession.html#SoupSession-request-started" title="The “request-started” signal"><span class="type">“request_started”</span></a> signal. Deprecated 2.50. Use <a class="link" href="SoupMessage.html#SoupMessage-starting" title="The “starting” signal"><span class="type">“starting”</span></a> instead.</p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><em class="structfield"><code><a name="SoupSessionFeatureInterface.request-unqueued"></a>request_unqueued</code></em> ()</p></td> -<td class="struct_member_description"><p>Proxies the session's <a class="link" href="SoupSession.html#SoupSession-request-unqueued" title="The “request-unqueued” signal"><span class="type">“request_unqueued”</span></a> signal</p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><em class="structfield"><code><a name="SoupSessionFeatureInterface.add-feature"></a>add_feature</code></em> ()</p></td> -<td class="struct_member_description"><p>adds a sub-feature to the main feature</p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><em class="structfield"><code><a name="SoupSessionFeatureInterface.remove-feature"></a>remove_feature</code></em> ()</p></td> -<td class="struct_member_description"><p>removes a sub-feature from the main feature</p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><em class="structfield"><code><a name="SoupSessionFeatureInterface.has-feature"></a>has_feature</code></em> ()</p></td> -<td class="struct_member_description"><p>tests if the feature includes a sub-feature</p></td> -<td class="struct_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.24</p> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/SoupSessionSync.html b/docs/reference/html/SoupSessionSync.html deleted file mode 100644 index b9d6f148..00000000 --- a/docs/reference/html/SoupSessionSync.html +++ /dev/null @@ -1,81 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SoupSessionSync: 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="ch02.html" title="Core API"> -<link rel="prev" href="SoupSessionAsync.html" title="SoupSessionAsync"> -<link rel="next" href="libsoup-2.4-soup-status.html" title="soup-status"> -<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="#SoupSessionSync.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupSessionSync.object-hierarchy" class="shortcut">Object Hierarchy</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="SoupSessionAsync.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="libsoup-2.4-soup-status.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="SoupSessionSync"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="SoupSessionSync.top_of_page"></a>SoupSessionSync</span></h2> -<p>SoupSessionSync — SoupSession for blocking I/O in multithreaded programs -(deprecated).</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="SoupSessionSync.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="SoupSessionSync.html#SoupSessionSync-struct" title="SoupSessionSync">SoupSessionSync</a></td> -</tr></tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupSessionSync.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> GObject - <span class="lineart">╰──</span> <a class="link" href="SoupSession.html" title="SoupSession">SoupSession</a> - <span class="lineart">╰──</span> SoupSessionSync -</pre> -</div> -<div class="refsect1"> -<a name="SoupSessionSync.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="SoupSessionSync.description"></a><h2>Description</h2> -<p><a class="link" href="SoupSessionSync.html" title="SoupSessionSync"><span class="type">SoupSessionSync</span></a> is an implementation of <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> that uses -synchronous I/O, intended for use in multi-threaded programs.</p> -</div> -<div class="refsect1"> -<a name="SoupSessionSync.functions_details"></a><h2>Functions</h2> -<p></p> -</div> -<div class="refsect1"> -<a name="SoupSessionSync.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupSessionSync-struct"></a><h3>SoupSessionSync</h3> -<pre class="programlisting">typedef struct _SoupSessionSync SoupSessionSync;</pre> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/SoupSocket.html b/docs/reference/html/SoupSocket.html deleted file mode 100644 index 59807f32..00000000 --- a/docs/reference/html/SoupSocket.html +++ /dev/null @@ -1,1624 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SoupSocket: 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="ch05.html" title="Low-level Networking API"> -<link rel="prev" href="SoupAddress.html" title="SoupAddress"> -<link rel="next" href="ix01.html" title="Index"> -<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="#SoupSocket.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupSocket.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> - <a href="#SoupSocket.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> - <a href="#SoupSocket.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> - <a href="#SoupSocket.signals" class="shortcut">Signals</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="ch05.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="SoupAddress.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="ix01.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="SoupSocket"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="SoupSocket.top_of_page"></a>SoupSocket</span></h2> -<p>SoupSocket — A network socket</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="SoupSocket.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="SoupSocket.html" title="SoupSocket"><span class="returnvalue">SoupSocket</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupSocket.html#soup-socket-new" title="soup_socket_new ()">soup_socket_new</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<span class="c_punctuation">(</span><a class="link" href="SoupSocket.html#SoupSocketCallback" title="SoupSocketCallback ()">*SoupSocketCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupSocket.html#soup-socket-connect-async" title="soup_socket_connect_async ()">soup_socket_connect_async</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">guint</span> -</td> -<td class="function_name"> -<a class="link" href="SoupSocket.html#soup-socket-connect-sync" title="soup_socket_connect_sync ()">soup_socket_connect_sync</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupSocket.html#soup-socket-listen" title="soup_socket_listen ()">soup_socket_listen</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupSocket.html#soup-socket-start-ssl" title="soup_socket_start_ssl ()">soup_socket_start_ssl</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupSocket.html#soup-socket-start-proxy-ssl" title="soup_socket_start_proxy_ssl ()">soup_socket_start_proxy_ssl</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupSocket.html#soup-socket-is-ssl" title="soup_socket_is_ssl ()">soup_socket_is_ssl</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupSocket.html#soup-socket-disconnect" title="soup_socket_disconnect ()">soup_socket_disconnect</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupSocket.html#soup-socket-is-connected" title="soup_socket_is_connected ()">soup_socket_is_connected</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupAddress.html" title="SoupAddress"><span class="returnvalue">SoupAddress</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupSocket.html#soup-socket-get-local-address" title="soup_socket_get_local_address ()">soup_socket_get_local_address</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupAddress.html" title="SoupAddress"><span class="returnvalue">SoupAddress</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupSocket.html#soup-socket-get-remote-address" title="soup_socket_get_remote_address ()">soup_socket_get_remote_address</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">int</span> -</td> -<td class="function_name"> -<a class="link" href="SoupSocket.html#soup-socket-get-fd" title="soup_socket_get_fd ()">soup_socket_get_fd</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupSocket.html#SoupSocketIOStatus" title="enum SoupSocketIOStatus"><span class="returnvalue">SoupSocketIOStatus</span></a> -</td> -<td class="function_name"> -<a class="link" href="SoupSocket.html#soup-socket-read" title="soup_socket_read ()">soup_socket_read</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupSocket.html#SoupSocketIOStatus" title="enum SoupSocketIOStatus"><span class="returnvalue">SoupSocketIOStatus</span></a> -</td> -<td class="function_name"> -<a class="link" href="SoupSocket.html#soup-socket-read-until" title="soup_socket_read_until ()">soup_socket_read_until</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupSocket.html#SoupSocketIOStatus" title="enum SoupSocketIOStatus"><span class="returnvalue">SoupSocketIOStatus</span></a> -</td> -<td class="function_name"> -<a class="link" href="SoupSocket.html#soup-socket-write" title="soup_socket_write ()">soup_socket_write</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupSocket.properties"></a><h2>Properties</h2> -<div class="informaltable"><table class="informaltable" border="0"> -<colgroup> -<col width="150px" class="properties_type"> -<col width="300px" class="properties_name"> -<col width="200px" class="properties_flags"> -</colgroup> -<tbody> -<tr> -<td class="property_type"><span class="type">gpointer</span></td> -<td class="property_name"><a class="link" href="SoupSocket.html#SoupSocket--async-context" title="The “async-context” property">async-context</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -<tr> -<td class="property_type"><span class="type">gint</span></td> -<td class="property_name"><a class="link" href="SoupSocket.html#SoupSocket--fd" title="The “fd” property">fd</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">GSocket</span> *</td> -<td class="property_name"><a class="link" href="SoupSocket.html#SoupSocket--gsocket" title="The “gsocket” property">gsocket</a></td> -<td class="property_flags">Write / Construct Only</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">GIOStream</span> *</td> -<td class="property_name"><a class="link" href="SoupSocket.html#SoupSocket--iostream" title="The “iostream” property">iostream</a></td> -<td class="property_flags">Write / Construct Only</td> -</tr> -<tr> -<td class="property_type"><span class="type">gboolean</span></td> -<td class="property_name"><a class="link" href="SoupSocket.html#SoupSocket--ipv6-only" title="The “ipv6-only” property">ipv6-only</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><span class="type">gboolean</span></td> -<td class="property_name"><a class="link" href="SoupSocket.html#SoupSocket--is-server" title="The “is-server” property">is-server</a></td> -<td class="property_flags">Read</td> -</tr> -<tr> -<td class="property_type"> -<a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> *</td> -<td class="property_name"><a class="link" href="SoupSocket.html#SoupSocket--local-address" title="The “local-address” property">local-address</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -<tr> -<td class="property_type"><span class="type">gboolean</span></td> -<td class="property_name"><a class="link" href="SoupSocket.html#SoupSocket--non-blocking" title="The “non-blocking” property">non-blocking</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> *</td> -<td class="property_name"><a class="link" href="SoupSocket.html#SoupSocket--remote-address" title="The “remote-address” property">remote-address</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">SoupSocketProperties</span> *</td> -<td class="property_name"><a class="link" href="SoupSocket.html#SoupSocket--socket-properties" title="The “socket-properties” property">socket-properties</a></td> -<td class="property_flags">Write</td> -</tr> -<tr> -<td class="property_type"><span class="type">gpointer</span></td> -<td class="property_name"><a class="link" href="SoupSocket.html#SoupSocket--ssl-creds" title="The “ssl-creds” property">ssl-creds</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><span class="type">gboolean</span></td> -<td class="property_name"><a class="link" href="SoupSocket.html#SoupSocket--ssl-fallback" title="The “ssl-fallback” property">ssl-fallback</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -<tr> -<td class="property_type"><span class="type">gboolean</span></td> -<td class="property_name"><a class="link" href="SoupSocket.html#SoupSocket--ssl-strict" title="The “ssl-strict” property">ssl-strict</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -<tr> -<td class="property_type"><span class="type">guint</span></td> -<td class="property_name"><a class="link" href="SoupSocket.html#SoupSocket--timeout" title="The “timeout” property">timeout</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">GTlsCertificate</span> *</td> -<td class="property_name"><a class="link" href="SoupSocket.html#SoupSocket--tls-certificate" title="The “tls-certificate” property">tls-certificate</a></td> -<td class="property_flags">Read</td> -</tr> -<tr> -<td class="property_type"><span class="type">GTlsCertificateFlags</span></td> -<td class="property_name"><a class="link" href="SoupSocket.html#SoupSocket--tls-errors" title="The “tls-errors” property">tls-errors</a></td> -<td class="property_flags">Read</td> -</tr> -<tr> -<td class="property_type"><span class="type">gboolean</span></td> -<td class="property_name"><a class="link" href="SoupSocket.html#SoupSocket--trusted-certificate" title="The “trusted-certificate” property">trusted-certificate</a></td> -<td class="property_flags">Read</td> -</tr> -<tr> -<td class="property_type"><span class="type">gboolean</span></td> -<td class="property_name"><a class="link" href="SoupSocket.html#SoupSocket--use-thread-context" title="The “use-thread-context” property">use-thread-context</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupSocket.signals"></a><h2>Signals</h2> -<div class="informaltable"><table class="informaltable" border="0"> -<colgroup> -<col width="150px" class="signals_return"> -<col width="300px" class="signals_name"> -<col width="200px" class="signals_flags"> -</colgroup> -<tbody> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="SoupSocket.html#SoupSocket-disconnected" title="The “disconnected” signal">disconnected</a></td> -<td class="signal_flags">Run Last</td> -</tr> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="SoupSocket.html#SoupSocket-event" title="The “event” signal">event</a></td> -<td class="signal_flags">Run Last</td> -</tr> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="SoupSocket.html#SoupSocket-new-connection" title="The “new-connection” signal">new-connection</a></td> -<td class="signal_flags">Run First</td> -</tr> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="SoupSocket.html#SoupSocket-readable" title="The “readable” signal">readable</a></td> -<td class="signal_flags">Run Last</td> -</tr> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="SoupSocket.html#SoupSocket-writable" title="The “writable” signal">writable</a></td> -<td class="signal_flags">Run Last</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupSocket.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="SoupSocket.html#SoupSocket-struct" title="SoupSocket">SoupSocket</a></td> -</tr> -<tr> -<td class="datatype_keyword">enum</td> -<td class="function_name"><a class="link" href="SoupSocket.html#SoupSocketIOStatus" title="enum SoupSocketIOStatus">SoupSocketIOStatus</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSocket.html#SOUP-SOCKET-LOCAL-ADDRESS:CAPS" title="SOUP_SOCKET_LOCAL_ADDRESS">SOUP_SOCKET_LOCAL_ADDRESS</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSocket.html#SOUP-SOCKET-REMOTE-ADDRESS:CAPS" title="SOUP_SOCKET_REMOTE_ADDRESS">SOUP_SOCKET_REMOTE_ADDRESS</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSocket.html#SOUP-SOCKET-FLAG-NONBLOCKING:CAPS" title="SOUP_SOCKET_FLAG_NONBLOCKING">SOUP_SOCKET_FLAG_NONBLOCKING</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSocket.html#SOUP-SOCKET-IS-SERVER:CAPS" title="SOUP_SOCKET_IS_SERVER">SOUP_SOCKET_IS_SERVER</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSocket.html#SOUP-SOCKET-SSL-CREDENTIALS:CAPS" title="SOUP_SOCKET_SSL_CREDENTIALS">SOUP_SOCKET_SSL_CREDENTIALS</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSocket.html#SOUP-SOCKET-ASYNC-CONTEXT:CAPS" title="SOUP_SOCKET_ASYNC_CONTEXT">SOUP_SOCKET_ASYNC_CONTEXT</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSocket.html#SOUP-SOCKET-TIMEOUT:CAPS" title="SOUP_SOCKET_TIMEOUT">SOUP_SOCKET_TIMEOUT</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSocket.html#SOUP-SOCKET-SSL-FALLBACK:CAPS" title="SOUP_SOCKET_SSL_FALLBACK">SOUP_SOCKET_SSL_FALLBACK</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSocket.html#SOUP-SOCKET-SSL-STRICT:CAPS" title="SOUP_SOCKET_SSL_STRICT">SOUP_SOCKET_SSL_STRICT</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSocket.html#SOUP-SOCKET-TLS-CERTIFICATE:CAPS" title="SOUP_SOCKET_TLS_CERTIFICATE">SOUP_SOCKET_TLS_CERTIFICATE</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSocket.html#SOUP-SOCKET-TLS-ERRORS:CAPS" title="SOUP_SOCKET_TLS_ERRORS">SOUP_SOCKET_TLS_ERRORS</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSocket.html#SOUP-SOCKET-TRUSTED-CERTIFICATE:CAPS" title="SOUP_SOCKET_TRUSTED_CERTIFICATE">SOUP_SOCKET_TRUSTED_CERTIFICATE</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupSocket.html#SOUP-SOCKET-USE-THREAD-CONTEXT:CAPS" title="SOUP_SOCKET_USE_THREAD_CONTEXT">SOUP_SOCKET_USE_THREAD_CONTEXT</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupSocket.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> GObject - <span class="lineart">╰──</span> SoupSocket -</pre> -</div> -<div class="refsect1"> -<a name="SoupSocket.implemented-interfaces"></a><h2>Implemented Interfaces</h2> -<p> -SoupSocket implements - GInitable.</p> -</div> -<div class="refsect1"> -<a name="SoupSocket.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="SoupSocket.description"></a><h2>Description</h2> -<p><a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a> is libsoup's TCP socket type. While it is primarily -intended for internal use, <a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a>s are exposed in the -API in various places, and some of their methods (eg, -<a class="link" href="SoupSocket.html#soup-socket-get-remote-address" title="soup_socket_get_remote_address ()"><code class="function">soup_socket_get_remote_address()</code></a>) may be useful to applications.</p> -</div> -<div class="refsect1"> -<a name="SoupSocket.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="soup-socket-new"></a><h3>soup_socket_new ()</h3> -<pre class="programlisting"><a class="link" href="SoupSocket.html" title="SoupSocket"><span class="returnvalue">SoupSocket</span></a> * -soup_socket_new (<em class="parameter"><code>const <span class="type">char</span> *optname1</code></em>, - <em class="parameter"><code>...</code></em>);</pre> -<p>Creates a new (disconnected) socket</p> -<div class="refsect3"> -<a name="soup-socket-new.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>optname1</p></td> -<td class="parameter_description"><p>name of first property to set (or <code class="literal">NULL</code>)</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>...</p></td> -<td class="parameter_description"><p>value of <em class="parameter"><code>optname1</code></em> -, followed by additional property/value pairs</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-socket-new.returns"></a><h4>Returns</h4> -<p> the new socket</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSocketCallback"></a><h3>SoupSocketCallback ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -<span class="c_punctuation">(</span>*SoupSocketCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a> *sock</code></em>, - <em class="parameter"><code><span class="type">guint</span> status</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> -<p>The callback function passed to <a class="link" href="SoupSocket.html#soup-socket-connect-async" title="soup_socket_connect_async ()"><code class="function">soup_socket_connect_async()</code></a>.</p> -<div class="refsect3"> -<a name="SoupSocketCallback.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>sock</p></td> -<td class="parameter_description"><p>the <a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>status</p></td> -<td class="parameter_description"><p>an HTTP status code indicating success or failure</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>the data passed to <a class="link" href="SoupSocket.html#soup-socket-connect-async" title="soup_socket_connect_async ()"><code class="function">soup_socket_connect_async()</code></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-socket-connect-async"></a><h3>soup_socket_connect_async ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_socket_connect_async (<em class="parameter"><code><a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a> *sock</code></em>, - <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>, - <em class="parameter"><code><a class="link" href="SoupSocket.html#SoupSocketCallback" title="SoupSocketCallback ()"><span class="type">SoupSocketCallback</span></a> callback</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> -<p>Begins asynchronously connecting to <em class="parameter"><code>sock</code></em> -'s remote address. The -socket will call <em class="parameter"><code>callback</code></em> - when it succeeds or fails (but not -before returning from this function).</p> -<p>If <em class="parameter"><code>cancellable</code></em> - is non-<code class="literal">NULL</code>, it can be used to cancel the -connection. <em class="parameter"><code>callback</code></em> - will still be invoked in this case, with a -status of <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-CANCELLED:CAPS"><code class="literal">SOUP_STATUS_CANCELLED</code></a>.</p> -<div class="refsect3"> -<a name="soup-socket-connect-async.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>sock</p></td> -<td class="parameter_description"><p>a client <a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a> (which must not already be connected)</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>cancellable</p></td> -<td class="parameter_description"><p>a <span class="type">GCancellable</span>, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>callback</p></td> -<td class="parameter_description"><p>callback to call after connecting. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>data to pass to <em class="parameter"><code>callback</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-socket-connect-sync"></a><h3>soup_socket_connect_sync ()</h3> -<pre class="programlisting"><span class="returnvalue">guint</span> -soup_socket_connect_sync (<em class="parameter"><code><a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a> *sock</code></em>, - <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>);</pre> -<p>Attempt to synchronously connect <em class="parameter"><code>sock</code></em> - to its remote address.</p> -<p>If <em class="parameter"><code>cancellable</code></em> - is non-<code class="literal">NULL</code>, it can be used to cancel the -connection, in which case <a class="link" href="SoupSocket.html#soup-socket-connect-sync" title="soup_socket_connect_sync ()"><code class="function">soup_socket_connect_sync()</code></a> will return -<a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-CANCELLED:CAPS"><code class="literal">SOUP_STATUS_CANCELLED</code></a>.</p> -<div class="refsect3"> -<a name="soup-socket-connect-sync.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>sock</p></td> -<td class="parameter_description"><p>a client <a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a> (which must not already be connected)</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>cancellable</p></td> -<td class="parameter_description"><p>a <span class="type">GCancellable</span>, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-socket-connect-sync.returns"></a><h4>Returns</h4> -<p> a success or failure code.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-socket-listen"></a><h3>soup_socket_listen ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_socket_listen (<em class="parameter"><code><a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a> *sock</code></em>);</pre> -<p>Makes <em class="parameter"><code>sock</code></em> - start listening on its local address. When connections -come in, <em class="parameter"><code>sock</code></em> - will emit <a class="link" href="SoupSocket.html#SoupSocket-new-connection" title="The “new-connection” signal"><span class="type">“new_connection”</span></a>.</p> -<div class="refsect3"> -<a name="soup-socket-listen.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>sock</p></td> -<td class="parameter_description"><p>a server <a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a> (which must not already be connected or -listening)</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-socket-listen.returns"></a><h4>Returns</h4> -<p> whether or not <em class="parameter"><code>sock</code></em> -is now listening.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-socket-start-ssl"></a><h3>soup_socket_start_ssl ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_socket_start_ssl (<em class="parameter"><code><a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a> *sock</code></em>, - <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>);</pre> -<p>Starts using SSL on <em class="parameter"><code>socket</code></em> -.</p> -<div class="refsect3"> -<a name="soup-socket-start-ssl.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>sock</p></td> -<td class="parameter_description"><p>the socket</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>cancellable</p></td> -<td class="parameter_description"><p>a <span class="type">GCancellable</span></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-socket-start-ssl.returns"></a><h4>Returns</h4> -<p> success or failure</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-socket-start-proxy-ssl"></a><h3>soup_socket_start_proxy_ssl ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_socket_start_proxy_ssl (<em class="parameter"><code><a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a> *sock</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *ssl_host</code></em>, - <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>);</pre> -<p>Starts using SSL on <em class="parameter"><code>socket</code></em> -, expecting to find a host named -<em class="parameter"><code>ssl_host</code></em> -.</p> -<div class="refsect3"> -<a name="soup-socket-start-proxy-ssl.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>sock</p></td> -<td class="parameter_description"><p>the socket</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>ssl_host</p></td> -<td class="parameter_description"><p>hostname of the SSL server</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>cancellable</p></td> -<td class="parameter_description"><p>a <span class="type">GCancellable</span></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-socket-start-proxy-ssl.returns"></a><h4>Returns</h4> -<p> success or failure</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-socket-is-ssl"></a><h3>soup_socket_is_ssl ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_socket_is_ssl (<em class="parameter"><code><a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a> *sock</code></em>);</pre> -<p>Tests if <em class="parameter"><code>sock</code></em> - is doing (or has attempted to do) SSL.</p> -<div class="refsect3"> -<a name="soup-socket-is-ssl.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>sock</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-socket-is-ssl.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if <em class="parameter"><code>sock</code></em> -has SSL credentials set</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-socket-disconnect"></a><h3>soup_socket_disconnect ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_socket_disconnect (<em class="parameter"><code><a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a> *sock</code></em>);</pre> -<p>Disconnects <em class="parameter"><code>sock</code></em> -. Any further read or write attempts on it will -fail.</p> -<div class="refsect3"> -<a name="soup-socket-disconnect.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>sock</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-socket-is-connected"></a><h3>soup_socket_is_connected ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_socket_is_connected (<em class="parameter"><code><a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a> *sock</code></em>);</pre> -<p>Tests if <em class="parameter"><code>sock</code></em> - is connected to another host</p> -<div class="refsect3"> -<a name="soup-socket-is-connected.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>sock</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-socket-is-connected.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> or <code class="literal">FALSE</code>.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-socket-get-local-address"></a><h3>soup_socket_get_local_address ()</h3> -<pre class="programlisting"><a class="link" href="SoupAddress.html" title="SoupAddress"><span class="returnvalue">SoupAddress</span></a> * -soup_socket_get_local_address (<em class="parameter"><code><a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a> *sock</code></em>);</pre> -<p>Returns the <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> corresponding to the local end of <em class="parameter"><code>sock</code></em> -.</p> -<p>Calling this method on an unconnected socket is considered to be -an error, and produces undefined results.</p> -<div class="refsect3"> -<a name="soup-socket-get-local-address.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>sock</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-socket-get-local-address.returns"></a><h4>Returns</h4> -<p>the <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a>. </p> -<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-socket-get-remote-address"></a><h3>soup_socket_get_remote_address ()</h3> -<pre class="programlisting"><a class="link" href="SoupAddress.html" title="SoupAddress"><span class="returnvalue">SoupAddress</span></a> * -soup_socket_get_remote_address (<em class="parameter"><code><a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a> *sock</code></em>);</pre> -<p>Returns the <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> corresponding to the remote end of <em class="parameter"><code>sock</code></em> -.</p> -<p>Calling this method on an unconnected socket is considered to be -an error, and produces undefined results.</p> -<div class="refsect3"> -<a name="soup-socket-get-remote-address.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>sock</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-socket-get-remote-address.returns"></a><h4>Returns</h4> -<p>the <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a>. </p> -<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-socket-get-fd"></a><h3>soup_socket_get_fd ()</h3> -<pre class="programlisting"><span class="returnvalue">int</span> -soup_socket_get_fd (<em class="parameter"><code><a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a> *sock</code></em>);</pre> -<p>Gets <em class="parameter"><code>sock</code></em> -'s underlying file descriptor.</p> -<p>Note that fiddling with the file descriptor may break the -<a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a>.</p> -<div class="refsect3"> -<a name="soup-socket-get-fd.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>sock</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-socket-get-fd.returns"></a><h4>Returns</h4> -<p> <em class="parameter"><code>sock</code></em> -'s file descriptor.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-socket-read"></a><h3>soup_socket_read ()</h3> -<pre class="programlisting"><a class="link" href="SoupSocket.html#SoupSocketIOStatus" title="enum SoupSocketIOStatus"><span class="returnvalue">SoupSocketIOStatus</span></a> -soup_socket_read (<em class="parameter"><code><a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a> *sock</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> buffer</code></em>, - <em class="parameter"><code><span class="type">gsize</span> len</code></em>, - <em class="parameter"><code><span class="type">gsize</span> *nread</code></em>, - <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>Attempts to read up to <em class="parameter"><code>len</code></em> - bytes from <em class="parameter"><code>sock</code></em> - into <em class="parameter"><code>buffer</code></em> -. If some -data is successfully read, <a class="link" href="SoupSocket.html#soup-socket-read" title="soup_socket_read ()"><code class="function">soup_socket_read()</code></a> will return -<a class="link" href="SoupSocket.html#SOUP-SOCKET-OK:CAPS"><code class="literal">SOUP_SOCKET_OK</code></a>, and *<em class="parameter"><code>nread</code></em> - will contain the number of bytes -actually read (which may be less than <em class="parameter"><code>len</code></em> -).</p> -<p>If <em class="parameter"><code>sock</code></em> - is non-blocking, and no data is available, the return -value will be <a class="link" href="SoupSocket.html#SOUP-SOCKET-WOULD-BLOCK:CAPS"><code class="literal">SOUP_SOCKET_WOULD_BLOCK</code></a>. In this case, the caller -can connect to the <a class="link" href="SoupSocket.html#SoupSocket-readable" title="The “readable” signal"><span class="type">“readable”</span></a> signal to know when there -is more data to read. (NB: You MUST read all available data off the -socket first. <a class="link" href="SoupSocket.html#SoupSocket-readable" title="The “readable” signal"><span class="type">“readable”</span></a> is only emitted after -<a class="link" href="SoupSocket.html#soup-socket-read" title="soup_socket_read ()"><code class="function">soup_socket_read()</code></a> returns <a class="link" href="SoupSocket.html#SOUP-SOCKET-WOULD-BLOCK:CAPS"><code class="literal">SOUP_SOCKET_WOULD_BLOCK</code></a>, and it is only -emitted once. See the documentation for <a class="link" href="SoupSocket.html#SoupSocket--non-blocking" title="The “non-blocking” property"><span class="type">“non-blocking”</span></a>.)</p> -<div class="refsect3"> -<a name="soup-socket-read.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>sock</p></td> -<td class="parameter_description"><p>the socket</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>buffer</p></td> -<td class="parameter_description"><p>buffer to read -into. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=len][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint8]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>len</p></td> -<td class="parameter_description"><p>size of <em class="parameter"><code>buffer</code></em> -in bytes</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>nread</p></td> -<td class="parameter_description"><p>on return, the number of bytes read into <em class="parameter"><code>buffer</code></em> -. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>cancellable</p></td> -<td class="parameter_description"><p>a <span class="type">GCancellable</span>, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>error pointer</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-socket-read.returns"></a><h4>Returns</h4> -<p> a <a class="link" href="SoupSocket.html#SoupSocketIOStatus" title="enum SoupSocketIOStatus"><span class="type">SoupSocketIOStatus</span></a>, as described above (or -<a class="link" href="SoupSocket.html#SOUP-SOCKET-EOF:CAPS"><code class="literal">SOUP_SOCKET_EOF</code></a> if the socket is no longer connected, or -<a class="link" href="SoupSocket.html#SOUP-SOCKET-ERROR:CAPS"><code class="literal">SOUP_SOCKET_ERROR</code></a> on any other error, in which case <em class="parameter"><code>error</code></em> -will -also be set).</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-socket-read-until"></a><h3>soup_socket_read_until ()</h3> -<pre class="programlisting"><a class="link" href="SoupSocket.html#SoupSocketIOStatus" title="enum SoupSocketIOStatus"><span class="returnvalue">SoupSocketIOStatus</span></a> -soup_socket_read_until (<em class="parameter"><code><a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a> *sock</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> buffer</code></em>, - <em class="parameter"><code><span class="type">gsize</span> len</code></em>, - <em class="parameter"><code><span class="type">gconstpointer</span> boundary</code></em>, - <em class="parameter"><code><span class="type">gsize</span> boundary_len</code></em>, - <em class="parameter"><code><span class="type">gsize</span> *nread</code></em>, - <em class="parameter"><code><span class="type">gboolean</span> *got_boundary</code></em>, - <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>Like <a class="link" href="SoupSocket.html#soup-socket-read" title="soup_socket_read ()"><code class="function">soup_socket_read()</code></a>, but reads no further than the first -occurrence of <em class="parameter"><code>boundary</code></em> -. (If the boundary is found, it will be -included in the returned data, and *<em class="parameter"><code>got_boundary</code></em> - will be set to -<code class="literal">TRUE</code>.) Any data after the boundary will returned in future reads.</p> -<p>soup_socket_read_until() will almost always return fewer than <em class="parameter"><code>len</code></em> - -bytes: if the boundary is found, then it will only return the bytes -up until the end of the boundary, and if the boundary is not found, -then it will leave the last <code class="literal">(boundary_len - 1)</code> -bytes in its internal buffer, in case they form the start of the -boundary string. Thus, <em class="parameter"><code>len</code></em> - normally needs to be at least 1 byte -longer than <em class="parameter"><code>boundary_len</code></em> - if you want to make any progress at all.</p> -<div class="refsect3"> -<a name="soup-socket-read-until.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>sock</p></td> -<td class="parameter_description"><p>the socket</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>buffer</p></td> -<td class="parameter_description"><p>buffer to read -into. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=len][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint8]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>len</p></td> -<td class="parameter_description"><p>size of <em class="parameter"><code>buffer</code></em> -in bytes</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>boundary</p></td> -<td class="parameter_description"><p>boundary to read until</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>boundary_len</p></td> -<td class="parameter_description"><p>length of <em class="parameter"><code>boundary</code></em> -in bytes</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>nread</p></td> -<td class="parameter_description"><p>on return, the number of bytes read into <em class="parameter"><code>buffer</code></em> -. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>got_boundary</p></td> -<td class="parameter_description"><p>on return, whether or not the data in <em class="parameter"><code>buffer</code></em> -ends with the boundary string</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>cancellable</p></td> -<td class="parameter_description"><p>a <span class="type">GCancellable</span>, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>error pointer</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-socket-read-until.returns"></a><h4>Returns</h4> -<p> as for <a class="link" href="SoupSocket.html#soup-socket-read" title="soup_socket_read ()"><code class="function">soup_socket_read()</code></a></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-socket-write"></a><h3>soup_socket_write ()</h3> -<pre class="programlisting"><a class="link" href="SoupSocket.html#SoupSocketIOStatus" title="enum SoupSocketIOStatus"><span class="returnvalue">SoupSocketIOStatus</span></a> -soup_socket_write (<em class="parameter"><code><a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a> *sock</code></em>, - <em class="parameter"><code><span class="type">gconstpointer</span> buffer</code></em>, - <em class="parameter"><code><span class="type">gsize</span> len</code></em>, - <em class="parameter"><code><span class="type">gsize</span> *nwrote</code></em>, - <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>Attempts to write <em class="parameter"><code>len</code></em> - bytes from <em class="parameter"><code>buffer</code></em> - to <em class="parameter"><code>sock</code></em> -. If some data is -successfully written, the return status will be <a class="link" href="SoupSocket.html#SOUP-SOCKET-OK:CAPS"><code class="literal">SOUP_SOCKET_OK</code></a>, -and *<em class="parameter"><code>nwrote</code></em> - will contain the number of bytes actually written -(which may be less than <em class="parameter"><code>len</code></em> -).</p> -<p>If <em class="parameter"><code>sock</code></em> - is non-blocking, and no data could be written right away, -the return value will be <a class="link" href="SoupSocket.html#SOUP-SOCKET-WOULD-BLOCK:CAPS"><code class="literal">SOUP_SOCKET_WOULD_BLOCK</code></a>. In this case, -the caller can connect to the <a class="link" href="SoupSocket.html#SoupSocket-writable" title="The “writable” signal"><span class="type">“writable”</span></a> signal to know -when more data can be written. (NB: <a class="link" href="SoupSocket.html#SoupSocket-writable" title="The “writable” signal"><span class="type">“writable”</span></a> is only -emitted after <a class="link" href="SoupSocket.html#soup-socket-write" title="soup_socket_write ()"><code class="function">soup_socket_write()</code></a> returns <a class="link" href="SoupSocket.html#SOUP-SOCKET-WOULD-BLOCK:CAPS"><code class="literal">SOUP_SOCKET_WOULD_BLOCK</code></a>, -and it is only emitted once. See the documentation for -<a class="link" href="SoupSocket.html#SoupSocket--non-blocking" title="The “non-blocking” property"><span class="type">“non-blocking”</span></a>.)</p> -<div class="refsect3"> -<a name="soup-socket-write.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>sock</p></td> -<td class="parameter_description"><p>the socket</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>buffer</p></td> -<td class="parameter_description"><p>data to write. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=len][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint8]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>len</p></td> -<td class="parameter_description"><p>size of <em class="parameter"><code>buffer</code></em> -, in bytes</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>nwrote</p></td> -<td class="parameter_description"><p>on return, number of bytes written. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>cancellable</p></td> -<td class="parameter_description"><p>a <span class="type">GCancellable</span>, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>error pointer</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-socket-write.returns"></a><h4>Returns</h4> -<p> a <a class="link" href="SoupSocket.html#SoupSocketIOStatus" title="enum SoupSocketIOStatus"><span class="type">SoupSocketIOStatus</span></a>, as described above (or -<a class="link" href="SoupSocket.html#SOUP-SOCKET-EOF:CAPS"><code class="literal">SOUP_SOCKET_EOF</code></a> or <a class="link" href="SoupSocket.html#SOUP-SOCKET-ERROR:CAPS"><code class="literal">SOUP_SOCKET_ERROR</code></a>. <em class="parameter"><code>error</code></em> -will be set if the -return value is <a class="link" href="SoupSocket.html#SOUP-SOCKET-ERROR:CAPS"><code class="literal">SOUP_SOCKET_ERROR</code></a>.)</p> -</div> -</div> -</div> -<div class="refsect1"> -<a name="SoupSocket.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupSocket-struct"></a><h3>SoupSocket</h3> -<pre class="programlisting">typedef struct _SoupSocket SoupSocket;</pre> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSocketIOStatus"></a><h3>enum SoupSocketIOStatus</h3> -<p>Return value from the <a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a> IO methods.</p> -<div class="refsect3"> -<a name="SoupSocketIOStatus.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="enum_members_name"> -<col class="enum_members_description"> -<col width="200px" class="enum_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="enum_member_name"><p><a name="SOUP-SOCKET-OK:CAPS"></a>SOUP_SOCKET_OK</p></td> -<td class="enum_member_description"> -<p>Success</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-SOCKET-WOULD-BLOCK:CAPS"></a>SOUP_SOCKET_WOULD_BLOCK</p></td> -<td class="enum_member_description"> -<p>Cannot read/write any more at this time</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-SOCKET-EOF:CAPS"></a>SOUP_SOCKET_EOF</p></td> -<td class="enum_member_description"> -<p>End of file</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-SOCKET-ERROR:CAPS"></a>SOUP_SOCKET_ERROR</p></td> -<td class="enum_member_description"> -<p>Other error</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SOCKET-LOCAL-ADDRESS:CAPS"></a><h3>SOUP_SOCKET_LOCAL_ADDRESS</h3> -<pre class="programlisting">#define SOUP_SOCKET_LOCAL_ADDRESS "local-address" -</pre> -<p>Alias for the <a class="link" href="SoupSocket.html#SoupSocket--local-address" title="The “local-address” property"><span class="type">“local-address”</span></a> property. (Address -of local end of socket.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SOCKET-REMOTE-ADDRESS:CAPS"></a><h3>SOUP_SOCKET_REMOTE_ADDRESS</h3> -<pre class="programlisting">#define SOUP_SOCKET_REMOTE_ADDRESS "remote-address" -</pre> -<p>Alias for the <a class="link" href="SoupSocket.html#SoupSocket--remote-address" title="The “remote-address” property"><span class="type">“remote-address”</span></a> property. (Address -of remote end of socket.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SOCKET-FLAG-NONBLOCKING:CAPS"></a><h3>SOUP_SOCKET_FLAG_NONBLOCKING</h3> -<pre class="programlisting">#define SOUP_SOCKET_FLAG_NONBLOCKING "non-blocking" -</pre> -<p>Alias for the <a class="link" href="SoupSocket.html#SoupSocket--non-blocking" title="The “non-blocking” property"><span class="type">“non-blocking”</span></a> property. (Whether -or not the socket uses non-blocking I/O.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SOCKET-IS-SERVER:CAPS"></a><h3>SOUP_SOCKET_IS_SERVER</h3> -<pre class="programlisting">#define SOUP_SOCKET_IS_SERVER "is-server" -</pre> -<p>Alias for the <a class="link" href="SoupSocket.html#SoupSocket--is-server" title="The “is-server” property"><span class="type">“is-server”</span></a> property, qv.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SOCKET-SSL-CREDENTIALS:CAPS"></a><h3>SOUP_SOCKET_SSL_CREDENTIALS</h3> -<pre class="programlisting">#define SOUP_SOCKET_SSL_CREDENTIALS "ssl-creds" -</pre> -<p>Alias for the <a class="link" href="SoupSocket.html#SoupSocket--ssl-creds" title="The “ssl-creds” property"><span class="type">“ssl-creds”</span></a> property. -(SSL credential information.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SOCKET-ASYNC-CONTEXT:CAPS"></a><h3>SOUP_SOCKET_ASYNC_CONTEXT</h3> -<pre class="programlisting">#define SOUP_SOCKET_ASYNC_CONTEXT "async-context" -</pre> -<p>Alias for the <a class="link" href="SoupSocket.html#SoupSocket--async-context" title="The “async-context” property"><span class="type">“async-context”</span></a> property. (The -socket's <span class="type">GMainContext</span>.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SOCKET-TIMEOUT:CAPS"></a><h3>SOUP_SOCKET_TIMEOUT</h3> -<pre class="programlisting">#define SOUP_SOCKET_TIMEOUT "timeout" -</pre> -<p>Alias for the <a class="link" href="SoupSocket.html#SoupSocket--timeout" title="The “timeout” property"><span class="type">“timeout”</span></a> property. (The timeout -in seconds for blocking socket I/O operations.)</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SOCKET-SSL-FALLBACK:CAPS"></a><h3>SOUP_SOCKET_SSL_FALLBACK</h3> -<pre class="programlisting">#define SOUP_SOCKET_SSL_FALLBACK "ssl-fallback" -</pre> -<p>Alias for the <a class="link" href="SoupSocket.html#SoupSocket--ssl-fallback" title="The “ssl-fallback” property"><span class="type">“ssl-fallback”</span></a> property.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SOCKET-SSL-STRICT:CAPS"></a><h3>SOUP_SOCKET_SSL_STRICT</h3> -<pre class="programlisting">#define SOUP_SOCKET_SSL_STRICT "ssl-strict" -</pre> -<p>Alias for the <a class="link" href="SoupSocket.html#SoupSocket--ssl-strict" title="The “ssl-strict” property"><span class="type">“ssl-strict”</span></a> property.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SOCKET-TLS-CERTIFICATE:CAPS"></a><h3>SOUP_SOCKET_TLS_CERTIFICATE</h3> -<pre class="programlisting">#define SOUP_SOCKET_TLS_CERTIFICATE "tls-certificate" -</pre> -<p>Alias for the <a class="link" href="SoupSocket.html#SoupSocket--tls-certificate" title="The “tls-certificate” property"><span class="type">“tls-certificate”</span></a> -property. Note that this property's value is only useful -if the socket is for a TLS connection, and only reliable -after some data has been transferred to or from it.</p> -<p class="since">Since: 2.34</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SOCKET-TLS-ERRORS:CAPS"></a><h3>SOUP_SOCKET_TLS_ERRORS</h3> -<pre class="programlisting">#define SOUP_SOCKET_TLS_ERRORS "tls-errors" -</pre> -<p>Alias for the <a class="link" href="SoupSocket.html#SoupSocket--tls-errors" title="The “tls-errors” property"><span class="type">“tls-errors”</span></a> -property. Note that this property's value is only useful -if the socket is for a TLS connection, and only reliable -after some data has been transferred to or from it.</p> -<p class="since">Since: 2.34</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SOCKET-TRUSTED-CERTIFICATE:CAPS"></a><h3>SOUP_SOCKET_TRUSTED_CERTIFICATE</h3> -<pre class="programlisting">#define SOUP_SOCKET_TRUSTED_CERTIFICATE "trusted-certificate" -</pre> -<p>Alias for the <a class="link" href="SoupSocket.html#SoupSocket--trusted-certificate" title="The “trusted-certificate” property"><span class="type">“trusted-certificate”</span></a> -property.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SOCKET-USE-THREAD-CONTEXT:CAPS"></a><h3>SOUP_SOCKET_USE_THREAD_CONTEXT</h3> -<pre class="programlisting">#define SOUP_SOCKET_USE_THREAD_CONTEXT "use-thread-context" -</pre> -<p>Alias for the <a class="link" href="SoupSocket.html#SoupSocket--use-thread-context" title="The “use-thread-context” property"><span class="type">“use-thread-context”</span></a> property. (Use -<code class="function">g_main_context_get_thread_default()</code>)</p> -<p class="since">Since: 2.38</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupSocket.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> -<a name="SoupSocket--async-context"></a><h3>The <code class="literal">“async-context”</code> property</h3> -<pre class="programlisting"> “async-context” <span class="type">gpointer</span></pre> -<p>The GMainContext to dispatch this socket's async I/O in.</p> -<p>Flags: Read / Write / Construct Only</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSocket--fd"></a><h3>The <code class="literal">“fd”</code> property</h3> -<pre class="programlisting"> “fd” <span class="type">gint</span></pre> -<p>The socket's file descriptor.</p> -<p>Flags: Read / Write / Construct Only</p> -<p>Allowed values: >= -1</p> -<p>Default value: -1</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSocket--gsocket"></a><h3>The <code class="literal">“gsocket”</code> property</h3> -<pre class="programlisting"> “gsocket” <span class="type">GSocket</span> *</pre> -<p>The socket's underlying GSocket.</p> -<p>Flags: Write / Construct Only</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSocket--iostream"></a><h3>The <code class="literal">“iostream”</code> property</h3> -<pre class="programlisting"> “iostream” <span class="type">GIOStream</span> *</pre> -<p>The socket's underlying GIOStream.</p> -<p>Flags: Write / Construct Only</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSocket--ipv6-only"></a><h3>The <code class="literal">“ipv6-only”</code> property</h3> -<pre class="programlisting"> “ipv6-only” <span class="type">gboolean</span></pre> -<p>IPv6 only.</p> -<p>Flags: Read / Write</p> -<p>Default value: FALSE</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSocket--is-server"></a><h3>The <code class="literal">“is-server”</code> property</h3> -<pre class="programlisting"> “is-server” <span class="type">gboolean</span></pre> -<p>Whether or not the socket is a server socket.</p> -<p>Note that for "ordinary" <a href="SoupSocket.html#SoupSocket-struct"><span class="type">SoupSockets</span></a> this will be set for -both listening sockets and the sockets emitted by -<a class="link" href="SoupSocket.html#SoupSocket-new-connection" title="The “new-connection” signal"><span class="type">“new-connection”</span></a>, but for sockets created by -setting <a class="link" href="SoupSocket.html#SoupSocket--fd" title="The “fd” property"><span class="type">“fd”</span></a>, it will only be set for listening -sockets.</p> -<p>Flags: Read</p> -<p>Default value: FALSE</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSocket--local-address"></a><h3>The <code class="literal">“local-address”</code> property</h3> -<pre class="programlisting"> “local-address” <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> *</pre> -<p>Address of local end of socket.</p> -<p>Flags: Read / Write / Construct Only</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSocket--non-blocking"></a><h3>The <code class="literal">“non-blocking”</code> property</h3> -<pre class="programlisting"> “non-blocking” <span class="type">gboolean</span></pre> -<p>Whether or not the socket uses non-blocking I/O.</p> -<p><a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a>'s I/O methods are designed around the idea of -using a single codepath for both synchronous and -asynchronous I/O. If you want to read off a <a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a>, -the "correct" way to do it is to call <a class="link" href="SoupSocket.html#soup-socket-read" title="soup_socket_read ()"><code class="function">soup_socket_read()</code></a> or -<a class="link" href="SoupSocket.html#soup-socket-read-until" title="soup_socket_read_until ()"><code class="function">soup_socket_read_until()</code></a> repeatedly until you have read -everything you want. If it returns <a class="link" href="SoupSocket.html#SOUP-SOCKET-WOULD-BLOCK:CAPS"><code class="literal">SOUP_SOCKET_WOULD_BLOCK</code></a> -at any point, stop reading and wait for it to emit the -<a class="link" href="SoupSocket.html#SoupSocket-readable" title="The “readable” signal"><span class="type">“readable”</span></a> signal. Then go back to the -reading-as-much-as-you-can loop. Likewise, for writing to a -<a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a>, you should call <a class="link" href="SoupSocket.html#soup-socket-write" title="soup_socket_write ()"><code class="function">soup_socket_write()</code></a> either -until you have written everything, or it returns -<a class="link" href="SoupSocket.html#SOUP-SOCKET-WOULD-BLOCK:CAPS"><code class="literal">SOUP_SOCKET_WOULD_BLOCK</code></a> (in which case you wait for -<a class="link" href="SoupSocket.html#SoupSocket-writable" title="The “writable” signal"><span class="type">“writable”</span></a> and then go back into the loop).</p> -<p>Code written this way will work correctly with both -blocking and non-blocking sockets; blocking sockets will -simply never return <a class="link" href="SoupSocket.html#SOUP-SOCKET-WOULD-BLOCK:CAPS"><code class="literal">SOUP_SOCKET_WOULD_BLOCK</code></a>, and so the -code that handles that case just won't get used for them.</p> -<p>Flags: Read / Write</p> -<p>Default value: TRUE</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSocket--remote-address"></a><h3>The <code class="literal">“remote-address”</code> property</h3> -<pre class="programlisting"> “remote-address” <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> *</pre> -<p>Address of remote end of socket.</p> -<p>Flags: Read / Write / Construct Only</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSocket--socket-properties"></a><h3>The <code class="literal">“socket-properties”</code> property</h3> -<pre class="programlisting"> “socket-properties” <span class="type">SoupSocketProperties</span> *</pre> -<p>Socket properties.</p> -<p>Flags: Write</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSocket--ssl-creds"></a><h3>The <code class="literal">“ssl-creds”</code> property</h3> -<pre class="programlisting"> “ssl-creds” <span class="type">gpointer</span></pre> -<p>SSL credential information, passed from the session to the SSL implementation.</p> -<p>Flags: Read / Write</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSocket--ssl-fallback"></a><h3>The <code class="literal">“ssl-fallback”</code> property</h3> -<pre class="programlisting"> “ssl-fallback” <span class="type">gboolean</span></pre> -<p>Use SSLv3 instead of TLS (client-side only).</p> -<p>Flags: Read / Write / Construct Only</p> -<p>Default value: FALSE</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSocket--ssl-strict"></a><h3>The <code class="literal">“ssl-strict”</code> property</h3> -<pre class="programlisting"> “ssl-strict” <span class="type">gboolean</span></pre> -<p>Whether certificate errors should be considered a connection error.</p> -<p>Flags: Read / Write / Construct Only</p> -<p>Default value: TRUE</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSocket--timeout"></a><h3>The <code class="literal">“timeout”</code> property</h3> -<pre class="programlisting"> “timeout” <span class="type">guint</span></pre> -<p>Value in seconds to timeout a blocking I/O.</p> -<p>Flags: Read / Write</p> -<p>Default value: 0</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSocket--tls-certificate"></a><h3>The <code class="literal">“tls-certificate”</code> property</h3> -<pre class="programlisting"> “tls-certificate” <span class="type">GTlsCertificate</span> *</pre> -<p>The peer's TLS certificate.</p> -<p>Flags: Read</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSocket--tls-errors"></a><h3>The <code class="literal">“tls-errors”</code> property</h3> -<pre class="programlisting"> “tls-errors” <span class="type">GTlsCertificateFlags</span></pre> -<p>Errors with the peer's TLS certificate.</p> -<p>Flags: Read</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSocket--trusted-certificate"></a><h3>The <code class="literal">“trusted-certificate”</code> property</h3> -<pre class="programlisting"> “trusted-certificate” <span class="type">gboolean</span></pre> -<p>Whether the server certificate is trusted, if this is an SSL socket.</p> -<p>Flags: Read</p> -<p>Default value: FALSE</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSocket--use-thread-context"></a><h3>The <code class="literal">“use-thread-context”</code> property</h3> -<pre class="programlisting"> “use-thread-context” <span class="type">gboolean</span></pre> -<p>Use <code class="function">g_main_context_get_thread_default()</code>.</p> -<p>Flags: Read / Write / Construct Only</p> -<p>Default value: FALSE</p> -<p class="since">Since: 2.38</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupSocket.signal-details"></a><h2>Signal Details</h2> -<div class="refsect2"> -<a name="SoupSocket-disconnected"></a><h3>The <code class="literal">“disconnected”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a> *sock, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted when the socket is disconnected, for whatever -reason.</p> -<div class="refsect3"> -<a name="SoupSocket-disconnected.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>sock</p></td> -<td class="parameter_description"><p>the socket</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run Last</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSocket-event"></a><h3>The <code class="literal">“event”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a> *sock, - <span class="type">GSocketClientEvent</span> event, - <span class="type">GIOStream</span> *connection, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted when a network-related event occurs. See -<span class="type">“event”</span> for more details.</p> -<div class="refsect3"> -<a name="SoupSocket-event.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>sock</p></td> -<td class="parameter_description"><p>the socket</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>event</p></td> -<td class="parameter_description"><p>the event that occurred</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>connection</p></td> -<td class="parameter_description"><p>the current connection state</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run Last</p> -<p class="since">Since: 2.38</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSocket-new-connection"></a><h3>The <code class="literal">“new-connection”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a> *sock, - <a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a> *new, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted when a listening socket (set up with -<a class="link" href="SoupSocket.html#soup-socket-listen" title="soup_socket_listen ()"><code class="function">soup_socket_listen()</code></a>) receives a new connection.</p> -<p>You must ref the <em class="parameter"><code>new</code></em> - if you want to keep it; otherwise it -will be destroyed after the signal is emitted.</p> -<div class="refsect3"> -<a name="SoupSocket-new-connection.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>sock</p></td> -<td class="parameter_description"><p>the socket</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>new</p></td> -<td class="parameter_description"><p>the new socket</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run First</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSocket-readable"></a><h3>The <code class="literal">“readable”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a> *sock, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted when an async socket is readable. See -<a class="link" href="SoupSocket.html#soup-socket-read" title="soup_socket_read ()"><code class="function">soup_socket_read()</code></a>, <a class="link" href="SoupSocket.html#soup-socket-read-until" title="soup_socket_read_until ()"><code class="function">soup_socket_read_until()</code></a> and -<a class="link" href="SoupSocket.html#SoupSocket--non-blocking" title="The “non-blocking” property"><span class="type">“non-blocking”</span></a>.</p> -<div class="refsect3"> -<a name="SoupSocket-readable.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>sock</p></td> -<td class="parameter_description"><p>the socket</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run Last</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupSocket-writable"></a><h3>The <code class="literal">“writable”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a> *sock, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted when an async socket is writable. See -<a class="link" href="SoupSocket.html#soup-socket-write" title="soup_socket_write ()"><code class="function">soup_socket_write()</code></a> and <a class="link" href="SoupSocket.html#SoupSocket--non-blocking" title="The “non-blocking” property"><span class="type">“non-blocking”</span></a>.</p> -<div class="refsect3"> -<a name="SoupSocket-writable.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>sock</p></td> -<td class="parameter_description"><p>the socket</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run Last</p> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/SoupURI.html b/docs/reference/html/SoupURI.html deleted file mode 100644 index 6c6ad711..00000000 --- a/docs/reference/html/SoupURI.html +++ /dev/null @@ -1,1672 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SoupURI: 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="ch02.html" title="Core API"> -<link rel="prev" href="libsoup-2.4-Top-Level-Domain-utils.html" title="Top Level Domain utils"> -<link rel="next" href="libsoup-2.4-Version-Information.html" title="Version Information"> -<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="#SoupURI.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupURI.object-hierarchy" class="shortcut">Object Hierarchy</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="libsoup-2.4-Top-Level-Domain-utils.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="libsoup-2.4-Version-Information.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="SoupURI"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="SoupURI.top_of_page"></a>SoupURI</span></h2> -<p>SoupURI — URIs</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="SoupURI.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="SoupURI.html" title="SoupURI"><span class="returnvalue">SoupURI</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupURI.html#soup-uri-new-with-base" title="soup_uri_new_with_base ()">soup_uri_new_with_base</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupURI.html" title="SoupURI"><span class="returnvalue">SoupURI</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupURI.html#soup-uri-new" title="soup_uri_new ()">soup_uri_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="SoupURI.html#soup-uri-to-string" title="soup_uri_to_string ()">soup_uri_to_string</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupURI.html" title="SoupURI"><span class="returnvalue">SoupURI</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupURI.html#soup-uri-copy" title="soup_uri_copy ()">soup_uri_copy</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupURI.html" title="SoupURI"><span class="returnvalue">SoupURI</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupURI.html#soup-uri-copy-host" title="soup_uri_copy_host ()">soup_uri_copy_host</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupURI.html#soup-uri-equal" title="soup_uri_equal ()">soup_uri_equal</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupURI.html#soup-uri-host-equal" title="soup_uri_host_equal ()">soup_uri_host_equal</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">guint</span> -</td> -<td class="function_name"> -<a class="link" href="SoupURI.html#soup-uri-host-hash" title="soup_uri_host_hash ()">soup_uri_host_hash</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupURI.html#soup-uri-free" title="soup_uri_free ()">soup_uri_free</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="SoupURI.html#soup-uri-encode" title="soup_uri_encode ()">soup_uri_encode</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="SoupURI.html#soup-uri-decode" title="soup_uri_decode ()">soup_uri_decode</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="SoupURI.html#soup-uri-normalize" title="soup_uri_normalize ()">soup_uri_normalize</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="SoupURI.html#soup-uri-uses-default-port" title="soup_uri_uses_default_port ()">soup_uri_uses_default_port</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"> -<a class="link" href="SoupURI.html#SOUP-URI-IS-VALID:CAPS" title="SOUP_URI_IS_VALID()">SOUP_URI_IS_VALID</a><span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"> -<a class="link" href="SoupURI.html#SOUP-URI-VALID-FOR-HTTP:CAPS" title="SOUP_URI_VALID_FOR_HTTP()">SOUP_URI_VALID_FOR_HTTP</a><span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupURI.html#soup-uri-set-scheme" title="soup_uri_set_scheme ()">soup_uri_set_scheme</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupURI.html#soup-uri-get-scheme" title="soup_uri_get_scheme ()">soup_uri_get_scheme</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupURI.html#soup-uri-set-user" title="soup_uri_set_user ()">soup_uri_set_user</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupURI.html#soup-uri-get-user" title="soup_uri_get_user ()">soup_uri_get_user</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupURI.html#soup-uri-set-password" title="soup_uri_set_password ()">soup_uri_set_password</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupURI.html#soup-uri-get-password" title="soup_uri_get_password ()">soup_uri_get_password</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupURI.html#soup-uri-set-host" title="soup_uri_set_host ()">soup_uri_set_host</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupURI.html#soup-uri-get-host" title="soup_uri_get_host ()">soup_uri_get_host</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupURI.html#soup-uri-set-port" title="soup_uri_set_port ()">soup_uri_set_port</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">guint</span> -</td> -<td class="function_name"> -<a class="link" href="SoupURI.html#soup-uri-get-port" title="soup_uri_get_port ()">soup_uri_get_port</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupURI.html#soup-uri-set-path" title="soup_uri_set_path ()">soup_uri_set_path</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupURI.html#soup-uri-get-path" title="soup_uri_get_path ()">soup_uri_get_path</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupURI.html#soup-uri-set-query" title="soup_uri_set_query ()">soup_uri_set_query</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupURI.html#soup-uri-set-query-from-form" title="soup_uri_set_query_from_form ()">soup_uri_set_query_from_form</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupURI.html#soup-uri-set-query-from-fields" title="soup_uri_set_query_from_fields ()">soup_uri_set_query_from_fields</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupURI.html#soup-uri-get-query" title="soup_uri_get_query ()">soup_uri_get_query</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupURI.html#soup-uri-set-fragment" title="soup_uri_set_fragment ()">soup_uri_set_fragment</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="SoupURI.html#soup-uri-get-fragment" title="soup_uri_get_fragment ()">soup_uri_get_fragment</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupURI.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="SoupURI.html#SoupURI-struct" title="SoupURI">SoupURI</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupURI.html#SOUP-URI-SCHEME-HTTP:CAPS" title="SOUP_URI_SCHEME_HTTP">SOUP_URI_SCHEME_HTTP</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupURI.html#SOUP-URI-SCHEME-HTTPS:CAPS" title="SOUP_URI_SCHEME_HTTPS">SOUP_URI_SCHEME_HTTPS</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupURI.html#SOUP-URI-SCHEME-DATA:CAPS" title="SOUP_URI_SCHEME_DATA">SOUP_URI_SCHEME_DATA</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupURI.html#SOUP-URI-SCHEME-FILE:CAPS" title="SOUP_URI_SCHEME_FILE">SOUP_URI_SCHEME_FILE</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupURI.html#SOUP-URI-SCHEME-FTP:CAPS" title="SOUP_URI_SCHEME_FTP">SOUP_URI_SCHEME_FTP</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupURI.html#SOUP-URI-SCHEME-RESOURCE:CAPS" title="SOUP_URI_SCHEME_RESOURCE">SOUP_URI_SCHEME_RESOURCE</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupURI.html#SOUP-URI-SCHEME-WS:CAPS" title="SOUP_URI_SCHEME_WS">SOUP_URI_SCHEME_WS</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="SoupURI.html#SOUP-URI-SCHEME-WSS:CAPS" title="SOUP_URI_SCHEME_WSS">SOUP_URI_SCHEME_WSS</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupURI.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> <a href="/home/claudio/gnome3/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a> - <span class="lineart">╰──</span> SoupURI -</pre> -</div> -<div class="refsect1"> -<a name="SoupURI.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="SoupURI.description"></a><h2>Description</h2> -<p>A <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> represents a (parsed) URI.</p> -<p>Many applications will not need to use <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> directly at all; on -the client side, <a class="link" href="SoupMessage.html#soup-message-new" title="soup_message_new ()"><code class="function">soup_message_new()</code></a> takes a stringified URI, and on -the server side, the path and query components are provided for you -in the server callback.</p> -</div> -<div class="refsect1"> -<a name="SoupURI.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="soup-uri-new-with-base"></a><h3>soup_uri_new_with_base ()</h3> -<pre class="programlisting"><a class="link" href="SoupURI.html" title="SoupURI"><span class="returnvalue">SoupURI</span></a> * -soup_uri_new_with_base (<em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *base</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *uri_string</code></em>);</pre> -<p>Parses <em class="parameter"><code>uri_string</code></em> - relative to <em class="parameter"><code>base</code></em> -.</p> -<div class="refsect3"> -<a name="soup-uri-new-with-base.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>base</p></td> -<td class="parameter_description"><p>a base URI</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>uri_string</p></td> -<td class="parameter_description"><p>the URI</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-uri-new-with-base.returns"></a><h4>Returns</h4> -<p> a parsed <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a>.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-uri-new"></a><h3>soup_uri_new ()</h3> -<pre class="programlisting"><a class="link" href="SoupURI.html" title="SoupURI"><span class="returnvalue">SoupURI</span></a> * -soup_uri_new (<em class="parameter"><code>const <span class="type">char</span> *uri_string</code></em>);</pre> -<p>Parses an absolute URI.</p> -<p>You can also pass <code class="literal">NULL</code> for <em class="parameter"><code>uri_string</code></em> - if you want to get back an -"empty" <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> that you can fill in by hand. (You will need to -call at least <a class="link" href="SoupURI.html#soup-uri-set-scheme" title="soup_uri_set_scheme ()"><code class="function">soup_uri_set_scheme()</code></a> and <a class="link" href="SoupURI.html#soup-uri-set-path" title="soup_uri_set_path ()"><code class="function">soup_uri_set_path()</code></a>, since -those fields are required.)</p> -<div class="refsect3"> -<a name="soup-uri-new.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>uri_string</p></td> -<td class="parameter_description"><p>a URI. </p></td> -<td class="parameter_annotations"><span class="annotation">[<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-uri-new.returns"></a><h4>Returns</h4> -<p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a>, or <code class="literal">NULL</code> if the given string -was found to be invalid. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-uri-to-string"></a><h3>soup_uri_to_string ()</h3> -<pre class="programlisting"><span class="returnvalue">char</span> * -soup_uri_to_string (<em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>, - <em class="parameter"><code><span class="type">gboolean</span> just_path_and_query</code></em>);</pre> -<p>Returns a string representing <em class="parameter"><code>uri</code></em> -.</p> -<p>If <em class="parameter"><code>just_path_and_query</code></em> - is <code class="literal">TRUE</code>, this concatenates the path and query -together. That is, it constructs the string that would be needed in -the Request-Line of an HTTP request for <em class="parameter"><code>uri</code></em> -.</p> -<p>Note that the output will never contain a password, even if <em class="parameter"><code>uri</code></em> - -does.</p> -<div class="refsect3"> -<a name="soup-uri-to-string.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>uri</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>just_path_and_query</p></td> -<td class="parameter_description"><p>if <code class="literal">TRUE</code>, output just the path and query portions</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-uri-to-string.returns"></a><h4>Returns</h4> -<p> a string representing <em class="parameter"><code>uri</code></em> -, which the caller must free.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-uri-copy"></a><h3>soup_uri_copy ()</h3> -<pre class="programlisting"><a class="link" href="SoupURI.html" title="SoupURI"><span class="returnvalue">SoupURI</span></a> * -soup_uri_copy (<em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>);</pre> -<p>Copies <em class="parameter"><code>uri</code></em> -</p> -<div class="refsect3"> -<a name="soup-uri-copy.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>uri</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-uri-copy.returns"></a><h4>Returns</h4> -<p> a copy of <em class="parameter"><code>uri</code></em> -, which must be freed with <a class="link" href="SoupURI.html#soup-uri-free" title="soup_uri_free ()"><code class="function">soup_uri_free()</code></a></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-uri-copy-host"></a><h3>soup_uri_copy_host ()</h3> -<pre class="programlisting"><a class="link" href="SoupURI.html" title="SoupURI"><span class="returnvalue">SoupURI</span></a> * -soup_uri_copy_host (<em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>);</pre> -<p>Makes a copy of <em class="parameter"><code>uri</code></em> -, considering only the protocol, host, and port</p> -<div class="refsect3"> -<a name="soup-uri-copy-host.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>uri</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-uri-copy-host.returns"></a><h4>Returns</h4> -<p> the new <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p> -</div> -<p class="since">Since: 2.28</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-uri-equal"></a><h3>soup_uri_equal ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_uri_equal (<em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri1</code></em>, - <em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri2</code></em>);</pre> -<p>Tests whether or not <em class="parameter"><code>uri1</code></em> - and <em class="parameter"><code>uri2</code></em> - are equal in all parts</p> -<div class="refsect3"> -<a name="soup-uri-equal.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>uri1</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>uri2</p></td> -<td class="parameter_description"><p>another <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-uri-equal.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> or <code class="literal">FALSE</code></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-uri-host-equal"></a><h3>soup_uri_host_equal ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_uri_host_equal (<em class="parameter"><code><span class="type">gconstpointer</span> v1</code></em>, - <em class="parameter"><code><span class="type">gconstpointer</span> v2</code></em>);</pre> -<p>Compares <em class="parameter"><code>v1</code></em> - and <em class="parameter"><code>v2</code></em> -, considering only the scheme, host, and port.</p> -<div class="refsect3"> -<a name="soup-uri-host-equal.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>v1</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> with a non-<code class="literal">NULL</code> <em class="parameter"><code>host</code></em> -member. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Soup.URI]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>v2</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> with a non-<code class="literal">NULL</code> <em class="parameter"><code>host</code></em> -member. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Soup.URI]</span></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-uri-host-equal.returns"></a><h4>Returns</h4> -<p> whether or not the URIs are equal in scheme, host, -and port.</p> -</div> -<p class="since">Since: 2.28</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-uri-host-hash"></a><h3>soup_uri_host_hash ()</h3> -<pre class="programlisting"><span class="returnvalue">guint</span> -soup_uri_host_hash (<em class="parameter"><code><span class="type">gconstpointer</span> key</code></em>);</pre> -<p>Hashes <em class="parameter"><code>key</code></em> -, considering only the scheme, host, and port.</p> -<div class="refsect3"> -<a name="soup-uri-host-hash.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>key</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> with a non-<code class="literal">NULL</code> <em class="parameter"><code>host</code></em> -member. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> Soup.URI]</span></td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-uri-host-hash.returns"></a><h4>Returns</h4> -<p> a hash</p> -</div> -<p class="since">Since: 2.28</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-uri-free"></a><h3>soup_uri_free ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_uri_free (<em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>);</pre> -<p>Frees <em class="parameter"><code>uri</code></em> -.</p> -<div class="refsect3"> -<a name="soup-uri-free.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>uri</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-uri-encode"></a><h3>soup_uri_encode ()</h3> -<pre class="programlisting"><span class="returnvalue">char</span> * -soup_uri_encode (<em class="parameter"><code>const <span class="type">char</span> *part</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *escape_extra</code></em>);</pre> -<p>This %-encodes the given URI part and returns the escaped -version in allocated memory, which the caller must free when it is -done.</p> -<div class="refsect3"> -<a name="soup-uri-encode.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>part</p></td> -<td class="parameter_description"><p>a URI part</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>escape_extra</p></td> -<td class="parameter_description"><p>additional reserved characters to -escape (or <code class="literal">NULL</code>). </p></td> -<td class="parameter_annotations"><span class="annotation">[<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-uri-encode.returns"></a><h4>Returns</h4> -<p> the encoded URI part</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-uri-decode"></a><h3>soup_uri_decode ()</h3> -<pre class="programlisting"><span class="returnvalue">char</span> * -soup_uri_decode (<em class="parameter"><code>const <span class="type">char</span> *part</code></em>);</pre> -<p>Fully %-decodes <em class="parameter"><code>part</code></em> -.</p> -<p>In the past, this would return <code class="literal">NULL</code> if <em class="parameter"><code>part</code></em> - contained invalid -percent-encoding, but now it just ignores the problem (as -<a class="link" href="SoupURI.html#soup-uri-new" title="soup_uri_new ()"><code class="function">soup_uri_new()</code></a> already did).</p> -<div class="refsect3"> -<a name="soup-uri-decode.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>part</p></td> -<td class="parameter_description"><p>a URI part</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-uri-decode.returns"></a><h4>Returns</h4> -<p> the decoded URI part.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-uri-normalize"></a><h3>soup_uri_normalize ()</h3> -<pre class="programlisting"><span class="returnvalue">char</span> * -soup_uri_normalize (<em class="parameter"><code>const <span class="type">char</span> *part</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *unescape_extra</code></em>);</pre> -<p>%-decodes any "unreserved" characters (or characters in -<em class="parameter"><code>unescape_extra</code></em> -) in <em class="parameter"><code>part</code></em> -, and %-encodes any non-ASCII -characters, spaces, and non-printing characters in <em class="parameter"><code>part</code></em> -.</p> -<p>"Unreserved" characters are those that are not allowed to be used -for punctuation according to the URI spec. For example, letters are -unreserved, so <a class="link" href="SoupURI.html#soup-uri-normalize" title="soup_uri_normalize ()"><code class="function">soup_uri_normalize()</code></a> will turn -<code class="literal">http://example.com/foo/b%61r</code> into -<code class="literal">http://example.com/foo/bar</code>, which is guaranteed -to mean the same thing. However, "/" is "reserved", so -<code class="literal">http://example.com/foo%2Fbar</code> would not -be changed, because it might mean something different to the -server.</p> -<p>In the past, this would return <code class="literal">NULL</code> if <em class="parameter"><code>part</code></em> - contained invalid -percent-encoding, but now it just ignores the problem (as -<a class="link" href="SoupURI.html#soup-uri-new" title="soup_uri_new ()"><code class="function">soup_uri_new()</code></a> already did).</p> -<div class="refsect3"> -<a name="soup-uri-normalize.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>part</p></td> -<td class="parameter_description"><p>a URI part</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>unescape_extra</p></td> -<td class="parameter_description"><p>reserved characters to unescape (or <code class="literal">NULL</code>). </p></td> -<td class="parameter_annotations"><span class="annotation">[<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-uri-normalize.returns"></a><h4>Returns</h4> -<p> the normalized URI part</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-uri-uses-default-port"></a><h3>soup_uri_uses_default_port ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_uri_uses_default_port (<em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>);</pre> -<p>Tests if <em class="parameter"><code>uri</code></em> - uses the default port for its scheme. (Eg, 80 for -http.) (This only works for http, https and ftp; libsoup does not know -the default ports of other protocols.)</p> -<div class="refsect3"> -<a name="soup-uri-uses-default-port.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>uri</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-uri-uses-default-port.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> or <code class="literal">FALSE</code></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-URI-IS-VALID:CAPS"></a><h3>SOUP_URI_IS_VALID()</h3> -<pre class="programlisting">#define SOUP_URI_IS_VALID(uri) ((uri) && (uri)->scheme && (uri)->path) -</pre> -<p>Tests whether <em class="parameter"><code>uri</code></em> - is a valid <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a>; that is, that it is non-<code class="literal">NULL</code> -and its <em class="parameter"><code>scheme</code></em> - and <em class="parameter"><code>path</code></em> - members are also non-<code class="literal">NULL</code>.</p> -<p>This macro does not check whether http and https URIs have a non-<code class="literal">NULL</code> -<em class="parameter"><code>host</code></em> - member.</p> -<div class="refsect3"> -<a name="SOUP-URI-IS-VALID.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>uri</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="SOUP-URI-IS-VALID.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if <em class="parameter"><code>uri</code></em> -is valid for use.</p> -</div> -<p class="since">Since: 2.38</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-URI-VALID-FOR-HTTP:CAPS"></a><h3>SOUP_URI_VALID_FOR_HTTP()</h3> -<pre class="programlisting">#define SOUP_URI_VALID_FOR_HTTP(uri) ((uri) && ((uri)->scheme == SOUP_URI_SCHEME_HTTP || (uri)->scheme == SOUP_URI_SCHEME_HTTPS) && (uri)->host && (uri)->path) -</pre> -<p>Tests if <em class="parameter"><code>uri</code></em> - is a valid <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> for HTTP communication; that is, if -it can be used to construct a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>.</p> -<div class="refsect3"> -<a name="SOUP-URI-VALID-FOR-HTTP.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>uri</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="SOUP-URI-VALID-FOR-HTTP.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if <em class="parameter"><code>uri</code></em> -is a valid "http" or "https" URI.</p> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-uri-set-scheme"></a><h3>soup_uri_set_scheme ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_uri_set_scheme (<em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *scheme</code></em>);</pre> -<p>Sets <em class="parameter"><code>uri</code></em> -'s scheme to <em class="parameter"><code>scheme</code></em> -. This will also set <em class="parameter"><code>uri</code></em> -'s port to -the default port for <em class="parameter"><code>scheme</code></em> -, if known.</p> -<div class="refsect3"> -<a name="soup-uri-set-scheme.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>uri</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>scheme</p></td> -<td class="parameter_description"><p>the URI scheme</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-uri-get-scheme"></a><h3>soup_uri_get_scheme ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -soup_uri_get_scheme (<em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>);</pre> -<p>Gets <em class="parameter"><code>uri</code></em> -'s scheme.</p> -<div class="refsect3"> -<a name="soup-uri-get-scheme.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>uri</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-uri-get-scheme.returns"></a><h4>Returns</h4> -<p> <em class="parameter"><code>uri</code></em> -'s scheme.</p> -</div> -<p class="since">Since: 2.32</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-uri-set-user"></a><h3>soup_uri_set_user ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_uri_set_user (<em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *user</code></em>);</pre> -<p>Sets <em class="parameter"><code>uri</code></em> -'s user to <em class="parameter"><code>user</code></em> -.</p> -<div class="refsect3"> -<a name="soup-uri-set-user.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>uri</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user</p></td> -<td class="parameter_description"><p>the username, or <code class="literal">NULL</code>. </p></td> -<td class="parameter_annotations"><span class="annotation">[<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> -<hr> -<div class="refsect2"> -<a name="soup-uri-get-user"></a><h3>soup_uri_get_user ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -soup_uri_get_user (<em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>);</pre> -<p>Gets <em class="parameter"><code>uri</code></em> -'s user.</p> -<div class="refsect3"> -<a name="soup-uri-get-user.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>uri</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-uri-get-user.returns"></a><h4>Returns</h4> -<p> <em class="parameter"><code>uri</code></em> -'s user.</p> -</div> -<p class="since">Since: 2.32</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-uri-set-password"></a><h3>soup_uri_set_password ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_uri_set_password (<em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *password</code></em>);</pre> -<p>Sets <em class="parameter"><code>uri</code></em> -'s password to <em class="parameter"><code>password</code></em> -.</p> -<div class="refsect3"> -<a name="soup-uri-set-password.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>uri</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>password</p></td> -<td class="parameter_description"><p>the password, or <code class="literal">NULL</code>. </p></td> -<td class="parameter_annotations"><span class="annotation">[<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> -<hr> -<div class="refsect2"> -<a name="soup-uri-get-password"></a><h3>soup_uri_get_password ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -soup_uri_get_password (<em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>);</pre> -<p>Gets <em class="parameter"><code>uri</code></em> -'s password.</p> -<div class="refsect3"> -<a name="soup-uri-get-password.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>uri</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-uri-get-password.returns"></a><h4>Returns</h4> -<p> <em class="parameter"><code>uri</code></em> -'s password.</p> -</div> -<p class="since">Since: 2.32</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-uri-set-host"></a><h3>soup_uri_set_host ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_uri_set_host (<em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *host</code></em>);</pre> -<p>Sets <em class="parameter"><code>uri</code></em> -'s host to <em class="parameter"><code>host</code></em> -.</p> -<p>If <em class="parameter"><code>host</code></em> - is an IPv6 IP address, it should not include the brackets -required by the URI syntax; they will be added automatically when -converting <em class="parameter"><code>uri</code></em> - to a string.</p> -<p>http and https URIs should not have a <code class="literal">NULL</code> <em class="parameter"><code>host</code></em> -.</p> -<div class="refsect3"> -<a name="soup-uri-set-host.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>uri</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>host</p></td> -<td class="parameter_description"><p>the hostname or IP address, or <code class="literal">NULL</code>. </p></td> -<td class="parameter_annotations"><span class="annotation">[<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> -<hr> -<div class="refsect2"> -<a name="soup-uri-get-host"></a><h3>soup_uri_get_host ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -soup_uri_get_host (<em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>);</pre> -<p>Gets <em class="parameter"><code>uri</code></em> -'s host.</p> -<div class="refsect3"> -<a name="soup-uri-get-host.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>uri</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-uri-get-host.returns"></a><h4>Returns</h4> -<p> <em class="parameter"><code>uri</code></em> -'s host.</p> -</div> -<p class="since">Since: 2.32</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-uri-set-port"></a><h3>soup_uri_set_port ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_uri_set_port (<em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>, - <em class="parameter"><code><span class="type">guint</span> port</code></em>);</pre> -<p>Sets <em class="parameter"><code>uri</code></em> -'s port to <em class="parameter"><code>port</code></em> -. If <em class="parameter"><code>port</code></em> - is 0, <em class="parameter"><code>uri</code></em> - will not have an -explicitly-specified port.</p> -<div class="refsect3"> -<a name="soup-uri-set-port.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>uri</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>port</p></td> -<td class="parameter_description"><p>the port, or 0</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-uri-get-port"></a><h3>soup_uri_get_port ()</h3> -<pre class="programlisting"><span class="returnvalue">guint</span> -soup_uri_get_port (<em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>);</pre> -<p>Gets <em class="parameter"><code>uri</code></em> -'s port.</p> -<div class="refsect3"> -<a name="soup-uri-get-port.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>uri</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-uri-get-port.returns"></a><h4>Returns</h4> -<p> <em class="parameter"><code>uri</code></em> -'s port.</p> -</div> -<p class="since">Since: 2.32</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-uri-set-path"></a><h3>soup_uri_set_path ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_uri_set_path (<em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *path</code></em>);</pre> -<p>Sets <em class="parameter"><code>uri</code></em> -'s path to <em class="parameter"><code>path</code></em> -.</p> -<div class="refsect3"> -<a name="soup-uri-set-path.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>uri</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>path</p></td> -<td class="parameter_description"><p>the non-<code class="literal">NULL</code> path</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-uri-get-path"></a><h3>soup_uri_get_path ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -soup_uri_get_path (<em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>);</pre> -<p>Gets <em class="parameter"><code>uri</code></em> -'s path.</p> -<div class="refsect3"> -<a name="soup-uri-get-path.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>uri</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-uri-get-path.returns"></a><h4>Returns</h4> -<p> <em class="parameter"><code>uri</code></em> -'s path.</p> -</div> -<p class="since">Since: 2.32</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-uri-set-query"></a><h3>soup_uri_set_query ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_uri_set_query (<em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *query</code></em>);</pre> -<p>Sets <em class="parameter"><code>uri</code></em> -'s query to <em class="parameter"><code>query</code></em> -.</p> -<div class="refsect3"> -<a name="soup-uri-set-query.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>uri</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>query</p></td> -<td class="parameter_description"><p>the query. </p></td> -<td class="parameter_annotations"><span class="annotation">[<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> -<hr> -<div class="refsect2"> -<a name="soup-uri-set-query-from-form"></a><h3>soup_uri_set_query_from_form ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_uri_set_query_from_form (<em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>, - <em class="parameter"><code><span class="type">GHashTable</span> *form</code></em>);</pre> -<p>Sets <em class="parameter"><code>uri</code></em> -'s query to the result of encoding <em class="parameter"><code>form</code></em> - according to the -HTML form rules. See <a class="link" href="libsoup-2.4-HTML-Form-Support.html#soup-form-encode-hash" title="soup_form_encode_hash ()"><code class="function">soup_form_encode_hash()</code></a> for more information.</p> -<div class="refsect3"> -<a name="soup-uri-set-query-from-form.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>uri</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>form</p></td> -<td class="parameter_description"><p>a <span class="type">GHashTable</span> containing HTML form -information. </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]</span></td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-uri-set-query-from-fields"></a><h3>soup_uri_set_query_from_fields ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_uri_set_query_from_fields (<em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *first_field</code></em>, - <em class="parameter"><code>...</code></em>);</pre> -<p>Sets <em class="parameter"><code>uri</code></em> -'s query to the result of encoding the given form fields -and values according to the * HTML form rules. See -<a class="link" href="libsoup-2.4-HTML-Form-Support.html#soup-form-encode" title="soup_form_encode ()"><code class="function">soup_form_encode()</code></a> for more information.</p> -<div class="refsect3"> -<a name="soup-uri-set-query-from-fields.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>uri</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>first_field</p></td> -<td class="parameter_description"><p>name of the first form field to encode into query</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>...</p></td> -<td class="parameter_description"><p>value of <em class="parameter"><code>first_field</code></em> -, followed by additional field names -and values, terminated by <code class="literal">NULL</code>.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-uri-get-query"></a><h3>soup_uri_get_query ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -soup_uri_get_query (<em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>);</pre> -<p>Gets <em class="parameter"><code>uri</code></em> -'s query.</p> -<div class="refsect3"> -<a name="soup-uri-get-query.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>uri</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-uri-get-query.returns"></a><h4>Returns</h4> -<p> <em class="parameter"><code>uri</code></em> -'s query.</p> -</div> -<p class="since">Since: 2.32</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-uri-set-fragment"></a><h3>soup_uri_set_fragment ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_uri_set_fragment (<em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *fragment</code></em>);</pre> -<p>Sets <em class="parameter"><code>uri</code></em> -'s fragment to <em class="parameter"><code>fragment</code></em> -.</p> -<div class="refsect3"> -<a name="soup-uri-set-fragment.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>uri</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>fragment</p></td> -<td class="parameter_description"><p>the fragment. </p></td> -<td class="parameter_annotations"><span class="annotation">[<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> -<hr> -<div class="refsect2"> -<a name="soup-uri-get-fragment"></a><h3>soup_uri_get_fragment ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -soup_uri_get_fragment (<em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>);</pre> -<p>Gets <em class="parameter"><code>uri</code></em> -'s fragment.</p> -<div class="refsect3"> -<a name="soup-uri-get-fragment.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>uri</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-uri-get-fragment.returns"></a><h4>Returns</h4> -<p> <em class="parameter"><code>uri</code></em> -'s fragment.</p> -</div> -<p class="since">Since: 2.32</p> -</div> -</div> -<div class="refsect1"> -<a name="SoupURI.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupURI-struct"></a><h3>SoupURI</h3> -<pre class="programlisting">typedef struct { - const char *scheme; - - char *user; - char *password; - - char *host; - guint port; - - char *path; - char *query; - - char *fragment; -} SoupURI; -</pre> -<p>A <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> represents a (parsed) URI. <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> supports RFC 3986 -(URI Generic Syntax), and can parse any valid URI. However, libsoup -only uses "http" and "https" URIs internally; You can use -<a class="link" href="SoupURI.html#SOUP-URI-VALID-FOR-HTTP:CAPS" title="SOUP_URI_VALID_FOR_HTTP()"><code class="function">SOUP_URI_VALID_FOR_HTTP()</code></a> to test if a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> is a valid HTTP -URI.</p> -<p><em class="parameter"><code>scheme</code></em> - will always be set in any URI. It is an interned string and -is always all lowercase. (If you parse a URI with a non-lowercase -scheme, it will be converted to lowercase.) The macros -<a class="link" href="SoupURI.html#SOUP-URI-SCHEME-HTTP:CAPS" title="SOUP_URI_SCHEME_HTTP"><code class="literal">SOUP_URI_SCHEME_HTTP</code></a> and <a class="link" href="SoupURI.html#SOUP-URI-SCHEME-HTTPS:CAPS" title="SOUP_URI_SCHEME_HTTPS"><code class="literal">SOUP_URI_SCHEME_HTTPS</code></a> provide the -interned values for "http" and "https" and can be compared against -URI <em class="parameter"><code>scheme</code></em> - values.</p> -<p><em class="parameter"><code>user</code></em> - and <em class="parameter"><code>password</code></em> - are parsed as defined in the older URI specs -(ie, separated by a colon; RFC 3986 only talks about a single -"userinfo" field). Note that <em class="parameter"><code>password</code></em> - is not included in the -output of <a class="link" href="SoupURI.html#soup-uri-to-string" title="soup_uri_to_string ()"><code class="function">soup_uri_to_string()</code></a>. libsoup does not normally use these -fields; authentication is handled via <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> signals.</p> -<p><em class="parameter"><code>host</code></em> - contains the hostname, and <em class="parameter"><code>port</code></em> - the port specified in the -URI. If the URI doesn't contain a hostname, <em class="parameter"><code>host</code></em> - will be <code class="literal">NULL</code>, -and if it doesn't specify a port, <em class="parameter"><code>port</code></em> - may be 0. However, for -"http" and "https" URIs, <em class="parameter"><code>host</code></em> - is guaranteed to be non-<code class="literal">NULL</code> -(trying to parse an http URI with no <em class="parameter"><code>host</code></em> - will return <code class="literal">NULL</code>), and -<em class="parameter"><code>port</code></em> - will always be non-0 (because libsoup knows the default value -to use when it is not specified in the URI).</p> -<p><em class="parameter"><code>path</code></em> - is always non-<code class="literal">NULL</code>. For http/https URIs, <em class="parameter"><code>path</code></em> - will never be -an empty string either; if the input URI has no path, the parsed -<a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> will have a <em class="parameter"><code>path</code></em> - of "/".</p> -<p><em class="parameter"><code>query</code></em> - and <em class="parameter"><code>fragment</code></em> - are optional for all URI types. -<a class="link" href="libsoup-2.4-HTML-Form-Support.html#soup-form-decode" title="soup_form_decode ()"><code class="function">soup_form_decode()</code></a> may be useful for parsing <em class="parameter"><code>query</code></em> -.</p> -<p>Note that <em class="parameter"><code>path</code></em> -, <em class="parameter"><code>query</code></em> -, and <em class="parameter"><code>fragment</code></em> - may contain -%-encoded characters. <a class="link" href="SoupURI.html#soup-uri-new" title="soup_uri_new ()"><code class="function">soup_uri_new()</code></a> calls -<a class="link" href="SoupURI.html#soup-uri-normalize" title="soup_uri_normalize ()"><code class="function">soup_uri_normalize()</code></a> on them, but not <a class="link" href="SoupURI.html#soup-uri-decode" title="soup_uri_decode ()"><code class="function">soup_uri_decode()</code></a>. This is -necessary to ensure that <a class="link" href="SoupURI.html#soup-uri-to-string" title="soup_uri_to_string ()"><code class="function">soup_uri_to_string()</code></a> will generate a URI -that has exactly the same meaning as the original. (In theory, -<a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> should leave <em class="parameter"><code>user</code></em> -, <em class="parameter"><code>password</code></em> -, and <em class="parameter"><code>host</code></em> - partially-encoded -as well, but this would be more annoying than useful.)</p> -<div class="refsect3"> -<a name="SoupURI.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="struct_members_name"> -<col class="struct_members_description"> -<col width="200px" class="struct_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="struct_member_name"><p>const <span class="type">char</span> *<em class="structfield"><code><a name="SoupURI-struct.scheme"></a>scheme</code></em>;</p></td> -<td class="struct_member_description"><p>the URI scheme (eg, "http")</p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="SoupURI-struct.user"></a>user</code></em>;</p></td> -<td class="struct_member_description"><p>a username, or <code class="literal">NULL</code></p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="SoupURI-struct.password"></a>password</code></em>;</p></td> -<td class="struct_member_description"><p>a password, or <code class="literal">NULL</code></p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="SoupURI-struct.host"></a>host</code></em>;</p></td> -<td class="struct_member_description"><p>the hostname or IP address, or <code class="literal">NULL</code></p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><span class="type">guint</span> <em class="structfield"><code><a name="SoupURI-struct.port"></a>port</code></em>;</p></td> -<td class="struct_member_description"><p>the port number on <em class="parameter"><code>host</code></em> -</p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="SoupURI-struct.path"></a>path</code></em>;</p></td> -<td class="struct_member_description"><p>the path on <em class="parameter"><code>host</code></em> -</p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="SoupURI-struct.query"></a>query</code></em>;</p></td> -<td class="struct_member_description"><p>a query for <em class="parameter"><code>path</code></em> -, or <code class="literal">NULL</code></p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="SoupURI-struct.fragment"></a>fragment</code></em>;</p></td> -<td class="struct_member_description"><p>a fragment identifier within <em class="parameter"><code>path</code></em> -, or <code class="literal">NULL</code></p></td> -<td class="struct_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-URI-SCHEME-HTTP:CAPS"></a><h3>SOUP_URI_SCHEME_HTTP</h3> -<pre class="programlisting">#define SOUP_URI_SCHEME_HTTP _SOUP_ATOMIC_INTERN_STRING (_SOUP_URI_SCHEME_HTTP, "http") -</pre> -<p>"http" as an interned string; you can compare this directly to a -<a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a>'s <code class="literal">scheme</code> field using -<code class="literal">==</code>.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-URI-SCHEME-HTTPS:CAPS"></a><h3>SOUP_URI_SCHEME_HTTPS</h3> -<pre class="programlisting">#define SOUP_URI_SCHEME_HTTPS _SOUP_ATOMIC_INTERN_STRING (_SOUP_URI_SCHEME_HTTPS, "https") -</pre> -<p>"https" as an interned string; you can compare this directly to a -<a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a>'s <code class="literal">scheme</code> field using -<code class="literal">==</code>.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-URI-SCHEME-DATA:CAPS"></a><h3>SOUP_URI_SCHEME_DATA</h3> -<pre class="programlisting">#define SOUP_URI_SCHEME_DATA _SOUP_ATOMIC_INTERN_STRING (_SOUP_URI_SCHEME_DATA, "data") -</pre> -<p>"data" as an interned string; you can compare this directly to a -<a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a>'s <code class="literal">scheme</code> field using -<code class="literal">==</code>.</p> -<p class="since">Since: 2.30</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-URI-SCHEME-FILE:CAPS"></a><h3>SOUP_URI_SCHEME_FILE</h3> -<pre class="programlisting">#define SOUP_URI_SCHEME_FILE _SOUP_ATOMIC_INTERN_STRING (_SOUP_URI_SCHEME_FILE, "file") -</pre> -<p>"file" as an interned string; you can compare this directly to a -<a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a>'s <code class="literal">scheme</code> field using -<code class="literal">==</code>.</p> -<p class="since">Since: 2.30</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-URI-SCHEME-FTP:CAPS"></a><h3>SOUP_URI_SCHEME_FTP</h3> -<pre class="programlisting">#define SOUP_URI_SCHEME_FTP _SOUP_ATOMIC_INTERN_STRING (_SOUP_URI_SCHEME_FTP, "ftp") -</pre> -<p>"ftp" as an interned string; you can compare this directly to a -<a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a>'s <code class="literal">scheme</code> field using -<code class="literal">==</code>.</p> -<p class="since">Since: 2.30</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-URI-SCHEME-RESOURCE:CAPS"></a><h3>SOUP_URI_SCHEME_RESOURCE</h3> -<pre class="programlisting">#define SOUP_URI_SCHEME_RESOURCE _SOUP_ATOMIC_INTERN_STRING (_SOUP_URI_SCHEME_RESOURCE, "resource") -</pre> -<p>"data" as an interned string; you can compare this directly to a -<a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a>'s <code class="literal">scheme</code> field using -<code class="literal">==</code>.</p> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-URI-SCHEME-WS:CAPS"></a><h3>SOUP_URI_SCHEME_WS</h3> -<pre class="programlisting">#define SOUP_URI_SCHEME_WS _SOUP_ATOMIC_INTERN_STRING (_SOUP_URI_SCHEME_WS, "ws") -</pre> -<p>"ws" (WebSocket) as an interned string; you can compare this -directly to a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a>'s <code class="literal">scheme</code> field using -<code class="literal">==</code>.</p> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-URI-SCHEME-WSS:CAPS"></a><h3>SOUP_URI_SCHEME_WSS</h3> -<pre class="programlisting">#define SOUP_URI_SCHEME_WSS _SOUP_ATOMIC_INTERN_STRING (_SOUP_URI_SCHEME_WSS, "wss") -</pre> -<p>"wss" (WebSocket over TLS) as an interned string; you can compare -this directly to a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a>'s <code class="literal">scheme</code> field using -<code class="literal">==</code>.</p> -<p class="since">Since: 2.50</p> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/annotation-glossary.html b/docs/reference/html/annotation-glossary.html deleted file mode 100644 index 8b5d180c..00000000 --- a/docs/reference/html/annotation-glossary.html +++ /dev/null @@ -1,80 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Annotation Glossary: 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="index.html" title="libsoup Reference Manual"> -<link rel="prev" href="ix01.html" title="Index"> -<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"><span id="nav_glossary"><a class="shortcut" href="#glsA">A</a> - <span class="dim">|</span> - <a class="shortcut" href="#glsE">E</a> - <span class="dim">|</span> - <a class="shortcut" href="#glsI">I</a> - <span class="dim">|</span> - <a class="shortcut" href="#glsN">N</a> - <span class="dim">|</span> - <a class="shortcut" href="#glsO">O</a> - <span class="dim">|</span> - <a class="shortcut" href="#glsR">R</a> - <span class="dim">|</span> - <a class="shortcut" href="#glsS">S</a> - <span class="dim">|</span> - <a class="shortcut" href="#glsT">T</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><img src="up-insensitive.png" width="16" height="16" border="0"></td> -<td><a accesskey="p" href="ix01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><img src="right-insensitive.png" width="16" height="16" border="0"></td> -</tr></table> -<div class="glossary"> -<div class="titlepage"><div><div><h1 class="title"> -<a name="annotation-glossary"></a>Annotation Glossary</h1></div></div></div> -<a name="glsA"></a><h3 class="title">A</h3> -<dt><span class="glossterm"><a name="annotation-glossterm-allow-none"></a>allow-none</span></dt> -<dd class="glossdef"><p>NULL is OK, both for passing and for returning.</p></dd> -<dt><span class="glossterm"><a name="annotation-glossterm-array"></a>array</span></dt> -<dd class="glossdef"><p>Parameter points to an array of items.</p></dd> -<a name="glsE"></a><h3 class="title">E</h3> -<dt><span class="glossterm"><a name="annotation-glossterm-element-type"></a>element-type</span></dt> -<dd class="glossdef"><p>Generics and defining elements of containers and arrays.</p></dd> -<a name="glsI"></a><h3 class="title">I</h3> -<dt><span class="glossterm"><a name="annotation-glossterm-inout"></a>inout</span></dt> -<dd class="glossdef"><p>Parameter for input and for returning results. Default is <acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>.</p></dd> -<a name="glsN"></a><h3 class="title">N</h3> -<dt><span class="glossterm"><a name="annotation-glossterm-nullable"></a>nullable</span></dt> -<dd class="glossdef"><p>NULL may be passed as the value in, out, in-out; or as a return value.</p></dd> -<a name="glsO"></a><h3 class="title">O</h3> -<dt><span class="glossterm"><a name="annotation-glossterm-optional"></a>optional</span></dt> -<dd class="glossdef"><p>NULL may be passed instead of a pointer to a location.</p></dd> -<dt><span class="glossterm"><a name="annotation-glossterm-out"></a>out</span></dt> -<dd class="glossdef"><p>Parameter for returning results. Default is <acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>.</p></dd> -<a name="glsR"></a><h3 class="title">R</h3> -<dt><span class="glossterm"><a name="annotation-glossterm-rename-to"></a>rename-to</span></dt> -<dd class="glossdef"><p>Rename the original symbol's name to SYMBOL.</p></dd> -<a name="glsS"></a><h3 class="title">S</h3> -<dt><span class="glossterm"><a name="annotation-glossterm-scope%20async"></a>scope async</span></dt> -<dd class="glossdef"><p>The callback is valid until first called.</p></dd> -<dt><span class="glossterm"><a name="annotation-glossterm-scope%20call"></a>scope call</span></dt> -<dd class="glossdef"><p>The callback is valid only during the call to the method.</p></dd> -<dt><span class="glossterm"><a name="annotation-glossterm-skip"></a>skip</span></dt> -<dd class="glossdef"><p>Exposed in C code, not necessarily available in other languages.</p></dd> -<a name="glsT"></a><h3 class="title">T</h3> -<dt><span class="glossterm"><a name="annotation-glossterm-transfer%20container"></a>transfer container</span></dt> -<dd class="glossdef"><p>Free data container after the code is done.</p></dd> -<dt><span class="glossterm"><a name="annotation-glossterm-transfer%20full"></a>transfer full</span></dt> -<dd class="glossdef"><p>Free data after the code is done.</p></dd> -<dt><span class="glossterm"><a name="annotation-glossterm-transfer%20none"></a>transfer none</span></dt> -<dd class="glossdef"><p>Don't free data after the code is done.</p></dd> -<dt><span class="glossterm"><a name="annotation-glossterm-type"></a>type</span></dt> -<dd class="glossdef"><p>Override the parsed C type with given type.</p></dd> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/ch01.html b/docs/reference/html/ch01.html deleted file mode 100644 index 4836816a..00000000 --- a/docs/reference/html/ch01.html +++ /dev/null @@ -1,48 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Tutorial: 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="index.html" title="libsoup Reference Manual"> -<link rel="prev" href="index.html" title="libsoup Reference Manual"> -<link rel="next" href="libsoup-build-howto.html" title="Compiling with libsoup"> -<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"></td> -<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> -<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> -<td><a accesskey="p" href="index.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="libsoup-build-howto.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="chapter"> -<div class="titlepage"><div><div><h1 class="title"> -<a name="id-1.2"></a>Tutorial</h1></div></div></div> -<div class="toc"><dl class="toc"> -<dt> -<span class="refentrytitle"><a href="libsoup-build-howto.html">Compiling with libsoup</a></span><span class="refpurpose"> — Notes on compiling</span> -</dt> -<dt> -<span class="refentrytitle"><a href="libsoup-client-howto.html">libsoup Client Basics</a></span><span class="refpurpose"> — Client-side tutorial</span> -</dt> -<dt> -<span class="refentrytitle"><a href="libsoup-request-howto.html">libsoup Client SoupRequest API</a></span><span class="refpurpose"> — Using -libsoup with a mix of <code class="literal">http</code> and non-<code class="literal">http</code> URIs.</span> -</dt> -<dt> -<span class="refentrytitle"><a href="libsoup-session-porting.html">Porting to the new SoupSession</a></span><span class="refpurpose"> — Notes on -porting from SoupSessionAsync and SoupSessionSync to SoupSession</span> -</dt> -<dt> -<span class="refentrytitle"><a href="libsoup-server-howto.html">libsoup Server Basics</a></span><span class="refpurpose"> — Server-side tutorial</span> -</dt> -</dl></div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/ch02.html b/docs/reference/html/ch02.html deleted file mode 100644 index f2f15dd2..00000000 --- a/docs/reference/html/ch02.html +++ /dev/null @@ -1,111 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Core API: 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="index.html" title="libsoup Reference Manual"> -<link rel="prev" href="libsoup-server-howto.html" title="libsoup Server Basics"> -<link rel="next" href="SoupAuth.html" title="SoupAuth"> -<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"></td> -<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> -<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> -<td><a accesskey="p" href="libsoup-server-howto.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="SoupAuth.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="chapter"> -<div class="titlepage"><div><div><h1 class="title"> -<a name="id-1.3"></a>Core API</h1></div></div></div> -<div class="toc"><dl class="toc"> -<dt> -<span class="refentrytitle"><a href="SoupAuth.html">SoupAuth</a></span><span class="refpurpose"> — HTTP client-side authentication support</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupAuthDomain.html">SoupAuthDomain</a></span><span class="refpurpose"> — Server-side authentication</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupAuthDomainBasic.html">SoupAuthDomainBasic</a></span><span class="refpurpose"> — Server-side "Basic" authentication</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupAuthDomainDigest.html">SoupAuthDomainDigest</a></span><span class="refpurpose"> — Server-side "Digest" authentication</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupCache.html">SoupCache</a></span><span class="refpurpose"> — Caching support</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupCookie.html">SoupCookie</a></span><span class="refpurpose"> — HTTP Cookies</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupMessage.html">SoupMessage</a></span><span class="refpurpose"> — An HTTP request and response.</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupMessageHeaders.html">SoupMessageHeaders</a></span><span class="refpurpose"> — HTTP message headers</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupMessageBody.html">SoupMessageBody</a></span><span class="refpurpose"> — HTTP message body</span> -</dt> -<dt> -<span class="refentrytitle"><a href="libsoup-2.4-soup-method.html">soup-method</a></span><span class="refpurpose"> — HTTP method definitions</span> -</dt> -<dt> -<span class="refentrytitle"><a href="libsoup-2.4-Soup-Miscellaneous-Utilities.html">Soup Miscellaneous Utilities</a></span><span class="refpurpose"> — Miscellaneous functions</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupMultipart.html">SoupMultipart</a></span><span class="refpurpose"> — multipart HTTP message bodies</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupMultipartInputStream.html">SoupMultipartInputStream</a></span><span class="refpurpose"> — Multipart input handling stream</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupRequest.html">SoupRequest</a></span><span class="refpurpose"> — Protocol-independent streaming request interface</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupRequestHTTP.html">SoupRequestHTTP</a></span><span class="refpurpose"> — SoupRequest support for "http" and "https" URIs</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupRequestFile.html">SoupRequestFile</a></span><span class="refpurpose"> — SoupRequest support for "file" and "resource" URIs</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupRequestData.html">SoupRequestData</a></span><span class="refpurpose"> — SoupRequest support for "data" URIs</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupServer.html">SoupServer</a></span><span class="refpurpose"> — HTTP server</span> -</dt> -<dt> -<span class="refentrytitle"><a href="libsoup-2.4-SoupServer-deprecated-API.html">SoupServer deprecated API</a></span><span class="refpurpose"></span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupSession.html">SoupSession</a></span><span class="refpurpose"> — Soup session state object</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupSessionAsync.html">SoupSessionAsync</a></span><span class="refpurpose"> — SoupSession for asynchronous (main-loop-based) I/O -(deprecated).</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupSessionSync.html">SoupSessionSync</a></span><span class="refpurpose"> — SoupSession for blocking I/O in multithreaded programs -(deprecated).</span> -</dt> -<dt> -<span class="refentrytitle"><a href="libsoup-2.4-soup-status.html">soup-status</a></span><span class="refpurpose"> — HTTP (and libsoup) status codes</span> -</dt> -<dt> -<span class="refentrytitle"><a href="libsoup-2.4-Top-Level-Domain-utils.html">Top Level Domain utils</a></span><span class="refpurpose"> — Top-Level Domain Utilities</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupURI.html">SoupURI</a></span><span class="refpurpose"> — URIs</span> -</dt> -<dt> -<span class="refentrytitle"><a href="libsoup-2.4-Version-Information.html">Version Information</a></span><span class="refpurpose"> — Variables and functions to check the libsoup version</span> -</dt> -</dl></div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/ch03.html b/docs/reference/html/ch03.html deleted file mode 100644 index 6c2f5af3..00000000 --- a/docs/reference/html/ch03.html +++ /dev/null @@ -1,58 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Additional Features: 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="index.html" title="libsoup Reference Manual"> -<link rel="prev" href="libsoup-2.4-Version-Information.html" title="Version Information"> -<link rel="next" href="SoupSessionFeature.html" title="SoupSessionFeature"> -<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"></td> -<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> -<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> -<td><a accesskey="p" href="libsoup-2.4-Version-Information.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="SoupSessionFeature.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="chapter"> -<div class="titlepage"><div><div><h1 class="title"> -<a name="id-1.4"></a>Additional Features</h1></div></div></div> -<div class="toc"><dl class="toc"> -<dt> -<span class="refentrytitle"><a href="SoupSessionFeature.html">SoupSessionFeature</a></span><span class="refpurpose"> — Interface for miscellaneous session features</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupAuthManager.html">SoupAuthManager</a></span><span class="refpurpose"> — HTTP client-side authentication handler</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupContentDecoder.html">SoupContentDecoder</a></span><span class="refpurpose"> — Content-Encoding handler</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupContentSniffer.html">SoupContentSniffer</a></span><span class="refpurpose"> — Content sniffing for SoupSession</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupCookieJar.html">SoupCookieJar</a></span><span class="refpurpose"> — Automatic cookie handling for SoupSession</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupCookieJarText.html">SoupCookieJarText</a></span><span class="refpurpose"> — Text-file-based ("cookies.txt") Cookie Jar</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupCookieJarDB.html">SoupCookieJarDB</a></span><span class="refpurpose"> — Database-based Cookie Jar</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupLogger.html">SoupLogger</a></span><span class="refpurpose"> — Debug logging support</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupProxyResolverDefault.html">SoupProxyResolverDefault</a></span><span class="refpurpose"> — System proxy configuration integration</span> -</dt> -</dl></div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/ch04.html b/docs/reference/html/ch04.html deleted file mode 100644 index 645bbe16..00000000 --- a/docs/reference/html/ch04.html +++ /dev/null @@ -1,40 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Web Services APIs: 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="index.html" title="libsoup Reference Manual"> -<link rel="prev" href="SoupProxyResolverDefault.html" title="SoupProxyResolverDefault"> -<link rel="next" href="libsoup-2.4-HTML-Form-Support.html" title="HTML Form Support"> -<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"></td> -<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> -<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> -<td><a accesskey="p" href="SoupProxyResolverDefault.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="libsoup-2.4-HTML-Form-Support.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="chapter"> -<div class="titlepage"><div><div><h1 class="title"> -<a name="id-1.5"></a>Web Services APIs</h1></div></div></div> -<div class="toc"><dl class="toc"> -<dt> -<span class="refentrytitle"><a href="libsoup-2.4-HTML-Form-Support.html">HTML Form Support</a></span><span class="refpurpose"> — HTML form handling</span> -</dt> -<dt> -<span class="refentrytitle"><a href="libsoup-2.4-XMLRPC-Support.html">XMLRPC Support</a></span><span class="refpurpose"> — XML-RPC support</span> -</dt> -<dt> -<span class="refentrytitle"><a href="libsoup-2.4-WebSockets.html">WebSockets</a></span><span class="refpurpose"> — The WebSocket Protocol</span> -</dt> -</dl></div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/ch05.html b/docs/reference/html/ch05.html deleted file mode 100644 index 12099f3c..00000000 --- a/docs/reference/html/ch05.html +++ /dev/null @@ -1,37 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Low-level Networking API: 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="index.html" title="libsoup Reference Manual"> -<link rel="prev" href="libsoup-2.4-WebSockets.html" title="WebSockets"> -<link rel="next" href="SoupAddress.html" title="SoupAddress"> -<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"></td> -<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> -<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> -<td><a accesskey="p" href="libsoup-2.4-WebSockets.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="SoupAddress.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="chapter"> -<div class="titlepage"><div><div><h1 class="title"> -<a name="id-1.6"></a>Low-level Networking API</h1></div></div></div> -<div class="toc"><dl class="toc"> -<dt> -<span class="refentrytitle"><a href="SoupAddress.html">SoupAddress</a></span><span class="refpurpose"> — DNS support</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupSocket.html">SoupSocket</a></span><span class="refpurpose"> — A network socket</span> -</dt> -</dl></div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/home.png b/docs/reference/html/home.png Binary files differdeleted file mode 100644 index 9346b336..00000000 --- a/docs/reference/html/home.png +++ /dev/null diff --git a/docs/reference/html/index.html b/docs/reference/html/index.html deleted file mode 100644 index fd6bde9a..00000000 --- a/docs/reference/html/index.html +++ /dev/null @@ -1,180 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>libsoup Reference Manual: 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="next" href="ch01.html" title="Tutorial"> -<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"> -<div class="book"> -<div class="titlepage"> -<div><div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">libsoup Reference Manual</p></th></tr></table></div></div> -<hr> -</div> -<div class="toc"><dl class="toc"> -<dt><span class="chapter"><a href="ch01.html">Tutorial</a></span></dt> -<dd><dl> -<dt> -<span class="refentrytitle"><a href="libsoup-build-howto.html">Compiling with libsoup</a></span><span class="refpurpose"> — Notes on compiling</span> -</dt> -<dt> -<span class="refentrytitle"><a href="libsoup-client-howto.html">libsoup Client Basics</a></span><span class="refpurpose"> — Client-side tutorial</span> -</dt> -<dt> -<span class="refentrytitle"><a href="libsoup-request-howto.html">libsoup Client SoupRequest API</a></span><span class="refpurpose"> — Using -libsoup with a mix of <code class="literal">http</code> and non-<code class="literal">http</code> URIs.</span> -</dt> -<dt> -<span class="refentrytitle"><a href="libsoup-session-porting.html">Porting to the new SoupSession</a></span><span class="refpurpose"> — Notes on -porting from SoupSessionAsync and SoupSessionSync to SoupSession</span> -</dt> -<dt> -<span class="refentrytitle"><a href="libsoup-server-howto.html">libsoup Server Basics</a></span><span class="refpurpose"> — Server-side tutorial</span> -</dt> -</dl></dd> -<dt><span class="chapter"><a href="ch02.html">Core API</a></span></dt> -<dd><dl> -<dt> -<span class="refentrytitle"><a href="SoupAuth.html">SoupAuth</a></span><span class="refpurpose"> — HTTP client-side authentication support</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupAuthDomain.html">SoupAuthDomain</a></span><span class="refpurpose"> — Server-side authentication</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupAuthDomainBasic.html">SoupAuthDomainBasic</a></span><span class="refpurpose"> — Server-side "Basic" authentication</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupAuthDomainDigest.html">SoupAuthDomainDigest</a></span><span class="refpurpose"> — Server-side "Digest" authentication</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupCache.html">SoupCache</a></span><span class="refpurpose"> — Caching support</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupCookie.html">SoupCookie</a></span><span class="refpurpose"> — HTTP Cookies</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupMessage.html">SoupMessage</a></span><span class="refpurpose"> — An HTTP request and response.</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupMessageHeaders.html">SoupMessageHeaders</a></span><span class="refpurpose"> — HTTP message headers</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupMessageBody.html">SoupMessageBody</a></span><span class="refpurpose"> — HTTP message body</span> -</dt> -<dt> -<span class="refentrytitle"><a href="libsoup-2.4-soup-method.html">soup-method</a></span><span class="refpurpose"> — HTTP method definitions</span> -</dt> -<dt> -<span class="refentrytitle"><a href="libsoup-2.4-Soup-Miscellaneous-Utilities.html">Soup Miscellaneous Utilities</a></span><span class="refpurpose"> — Miscellaneous functions</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupMultipart.html">SoupMultipart</a></span><span class="refpurpose"> — multipart HTTP message bodies</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupMultipartInputStream.html">SoupMultipartInputStream</a></span><span class="refpurpose"> — Multipart input handling stream</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupRequest.html">SoupRequest</a></span><span class="refpurpose"> — Protocol-independent streaming request interface</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupRequestHTTP.html">SoupRequestHTTP</a></span><span class="refpurpose"> — SoupRequest support for "http" and "https" URIs</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupRequestFile.html">SoupRequestFile</a></span><span class="refpurpose"> — SoupRequest support for "file" and "resource" URIs</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupRequestData.html">SoupRequestData</a></span><span class="refpurpose"> — SoupRequest support for "data" URIs</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupServer.html">SoupServer</a></span><span class="refpurpose"> — HTTP server</span> -</dt> -<dt> -<span class="refentrytitle"><a href="libsoup-2.4-SoupServer-deprecated-API.html">SoupServer deprecated API</a></span><span class="refpurpose"></span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupSession.html">SoupSession</a></span><span class="refpurpose"> — Soup session state object</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupSessionAsync.html">SoupSessionAsync</a></span><span class="refpurpose"> — SoupSession for asynchronous (main-loop-based) I/O -(deprecated).</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupSessionSync.html">SoupSessionSync</a></span><span class="refpurpose"> — SoupSession for blocking I/O in multithreaded programs -(deprecated).</span> -</dt> -<dt> -<span class="refentrytitle"><a href="libsoup-2.4-soup-status.html">soup-status</a></span><span class="refpurpose"> — HTTP (and libsoup) status codes</span> -</dt> -<dt> -<span class="refentrytitle"><a href="libsoup-2.4-Top-Level-Domain-utils.html">Top Level Domain utils</a></span><span class="refpurpose"> — Top-Level Domain Utilities</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupURI.html">SoupURI</a></span><span class="refpurpose"> — URIs</span> -</dt> -<dt> -<span class="refentrytitle"><a href="libsoup-2.4-Version-Information.html">Version Information</a></span><span class="refpurpose"> — Variables and functions to check the libsoup version</span> -</dt> -</dl></dd> -<dt><span class="chapter"><a href="ch03.html">Additional Features</a></span></dt> -<dd><dl> -<dt> -<span class="refentrytitle"><a href="SoupSessionFeature.html">SoupSessionFeature</a></span><span class="refpurpose"> — Interface for miscellaneous session features</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupAuthManager.html">SoupAuthManager</a></span><span class="refpurpose"> — HTTP client-side authentication handler</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupContentDecoder.html">SoupContentDecoder</a></span><span class="refpurpose"> — Content-Encoding handler</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupContentSniffer.html">SoupContentSniffer</a></span><span class="refpurpose"> — Content sniffing for SoupSession</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupCookieJar.html">SoupCookieJar</a></span><span class="refpurpose"> — Automatic cookie handling for SoupSession</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupCookieJarText.html">SoupCookieJarText</a></span><span class="refpurpose"> — Text-file-based ("cookies.txt") Cookie Jar</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupCookieJarDB.html">SoupCookieJarDB</a></span><span class="refpurpose"> — Database-based Cookie Jar</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupLogger.html">SoupLogger</a></span><span class="refpurpose"> — Debug logging support</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupProxyResolverDefault.html">SoupProxyResolverDefault</a></span><span class="refpurpose"> — System proxy configuration integration</span> -</dt> -</dl></dd> -<dt><span class="chapter"><a href="ch04.html">Web Services APIs</a></span></dt> -<dd><dl> -<dt> -<span class="refentrytitle"><a href="libsoup-2.4-HTML-Form-Support.html">HTML Form Support</a></span><span class="refpurpose"> — HTML form handling</span> -</dt> -<dt> -<span class="refentrytitle"><a href="libsoup-2.4-XMLRPC-Support.html">XMLRPC Support</a></span><span class="refpurpose"> — XML-RPC support</span> -</dt> -<dt> -<span class="refentrytitle"><a href="libsoup-2.4-WebSockets.html">WebSockets</a></span><span class="refpurpose"> — The WebSocket Protocol</span> -</dt> -</dl></dd> -<dt><span class="chapter"><a href="ch05.html">Low-level Networking API</a></span></dt> -<dd><dl> -<dt> -<span class="refentrytitle"><a href="SoupAddress.html">SoupAddress</a></span><span class="refpurpose"> — DNS support</span> -</dt> -<dt> -<span class="refentrytitle"><a href="SoupSocket.html">SoupSocket</a></span><span class="refpurpose"> — A network socket</span> -</dt> -</dl></dd> -<dt><span class="index"><a href="ix01.html">Index</a></span></dt> -<dt><span class="glossary"><a href="annotation-glossary.html">Annotation Glossary</a></span></dt> -</dl></div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/ix01.html b/docs/reference/html/ix01.html deleted file mode 100644 index 0f5c2289..00000000 --- a/docs/reference/html/ix01.html +++ /dev/null @@ -1,1602 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Index: 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="index.html" title="libsoup Reference Manual"> -<link rel="prev" href="SoupSocket.html" title="SoupSocket"> -<link rel="next" href="annotation-glossary.html" title="Annotation Glossary"> -<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"></td> -<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> -<td><img src="up-insensitive.png" width="16" height="16" border="0"></td> -<td><a accesskey="p" href="SoupSocket.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="annotation-glossary.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="index"> -<div class="titlepage"><div><div><h1 class="title"> -<a name="id-1.7"></a>Index</h1></div></div></div> -<div xmlns:xlink="http://www.w3.org/1999/xlink" class="index"><div class="indexdiv"> -<h3>S</h3> -<dl> -<dt id="ientry-idm34753">SoupAddress, <a class="indexterm" href="SoupAddress.html#SoupAddress-struct">SoupAddress</a> -</dt> -<dt id="ientry-idm34852">SoupAddress:family, <a class="indexterm" href="SoupAddress.html#SoupAddress--family">The “family” property</a> -</dt> -<dt id="ientry-idm34863">SoupAddress:name, <a class="indexterm" href="SoupAddress.html#SoupAddress--name">The “name” property</a> -</dt> -<dt id="ientry-idm34874">SoupAddress:physical, <a class="indexterm" href="SoupAddress.html#SoupAddress--physical">The “physical” property</a> -</dt> -<dt id="ientry-idm34885">SoupAddress:port, <a class="indexterm" href="SoupAddress.html#SoupAddress--port">The “port” property</a> -</dt> -<dt id="ientry-idm34897">SoupAddress:protocol, <a class="indexterm" href="SoupAddress.html#SoupAddress--protocol">The “protocol” property</a> -</dt> -<dt id="ientry-idm34908">SoupAddress:sockaddr, <a class="indexterm" href="SoupAddress.html#SoupAddress--sockaddr">The “sockaddr” property</a> -</dt> -<dt id="ientry-idm34090">SoupAddressCallback, <a class="indexterm" href="SoupAddress.html#SoupAddressCallback">SoupAddressCallback ()</a> -</dt> -<dt id="ientry-idm34758">SoupAddressFamily, <a class="indexterm" href="SoupAddress.html#SoupAddressFamily">enum SoupAddressFamily</a> -</dt> -<dt id="ientry-idm1717">SoupAuth, <a class="indexterm" href="SoupAuth.html#SoupAuth-struct">SoupAuth</a> -</dt> -<dt id="ientry-idm1833">SoupAuth:host, <a class="indexterm" href="SoupAuth.html#SoupAuth--host">The “host” property</a> -</dt> -<dt id="ientry-idm1844">SoupAuth:is-authenticated, <a class="indexterm" href="SoupAuth.html#SoupAuth--is-authenticated">The “is-authenticated” property</a> -</dt> -<dt id="ientry-idm1855">SoupAuth:is-for-proxy, <a class="indexterm" href="SoupAuth.html#SoupAuth--is-for-proxy">The “is-for-proxy” property</a> -</dt> -<dt id="ientry-idm1866">SoupAuth:realm, <a class="indexterm" href="SoupAuth.html#SoupAuth--realm">The “realm” property</a> -</dt> -<dt id="ientry-idm1877">SoupAuth:scheme-name, <a class="indexterm" href="SoupAuth.html#SoupAuth--scheme-name">The “scheme-name” property</a> -</dt> -<dt id="ientry-idm2768">SoupAuthDomain, <a class="indexterm" href="SoupAuthDomain.html#SoupAuthDomain-struct">SoupAuthDomain</a> -</dt> -<dt id="ientry-idm2852">SoupAuthDomain:add-path, <a class="indexterm" href="SoupAuthDomain.html#SoupAuthDomain--add-path">The “add-path” property</a> -</dt> -<dt id="ientry-idm2863">SoupAuthDomain:filter, <a class="indexterm" href="SoupAuthDomain.html#SoupAuthDomain--filter">The “filter” property</a> -</dt> -<dt id="ientry-idm2873">SoupAuthDomain:filter-data, <a class="indexterm" href="SoupAuthDomain.html#SoupAuthDomain--filter-data">The “filter-data” property</a> -</dt> -<dt id="ientry-idm2883">SoupAuthDomain:generic-auth-callback, <a class="indexterm" href="SoupAuthDomain.html#SoupAuthDomain--generic-auth-callback">The “generic-auth-callback” property</a> -</dt> -<dt id="ientry-idm2893">SoupAuthDomain:generic-auth-data, <a class="indexterm" href="SoupAuthDomain.html#SoupAuthDomain--generic-auth-data">The “generic-auth-data” property</a> -</dt> -<dt id="ientry-idm2903">SoupAuthDomain:proxy, <a class="indexterm" href="SoupAuthDomain.html#SoupAuthDomain--proxy">The “proxy” property</a> -</dt> -<dt id="ientry-idm2914">SoupAuthDomain:realm, <a class="indexterm" href="SoupAuthDomain.html#SoupAuthDomain--realm">The “realm” property</a> -</dt> -<dt id="ientry-idm2925">SoupAuthDomain:remove-path, <a class="indexterm" href="SoupAuthDomain.html#SoupAuthDomain--remove-path">The “remove-path” property</a> -</dt> -<dt id="ientry-idm3225">SoupAuthDomainBasic, <a class="indexterm" href="SoupAuthDomainBasic.html#SoupAuthDomainBasic-struct">SoupAuthDomainBasic</a> -</dt> -<dt id="ientry-idm3253">SoupAuthDomainBasic:auth-callback, <a class="indexterm" href="SoupAuthDomainBasic.html#SoupAuthDomainBasic--auth-callback">The “auth-callback” property</a> -</dt> -<dt id="ientry-idm3263">SoupAuthDomainBasic:auth-data, <a class="indexterm" href="SoupAuthDomainBasic.html#SoupAuthDomainBasic--auth-data">The “auth-data” property</a> -</dt> -<dt id="ientry-idm3079">SoupAuthDomainBasicAuthCallback, <a class="indexterm" href="SoupAuthDomainBasic.html#SoupAuthDomainBasicAuthCallback">SoupAuthDomainBasicAuthCallback ()</a> -</dt> -<dt id="ientry-idm3608">SoupAuthDomainDigest, <a class="indexterm" href="SoupAuthDomainDigest.html#SoupAuthDomainDigest-struct">SoupAuthDomainDigest</a> -</dt> -<dt id="ientry-idm3636">SoupAuthDomainDigest:auth-callback, <a class="indexterm" href="SoupAuthDomainDigest.html#SoupAuthDomainDigest--auth-callback">The “auth-callback” property</a> -</dt> -<dt id="ientry-idm3646">SoupAuthDomainDigest:auth-data, <a class="indexterm" href="SoupAuthDomainDigest.html#SoupAuthDomainDigest--auth-data">The “auth-data” property</a> -</dt> -<dt id="ientry-idm3418">SoupAuthDomainDigestAuthCallback, <a class="indexterm" href="SoupAuthDomainDigest.html#SoupAuthDomainDigestAuthCallback">SoupAuthDomainDigestAuthCallback ()</a> -</dt> -<dt id="ientry-idm2226">SoupAuthDomainFilter, <a class="indexterm" href="SoupAuthDomain.html#SoupAuthDomainFilter">SoupAuthDomainFilter ()</a> -</dt> -<dt id="ientry-idm2404">SoupAuthDomainGenericAuthCallback, <a class="indexterm" href="SoupAuthDomain.html#SoupAuthDomainGenericAuthCallback">SoupAuthDomainGenericAuthCallback ()</a> -</dt> -<dt id="ientry-idm27901">SoupAuthManager, <a class="indexterm" href="SoupAuthManager.html#SoupAuthManager-struct">SoupAuthManager</a> -</dt> -<dt id="ientry-idm27930">SoupAuthManager::authenticate, <a class="indexterm" href="SoupAuthManager.html#SoupAuthManager-authenticate">The “authenticate” signal</a> -</dt> -<dt id="ientry-idm12275">SoupBuffer, <a class="indexterm" href="SoupMessageBody.html#SoupBuffer-struct">SoupBuffer</a> -</dt> -<dt id="ientry-idm4028">SoupCache, <a class="indexterm" href="SoupCache.html#SoupCache-struct">struct SoupCache</a> -</dt> -<dt id="ientry-idm4063">SoupCache:cache-dir, <a class="indexterm" href="SoupCache.html#SoupCache--cache-dir">The “cache-dir” property</a> -</dt> -<dt id="ientry-idm4074">SoupCache:cache-type, <a class="indexterm" href="SoupCache.html#SoupCache--cache-type">The “cache-type” property</a> -</dt> -<dt id="ientry-idm4033">SoupCacheType, <a class="indexterm" href="SoupCache.html#SoupCacheType">enum SoupCacheType</a> -</dt> -<dt id="ientry-idm7362">SoupChunkAllocator, <a class="indexterm" href="SoupMessage.html#SoupChunkAllocator">SoupChunkAllocator ()</a> -</dt> -<dt id="ientry-idm18999">SoupClientContext, <a class="indexterm" href="SoupServer.html#SoupClientContext">SoupServer</a> -</dt> -<dt id="ientry-idm28082">SoupContentDecoder, <a class="indexterm" href="SoupContentDecoder.html#SoupContentDecoder-struct">SoupContentDecoder</a> -</dt> -<dt id="ientry-idm28292">SoupContentSniffer, <a class="indexterm" href="SoupContentSniffer.html#SoupContentSniffer-struct">SoupContentSniffer</a> -</dt> -<dt id="ientry-idm5606">SoupCookie, <a class="indexterm" href="SoupCookie.html#SoupCookie-struct">SoupCookie</a> -</dt> -<dt id="ientry-idm29084">SoupCookieJar, <a class="indexterm" href="SoupCookieJar.html#SoupCookieJar-struct">SoupCookieJar</a> -</dt> -<dt id="ientry-idm29175">SoupCookieJar::changed, <a class="indexterm" href="SoupCookieJar.html#SoupCookieJar-changed">The “changed” signal</a> -</dt> -<dt id="ientry-idm29149">SoupCookieJar:accept-policy, <a class="indexterm" href="SoupCookieJar.html#SoupCookieJar--accept-policy">The “accept-policy” property</a> -</dt> -<dt id="ientry-idm29162">SoupCookieJar:read-only, <a class="indexterm" href="SoupCookieJar.html#SoupCookieJar--read-only">The “read-only” property</a> -</dt> -<dt id="ientry-idm29089">SoupCookieJarAcceptPolicy, <a class="indexterm" href="SoupCookieJar.html#SoupCookieJarAcceptPolicy">enum SoupCookieJarAcceptPolicy</a> -</dt> -<dt id="ientry-idm29536">SoupCookieJarDB, <a class="indexterm" href="SoupCookieJarDB.html#SoupCookieJarDB-struct">SoupCookieJarDB</a> -</dt> -<dt id="ientry-idm29552">SoupCookieJarDB:filename, <a class="indexterm" href="SoupCookieJarDB.html#SoupCookieJarDB--filename">The “filename” property</a> -</dt> -<dt id="ientry-idm29374">SoupCookieJarText, <a class="indexterm" href="SoupCookieJarText.html#SoupCookieJarText-struct">SoupCookieJarText</a> -</dt> -<dt id="ientry-idm29390">SoupCookieJarText:filename, <a class="indexterm" href="SoupCookieJarText.html#SoupCookieJarText--filename">The “filename” property</a> -</dt> -<dt id="ientry-idm14669">SoupDate, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate-struct">SoupDate</a> -</dt> -<dt id="ientry-idm14768">SoupDateFormat, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDateFormat">enum SoupDateFormat</a> -</dt> -<dt id="ientry-idm10869">SoupEncoding, <a class="indexterm" href="SoupMessageHeaders.html#SoupEncoding">enum SoupEncoding</a> -</dt> -<dt id="ientry-idm10918">SoupExpectation, <a class="indexterm" href="SoupMessageHeaders.html#SoupExpectation">enum SoupExpectation</a> -</dt> -<dt id="ientry-idm7746">SoupHTTPVersion, <a class="indexterm" href="SoupMessage.html#SoupHTTPVersion">enum SoupHTTPVersion</a> -</dt> -<dt id="ientry-idm30108">SoupLogger, <a class="indexterm" href="SoupLogger.html#SoupLogger-struct">SoupLogger</a> -</dt> -<dt id="ientry-idm30153">SoupLogger:level, <a class="indexterm" href="SoupLogger.html#SoupLogger--level">The “level” property</a> -</dt> -<dt id="ientry-idm30166">SoupLogger:max-body-size, <a class="indexterm" href="SoupLogger.html#SoupLogger--max-body-size">The “max-body-size” property</a> -</dt> -<dt id="ientry-idm29783">SoupLoggerFilter, <a class="indexterm" href="SoupLogger.html#SoupLoggerFilter">SoupLoggerFilter ()</a> -</dt> -<dt id="ientry-idm30113">SoupLoggerLogLevel, <a class="indexterm" href="SoupLogger.html#SoupLoggerLogLevel">enum SoupLoggerLogLevel</a> -</dt> -<dt id="ientry-idm29969">SoupLoggerPrinter, <a class="indexterm" href="SoupLogger.html#SoupLoggerPrinter">SoupLoggerPrinter ()</a> -</dt> -<dt id="ientry-idm12318">SoupMemoryUse, <a class="indexterm" href="SoupMessageBody.html#SoupMemoryUse">enum SoupMemoryUse</a> -</dt> -<dt id="ientry-idm7612">SoupMessage, <a class="indexterm" href="SoupMessage.html#SoupMessage-struct">SoupMessage</a> -</dt> -<dt id="ientry-idm8289">SoupMessage::content-sniffed, <a class="indexterm" href="SoupMessage.html#SoupMessage-content-sniffed">The “content-sniffed” signal</a> -</dt> -<dt id="ientry-idm8363">SoupMessage::finished, <a class="indexterm" href="SoupMessage.html#SoupMessage-finished">The “finished” signal</a> -</dt> -<dt id="ientry-idm8402">SoupMessage::got-body, <a class="indexterm" href="SoupMessage.html#SoupMessage-got-body">The “got-body” signal</a> -</dt> -<dt id="ientry-idm8442">SoupMessage::got-chunk, <a class="indexterm" href="SoupMessage.html#SoupMessage-got-chunk">The “got-chunk” signal</a> -</dt> -<dt id="ientry-idm8488">SoupMessage::got-headers, <a class="indexterm" href="SoupMessage.html#SoupMessage-got-headers">The “got-headers” signal</a> -</dt> -<dt id="ientry-idm8535">SoupMessage::got-informational, <a class="indexterm" href="SoupMessage.html#SoupMessage-got-informational">The “got-informational” signal</a> -</dt> -<dt id="ientry-idm8573">SoupMessage::network-event, <a class="indexterm" href="SoupMessage.html#SoupMessage-network-event">The “network-event” signal</a> -</dt> -<dt id="ientry-idm8638">SoupMessage::restarted, <a class="indexterm" href="SoupMessage.html#SoupMessage-restarted">The “restarted” signal</a> -</dt> -<dt id="ientry-idm8673">SoupMessage::starting, <a class="indexterm" href="SoupMessage.html#SoupMessage-starting">The “starting” signal</a> -</dt> -<dt id="ientry-idm8710">SoupMessage::wrote-body, <a class="indexterm" href="SoupMessage.html#SoupMessage-wrote-body">The “wrote-body” signal</a> -</dt> -<dt id="ientry-idm8745">SoupMessage::wrote-body-data, <a class="indexterm" href="SoupMessage.html#SoupMessage-wrote-body-data">The “wrote-body-data” signal</a> -</dt> -<dt id="ientry-idm8795">SoupMessage::wrote-chunk, <a class="indexterm" href="SoupMessage.html#SoupMessage-wrote-chunk">The “wrote-chunk” signal</a> -</dt> -<dt id="ientry-idm8839">SoupMessage::wrote-headers, <a class="indexterm" href="SoupMessage.html#SoupMessage-wrote-headers">The “wrote-headers” signal</a> -</dt> -<dt id="ientry-idm8874">SoupMessage::wrote-informational, <a class="indexterm" href="SoupMessage.html#SoupMessage-wrote-informational">The “wrote-informational” signal</a> -</dt> -<dt id="ientry-idm8090">SoupMessage:first-party, <a class="indexterm" href="SoupMessage.html#SoupMessage--first-party">The “first-party” property</a> -</dt> -<dt id="ientry-idm8104">SoupMessage:flags, <a class="indexterm" href="SoupMessage.html#SoupMessage--flags">The “flags” property</a> -</dt> -<dt id="ientry-idm8114">SoupMessage:http-version, <a class="indexterm" href="SoupMessage.html#SoupMessage--http-version">The “http-version” property</a> -</dt> -<dt id="ientry-idm8125">SoupMessage:method, <a class="indexterm" href="SoupMessage.html#SoupMessage--method">The “method” property</a> -</dt> -<dt id="ientry-idm8136">SoupMessage:priority, <a class="indexterm" href="SoupMessage.html#SoupMessage--priority">The “priority” property</a> -</dt> -<dt id="ientry-idm8147">SoupMessage:reason-phrase, <a class="indexterm" href="SoupMessage.html#SoupMessage--reason-phrase">The “reason-phrase” property</a> -</dt> -<dt id="ientry-idm8158">SoupMessage:request-body, <a class="indexterm" href="SoupMessage.html#SoupMessage--request-body">The “request-body” property</a> -</dt> -<dt id="ientry-idm8168">SoupMessage:request-body-data, <a class="indexterm" href="SoupMessage.html#SoupMessage--request-body-data">The “request-body-data” property</a> -</dt> -<dt id="ientry-idm8182">SoupMessage:request-headers, <a class="indexterm" href="SoupMessage.html#SoupMessage--request-headers">The “request-headers” property</a> -</dt> -<dt id="ientry-idm8192">SoupMessage:response-body, <a class="indexterm" href="SoupMessage.html#SoupMessage--response-body">The “response-body” property</a> -</dt> -<dt id="ientry-idm8202">SoupMessage:response-body-data, <a class="indexterm" href="SoupMessage.html#SoupMessage--response-body-data">The “response-body-data” property</a> -</dt> -<dt id="ientry-idm8216">SoupMessage:response-headers, <a class="indexterm" href="SoupMessage.html#SoupMessage--response-headers">The “response-headers” property</a> -</dt> -<dt id="ientry-idm8226">SoupMessage:server-side, <a class="indexterm" href="SoupMessage.html#SoupMessage--server-side">The “server-side” property</a> -</dt> -<dt id="ientry-idm8237">SoupMessage:status-code, <a class="indexterm" href="SoupMessage.html#SoupMessage--status-code">The “status-code” property</a> -</dt> -<dt id="ientry-idm8249">SoupMessage:tls-certificate, <a class="indexterm" href="SoupMessage.html#SoupMessage--tls-certificate">The “tls-certificate” property</a> -</dt> -<dt id="ientry-idm8263">SoupMessage:tls-errors, <a class="indexterm" href="SoupMessage.html#SoupMessage--tls-errors">The “tls-errors” property</a> -</dt> -<dt id="ientry-idm8277">SoupMessage:uri, <a class="indexterm" href="SoupMessage.html#SoupMessage--uri">The “uri” property</a> -</dt> -<dt id="ientry-idm12370">SoupMessageBody, <a class="indexterm" href="SoupMessageBody.html#SoupMessageBody-struct">SoupMessageBody</a> -</dt> -<dt id="ientry-idm7771">SoupMessageFlags, <a class="indexterm" href="SoupMessage.html#SoupMessageFlags">enum SoupMessageFlags</a> -</dt> -<dt id="ientry-idm10816">SoupMessageHeaders, <a class="indexterm" href="SoupMessageHeaders.html">SoupMessageHeaders</a> -</dt> -<dt id="ientry-idm9730">SoupMessageHeadersForeachFunc, <a class="indexterm" href="SoupMessageHeaders.html#SoupMessageHeadersForeachFunc">SoupMessageHeadersForeachFunc ()</a> -</dt> -<dt id="ientry-idm10855">SoupMessageHeadersIter, <a class="indexterm" href="SoupMessageHeaders.html#SoupMessageHeadersIter">SoupMessageHeadersIter</a> -</dt> -<dt id="ientry-idm10822">SoupMessageHeadersType, <a class="indexterm" href="SoupMessageHeaders.html#SoupMessageHeadersType">enum SoupMessageHeadersType</a> -</dt> -<dt id="ientry-idm7866">SoupMessagePriority, <a class="indexterm" href="SoupMessage.html#SoupMessagePriority">enum SoupMessagePriority</a> -</dt> -<dt id="ientry-idm15381">SoupMultipart, <a class="indexterm" href="SoupMultipart.html">SoupMultipart</a> -</dt> -<dt id="ientry-idm15818">SoupMultipartInputStream, <a class="indexterm" href="SoupMultipartInputStream.html#SoupMultipartInputStream-struct">struct SoupMultipartInputStream</a> -</dt> -<dt id="ientry-idm15826">SoupMultipartInputStream:message, <a class="indexterm" href="SoupMultipartInputStream.html#SoupMultipartInputStream--message">The “message” property</a> -</dt> -<dt id="ientry-idm30254">SoupProxyResolverDefault, <a class="indexterm" href="SoupProxyResolverDefault.html#SoupProxyResolverDefault-struct">SoupProxyResolverDefault</a> -</dt> -<dt id="ientry-idm30262">SoupProxyResolverDefault:gproxy-resolver, <a class="indexterm" href="SoupProxyResolverDefault.html#SoupProxyResolverDefault--gproxy-resolver">The “gproxy-resolver” property</a> -</dt> -<dt id="ientry-idm10943">SoupRange, <a class="indexterm" href="SoupMessageHeaders.html#SoupRange">SoupRange</a> -</dt> -<dt id="ientry-idm16334">SoupRequest, <a class="indexterm" href="SoupRequest.html#SoupRequest-struct">SoupRequest</a> -</dt> -<dt id="ientry-idm16365">SoupRequest:session, <a class="indexterm" href="SoupRequest.html#SoupRequest--session">The “session” property</a> -</dt> -<dt id="ientry-idm16379">SoupRequest:uri, <a class="indexterm" href="SoupRequest.html#SoupRequest--uri">The “uri” property</a> -</dt> -<dt id="ientry-idm16648">SoupRequestData, <a class="indexterm" href="SoupRequestData.html#SoupRequestData-struct">SoupRequestData</a> -</dt> -<dt id="ientry-idm22933">SoupRequestError, <a class="indexterm" href="SoupSession.html#SoupRequestError">enum SoupRequestError</a> -</dt> -<dt id="ientry-idm16598">SoupRequestFile, <a class="indexterm" href="SoupRequestFile.html#SoupRequestFile-struct">SoupRequestFile</a> -</dt> -<dt id="ientry-idm16494">SoupRequestHTTP, <a class="indexterm" href="SoupRequestHTTP.html#SoupRequestHTTP-struct">SoupRequestHTTP</a> -</dt> -<dt id="ientry-idm18948">SoupServer, <a class="indexterm" href="SoupServer.html#SoupServer-struct">SoupServer</a> -</dt> -<dt id="ientry-idm19288">SoupServer::request-aborted, <a class="indexterm" href="SoupServer.html#SoupServer-request-aborted">The “request-aborted” signal</a> -</dt> -<dt id="ientry-idm19349">SoupServer::request-finished, <a class="indexterm" href="SoupServer.html#SoupServer-request-finished">The “request-finished” signal</a> -</dt> -<dt id="ientry-idm19400">SoupServer::request-read, <a class="indexterm" href="SoupServer.html#SoupServer-request-read">The “request-read” signal</a> -</dt> -<dt id="ientry-idm19455">SoupServer::request-started, <a class="indexterm" href="SoupServer.html#SoupServer-request-started">The “request-started” signal</a> -</dt> -<dt id="ientry-idm19067">SoupServer:async-context, <a class="indexterm" href="SoupServer.html#SoupServer--async-context">The “async-context” property</a> -</dt> -<dt id="ientry-idm19091">SoupServer:http-aliases, <a class="indexterm" href="SoupServer.html#SoupServer--http-aliases">The “http-aliases” property</a> -</dt> -<dt id="ientry-idm19113">SoupServer:https-aliases, <a class="indexterm" href="SoupServer.html#SoupServer--https-aliases">The “https-aliases” property</a> -</dt> -<dt id="ientry-idm19130">SoupServer:interface, <a class="indexterm" href="SoupServer.html#SoupServer--interface">The “interface” property</a> -</dt> -<dt id="ientry-idm19154">SoupServer:port, <a class="indexterm" href="SoupServer.html#SoupServer--port">The “port” property</a> -</dt> -<dt id="ientry-idm19180">SoupServer:raw-paths, <a class="indexterm" href="SoupServer.html#SoupServer--raw-paths">The “raw-paths” property</a> -</dt> -<dt id="ientry-idm19191">SoupServer:server-header, <a class="indexterm" href="SoupServer.html#SoupServer--server-header">The “server-header” property</a> -</dt> -<dt id="ientry-idm19216">SoupServer:ssl-cert-file, <a class="indexterm" href="SoupServer.html#SoupServer--ssl-cert-file">The “ssl-cert-file” property</a> -</dt> -<dt id="ientry-idm19244">SoupServer:ssl-key-file, <a class="indexterm" href="SoupServer.html#SoupServer--ssl-key-file">The “ssl-key-file” property</a> -</dt> -<dt id="ientry-idm19265">SoupServer:tls-certificate, <a class="indexterm" href="SoupServer.html#SoupServer--tls-certificate">The “tls-certificate” property</a> -</dt> -<dt id="ientry-idm17927">SoupServerCallback, <a class="indexterm" href="SoupServer.html#SoupServerCallback">SoupServerCallback ()</a> -</dt> -<dt id="ientry-idm18953">SoupServerListenOptions, <a class="indexterm" href="SoupServer.html#SoupServerListenOptions">enum SoupServerListenOptions</a> -</dt> -<dt id="ientry-idm18278">SoupServerWebsocketCallback, <a class="indexterm" href="SoupServer.html#SoupServerWebsocketCallback">SoupServerWebsocketCallback ()</a> -</dt> -<dt id="ientry-idm22928">SoupSession, <a class="indexterm" href="SoupSession.html#SoupSession-struct">SoupSession</a> -</dt> -<dt id="ientry-idm23732">SoupSession::authenticate, <a class="indexterm" href="SoupSession.html#SoupSession-authenticate">The “authenticate” signal</a> -</dt> -<dt id="ientry-idm23816">SoupSession::connection-created, <a class="indexterm" href="SoupSession.html#SoupSession-connection-created">The “connection-created” signal</a> -</dt> -<dt id="ientry-idm23863">SoupSession::request-queued, <a class="indexterm" href="SoupSession.html#SoupSession-request-queued">The “request-queued” signal</a> -</dt> -<dt id="ientry-idm23948">SoupSession::request-started, <a class="indexterm" href="SoupSession.html#SoupSession-request-started">The “request-started” signal</a> -</dt> -<dt id="ientry-idm24007">SoupSession::request-unqueued, <a class="indexterm" href="SoupSession.html#SoupSession-request-unqueued">The “request-unqueued” signal</a> -</dt> -<dt id="ientry-idm24056">SoupSession::tunneling, <a class="indexterm" href="SoupSession.html#SoupSession-tunneling">The “tunneling” signal</a> -</dt> -<dt id="ientry-idm23197">SoupSession:accept-language, <a class="indexterm" href="SoupSession.html#SoupSession--accept-language">The “accept-language” property</a> -</dt> -<dt id="ientry-idm23217">SoupSession:accept-language-auto, <a class="indexterm" href="SoupSession.html#SoupSession--accept-language-auto">The “accept-language-auto” property</a> -</dt> -<dt id="ientry-idm23241">SoupSession:add-feature, <a class="indexterm" href="SoupSession.html#SoupSession--add-feature">The “add-feature” property</a> -</dt> -<dt id="ientry-idm23258">SoupSession:add-feature-by-type, <a class="indexterm" href="SoupSession.html#SoupSession--add-feature-by-type">The “add-feature-by-type” property</a> -</dt> -<dt id="ientry-idm23276">SoupSession:async-context, <a class="indexterm" href="SoupSession.html#SoupSession--async-context">The “async-context” property</a> -</dt> -<dt id="ientry-idm23306">SoupSession:http-aliases, <a class="indexterm" href="SoupSession.html#SoupSession--http-aliases">The “http-aliases” property</a> -</dt> -<dt id="ientry-idm23336">SoupSession:https-aliases, <a class="indexterm" href="SoupSession.html#SoupSession--https-aliases">The “https-aliases” property</a> -</dt> -<dt id="ientry-idm23353">SoupSession:idle-timeout, <a class="indexterm" href="SoupSession.html#SoupSession--idle-timeout">The “idle-timeout” property</a> -</dt> -<dt id="ientry-idm23376">SoupSession:local-address, <a class="indexterm" href="SoupSession.html#SoupSession--local-address">The “local-address” property</a> -</dt> -<dt id="ientry-idm23391">SoupSession:max-conns, <a class="indexterm" href="SoupSession.html#SoupSession--max-conns">The “max-conns” property</a> -</dt> -<dt id="ientry-idm23403">SoupSession:max-conns-per-host, <a class="indexterm" href="SoupSession.html#SoupSession--max-conns-per-host">The “max-conns-per-host” property</a> -</dt> -<dt id="ientry-idm23415">SoupSession:proxy-resolver, <a class="indexterm" href="SoupSession.html#SoupSession--proxy-resolver">The “proxy-resolver” property</a> -</dt> -<dt id="ientry-idm23441">SoupSession:proxy-uri, <a class="indexterm" href="SoupSession.html#SoupSession--proxy-uri">The “proxy-uri” property</a> -</dt> -<dt id="ientry-idm23467">SoupSession:remove-feature-by-type, <a class="indexterm" href="SoupSession.html#SoupSession--remove-feature-by-type">The “remove-feature-by-type” property</a> -</dt> -<dt id="ientry-idm23485">SoupSession:ssl-ca-file, <a class="indexterm" href="SoupSession.html#SoupSession--ssl-ca-file">The “ssl-ca-file” property</a> -</dt> -<dt id="ientry-idm23507">SoupSession:ssl-strict, <a class="indexterm" href="SoupSession.html#SoupSession--ssl-strict">The “ssl-strict” property</a> -</dt> -<dt id="ientry-idm23548">SoupSession:ssl-use-system-ca-file, <a class="indexterm" href="SoupSession.html#SoupSession--ssl-use-system-ca-file">The “ssl-use-system-ca-file” property</a> -</dt> -<dt id="ientry-idm23590">SoupSession:timeout, <a class="indexterm" href="SoupSession.html#SoupSession--timeout">The “timeout” property</a> -</dt> -<dt id="ientry-idm23614">SoupSession:tls-database, <a class="indexterm" href="SoupSession.html#SoupSession--tls-database">The “tls-database” property</a> -</dt> -<dt id="ientry-idm23651">SoupSession:tls-interaction, <a class="indexterm" href="SoupSession.html#SoupSession--tls-interaction">The “tls-interaction” property</a> -</dt> -<dt id="ientry-idm23667">SoupSession:use-ntlm, <a class="indexterm" href="SoupSession.html#SoupSession--use-ntlm">The “use-ntlm” property</a> -</dt> -<dt id="ientry-idm23686">SoupSession:use-thread-context, <a class="indexterm" href="SoupSession.html#SoupSession--use-thread-context">The “use-thread-context” property</a> -</dt> -<dt id="ientry-idm23707">SoupSession:user-agent, <a class="indexterm" href="SoupSession.html#SoupSession--user-agent">The “user-agent” property</a> -</dt> -<dt id="ientry-idm24143">SoupSessionAsync, <a class="indexterm" href="SoupSessionAsync.html#SoupSessionAsync-struct">SoupSessionAsync</a> -</dt> -<dt id="ientry-idm21103">SoupSessionCallback, <a class="indexterm" href="SoupSession.html#SoupSessionCallback">SoupSessionCallback ()</a> -</dt> -<dt id="ientry-idm22702">SoupSessionConnectProgressCallback, <a class="indexterm" href="SoupSession.html#SoupSessionConnectProgressCallback">SoupSessionConnectProgressCallback ()</a> -</dt> -<dt id="ientry-idm27622">SoupSessionFeature, <a class="indexterm" href="SoupSessionFeature.html#SoupSessionFeature-struct">SoupSessionFeature</a> -</dt> -<dt id="ientry-idm27632">SoupSessionFeatureInterface, <a class="indexterm" href="SoupSessionFeature.html#SoupSessionFeatureInterface">SoupSessionFeatureInterface</a> -</dt> -<dt id="ientry-idm24189">SoupSessionSync, <a class="indexterm" href="SoupSessionSync.html#SoupSessionSync-struct">SoupSessionSync</a> -</dt> -<dt id="ientry-idm36219">SoupSocket, <a class="indexterm" href="SoupSocket.html#SoupSocket-struct">SoupSocket</a> -</dt> -<dt id="ientry-idm36607">SoupSocket::disconnected, <a class="indexterm" href="SoupSocket.html#SoupSocket-disconnected">The “disconnected” signal</a> -</dt> -<dt id="ientry-idm36642">SoupSocket::event, <a class="indexterm" href="SoupSocket.html#SoupSocket-event">The “event” signal</a> -</dt> -<dt id="ientry-idm36697">SoupSocket::new-connection, <a class="indexterm" href="SoupSocket.html#SoupSocket-new-connection">The “new-connection” signal</a> -</dt> -<dt id="ientry-idm36744">SoupSocket::readable, <a class="indexterm" href="SoupSocket.html#SoupSocket-readable">The “readable” signal</a> -</dt> -<dt id="ientry-idm36785">SoupSocket::writable, <a class="indexterm" href="SoupSocket.html#SoupSocket-writable">The “writable” signal</a> -</dt> -<dt id="ientry-idm36380">SoupSocket:async-context, <a class="indexterm" href="SoupSocket.html#SoupSocket--async-context">The “async-context” property</a> -</dt> -<dt id="ientry-idm36390">SoupSocket:fd, <a class="indexterm" href="SoupSocket.html#SoupSocket--fd">The “fd” property</a> -</dt> -<dt id="ientry-idm36402">SoupSocket:gsocket, <a class="indexterm" href="SoupSocket.html#SoupSocket--gsocket">The “gsocket” property</a> -</dt> -<dt id="ientry-idm36412">SoupSocket:iostream, <a class="indexterm" href="SoupSocket.html#SoupSocket--iostream">The “iostream” property</a> -</dt> -<dt id="ientry-idm36422">SoupSocket:ipv6-only, <a class="indexterm" href="SoupSocket.html#SoupSocket--ipv6-only">The “ipv6-only” property</a> -</dt> -<dt id="ientry-idm36433">SoupSocket:is-server, <a class="indexterm" href="SoupSocket.html#SoupSocket--is-server">The “is-server” property</a> -</dt> -<dt id="ientry-idm36451">SoupSocket:local-address, <a class="indexterm" href="SoupSocket.html#SoupSocket--local-address">The “local-address” property</a> -</dt> -<dt id="ientry-idm36461">SoupSocket:non-blocking, <a class="indexterm" href="SoupSocket.html#SoupSocket--non-blocking">The “non-blocking” property</a> -</dt> -<dt id="ientry-idm36496">SoupSocket:remote-address, <a class="indexterm" href="SoupSocket.html#SoupSocket--remote-address">The “remote-address” property</a> -</dt> -<dt id="ientry-idm36506">SoupSocket:socket-properties, <a class="indexterm" href="SoupSocket.html#SoupSocket--socket-properties">The “socket-properties” property</a> -</dt> -<dt id="ientry-idm36516">SoupSocket:ssl-creds, <a class="indexterm" href="SoupSocket.html#SoupSocket--ssl-creds">The “ssl-creds” property</a> -</dt> -<dt id="ientry-idm36526">SoupSocket:ssl-fallback, <a class="indexterm" href="SoupSocket.html#SoupSocket--ssl-fallback">The “ssl-fallback” property</a> -</dt> -<dt id="ientry-idm36537">SoupSocket:ssl-strict, <a class="indexterm" href="SoupSocket.html#SoupSocket--ssl-strict">The “ssl-strict” property</a> -</dt> -<dt id="ientry-idm36548">SoupSocket:timeout, <a class="indexterm" href="SoupSocket.html#SoupSocket--timeout">The “timeout” property</a> -</dt> -<dt id="ientry-idm36559">SoupSocket:tls-certificate, <a class="indexterm" href="SoupSocket.html#SoupSocket--tls-certificate">The “tls-certificate” property</a> -</dt> -<dt id="ientry-idm36569">SoupSocket:tls-errors, <a class="indexterm" href="SoupSocket.html#SoupSocket--tls-errors">The “tls-errors” property</a> -</dt> -<dt id="ientry-idm36579">SoupSocket:trusted-certificate, <a class="indexterm" href="SoupSocket.html#SoupSocket--trusted-certificate">The “trusted-certificate” property</a> -</dt> -<dt id="ientry-idm36590">SoupSocket:use-thread-context, <a class="indexterm" href="SoupSocket.html#SoupSocket--use-thread-context">The “use-thread-context” property</a> -</dt> -<dt id="ientry-idm35356">SoupSocketCallback, <a class="indexterm" href="SoupSocket.html#SoupSocketCallback">SoupSocketCallback ()</a> -</dt> -<dt id="ientry-idm36224">SoupSocketIOStatus, <a class="indexterm" href="SoupSocket.html#SoupSocketIOStatus">enum SoupSocketIOStatus</a> -</dt> -<dt id="ientry-idm24524">SoupStatus, <a class="indexterm" href="libsoup-2.4-soup-status.html#SoupStatus">enum SoupStatus</a> -</dt> -<dt id="ientry-idm25089">SoupTLDError, <a class="indexterm" href="libsoup-2.4-Top-Level-Domain-utils.html#SoupTLDError">enum SoupTLDError</a> -</dt> -<dt id="ientry-idm26758">SoupURI, <a class="indexterm" href="SoupURI.html#SoupURI-struct">SoupURI</a> -</dt> -<dt id="ientry-idm33208">SoupWebsocketCloseCode, <a class="indexterm" href="libsoup-2.4-WebSockets.html#SoupWebsocketCloseCode">enum SoupWebsocketCloseCode</a> -</dt> -<dt id="ientry-idm33103">SoupWebsocketConnection, <a class="indexterm" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection-struct">SoupWebsocketConnection</a> -</dt> -<dt id="ientry-idm33461">SoupWebsocketConnection::closed, <a class="indexterm" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection-closed">The “closed” signal</a> -</dt> -<dt id="ientry-idm33501">SoupWebsocketConnection::closing, <a class="indexterm" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection-closing">The “closing” signal</a> -</dt> -<dt id="ientry-idm33538">SoupWebsocketConnection::error, <a class="indexterm" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection-error">The “error” signal</a> -</dt> -<dt id="ientry-idm33585">SoupWebsocketConnection::message, <a class="indexterm" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection-message">The “message” signal</a> -</dt> -<dt id="ientry-idm33640">SoupWebsocketConnection::pong, <a class="indexterm" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection-pong">The “pong” signal</a> -</dt> -<dt id="ientry-idm33353">SoupWebsocketConnection:connection-type, <a class="indexterm" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection--connection-type">The “connection-type” property</a> -</dt> -<dt id="ientry-idm33366">SoupWebsocketConnection:io-stream, <a class="indexterm" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection--io-stream">The “io-stream” property</a> -</dt> -<dt id="ientry-idm33379">SoupWebsocketConnection:keepalive-interval, <a class="indexterm" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection--keepalive-interval">The “keepalive-interval” property</a> -</dt> -<dt id="ientry-idm33392">SoupWebsocketConnection:max-incoming-payload-size, <a class="indexterm" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection--max-incoming-payload-size">The “max-incoming-payload-size” property</a> -</dt> -<dt id="ientry-idm33405">SoupWebsocketConnection:origin, <a class="indexterm" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection--origin">The “origin” property</a> -</dt> -<dt id="ientry-idm33418">SoupWebsocketConnection:protocol, <a class="indexterm" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection--protocol">The “protocol” property</a> -</dt> -<dt id="ientry-idm33433">SoupWebsocketConnection:state, <a class="indexterm" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection--state">The “state” property</a> -</dt> -<dt id="ientry-idm33446">SoupWebsocketConnection:uri, <a class="indexterm" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection--uri">The “uri” property</a> -</dt> -<dt id="ientry-idm33111">SoupWebsocketConnectionType, <a class="indexterm" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnectionType">enum SoupWebsocketConnectionType</a> -</dt> -<dt id="ientry-idm33179">SoupWebsocketDataType, <a class="indexterm" href="libsoup-2.4-WebSockets.html#SoupWebsocketDataType">enum SoupWebsocketDataType</a> -</dt> -<dt id="ientry-idm33299">SoupWebsocketError, <a class="indexterm" href="libsoup-2.4-WebSockets.html#SoupWebsocketError">enum SoupWebsocketError</a> -</dt> -<dt id="ientry-idm33146">SoupWebsocketState, <a class="indexterm" href="libsoup-2.4-WebSockets.html#SoupWebsocketState">enum SoupWebsocketState</a> -</dt> -<dt id="ientry-idm31914">SoupXMLRPCError, <a class="indexterm" href="libsoup-2.4-XMLRPC-Support.html#SoupXMLRPCError">enum SoupXMLRPCError</a> -</dt> -<dt id="ientry-idm31946">SoupXMLRPCFault, <a class="indexterm" href="libsoup-2.4-XMLRPC-Support.html#SoupXMLRPCFault">enum SoupXMLRPCFault</a> -</dt> -<dt id="ientry-idm32020">SoupXMLRPCParams, <a class="indexterm" href="libsoup-2.4-XMLRPC-Support.html#SoupXMLRPCParams">SoupXMLRPCParams</a> -</dt> -<dt id="ientry-idm34791">SOUP_ADDRESS_ANY_PORT, <a class="indexterm" href="SoupAddress.html#SOUP-ADDRESS-ANY-PORT:CAPS">SOUP_ADDRESS_ANY_PORT</a> -</dt> -<dt id="ientry-idm34653">soup_address_equal_by_ip, <a class="indexterm" href="SoupAddress.html#soup-address-equal-by-ip">soup_address_equal_by_ip ()</a> -</dt> -<dt id="ientry-idm34549">soup_address_equal_by_name, <a class="indexterm" href="SoupAddress.html#soup-address-equal-by-name">soup_address_equal_by_name ()</a> -</dt> -<dt id="ientry-idm34799">SOUP_ADDRESS_FAMILY, <a class="indexterm" href="SoupAddress.html#SOUP-ADDRESS-FAMILY:CAPS">SOUP_ADDRESS_FAMILY</a> -</dt> -<dt id="ientry-idm34436">soup_address_get_gsockaddr, <a class="indexterm" href="SoupAddress.html#soup-address-get-gsockaddr">soup_address_get_gsockaddr ()</a> -</dt> -<dt id="ientry-idm34343">soup_address_get_name, <a class="indexterm" href="SoupAddress.html#soup-address-get-name">soup_address_get_name ()</a> -</dt> -<dt id="ientry-idm34476">soup_address_get_physical, <a class="indexterm" href="SoupAddress.html#soup-address-get-physical">soup_address_get_physical ()</a> -</dt> -<dt id="ientry-idm34518">soup_address_get_port, <a class="indexterm" href="SoupAddress.html#soup-address-get-port">soup_address_get_port ()</a> -</dt> -<dt id="ientry-idm34383">soup_address_get_sockaddr, <a class="indexterm" href="SoupAddress.html#soup-address-get-sockaddr">soup_address_get_sockaddr ()</a> -</dt> -<dt id="ientry-idm34712">soup_address_hash_by_ip, <a class="indexterm" href="SoupAddress.html#soup-address-hash-by-ip">soup_address_hash_by_ip ()</a> -</dt> -<dt id="ientry-idm34614">soup_address_hash_by_name, <a class="indexterm" href="SoupAddress.html#soup-address-hash-by-name">soup_address_hash_by_name ()</a> -</dt> -<dt id="ientry-idm34306">soup_address_is_resolved, <a class="indexterm" href="SoupAddress.html#soup-address-is-resolved">soup_address_is_resolved ()</a> -</dt> -<dt id="ientry-idm34809">SOUP_ADDRESS_NAME, <a class="indexterm" href="SoupAddress.html#SOUP-ADDRESS-NAME:CAPS">SOUP_ADDRESS_NAME</a> -</dt> -<dt id="ientry-idm33941">soup_address_new, <a class="indexterm" href="SoupAddress.html#soup-address-new">soup_address_new ()</a> -</dt> -<dt id="ientry-idm34038">soup_address_new_any, <a class="indexterm" href="SoupAddress.html#soup-address-new-any">soup_address_new_any ()</a> -</dt> -<dt id="ientry-idm33990">soup_address_new_from_sockaddr, <a class="indexterm" href="SoupAddress.html#soup-address-new-from-sockaddr">soup_address_new_from_sockaddr ()</a> -</dt> -<dt id="ientry-idm34817">SOUP_ADDRESS_PHYSICAL, <a class="indexterm" href="SoupAddress.html#SOUP-ADDRESS-PHYSICAL:CAPS">SOUP_ADDRESS_PHYSICAL</a> -</dt> -<dt id="ientry-idm34825">SOUP_ADDRESS_PORT, <a class="indexterm" href="SoupAddress.html#SOUP-ADDRESS-PORT:CAPS">SOUP_ADDRESS_PORT</a> -</dt> -<dt id="ientry-idm34841">SOUP_ADDRESS_PROTOCOL, <a class="indexterm" href="SoupAddress.html#SOUP-ADDRESS-PROTOCOL:CAPS">SOUP_ADDRESS_PROTOCOL</a> -</dt> -<dt id="ientry-idm34147">soup_address_resolve_async, <a class="indexterm" href="SoupAddress.html#soup-address-resolve-async">soup_address_resolve_async ()</a> -</dt> -<dt id="ientry-idm34241">soup_address_resolve_sync, <a class="indexterm" href="SoupAddress.html#soup-address-resolve-sync">soup_address_resolve_sync ()</a> -</dt> -<dt id="ientry-idm34833">SOUP_ADDRESS_SOCKADDR, <a class="indexterm" href="SoupAddress.html#SOUP-ADDRESS-SOCKADDR:CAPS">SOUP_ADDRESS_SOCKADDR</a> -</dt> -<dt id="ientry-idm14371">soup_add_completion, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-add-completion">soup_add_completion ()</a> -</dt> -<dt id="ientry-idm14437">soup_add_idle, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-add-idle">soup_add_idle ()</a> -</dt> -<dt id="ientry-idm14509">soup_add_io_watch, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-add-io-watch">soup_add_io_watch ()</a> -</dt> -<dt id="ientry-idm14594">soup_add_timeout, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-add-timeout">soup_add_timeout ()</a> -</dt> -<dt id="ientry-idm1412">soup_auth_authenticate, <a class="indexterm" href="SoupAuth.html#soup-auth-authenticate">soup_auth_authenticate ()</a> -</dt> -<dt id="ientry-idm1457">soup_auth_can_authenticate, <a class="indexterm" href="SoupAuth.html#soup-auth-can-authenticate">soup_auth_can_authenticate ()</a> -</dt> -<dt id="ientry-idm2666">soup_auth_domain_accepts, <a class="indexterm" href="SoupAuthDomain.html#soup-auth-domain-accepts">soup_auth_domain_accepts ()</a> -</dt> -<dt id="ientry-idm2129">soup_auth_domain_add_path, <a class="indexterm" href="SoupAuthDomain.html#soup-auth-domain-add-path">soup_auth_domain_add_path ()</a> -</dt> -<dt id="ientry-idm2789">SOUP_AUTH_DOMAIN_ADD_PATH, <a class="indexterm" href="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-ADD-PATH:CAPS">SOUP_AUTH_DOMAIN_ADD_PATH</a> -</dt> -<dt id="ientry-idm3230">SOUP_AUTH_DOMAIN_BASIC_AUTH_CALLBACK, <a class="indexterm" href="SoupAuthDomainBasic.html#SOUP-AUTH-DOMAIN-BASIC-AUTH-CALLBACK:CAPS">SOUP_AUTH_DOMAIN_BASIC_AUTH_CALLBACK</a> -</dt> -<dt id="ientry-idm3240">SOUP_AUTH_DOMAIN_BASIC_AUTH_DATA, <a class="indexterm" href="SoupAuthDomainBasic.html#SOUP-AUTH-DOMAIN-BASIC-AUTH-DATA:CAPS">SOUP_AUTH_DOMAIN_BASIC_AUTH_DATA</a> -</dt> -<dt id="ientry-idm3036">soup_auth_domain_basic_new, <a class="indexterm" href="SoupAuthDomainBasic.html#soup-auth-domain-basic-new">soup_auth_domain_basic_new ()</a> -</dt> -<dt id="ientry-idm3160">soup_auth_domain_basic_set_auth_callback, <a class="indexterm" href="SoupAuthDomainBasic.html#soup-auth-domain-basic-set-auth-callback">soup_auth_domain_basic_set_auth_callback ()</a> -</dt> -<dt id="ientry-idm2723">soup_auth_domain_challenge, <a class="indexterm" href="SoupAuthDomain.html#soup-auth-domain-challenge">soup_auth_domain_challenge ()</a> -</dt> -<dt id="ientry-idm2549">soup_auth_domain_check_password, <a class="indexterm" href="SoupAuthDomain.html#soup-auth-domain-check-password">soup_auth_domain_check_password ()</a> -</dt> -<dt id="ientry-idm2614">soup_auth_domain_covers, <a class="indexterm" href="SoupAuthDomain.html#soup-auth-domain-covers">soup_auth_domain_covers ()</a> -</dt> -<dt id="ientry-idm3613">SOUP_AUTH_DOMAIN_DIGEST_AUTH_CALLBACK, <a class="indexterm" href="SoupAuthDomainDigest.html#SOUP-AUTH-DOMAIN-DIGEST-AUTH-CALLBACK:CAPS">SOUP_AUTH_DOMAIN_DIGEST_AUTH_CALLBACK</a> -</dt> -<dt id="ientry-idm3623">SOUP_AUTH_DOMAIN_DIGEST_AUTH_DATA, <a class="indexterm" href="SoupAuthDomainDigest.html#SOUP-AUTH-DOMAIN-DIGEST-AUTH-DATA:CAPS">SOUP_AUTH_DOMAIN_DIGEST_AUTH_DATA</a> -</dt> -<dt id="ientry-idm3552">soup_auth_domain_digest_encode_password, <a class="indexterm" href="SoupAuthDomainDigest.html#soup-auth-domain-digest-encode-password">soup_auth_domain_digest_encode_password ()</a> -</dt> -<dt id="ientry-idm3375">soup_auth_domain_digest_new, <a class="indexterm" href="SoupAuthDomainDigest.html#soup-auth-domain-digest-new">soup_auth_domain_digest_new ()</a> -</dt> -<dt id="ientry-idm3489">soup_auth_domain_digest_set_auth_callback, <a class="indexterm" href="SoupAuthDomainDigest.html#soup-auth-domain-digest-set-auth-callback">soup_auth_domain_digest_set_auth_callback ()</a> -</dt> -<dt id="ientry-idm2809">SOUP_AUTH_DOMAIN_FILTER, <a class="indexterm" href="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-FILTER:CAPS">SOUP_AUTH_DOMAIN_FILTER</a> -</dt> -<dt id="ientry-idm2819">SOUP_AUTH_DOMAIN_FILTER_DATA, <a class="indexterm" href="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-FILTER-DATA:CAPS">SOUP_AUTH_DOMAIN_FILTER_DATA</a> -</dt> -<dt id="ientry-idm2829">SOUP_AUTH_DOMAIN_GENERIC_AUTH_CALLBACK, <a class="indexterm" href="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-GENERIC-AUTH-CALLBACK:CAPS">SOUP_AUTH_DOMAIN_GENERIC_AUTH_CALLBACK</a> -</dt> -<dt id="ientry-idm2839">SOUP_AUTH_DOMAIN_GENERIC_AUTH_DATA, <a class="indexterm" href="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-GENERIC-AUTH-DATA:CAPS">SOUP_AUTH_DOMAIN_GENERIC_AUTH_DATA</a> -</dt> -<dt id="ientry-idm2372">soup_auth_domain_get_realm, <a class="indexterm" href="SoupAuthDomain.html#soup-auth-domain-get-realm">soup_auth_domain_get_realm ()</a> -</dt> -<dt id="ientry-idm2781">SOUP_AUTH_DOMAIN_PROXY, <a class="indexterm" href="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-PROXY:CAPS">SOUP_AUTH_DOMAIN_PROXY</a> -</dt> -<dt id="ientry-idm2773">SOUP_AUTH_DOMAIN_REALM, <a class="indexterm" href="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-REALM:CAPS">SOUP_AUTH_DOMAIN_REALM</a> -</dt> -<dt id="ientry-idm2177">soup_auth_domain_remove_path, <a class="indexterm" href="SoupAuthDomain.html#soup-auth-domain-remove-path">soup_auth_domain_remove_path ()</a> -</dt> -<dt id="ientry-idm2799">SOUP_AUTH_DOMAIN_REMOVE_PATH, <a class="indexterm" href="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-REMOVE-PATH:CAPS">SOUP_AUTH_DOMAIN_REMOVE_PATH</a> -</dt> -<dt id="ientry-idm2289">soup_auth_domain_set_filter, <a class="indexterm" href="SoupAuthDomain.html#soup-auth-domain-set-filter">soup_auth_domain_set_filter ()</a> -</dt> -<dt id="ientry-idm2485">soup_auth_domain_set_generic_auth_callback, <a class="indexterm" href="SoupAuthDomain.html#soup-auth-domain-set-generic-auth-callback">soup_auth_domain_set_generic_auth_callback ()</a> -</dt> -<dt id="ientry-idm1673">soup_auth_free_protection_space, <a class="indexterm" href="SoupAuth.html#soup-auth-free-protection-space">soup_auth_free_protection_space ()</a> -</dt> -<dt id="ientry-idm1579">soup_auth_get_authorization, <a class="indexterm" href="SoupAuth.html#soup-auth-get-authorization">soup_auth_get_authorization ()</a> -</dt> -<dt id="ientry-idm1317">soup_auth_get_host, <a class="indexterm" href="SoupAuth.html#soup-auth-get-host">soup_auth_get_host ()</a> -</dt> -<dt id="ientry-idm1379">soup_auth_get_info, <a class="indexterm" href="SoupAuth.html#soup-auth-get-info">soup_auth_get_info ()</a> -</dt> -<dt id="ientry-idm1625">soup_auth_get_protection_space, <a class="indexterm" href="SoupAuth.html#soup-auth-get-protection-space">soup_auth_get_protection_space ()</a> -</dt> -<dt id="ientry-idm1348">soup_auth_get_realm, <a class="indexterm" href="SoupAuth.html#soup-auth-get-realm">soup_auth_get_realm ()</a> -</dt> -<dt id="ientry-idm1286">soup_auth_get_scheme_name, <a class="indexterm" href="SoupAuth.html#soup-auth-get-scheme-name">soup_auth_get_scheme_name ()</a> -</dt> -<dt id="ientry-idm1806">SOUP_AUTH_HOST, <a class="indexterm" href="SoupAuth.html#SOUP-AUTH-HOST:CAPS">SOUP_AUTH_HOST</a> -</dt> -<dt id="ientry-idm1495">soup_auth_is_authenticated, <a class="indexterm" href="SoupAuth.html#soup-auth-is-authenticated">soup_auth_is_authenticated ()</a> -</dt> -<dt id="ientry-idm1822">SOUP_AUTH_IS_AUTHENTICATED, <a class="indexterm" href="SoupAuth.html#SOUP-AUTH-IS-AUTHENTICATED:CAPS">SOUP_AUTH_IS_AUTHENTICATED</a> -</dt> -<dt id="ientry-idm1251">soup_auth_is_for_proxy, <a class="indexterm" href="SoupAuth.html#soup-auth-is-for-proxy">soup_auth_is_for_proxy ()</a> -</dt> -<dt id="ientry-idm1814">SOUP_AUTH_IS_FOR_PROXY, <a class="indexterm" href="SoupAuth.html#SOUP-AUTH-IS-FOR-PROXY:CAPS">SOUP_AUTH_IS_FOR_PROXY</a> -</dt> -<dt id="ientry-idm1529">soup_auth_is_ready, <a class="indexterm" href="SoupAuth.html#soup-auth-is-ready">soup_auth_is_ready ()</a> -</dt> -<dt id="ientry-idm27869">soup_auth_manager_clear_cached_credentials, <a class="indexterm" href="SoupAuthManager.html#soup-auth-manager-clear-cached-credentials">soup_auth_manager_clear_cached_credentials ()</a> -</dt> -<dt id="ientry-idm27813">soup_auth_manager_use_auth, <a class="indexterm" href="SoupAuthManager.html#soup-auth-manager-use-auth">soup_auth_manager_use_auth ()</a> -</dt> -<dt id="ientry-idm1233">soup_auth_negotiate_supported, <a class="indexterm" href="SoupAuth.html#soup-auth-negotiate-supported">soup_auth_negotiate_supported ()</a> -</dt> -<dt id="ientry-idm1101">soup_auth_new, <a class="indexterm" href="SoupAuth.html#soup-auth-new">soup_auth_new ()</a> -</dt> -<dt id="ientry-idm1798">SOUP_AUTH_REALM, <a class="indexterm" href="SoupAuth.html#SOUP-AUTH-REALM:CAPS">SOUP_AUTH_REALM</a> -</dt> -<dt id="ientry-idm1790">SOUP_AUTH_SCHEME_NAME, <a class="indexterm" href="SoupAuth.html#SOUP-AUTH-SCHEME-NAME:CAPS">SOUP_AUTH_SCHEME_NAME</a> -</dt> -<dt id="ientry-idm1166">soup_auth_update, <a class="indexterm" href="SoupAuth.html#soup-auth-update">soup_auth_update ()</a> -</dt> -<dt id="ientry-idm11563">soup_buffer_copy, <a class="indexterm" href="SoupMessageBody.html#soup-buffer-copy">soup_buffer_copy ()</a> -</dt> -<dt id="ientry-idm11604">soup_buffer_free, <a class="indexterm" href="SoupMessageBody.html#soup-buffer-free">soup_buffer_free ()</a> -</dt> -<dt id="ientry-idm11635">soup_buffer_get_as_bytes, <a class="indexterm" href="SoupMessageBody.html#soup-buffer-get-as-bytes">soup_buffer_get_as_bytes ()</a> -</dt> -<dt id="ientry-idm11508">soup_buffer_get_data, <a class="indexterm" href="SoupMessageBody.html#soup-buffer-get-data">soup_buffer_get_data ()</a> -</dt> -<dt id="ientry-idm11471">soup_buffer_get_owner, <a class="indexterm" href="SoupMessageBody.html#soup-buffer-get-owner">soup_buffer_get_owner ()</a> -</dt> -<dt id="ientry-idm11216">soup_buffer_new, <a class="indexterm" href="SoupMessageBody.html#soup-buffer-new">soup_buffer_new ()</a> -</dt> -<dt id="ientry-idm11273">soup_buffer_new_subbuffer, <a class="indexterm" href="SoupMessageBody.html#soup-buffer-new-subbuffer">soup_buffer_new_subbuffer ()</a> -</dt> -<dt id="ientry-idm11414">soup_buffer_new_take, <a class="indexterm" href="SoupMessageBody.html#soup-buffer-new-take">soup_buffer_new_take ()</a> -</dt> -<dt id="ientry-idm11331">soup_buffer_new_with_owner, <a class="indexterm" href="SoupMessageBody.html#soup-buffer-new-with-owner">soup_buffer_new_with_owner ()</a> -</dt> -<dt id="ientry-idm3863">soup_cache_clear, <a class="indexterm" href="SoupCache.html#soup-cache-clear">soup_cache_clear ()</a> -</dt> -<dt id="ientry-idm3893">soup_cache_dump, <a class="indexterm" href="SoupCache.html#soup-cache-dump">soup_cache_dump ()</a> -</dt> -<dt id="ientry-idm3827">soup_cache_flush, <a class="indexterm" href="SoupCache.html#soup-cache-flush">soup_cache_flush ()</a> -</dt> -<dt id="ientry-idm3956">soup_cache_get_max_size, <a class="indexterm" href="SoupCache.html#soup-cache-get-max-size">soup_cache_get_max_size ()</a> -</dt> -<dt id="ientry-idm3926">soup_cache_load, <a class="indexterm" href="SoupCache.html#soup-cache-load">soup_cache_load ()</a> -</dt> -<dt id="ientry-idm3776">soup_cache_new, <a class="indexterm" href="SoupCache.html#soup-cache-new">soup_cache_new ()</a> -</dt> -<dt id="ientry-idm3988">soup_cache_set_max_size, <a class="indexterm" href="SoupCache.html#soup-cache-set-max-size">soup_cache_set_max_size ()</a> -</dt> -<dt id="ientry-idm27214">soup_check_version, <a class="indexterm" href="libsoup-2.4-Version-Information.html#soup-check-version">soup_check_version ()</a> -</dt> -<dt id="ientry-idm27264">SOUP_CHECK_VERSION, <a class="indexterm" href="libsoup-2.4-Version-Information.html#SOUP-CHECK-VERSION:CAPS">SOUP_CHECK_VERSION()</a> -</dt> -<dt id="ientry-idm19939">soup_client_context_get_address, <a class="indexterm" href="libsoup-2.4-SoupServer-deprecated-API.html#soup-client-context-get-address">soup_client_context_get_address ()</a> -</dt> -<dt id="ientry-idm18584">soup_client_context_get_auth_domain, <a class="indexterm" href="SoupServer.html#soup-client-context-get-auth-domain">soup_client_context_get_auth_domain ()</a> -</dt> -<dt id="ientry-idm18625">soup_client_context_get_auth_user, <a class="indexterm" href="SoupServer.html#soup-client-context-get-auth-user">soup_client_context_get_auth_user ()</a> -</dt> -<dt id="ientry-idm18661">soup_client_context_get_gsocket, <a class="indexterm" href="SoupServer.html#soup-client-context-get-gsocket">soup_client_context_get_gsocket ()</a> -</dt> -<dt id="ientry-idm18547">soup_client_context_get_host, <a class="indexterm" href="SoupServer.html#soup-client-context-get-host">soup_client_context_get_host ()</a> -</dt> -<dt id="ientry-idm18459">soup_client_context_get_local_address, <a class="indexterm" href="SoupServer.html#soup-client-context-get-local-address">soup_client_context_get_local_address ()</a> -</dt> -<dt id="ientry-idm18503">soup_client_context_get_remote_address, <a class="indexterm" href="SoupServer.html#soup-client-context-get-remote-address">soup_client_context_get_remote_address ()</a> -</dt> -<dt id="ientry-idm19889">soup_client_context_get_socket, <a class="indexterm" href="libsoup-2.4-SoupServer-deprecated-API.html#soup-client-context-get-socket">soup_client_context_get_socket ()</a> -</dt> -<dt id="ientry-idm18708">soup_client_context_steal_connection, <a class="indexterm" href="SoupServer.html#soup-client-context-steal-connection">soup_client_context_steal_connection ()</a> -</dt> -<dt id="ientry-idm28257">soup_content_sniffer_get_buffer_size, <a class="indexterm" href="SoupContentSniffer.html#soup-content-sniffer-get-buffer-size">soup_content_sniffer_get_buffer_size ()</a> -</dt> -<dt id="ientry-idm28166">soup_content_sniffer_new, <a class="indexterm" href="SoupContentSniffer.html#soup-content-sniffer-new">soup_content_sniffer_new ()</a> -</dt> -<dt id="ientry-idm28185">soup_content_sniffer_sniff, <a class="indexterm" href="SoupContentSniffer.html#soup-content-sniffer-sniff">soup_content_sniffer_sniff ()</a> -</dt> -<dt id="ientry-idm5567">soup_cookies_free, <a class="indexterm" href="SoupCookie.html#soup-cookies-free">soup_cookies_free ()</a> -</dt> -<dt id="ientry-idm5333">soup_cookies_from_request, <a class="indexterm" href="SoupCookie.html#soup-cookies-from-request">soup_cookies_from_request ()</a> -</dt> -<dt id="ientry-idm5384">soup_cookies_from_response, <a class="indexterm" href="SoupCookie.html#soup-cookies-from-response">soup_cookies_from_response ()</a> -</dt> -<dt id="ientry-idm5526">soup_cookies_to_cookie_header, <a class="indexterm" href="SoupCookie.html#soup-cookies-to-cookie-header">soup_cookies_to_cookie_header ()</a> -</dt> -<dt id="ientry-idm5432">soup_cookies_to_request, <a class="indexterm" href="SoupCookie.html#soup-cookies-to-request">soup_cookies_to_request ()</a> -</dt> -<dt id="ientry-idm5479">soup_cookies_to_response, <a class="indexterm" href="SoupCookie.html#soup-cookies-to-response">soup_cookies_to_response ()</a> -</dt> -<dt id="ientry-idm5158">soup_cookie_applies_to_uri, <a class="indexterm" href="SoupCookie.html#soup-cookie-applies-to-uri">soup_cookie_applies_to_uri ()</a> -</dt> -<dt id="ientry-idm4504">soup_cookie_copy, <a class="indexterm" href="SoupCookie.html#soup-cookie-copy">soup_cookie_copy ()</a> -</dt> -<dt id="ientry-idm5212">soup_cookie_domain_matches, <a class="indexterm" href="SoupCookie.html#soup-cookie-domain-matches">soup_cookie_domain_matches ()</a> -</dt> -<dt id="ientry-idm4538">soup_cookie_free, <a class="indexterm" href="SoupCookie.html#soup-cookie-free">soup_cookie_free ()</a> -</dt> -<dt id="ientry-idm4756">soup_cookie_get_domain, <a class="indexterm" href="SoupCookie.html#soup-cookie-get-domain">soup_cookie_get_domain ()</a> -</dt> -<dt id="ientry-idm4965">soup_cookie_get_expires, <a class="indexterm" href="SoupCookie.html#soup-cookie-get-expires">soup_cookie_get_expires ()</a> -</dt> -<dt id="ientry-idm5124">soup_cookie_get_http_only, <a class="indexterm" href="SoupCookie.html#soup-cookie-get-http-only">soup_cookie_get_http_only ()</a> -</dt> -<dt id="ientry-idm4608">soup_cookie_get_name, <a class="indexterm" href="SoupCookie.html#soup-cookie-get-name">soup_cookie_get_name ()</a> -</dt> -<dt id="ientry-idm4830">soup_cookie_get_path, <a class="indexterm" href="SoupCookie.html#soup-cookie-get-path">soup_cookie_get_path ()</a> -</dt> -<dt id="ientry-idm5047">soup_cookie_get_secure, <a class="indexterm" href="SoupCookie.html#soup-cookie-get-secure">soup_cookie_get_secure ()</a> -</dt> -<dt id="ientry-idm4682">soup_cookie_get_value, <a class="indexterm" href="SoupCookie.html#soup-cookie-get-value">soup_cookie_get_value ()</a> -</dt> -<dt id="ientry-idm29136">SOUP_COOKIE_JAR_ACCEPT_POLICY, <a class="indexterm" href="SoupCookieJar.html#SOUP-COOKIE-JAR-ACCEPT-POLICY:CAPS">SOUP_COOKIE_JAR_ACCEPT_POLICY</a> -</dt> -<dt id="ientry-idm28776">soup_cookie_jar_add_cookie, <a class="indexterm" href="SoupCookieJar.html#soup-cookie-jar-add-cookie">soup_cookie_jar_add_cookie ()</a> -</dt> -<dt id="ientry-idm28822">soup_cookie_jar_add_cookie_with_first_party, <a class="indexterm" href="SoupCookieJar.html#soup-cookie-jar-add-cookie-with-first-party">soup_cookie_jar_add_cookie_with_first_party ()</a> -</dt> -<dt id="ientry-idm28922">soup_cookie_jar_all_cookies, <a class="indexterm" href="SoupCookieJar.html#soup-cookie-jar-all-cookies">soup_cookie_jar_all_cookies ()</a> -</dt> -<dt id="ientry-idm29541">SOUP_COOKIE_JAR_DB_FILENAME, <a class="indexterm" href="SoupCookieJarDB.html#SOUP-COOKIE-JAR-DB-FILENAME:CAPS">SOUP_COOKIE_JAR_DB_FILENAME</a> -</dt> -<dt id="ientry-idm29477">soup_cookie_jar_db_new, <a class="indexterm" href="SoupCookieJarDB.html#soup-cookie-jar-db-new">soup_cookie_jar_db_new ()</a> -</dt> -<dt id="ientry-idm28880">soup_cookie_jar_delete_cookie, <a class="indexterm" href="SoupCookieJar.html#soup-cookie-jar-delete-cookie">soup_cookie_jar_delete_cookie ()</a> -</dt> -<dt id="ientry-idm28964">soup_cookie_jar_get_accept_policy, <a class="indexterm" href="SoupCookieJar.html#soup-cookie-jar-get-accept-policy">soup_cookie_jar_get_accept_policy ()</a> -</dt> -<dt id="ientry-idm28516">soup_cookie_jar_get_cookies, <a class="indexterm" href="SoupCookieJar.html#soup-cookie-jar-get-cookies">soup_cookie_jar_get_cookies ()</a> -</dt> -<dt id="ientry-idm28584">soup_cookie_jar_get_cookie_list, <a class="indexterm" href="SoupCookieJar.html#soup-cookie-jar-get-cookie-list">soup_cookie_jar_get_cookie_list ()</a> -</dt> -<dt id="ientry-idm29044">soup_cookie_jar_is_persistent, <a class="indexterm" href="SoupCookieJar.html#soup-cookie-jar-is-persistent">soup_cookie_jar_is_persistent ()</a> -</dt> -<dt id="ientry-idm28495">soup_cookie_jar_new, <a class="indexterm" href="SoupCookieJar.html#soup-cookie-jar-new">soup_cookie_jar_new ()</a> -</dt> -<dt id="ientry-idm29128">SOUP_COOKIE_JAR_READ_ONLY, <a class="indexterm" href="SoupCookieJar.html#SOUP-COOKIE-JAR-READ-ONLY:CAPS">SOUP_COOKIE_JAR_READ_ONLY</a> -</dt> -<dt id="ientry-idm29002">soup_cookie_jar_set_accept_policy, <a class="indexterm" href="SoupCookieJar.html#soup-cookie-jar-set-accept-policy">soup_cookie_jar_set_accept_policy ()</a> -</dt> -<dt id="ientry-idm28658">soup_cookie_jar_set_cookie, <a class="indexterm" href="SoupCookieJar.html#soup-cookie-jar-set-cookie">soup_cookie_jar_set_cookie ()</a> -</dt> -<dt id="ientry-idm28715">soup_cookie_jar_set_cookie_with_first_party, <a class="indexterm" href="SoupCookieJar.html#soup-cookie-jar-set-cookie-with-first-party">soup_cookie_jar_set_cookie_with_first_party ()</a> -</dt> -<dt id="ientry-idm29379">SOUP_COOKIE_JAR_TEXT_FILENAME, <a class="indexterm" href="SoupCookieJarText.html#SOUP-COOKIE-JAR-TEXT-FILENAME:CAPS">SOUP_COOKIE_JAR_TEXT_FILENAME</a> -</dt> -<dt id="ientry-idm29317">soup_cookie_jar_text_new, <a class="indexterm" href="SoupCookieJarText.html#soup-cookie-jar-text-new">soup_cookie_jar_text_new ()</a> -</dt> -<dt id="ientry-idm5723">SOUP_COOKIE_MAX_AGE_ONE_DAY, <a class="indexterm" href="SoupCookie.html#SOUP-COOKIE-MAX-AGE-ONE-DAY:CAPS">SOUP_COOKIE_MAX_AGE_ONE_DAY</a> -</dt> -<dt id="ientry-idm5711">SOUP_COOKIE_MAX_AGE_ONE_HOUR, <a class="indexterm" href="SoupCookie.html#SOUP-COOKIE-MAX-AGE-ONE-HOUR:CAPS">SOUP_COOKIE_MAX_AGE_ONE_HOUR</a> -</dt> -<dt id="ientry-idm5735">SOUP_COOKIE_MAX_AGE_ONE_WEEK, <a class="indexterm" href="SoupCookie.html#SOUP-COOKIE-MAX-AGE-ONE-WEEK:CAPS">SOUP_COOKIE_MAX_AGE_ONE_WEEK</a> -</dt> -<dt id="ientry-idm5747">SOUP_COOKIE_MAX_AGE_ONE_YEAR, <a class="indexterm" href="SoupCookie.html#SOUP-COOKIE-MAX-AGE-ONE-YEAR:CAPS">SOUP_COOKIE_MAX_AGE_ONE_YEAR</a> -</dt> -<dt id="ientry-idm4350">soup_cookie_new, <a class="indexterm" href="SoupCookie.html#soup-cookie-new">soup_cookie_new ()</a> -</dt> -<dt id="ientry-idm4441">soup_cookie_parse, <a class="indexterm" href="SoupCookie.html#soup-cookie-parse">soup_cookie_parse ()</a> -</dt> -<dt id="ientry-idm4716">soup_cookie_set_domain, <a class="indexterm" href="SoupCookie.html#soup-cookie-set-domain">soup_cookie_set_domain ()</a> -</dt> -<dt id="ientry-idm4916">soup_cookie_set_expires, <a class="indexterm" href="SoupCookie.html#soup-cookie-set-expires">soup_cookie_set_expires ()</a> -</dt> -<dt id="ientry-idm5081">soup_cookie_set_http_only, <a class="indexterm" href="SoupCookie.html#soup-cookie-set-http-only">soup_cookie_set_http_only ()</a> -</dt> -<dt id="ientry-idm4864">soup_cookie_set_max_age, <a class="indexterm" href="SoupCookie.html#soup-cookie-set-max-age">soup_cookie_set_max_age ()</a> -</dt> -<dt id="ientry-idm4568">soup_cookie_set_name, <a class="indexterm" href="SoupCookie.html#soup-cookie-set-name">soup_cookie_set_name ()</a> -</dt> -<dt id="ientry-idm4790">soup_cookie_set_path, <a class="indexterm" href="SoupCookie.html#soup-cookie-set-path">soup_cookie_set_path ()</a> -</dt> -<dt id="ientry-idm5004">soup_cookie_set_secure, <a class="indexterm" href="SoupCookie.html#soup-cookie-set-secure">soup_cookie_set_secure ()</a> -</dt> -<dt id="ientry-idm4642">soup_cookie_set_value, <a class="indexterm" href="SoupCookie.html#soup-cookie-set-value">soup_cookie_set_value ()</a> -</dt> -<dt id="ientry-idm5263">soup_cookie_to_cookie_header, <a class="indexterm" href="SoupCookie.html#soup-cookie-to-cookie-header">soup_cookie_to_cookie_header ()</a> -</dt> -<dt id="ientry-idm5298">soup_cookie_to_set_cookie_header, <a class="indexterm" href="SoupCookie.html#soup-cookie-to-set-cookie-header">soup_cookie_to_set_cookie_header ()</a> -</dt> -<dt id="ientry-idm13533">soup_date_free, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-free">soup_date_free ()</a> -</dt> -<dt id="ientry-idm13253">soup_date_get_day, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-day">soup_date_get_day ()</a> -</dt> -<dt id="ientry-idm13287">soup_date_get_hour, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-hour">soup_date_get_hour ()</a> -</dt> -<dt id="ientry-idm13321">soup_date_get_minute, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-minute">soup_date_get_minute ()</a> -</dt> -<dt id="ientry-idm13355">soup_date_get_month, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-month">soup_date_get_month ()</a> -</dt> -<dt id="ientry-idm13389">soup_date_get_offset, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-offset">soup_date_get_offset ()</a> -</dt> -<dt id="ientry-idm13429">soup_date_get_second, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-second">soup_date_get_second ()</a> -</dt> -<dt id="ientry-idm13463">soup_date_get_utc, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-utc">soup_date_get_utc ()</a> -</dt> -<dt id="ientry-idm13499">soup_date_get_year, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-year">soup_date_get_year ()</a> -</dt> -<dt id="ientry-idm13217">soup_date_is_past, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-is-past">soup_date_is_past ()</a> -</dt> -<dt id="ientry-idm12907">soup_date_new, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-new">soup_date_new ()</a> -</dt> -<dt id="ientry-idm13056">soup_date_new_from_now, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-new-from-now">soup_date_new_from_now ()</a> -</dt> -<dt id="ientry-idm12985">soup_date_new_from_string, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-new-from-string">soup_date_new_from_string ()</a> -</dt> -<dt id="ientry-idm13022">soup_date_new_from_time_t, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-new-from-time-t">soup_date_new_from_time_t ()</a> -</dt> -<dt id="ientry-idm13093">soup_date_to_string, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-to-string">soup_date_to_string ()</a> -</dt> -<dt id="ientry-idm13172">soup_date_to_timeval, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-to-timeval">soup_date_to_timeval ()</a> -</dt> -<dt id="ientry-idm13135">soup_date_to_time_t, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-to-time-t">soup_date_to_time_t ()</a> -</dt> -<dt id="ientry-idm30382">soup_form_decode, <a class="indexterm" href="libsoup-2.4-HTML-Form-Support.html#soup-form-decode">soup_form_decode ()</a> -</dt> -<dt id="ientry-idm30418">soup_form_decode_multipart, <a class="indexterm" href="libsoup-2.4-HTML-Form-Support.html#soup-form-decode-multipart">soup_form_decode_multipart ()</a> -</dt> -<dt id="ientry-idm30546">soup_form_encode, <a class="indexterm" href="libsoup-2.4-HTML-Form-Support.html#soup-form-encode">soup_form_encode ()</a> -</dt> -<dt id="ientry-idm30589">soup_form_encode_datalist, <a class="indexterm" href="libsoup-2.4-HTML-Form-Support.html#soup-form-encode-datalist">soup_form_encode_datalist ()</a> -</dt> -<dt id="ientry-idm30620">soup_form_encode_hash, <a class="indexterm" href="libsoup-2.4-HTML-Form-Support.html#soup-form-encode-hash">soup_form_encode_hash ()</a> -</dt> -<dt id="ientry-idm30654">soup_form_encode_valist, <a class="indexterm" href="libsoup-2.4-HTML-Form-Support.html#soup-form-encode-valist">soup_form_encode_valist ()</a> -</dt> -<dt id="ientry-idm30957">SOUP_FORM_MIME_TYPE_MULTIPART, <a class="indexterm" href="libsoup-2.4-HTML-Form-Support.html#SOUP-FORM-MIME-TYPE-MULTIPART:CAPS">SOUP_FORM_MIME_TYPE_MULTIPART</a> -</dt> -<dt id="ientry-idm30966">SOUP_FORM_MIME_TYPE_URLENCODED, <a class="indexterm" href="libsoup-2.4-HTML-Form-Support.html#SOUP-FORM-MIME-TYPE-URLENCODED:CAPS">SOUP_FORM_MIME_TYPE_URLENCODED</a> -</dt> -<dt id="ientry-idm30699">soup_form_request_new, <a class="indexterm" href="libsoup-2.4-HTML-Form-Support.html#soup-form-request-new">soup_form_request_new ()</a> -</dt> -<dt id="ientry-idm30769">soup_form_request_new_from_datalist, <a class="indexterm" href="libsoup-2.4-HTML-Form-Support.html#soup-form-request-new-from-datalist">soup_form_request_new_from_datalist ()</a> -</dt> -<dt id="ientry-idm30828">soup_form_request_new_from_hash, <a class="indexterm" href="libsoup-2.4-HTML-Form-Support.html#soup-form-request-new-from-hash">soup_form_request_new_from_hash ()</a> -</dt> -<dt id="ientry-idm30889">soup_form_request_new_from_multipart, <a class="indexterm" href="libsoup-2.4-HTML-Form-Support.html#soup-form-request-new-from-multipart">soup_form_request_new_from_multipart ()</a> -</dt> -<dt id="ientry-idm27160">soup_get_major_version, <a class="indexterm" href="libsoup-2.4-Version-Information.html#soup-get-major-version">soup_get_major_version ()</a> -</dt> -<dt id="ientry-idm27196">soup_get_micro_version, <a class="indexterm" href="libsoup-2.4-Version-Information.html#soup-get-micro-version">soup_get_micro_version ()</a> -</dt> -<dt id="ientry-idm27178">soup_get_minor_version, <a class="indexterm" href="libsoup-2.4-Version-Information.html#soup-get-minor-version">soup_get_minor_version ()</a> -</dt> -<dt id="ientry-idm13839">soup_headers_parse, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-headers-parse">soup_headers_parse ()</a> -</dt> -<dt id="ientry-idm13563">soup_headers_parse_request, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-headers-parse-request">soup_headers_parse_request ()</a> -</dt> -<dt id="ientry-idm13663">soup_headers_parse_response, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-headers-parse-response">soup_headers_parse_response ()</a> -</dt> -<dt id="ientry-idm13761">soup_headers_parse_status_line, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-headers-parse-status-line">soup_headers_parse_status_line ()</a> -</dt> -<dt id="ientry-idm14021">soup_header_contains, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-contains">soup_header_contains ()</a> -</dt> -<dt id="ientry-idm13986">soup_header_free_list, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-free-list">soup_header_free_list ()</a> -</dt> -<dt id="ientry-idm14148">soup_header_free_param_list, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-free-param-list">soup_header_free_param_list ()</a> -</dt> -<dt id="ientry-idm14182">soup_header_g_string_append_param, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-g-string-append-param">soup_header_g_string_append_param ()</a> -</dt> -<dt id="ientry-idm14245">soup_header_g_string_append_param_quoted, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-g-string-append-param-quoted">soup_header_g_string_append_param_quoted ()</a> -</dt> -<dt id="ientry-idm13898">soup_header_parse_list, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-parse-list">soup_header_parse_list ()</a> -</dt> -<dt id="ientry-idm14064">soup_header_parse_param_list, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-parse-param-list">soup_header_parse_param_list ()</a> -</dt> -<dt id="ientry-idm13934">soup_header_parse_quality_list, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-parse-quality-list">soup_header_parse_quality_list ()</a> -</dt> -<dt id="ientry-idm14105">soup_header_parse_semi_param_list, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-parse-semi-param-list">soup_header_parse_semi_param_list ()</a> -</dt> -<dt id="ientry-idm24922">SOUP_HTTP_ERROR, <a class="indexterm" href="libsoup-2.4-soup-status.html#SOUP-HTTP-ERROR:CAPS">SOUP_HTTP_ERROR</a> -</dt> -<dt id="ientry-idm29733">soup_logger_new, <a class="indexterm" href="SoupLogger.html#soup-logger-new">soup_logger_new ()</a> -</dt> -<dt id="ientry-idm30048">soup_logger_set_printer, <a class="indexterm" href="SoupLogger.html#soup-logger-set-printer">soup_logger_set_printer ()</a> -</dt> -<dt id="ientry-idm29845">soup_logger_set_request_filter, <a class="indexterm" href="SoupLogger.html#soup-logger-set-request-filter">soup_logger_set_request_filter ()</a> -</dt> -<dt id="ientry-idm29907">soup_logger_set_response_filter, <a class="indexterm" href="SoupLogger.html#soup-logger-set-response-filter">soup_logger_set_response_filter ()</a> -</dt> -<dt id="ientry-idm27305">SOUP_MAJOR_VERSION, <a class="indexterm" href="libsoup-2.4-Version-Information.html#SOUP-MAJOR-VERSION:CAPS">SOUP_MAJOR_VERSION</a> -</dt> -<dt id="ientry-idm7121">soup_message_add_header_handler, <a class="indexterm" href="SoupMessage.html#soup-message-add-header-handler">soup_message_add_header_handler ()</a> -</dt> -<dt id="ientry-idm7206">soup_message_add_status_code_handler, <a class="indexterm" href="SoupMessage.html#soup-message-add-status-code-handler">soup_message_add_status_code_handler ()</a> -</dt> -<dt id="ientry-idm11847">soup_message_body_append, <a class="indexterm" href="SoupMessageBody.html#soup-message-body-append">soup_message_body_append ()</a> -</dt> -<dt id="ientry-idm11910">soup_message_body_append_buffer, <a class="indexterm" href="SoupMessageBody.html#soup-message-body-append-buffer">soup_message_body_append_buffer ()</a> -</dt> -<dt id="ientry-idm11955">soup_message_body_append_take, <a class="indexterm" href="SoupMessageBody.html#soup-message-body-append-take">soup_message_body_append_take ()</a> -</dt> -<dt id="ientry-idm12045">soup_message_body_complete, <a class="indexterm" href="SoupMessageBody.html#soup-message-body-complete">soup_message_body_complete ()</a> -</dt> -<dt id="ientry-idm12073">soup_message_body_flatten, <a class="indexterm" href="SoupMessageBody.html#soup-message-body-flatten">soup_message_body_flatten ()</a> -</dt> -<dt id="ientry-idm11701">soup_message_body_free, <a class="indexterm" href="SoupMessageBody.html#soup-message-body-free">soup_message_body_free ()</a> -</dt> -<dt id="ientry-idm11811">soup_message_body_get_accumulate, <a class="indexterm" href="SoupMessageBody.html#soup-message-body-get-accumulate">soup_message_body_get_accumulate ()</a> -</dt> -<dt id="ientry-idm12109">soup_message_body_get_chunk, <a class="indexterm" href="SoupMessageBody.html#soup-message-body-get-chunk">soup_message_body_get_chunk ()</a> -</dt> -<dt id="ientry-idm12174">soup_message_body_got_chunk, <a class="indexterm" href="SoupMessageBody.html#soup-message-body-got-chunk">soup_message_body_got_chunk ()</a> -</dt> -<dt id="ientry-idm11682">soup_message_body_new, <a class="indexterm" href="SoupMessageBody.html#soup-message-body-new">soup_message_body_new ()</a> -</dt> -<dt id="ientry-idm11731">soup_message_body_set_accumulate, <a class="indexterm" href="SoupMessageBody.html#soup-message-body-set-accumulate">soup_message_body_set_accumulate ()</a> -</dt> -<dt id="ientry-idm12017">soup_message_body_truncate, <a class="indexterm" href="SoupMessageBody.html#soup-message-body-truncate">soup_message_body_truncate ()</a> -</dt> -<dt id="ientry-idm12224">soup_message_body_wrote_chunk, <a class="indexterm" href="SoupMessageBody.html#soup-message-body-wrote-chunk">soup_message_body_wrote_chunk ()</a> -</dt> -<dt id="ientry-idm7433">soup_message_disable_feature, <a class="indexterm" href="SoupMessage.html#soup-message-disable-feature">soup_message_disable_feature ()</a> -</dt> -<dt id="ientry-idm7985">SOUP_MESSAGE_FIRST_PARTY, <a class="indexterm" href="SoupMessage.html#SOUP-MESSAGE-FIRST-PARTY:CAPS">SOUP_MESSAGE_FIRST_PARTY</a> -</dt> -<dt id="ientry-idm7947">SOUP_MESSAGE_FLAGS, <a class="indexterm" href="SoupMessage.html#SOUP-MESSAGE-FLAGS:CAPS">SOUP_MESSAGE_FLAGS</a> -</dt> -<dt id="ientry-idm6740">soup_message_get_address, <a class="indexterm" href="SoupMessage.html#soup-message-get-address">soup_message_get_address ()</a> -</dt> -<dt id="ientry-idm7080">soup_message_get_first_party, <a class="indexterm" href="SoupMessage.html#soup-message-get-first-party">soup_message_get_first_party ()</a> -</dt> -<dt id="ientry-idm7331">soup_message_get_flags, <a class="indexterm" href="SoupMessage.html#soup-message-get-flags">soup_message_get_flags ()</a> -</dt> -<dt id="ientry-idm6958">soup_message_get_https_status, <a class="indexterm" href="SoupMessage.html#soup-message-get-https-status">soup_message_get_https_status ()</a> -</dt> -<dt id="ientry-idm6631">soup_message_get_http_version, <a class="indexterm" href="SoupMessage.html#soup-message-get-http-version">soup_message_get_http_version ()</a> -</dt> -<dt id="ientry-idm7528">soup_message_get_priority, <a class="indexterm" href="SoupMessage.html#soup-message-get-priority">soup_message_get_priority ()</a> -</dt> -<dt id="ientry-idm7485">soup_message_get_soup_request, <a class="indexterm" href="SoupMessage.html#soup-message-get-soup-request">soup_message_get_soup_request ()</a> -</dt> -<dt id="ientry-idm6662">soup_message_get_uri, <a class="indexterm" href="SoupMessage.html#soup-message-get-uri">soup_message_get_uri ()</a> -</dt> -<dt id="ientry-idm9264">soup_message_headers_append, <a class="indexterm" href="SoupMessageHeaders.html#soup-message-headers-append">soup_message_headers_append ()</a> -</dt> -<dt id="ientry-idm9440">soup_message_headers_clean_connection_headers, <a class="indexterm" href="SoupMessageHeaders.html#soup-message-headers-clean-connection-headers">soup_message_headers_clean_connection_headers ()</a> -</dt> -<dt id="ientry-idm9412">soup_message_headers_clear, <a class="indexterm" href="SoupMessageHeaders.html#soup-message-headers-clear">soup_message_headers_clear ()</a> -</dt> -<dt id="ientry-idm9779">soup_message_headers_foreach, <a class="indexterm" href="SoupMessageHeaders.html#soup-message-headers-foreach">soup_message_headers_foreach ()</a> -</dt> -<dt id="ientry-idm9236">soup_message_headers_free, <a class="indexterm" href="SoupMessageHeaders.html#soup-message-headers-free">soup_message_headers_free ()</a> -</dt> -<dt id="ientry-idm10628">soup_message_headers_free_ranges, <a class="indexterm" href="SoupMessageHeaders.html#soup-message-headers-free-ranges">soup_message_headers_free_ranges ()</a> -</dt> -<dt id="ientry-idm10294">soup_message_headers_get_content_disposition, <a class="indexterm" href="SoupMessageHeaders.html#soup-message-headers-get-content-disposition">soup_message_headers_get_content_disposition ()</a> -</dt> -<dt id="ientry-idm10021">soup_message_headers_get_content_length, <a class="indexterm" href="SoupMessageHeaders.html#soup-message-headers-get-content-length">soup_message_headers_get_content_length ()</a> -</dt> -<dt id="ientry-idm10670">soup_message_headers_get_content_range, <a class="indexterm" href="SoupMessageHeaders.html#soup-message-headers-get-content-range">soup_message_headers_get_content_range ()</a> -</dt> -<dt id="ientry-idm10178">soup_message_headers_get_content_type, <a class="indexterm" href="SoupMessageHeaders.html#soup-message-headers-get-content-type">soup_message_headers_get_content_type ()</a> -</dt> -<dt id="ientry-idm9950">soup_message_headers_get_encoding, <a class="indexterm" href="SoupMessageHeaders.html#soup-message-headers-get-encoding">soup_message_headers_get_encoding ()</a> -</dt> -<dt id="ientry-idm10101">soup_message_headers_get_expectations, <a class="indexterm" href="SoupMessageHeaders.html#soup-message-headers-get-expectations">soup_message_headers_get_expectations ()</a> -</dt> -<dt id="ientry-idm9577">soup_message_headers_get_headers_type, <a class="indexterm" href="SoupMessageHeaders.html#soup-message-headers-get-headers-type">soup_message_headers_get_headers_type ()</a> -</dt> -<dt id="ientry-idm9522">soup_message_headers_get_list, <a class="indexterm" href="SoupMessageHeaders.html#soup-message-headers-get-list">soup_message_headers_get_list ()</a> -</dt> -<dt id="ientry-idm9469">soup_message_headers_get_one, <a class="indexterm" href="SoupMessageHeaders.html#soup-message-headers-get-one">soup_message_headers_get_one ()</a> -</dt> -<dt id="ientry-idm10431">soup_message_headers_get_ranges, <a class="indexterm" href="SoupMessageHeaders.html#soup-message-headers-get-ranges">soup_message_headers_get_ranges ()</a> -</dt> -<dt id="ientry-idm9609">soup_message_headers_header_contains, <a class="indexterm" href="SoupMessageHeaders.html#soup-message-headers-header-contains">soup_message_headers_header_contains ()</a> -</dt> -<dt id="ientry-idm9672">soup_message_headers_header_equals, <a class="indexterm" href="SoupMessageHeaders.html#soup-message-headers-header-equals">soup_message_headers_header_equals ()</a> -</dt> -<dt id="ientry-idm9836">soup_message_headers_iter_init, <a class="indexterm" href="SoupMessageHeaders.html#soup-message-headers-iter-init">soup_message_headers_iter_init ()</a> -</dt> -<dt id="ientry-idm9879">soup_message_headers_iter_next, <a class="indexterm" href="SoupMessageHeaders.html#soup-message-headers-iter-next">soup_message_headers_iter_next ()</a> -</dt> -<dt id="ientry-idm9202">soup_message_headers_new, <a class="indexterm" href="SoupMessageHeaders.html#soup-message-headers-new">soup_message_headers_new ()</a> -</dt> -<dt id="ientry-idm9373">soup_message_headers_remove, <a class="indexterm" href="SoupMessageHeaders.html#soup-message-headers-remove">soup_message_headers_remove ()</a> -</dt> -<dt id="ientry-idm9319">soup_message_headers_replace, <a class="indexterm" href="SoupMessageHeaders.html#soup-message-headers-replace">soup_message_headers_replace ()</a> -</dt> -<dt id="ientry-idm10373">soup_message_headers_set_content_disposition, <a class="indexterm" href="SoupMessageHeaders.html#soup-message-headers-set-content-disposition">soup_message_headers_set_content_disposition ()</a> -</dt> -<dt id="ientry-idm10057">soup_message_headers_set_content_length, <a class="indexterm" href="SoupMessageHeaders.html#soup-message-headers-set-content-length">soup_message_headers_set_content_length ()</a> -</dt> -<dt id="ientry-idm10748">soup_message_headers_set_content_range, <a class="indexterm" href="SoupMessageHeaders.html#soup-message-headers-set-content-range">soup_message_headers_set_content_range ()</a> -</dt> -<dt id="ientry-idm10239">soup_message_headers_set_content_type, <a class="indexterm" href="SoupMessageHeaders.html#soup-message-headers-set-content-type">soup_message_headers_set_content_type ()</a> -</dt> -<dt id="ientry-idm9982">soup_message_headers_set_encoding, <a class="indexterm" href="SoupMessageHeaders.html#soup-message-headers-set-encoding">soup_message_headers_set_encoding ()</a> -</dt> -<dt id="ientry-idm10137">soup_message_headers_set_expectations, <a class="indexterm" href="SoupMessageHeaders.html#soup-message-headers-set-expectations">soup_message_headers_set_expectations ()</a> -</dt> -<dt id="ientry-idm10573">soup_message_headers_set_range, <a class="indexterm" href="SoupMessageHeaders.html#soup-message-headers-set-range">soup_message_headers_set_range ()</a> -</dt> -<dt id="ientry-idm10520">soup_message_headers_set_ranges, <a class="indexterm" href="SoupMessageHeaders.html#soup-message-headers-set-ranges">soup_message_headers_set_ranges ()</a> -</dt> -<dt id="ientry-idm7937">SOUP_MESSAGE_HTTP_VERSION, <a class="indexterm" href="SoupMessage.html#SOUP-MESSAGE-HTTP-VERSION:CAPS">SOUP_MESSAGE_HTTP_VERSION</a> -</dt> -<dt id="ientry-idm6922">soup_message_is_keepalive, <a class="indexterm" href="SoupMessage.html#soup-message-is-keepalive">soup_message_is_keepalive ()</a> -</dt> -<dt id="ientry-idm7919">SOUP_MESSAGE_METHOD, <a class="indexterm" href="SoupMessage.html#SOUP-MESSAGE-METHOD:CAPS">SOUP_MESSAGE_METHOD</a> -</dt> -<dt id="ientry-idm6346">soup_message_new, <a class="indexterm" href="SoupMessage.html#soup-message-new">soup_message_new ()</a> -</dt> -<dt id="ientry-idm6394">soup_message_new_from_uri, <a class="indexterm" href="SoupMessage.html#soup-message-new-from-uri">soup_message_new_from_uri ()</a> -</dt> -<dt id="ientry-idm7997">SOUP_MESSAGE_PRIORITY, <a class="indexterm" href="SoupMessage.html#SOUP-MESSAGE-PRIORITY:CAPS">SOUP_MESSAGE_PRIORITY</a> -</dt> -<dt id="ientry-idm7965">SOUP_MESSAGE_REASON_PHRASE, <a class="indexterm" href="SoupMessage.html#SOUP-MESSAGE-REASON-PHRASE:CAPS">SOUP_MESSAGE_REASON_PHRASE</a> -</dt> -<dt id="ientry-idm8009">SOUP_MESSAGE_REQUEST_BODY, <a class="indexterm" href="SoupMessage.html#SOUP-MESSAGE-REQUEST-BODY:CAPS">SOUP_MESSAGE_REQUEST_BODY</a> -</dt> -<dt id="ientry-idm8017">SOUP_MESSAGE_REQUEST_BODY_DATA, <a class="indexterm" href="SoupMessage.html#SOUP-MESSAGE-REQUEST-BODY-DATA:CAPS">SOUP_MESSAGE_REQUEST_BODY_DATA</a> -</dt> -<dt id="ientry-idm8029">SOUP_MESSAGE_REQUEST_HEADERS, <a class="indexterm" href="SoupMessage.html#SOUP-MESSAGE-REQUEST-HEADERS:CAPS">SOUP_MESSAGE_REQUEST_HEADERS</a> -</dt> -<dt id="ientry-idm8037">SOUP_MESSAGE_RESPONSE_BODY, <a class="indexterm" href="SoupMessage.html#SOUP-MESSAGE-RESPONSE-BODY:CAPS">SOUP_MESSAGE_RESPONSE_BODY</a> -</dt> -<dt id="ientry-idm8045">SOUP_MESSAGE_RESPONSE_BODY_DATA, <a class="indexterm" href="SoupMessage.html#SOUP-MESSAGE-RESPONSE-BODY-DATA:CAPS">SOUP_MESSAGE_RESPONSE_BODY_DATA</a> -</dt> -<dt id="ientry-idm8057">SOUP_MESSAGE_RESPONSE_HEADERS, <a class="indexterm" href="SoupMessage.html#SOUP-MESSAGE-RESPONSE-HEADERS:CAPS">SOUP_MESSAGE_RESPONSE_HEADERS</a> -</dt> -<dt id="ientry-idm7973">SOUP_MESSAGE_SERVER_SIDE, <a class="indexterm" href="SoupMessage.html#SOUP-MESSAGE-SERVER-SIDE:CAPS">SOUP_MESSAGE_SERVER_SIDE</a> -</dt> -<dt id="ientry-idm7033">soup_message_set_first_party, <a class="indexterm" href="SoupMessage.html#soup-message-set-first-party">soup_message_set_first_party ()</a> -</dt> -<dt id="ientry-idm7292">soup_message_set_flags, <a class="indexterm" href="SoupMessage.html#soup-message-set-flags">soup_message_set_flags ()</a> -</dt> -<dt id="ientry-idm6590">soup_message_set_http_version, <a class="indexterm" href="SoupMessage.html#soup-message-set-http-version">soup_message_set_http_version ()</a> -</dt> -<dt id="ientry-idm7564">soup_message_set_priority, <a class="indexterm" href="SoupMessage.html#soup-message-set-priority">soup_message_set_priority ()</a> -</dt> -<dt id="ientry-idm6863">soup_message_set_redirect, <a class="indexterm" href="SoupMessage.html#soup-message-set-redirect">soup_message_set_redirect ()</a> -</dt> -<dt id="ientry-idm6438">soup_message_set_request, <a class="indexterm" href="SoupMessage.html#soup-message-set-request">soup_message_set_request ()</a> -</dt> -<dt id="ientry-idm6514">soup_message_set_response, <a class="indexterm" href="SoupMessage.html#soup-message-set-response">soup_message_set_response ()</a> -</dt> -<dt id="ientry-idm6777">soup_message_set_status, <a class="indexterm" href="SoupMessage.html#soup-message-set-status">soup_message_set_status ()</a> -</dt> -<dt id="ientry-idm6817">soup_message_set_status_full, <a class="indexterm" href="SoupMessage.html#soup-message-set-status-full">soup_message_set_status_full ()</a> -</dt> -<dt id="ientry-idm6697">soup_message_set_uri, <a class="indexterm" href="SoupMessage.html#soup-message-set-uri">soup_message_set_uri ()</a> -</dt> -<dt id="ientry-idm7957">SOUP_MESSAGE_STATUS_CODE, <a class="indexterm" href="SoupMessage.html#SOUP-MESSAGE-STATUS-CODE:CAPS">SOUP_MESSAGE_STATUS_CODE</a> -</dt> -<dt id="ientry-idm8065">SOUP_MESSAGE_TLS_CERTIFICATE, <a class="indexterm" href="SoupMessage.html#SOUP-MESSAGE-TLS-CERTIFICATE:CAPS">SOUP_MESSAGE_TLS_CERTIFICATE</a> -</dt> -<dt id="ientry-idm8075">SOUP_MESSAGE_TLS_ERRORS, <a class="indexterm" href="SoupMessage.html#SOUP-MESSAGE-TLS-ERRORS:CAPS">SOUP_MESSAGE_TLS_ERRORS</a> -</dt> -<dt id="ientry-idm7927">SOUP_MESSAGE_URI, <a class="indexterm" href="SoupMessage.html#SOUP-MESSAGE-URI:CAPS">SOUP_MESSAGE_URI</a> -</dt> -<dt id="ientry-idm12564">SOUP_METHOD_CONNECT, <a class="indexterm" href="libsoup-2.4-soup-method.html#SOUP-METHOD-CONNECT:CAPS">SOUP_METHOD_CONNECT</a> -</dt> -<dt id="ientry-idm12588">SOUP_METHOD_COPY, <a class="indexterm" href="libsoup-2.4-soup-method.html#SOUP-METHOD-COPY:CAPS">SOUP_METHOD_COPY</a> -</dt> -<dt id="ientry-idm12552">SOUP_METHOD_DELETE, <a class="indexterm" href="libsoup-2.4-soup-method.html#SOUP-METHOD-DELETE:CAPS">SOUP_METHOD_DELETE</a> -</dt> -<dt id="ientry-idm12528">SOUP_METHOD_GET, <a class="indexterm" href="libsoup-2.4-soup-method.html#SOUP-METHOD-GET:CAPS">SOUP_METHOD_GET</a> -</dt> -<dt id="ientry-idm12534">SOUP_METHOD_HEAD, <a class="indexterm" href="libsoup-2.4-soup-method.html#SOUP-METHOD-HEAD:CAPS">SOUP_METHOD_HEAD</a> -</dt> -<dt id="ientry-idm12600">SOUP_METHOD_LOCK, <a class="indexterm" href="libsoup-2.4-soup-method.html#SOUP-METHOD-LOCK:CAPS">SOUP_METHOD_LOCK</a> -</dt> -<dt id="ientry-idm12582">SOUP_METHOD_MKCOL, <a class="indexterm" href="libsoup-2.4-soup-method.html#SOUP-METHOD-MKCOL:CAPS">SOUP_METHOD_MKCOL</a> -</dt> -<dt id="ientry-idm12594">SOUP_METHOD_MOVE, <a class="indexterm" href="libsoup-2.4-soup-method.html#SOUP-METHOD-MOVE:CAPS">SOUP_METHOD_MOVE</a> -</dt> -<dt id="ientry-idm12522">SOUP_METHOD_OPTIONS, <a class="indexterm" href="libsoup-2.4-soup-method.html#SOUP-METHOD-OPTIONS:CAPS">SOUP_METHOD_OPTIONS</a> -</dt> -<dt id="ientry-idm12546">SOUP_METHOD_POST, <a class="indexterm" href="libsoup-2.4-soup-method.html#SOUP-METHOD-POST:CAPS">SOUP_METHOD_POST</a> -</dt> -<dt id="ientry-idm12570">SOUP_METHOD_PROPFIND, <a class="indexterm" href="libsoup-2.4-soup-method.html#SOUP-METHOD-PROPFIND:CAPS">SOUP_METHOD_PROPFIND</a> -</dt> -<dt id="ientry-idm12576">SOUP_METHOD_PROPPATCH, <a class="indexterm" href="libsoup-2.4-soup-method.html#SOUP-METHOD-PROPPATCH:CAPS">SOUP_METHOD_PROPPATCH</a> -</dt> -<dt id="ientry-idm12540">SOUP_METHOD_PUT, <a class="indexterm" href="libsoup-2.4-soup-method.html#SOUP-METHOD-PUT:CAPS">SOUP_METHOD_PUT</a> -</dt> -<dt id="ientry-idm12558">SOUP_METHOD_TRACE, <a class="indexterm" href="libsoup-2.4-soup-method.html#SOUP-METHOD-TRACE:CAPS">SOUP_METHOD_TRACE</a> -</dt> -<dt id="ientry-idm12606">SOUP_METHOD_UNLOCK, <a class="indexterm" href="libsoup-2.4-soup-method.html#SOUP-METHOD-UNLOCK:CAPS">SOUP_METHOD_UNLOCK</a> -</dt> -<dt id="ientry-idm27325">SOUP_MICRO_VERSION, <a class="indexterm" href="libsoup-2.4-Version-Information.html#SOUP-MICRO-VERSION:CAPS">SOUP_MICRO_VERSION</a> -</dt> -<dt id="ientry-idm27315">SOUP_MINOR_VERSION, <a class="indexterm" href="libsoup-2.4-Version-Information.html#SOUP-MINOR-VERSION:CAPS">SOUP_MINOR_VERSION</a> -</dt> -<dt id="ientry-idm15256">soup_multipart_append_form_file, <a class="indexterm" href="SoupMultipart.html#soup-multipart-append-form-file">soup_multipart_append_form_file ()</a> -</dt> -<dt id="ientry-idm15206">soup_multipart_append_form_string, <a class="indexterm" href="SoupMultipart.html#soup-multipart-append-form-string">soup_multipart_append_form_string ()</a> -</dt> -<dt id="ientry-idm15156">soup_multipart_append_part, <a class="indexterm" href="SoupMultipart.html#soup-multipart-append-part">soup_multipart_append_part ()</a> -</dt> -<dt id="ientry-idm15019">soup_multipart_free, <a class="indexterm" href="SoupMultipart.html#soup-multipart-free">soup_multipart_free ()</a> -</dt> -<dt id="ientry-idm15049">soup_multipart_get_length, <a class="indexterm" href="SoupMultipart.html#soup-multipart-get-length">soup_multipart_get_length ()</a> -</dt> -<dt id="ientry-idm15083">soup_multipart_get_part, <a class="indexterm" href="SoupMultipart.html#soup-multipart-get-part">soup_multipart_get_part ()</a> -</dt> -<dt id="ientry-idm15564">soup_multipart_input_stream_get_headers, <a class="indexterm" href="SoupMultipartInputStream.html#soup-multipart-input-stream-get-headers">soup_multipart_input_stream_get_headers ()</a> -</dt> -<dt id="ientry-idm15511">soup_multipart_input_stream_new, <a class="indexterm" href="SoupMultipartInputStream.html#soup-multipart-input-stream-new">soup_multipart_input_stream_new ()</a> -</dt> -<dt id="ientry-idm15613">soup_multipart_input_stream_next_part, <a class="indexterm" href="SoupMultipartInputStream.html#soup-multipart-input-stream-next-part">soup_multipart_input_stream_next_part ()</a> -</dt> -<dt id="ientry-idm15680">soup_multipart_input_stream_next_part_async, <a class="indexterm" href="SoupMultipartInputStream.html#soup-multipart-input-stream-next-part-async">soup_multipart_input_stream_next_part_async ()</a> -</dt> -<dt id="ientry-idm15752">soup_multipart_input_stream_next_part_finish, <a class="indexterm" href="SoupMultipartInputStream.html#soup-multipart-input-stream-next-part-finish">soup_multipart_input_stream_next_part_finish ()</a> -</dt> -<dt id="ientry-idm14933">soup_multipart_new, <a class="indexterm" href="SoupMultipart.html#soup-multipart-new">soup_multipart_new ()</a> -</dt> -<dt id="ientry-idm14969">soup_multipart_new_from_message, <a class="indexterm" href="SoupMultipart.html#soup-multipart-new-from-message">soup_multipart_new_from_message ()</a> -</dt> -<dt id="ientry-idm15327">soup_multipart_to_message, <a class="indexterm" href="SoupMultipart.html#soup-multipart-to-message">soup_multipart_to_message ()</a> -</dt> -<dt id="ientry-idm22976">SOUP_REQUEST_ERROR, <a class="indexterm" href="SoupSession.html#SOUP-REQUEST-ERROR:CAPS">SOUP_REQUEST_ERROR</a> -</dt> -<dt id="ientry-idm16555">soup_request_file_get_file, <a class="indexterm" href="SoupRequestFile.html#soup-request-file-get-file">soup_request_file_get_file ()</a> -</dt> -<dt id="ientry-idm16172">soup_request_get_content_length, <a class="indexterm" href="SoupRequest.html#soup-request-get-content-length">soup_request_get_content_length ()</a> -</dt> -<dt id="ientry-idm16210">soup_request_get_content_type, <a class="indexterm" href="SoupRequest.html#soup-request-get-content-type">soup_request_get_content_type ()</a> -</dt> -<dt id="ientry-idm16254">soup_request_get_session, <a class="indexterm" href="SoupRequest.html#soup-request-get-session">soup_request_get_session ()</a> -</dt> -<dt id="ientry-idm16295">soup_request_get_uri, <a class="indexterm" href="SoupRequest.html#soup-request-get-uri">soup_request_get_uri ()</a> -</dt> -<dt id="ientry-idm16453">soup_request_http_get_message, <a class="indexterm" href="SoupRequestHTTP.html#soup-request-http-get-message">soup_request_http_get_message ()</a> -</dt> -<dt id="ientry-idm15967">soup_request_send, <a class="indexterm" href="SoupRequest.html#soup-request-send">soup_request_send ()</a> -</dt> -<dt id="ientry-idm16039">soup_request_send_async, <a class="indexterm" href="SoupRequest.html#soup-request-send-async">soup_request_send_async ()</a> -</dt> -<dt id="ientry-idm16108">soup_request_send_finish, <a class="indexterm" href="SoupRequest.html#soup-request-send-finish">soup_request_send_finish ()</a> -</dt> -<dt id="ientry-idm16342">SOUP_REQUEST_SESSION, <a class="indexterm" href="SoupRequest.html#SOUP-REQUEST-SESSION:CAPS">SOUP_REQUEST_SESSION</a> -</dt> -<dt id="ientry-idm16352">SOUP_REQUEST_URI, <a class="indexterm" href="SoupRequest.html#SOUP-REQUEST-URI:CAPS">SOUP_REQUEST_URI</a> -</dt> -<dt id="ientry-idm17839">soup_server_accept_iostream, <a class="indexterm" href="SoupServer.html#soup-server-accept-iostream">soup_server_accept_iostream ()</a> -</dt> -<dt id="ientry-idm18762">soup_server_add_auth_domain, <a class="indexterm" href="SoupServer.html#soup-server-add-auth-domain">soup_server_add_auth_domain ()</a> -</dt> -<dt id="ientry-idm18145">soup_server_add_early_handler, <a class="indexterm" href="SoupServer.html#soup-server-add-early-handler">soup_server_add_early_handler ()</a> -</dt> -<dt id="ientry-idm18033">soup_server_add_handler, <a class="indexterm" href="SoupServer.html#soup-server-add-handler">soup_server_add_handler ()</a> -</dt> -<dt id="ientry-idm18351">soup_server_add_websocket_handler, <a class="indexterm" href="SoupServer.html#soup-server-add-websocket-handler">soup_server_add_websocket_handler ()</a> -</dt> -<dt id="ientry-idm20059">SOUP_SERVER_ASYNC_CONTEXT, <a class="indexterm" href="libsoup-2.4-SoupServer-deprecated-API.html#SOUP-SERVER-ASYNC-CONTEXT:CAPS">SOUP_SERVER_ASYNC_CONTEXT</a> -</dt> -<dt id="ientry-idm17748">soup_server_disconnect, <a class="indexterm" href="SoupServer.html#soup-server-disconnect">soup_server_disconnect ()</a> -</dt> -<dt id="ientry-idm19838">soup_server_get_async_context, <a class="indexterm" href="libsoup-2.4-SoupServer-deprecated-API.html#soup-server-get-async-context">soup_server_get_async_context ()</a> -</dt> -<dt id="ientry-idm19663">soup_server_get_listener, <a class="indexterm" href="libsoup-2.4-SoupServer-deprecated-API.html#soup-server-get-listener">soup_server_get_listener ()</a> -</dt> -<dt id="ientry-idm17660">soup_server_get_listeners, <a class="indexterm" href="SoupServer.html#soup-server-get-listeners">soup_server_get_listeners ()</a> -</dt> -<dt id="ientry-idm19623">soup_server_get_port, <a class="indexterm" href="libsoup-2.4-SoupServer-deprecated-API.html#soup-server-get-port">soup_server_get_port ()</a> -</dt> -<dt id="ientry-idm17704">soup_server_get_uris, <a class="indexterm" href="SoupServer.html#soup-server-get-uris">soup_server_get_uris ()</a> -</dt> -<dt id="ientry-idm19054">SOUP_SERVER_HTTPS_ALIASES, <a class="indexterm" href="SoupServer.html#SOUP-SERVER-HTTPS-ALIASES:CAPS">SOUP_SERVER_HTTPS_ALIASES</a> -</dt> -<dt id="ientry-idm19044">SOUP_SERVER_HTTP_ALIASES, <a class="indexterm" href="SoupServer.html#SOUP-SERVER-HTTP-ALIASES:CAPS">SOUP_SERVER_HTTP_ALIASES</a> -</dt> -<dt id="ientry-idm20009">SOUP_SERVER_INTERFACE, <a class="indexterm" href="libsoup-2.4-SoupServer-deprecated-API.html#SOUP-SERVER-INTERFACE:CAPS">SOUP_SERVER_INTERFACE</a> -</dt> -<dt id="ientry-idm17788">soup_server_is_https, <a class="indexterm" href="SoupServer.html#soup-server-is-https">soup_server_is_https ()</a> -</dt> -<dt id="ientry-idm17261">soup_server_listen, <a class="indexterm" href="SoupServer.html#soup-server-listen">soup_server_listen ()</a> -</dt> -<dt id="ientry-idm17345">soup_server_listen_all, <a class="indexterm" href="SoupServer.html#soup-server-listen-all">soup_server_listen_all ()</a> -</dt> -<dt id="ientry-idm17584">soup_server_listen_fd, <a class="indexterm" href="SoupServer.html#soup-server-listen-fd">soup_server_listen_fd ()</a> -</dt> -<dt id="ientry-idm17428">soup_server_listen_local, <a class="indexterm" href="SoupServer.html#soup-server-listen-local">soup_server_listen_local ()</a> -</dt> -<dt id="ientry-idm17511">soup_server_listen_socket, <a class="indexterm" href="SoupServer.html#soup-server-listen-socket">soup_server_listen_socket ()</a> -</dt> -<dt id="ientry-idm17143">soup_server_new, <a class="indexterm" href="SoupServer.html#soup-server-new">soup_server_new ()</a> -</dt> -<dt id="ientry-idm18843">soup_server_pause_message, <a class="indexterm" href="SoupServer.html#soup-server-pause-message">soup_server_pause_message ()</a> -</dt> -<dt id="ientry-idm19991">SOUP_SERVER_PORT, <a class="indexterm" href="libsoup-2.4-SoupServer-deprecated-API.html#SOUP-SERVER-PORT:CAPS">SOUP_SERVER_PORT</a> -</dt> -<dt id="ientry-idm19795">soup_server_quit, <a class="indexterm" href="libsoup-2.4-SoupServer-deprecated-API.html#soup-server-quit">soup_server_quit ()</a> -</dt> -<dt id="ientry-idm19026">SOUP_SERVER_RAW_PATHS, <a class="indexterm" href="SoupServer.html#SOUP-SERVER-RAW-PATHS:CAPS">SOUP_SERVER_RAW_PATHS</a> -</dt> -<dt id="ientry-idm18803">soup_server_remove_auth_domain, <a class="indexterm" href="SoupServer.html#soup-server-remove-auth-domain">soup_server_remove_auth_domain ()</a> -</dt> -<dt id="ientry-idm18241">soup_server_remove_handler, <a class="indexterm" href="SoupServer.html#soup-server-remove-handler">soup_server_remove_handler ()</a> -</dt> -<dt id="ientry-idm19711">soup_server_run, <a class="indexterm" href="libsoup-2.4-SoupServer-deprecated-API.html#soup-server-run">soup_server_run ()</a> -</dt> -<dt id="ientry-idm19753">soup_server_run_async, <a class="indexterm" href="libsoup-2.4-SoupServer-deprecated-API.html#soup-server-run-async">soup_server_run_async ()</a> -</dt> -<dt id="ientry-idm19036">SOUP_SERVER_SERVER_HEADER, <a class="indexterm" href="SoupServer.html#SOUP-SERVER-SERVER-HEADER:CAPS">SOUP_SERVER_SERVER_HEADER</a> -</dt> -<dt id="ientry-idm17192">soup_server_set_ssl_cert_file, <a class="indexterm" href="SoupServer.html#soup-server-set-ssl-cert-file">soup_server_set_ssl_cert_file ()</a> -</dt> -<dt id="ientry-idm20027">SOUP_SERVER_SSL_CERT_FILE, <a class="indexterm" href="libsoup-2.4-SoupServer-deprecated-API.html#SOUP-SERVER-SSL-CERT-FILE:CAPS">SOUP_SERVER_SSL_CERT_FILE</a> -</dt> -<dt id="ientry-idm20043">SOUP_SERVER_SSL_KEY_FILE, <a class="indexterm" href="libsoup-2.4-SoupServer-deprecated-API.html#SOUP-SERVER-SSL-KEY-FILE:CAPS">SOUP_SERVER_SSL_KEY_FILE</a> -</dt> -<dt id="ientry-idm19016">SOUP_SERVER_TLS_CERTIFICATE, <a class="indexterm" href="SoupServer.html#SOUP-SERVER-TLS-CERTIFICATE:CAPS">SOUP_SERVER_TLS_CERTIFICATE</a> -</dt> -<dt id="ientry-idm18894">soup_server_unpause_message, <a class="indexterm" href="SoupServer.html#soup-server-unpause-message">soup_server_unpause_message ()</a> -</dt> -<dt id="ientry-idm21927">soup_session_abort, <a class="indexterm" href="SoupSession.html#soup-session-abort">soup_session_abort ()</a> -</dt> -<dt id="ientry-idm23144">SOUP_SESSION_ACCEPT_LANGUAGE, <a class="indexterm" href="SoupSession.html#SOUP-SESSION-ACCEPT-LANGUAGE:CAPS">SOUP_SESSION_ACCEPT_LANGUAGE</a> -</dt> -<dt id="ientry-idm23154">SOUP_SESSION_ACCEPT_LANGUAGE_AUTO, <a class="indexterm" href="SoupSession.html#SOUP-SESSION-ACCEPT-LANGUAGE-AUTO:CAPS">SOUP_SESSION_ACCEPT_LANGUAGE_AUTO</a> -</dt> -<dt id="ientry-idm22213">soup_session_add_feature, <a class="indexterm" href="SoupSession.html#soup-session-add-feature">soup_session_add_feature ()</a> -</dt> -<dt id="ientry-idm23114">SOUP_SESSION_ADD_FEATURE, <a class="indexterm" href="SoupSession.html#SOUP-SESSION-ADD-FEATURE:CAPS">SOUP_SESSION_ADD_FEATURE</a> -</dt> -<dt id="ientry-idm22260">soup_session_add_feature_by_type, <a class="indexterm" href="SoupSession.html#soup-session-add-feature-by-type">soup_session_add_feature_by_type ()</a> -</dt> -<dt id="ientry-idm23124">SOUP_SESSION_ADD_FEATURE_BY_TYPE, <a class="indexterm" href="SoupSession.html#SOUP-SESSION-ADD-FEATURE-BY-TYPE:CAPS">SOUP_SESSION_ADD_FEATURE_BY_TYPE</a> -</dt> -<dt id="ientry-idm23070">SOUP_SESSION_ASYNC_CONTEXT, <a class="indexterm" href="SoupSession.html#SOUP-SESSION-ASYNC-CONTEXT:CAPS">SOUP_SESSION_ASYNC_CONTEXT</a> -</dt> -<dt id="ientry-idm21332">soup_session_cancel_message, <a class="indexterm" href="SoupSession.html#soup-session-cancel-message">soup_session_cancel_message ()</a> -</dt> -<dt id="ientry-idm22766">soup_session_connect_async, <a class="indexterm" href="SoupSession.html#soup-session-connect-async">soup_session_connect_async ()</a> -</dt> -<dt id="ientry-idm22861">soup_session_connect_finish, <a class="indexterm" href="SoupSession.html#soup-session-connect-finish">soup_session_connect_finish ()</a> -</dt> -<dt id="ientry-idm22166">soup_session_get_async_context, <a class="indexterm" href="SoupSession.html#soup-session-get-async-context">soup_session_get_async_context ()</a> -</dt> -<dt id="ientry-idm22460">soup_session_get_feature, <a class="indexterm" href="SoupSession.html#soup-session-get-feature">soup_session_get_feature ()</a> -</dt> -<dt id="ientry-idm22408">soup_session_get_features, <a class="indexterm" href="SoupSession.html#soup-session-get-features">soup_session_get_features ()</a> -</dt> -<dt id="ientry-idm22516">soup_session_get_feature_for_message, <a class="indexterm" href="SoupSession.html#soup-session-get-feature-for-message">soup_session_get_feature_for_message ()</a> -</dt> -<dt id="ientry-idm22588">soup_session_has_feature, <a class="indexterm" href="SoupSession.html#soup-session-has-feature">soup_session_has_feature ()</a> -</dt> -<dt id="ientry-idm23174">SOUP_SESSION_HTTPS_ALIASES, <a class="indexterm" href="SoupSession.html#SOUP-SESSION-HTTPS-ALIASES:CAPS">SOUP_SESSION_HTTPS_ALIASES</a> -</dt> -<dt id="ientry-idm23164">SOUP_SESSION_HTTP_ALIASES, <a class="indexterm" href="SoupSession.html#SOUP-SESSION-HTTP-ALIASES:CAPS">SOUP_SESSION_HTTP_ALIASES</a> -</dt> -<dt id="ientry-idm23096">SOUP_SESSION_IDLE_TIMEOUT, <a class="indexterm" href="SoupSession.html#SOUP-SESSION-IDLE-TIMEOUT:CAPS">SOUP_SESSION_IDLE_TIMEOUT</a> -</dt> -<dt id="ientry-idm23184">SOUP_SESSION_LOCAL_ADDRESS, <a class="indexterm" href="SoupSession.html#SOUP-SESSION-LOCAL-ADDRESS:CAPS">SOUP_SESSION_LOCAL_ADDRESS</a> -</dt> -<dt id="ientry-idm23006">SOUP_SESSION_MAX_CONNS, <a class="indexterm" href="SoupSession.html#SOUP-SESSION-MAX-CONNS:CAPS">SOUP_SESSION_MAX_CONNS</a> -</dt> -<dt id="ientry-idm23014">SOUP_SESSION_MAX_CONNS_PER_HOST, <a class="indexterm" href="SoupSession.html#SOUP-SESSION-MAX-CONNS-PER-HOST:CAPS">SOUP_SESSION_MAX_CONNS_PER_HOST</a> -</dt> -<dt id="ientry-idm20758">soup_session_new, <a class="indexterm" href="SoupSession.html#soup-session-new">soup_session_new ()</a> -</dt> -<dt id="ientry-idm20775">soup_session_new_with_options, <a class="indexterm" href="SoupSession.html#soup-session-new-with-options">soup_session_new_with_options ()</a> -</dt> -<dt id="ientry-idm22069">soup_session_pause_message, <a class="indexterm" href="SoupSession.html#soup-session-pause-message">soup_session_pause_message ()</a> -</dt> -<dt id="ientry-idm21841">soup_session_prefetch_dns, <a class="indexterm" href="SoupSession.html#soup-session-prefetch-dns">soup_session_prefetch_dns ()</a> -</dt> -<dt id="ientry-idm22998">SOUP_SESSION_PROXY_RESOLVER, <a class="indexterm" href="SoupSession.html#SOUP-SESSION-PROXY-RESOLVER:CAPS">SOUP_SESSION_PROXY_RESOLVER</a> -</dt> -<dt id="ientry-idm22990">SOUP_SESSION_PROXY_URI, <a class="indexterm" href="SoupSession.html#SOUP-SESSION-PROXY-URI:CAPS">SOUP_SESSION_PROXY_URI</a> -</dt> -<dt id="ientry-idm21150">soup_session_queue_message, <a class="indexterm" href="SoupSession.html#soup-session-queue-message">soup_session_queue_message ()</a> -</dt> -<dt id="ientry-idm22011">soup_session_redirect_message, <a class="indexterm" href="SoupSession.html#soup-session-redirect-message">soup_session_redirect_message ()</a> -</dt> -<dt id="ientry-idm22322">soup_session_remove_feature, <a class="indexterm" href="SoupSession.html#soup-session-remove-feature">soup_session_remove_feature ()</a> -</dt> -<dt id="ientry-idm22363">soup_session_remove_feature_by_type, <a class="indexterm" href="SoupSession.html#soup-session-remove-feature-by-type">soup_session_remove_feature_by_type ()</a> -</dt> -<dt id="ientry-idm23134">SOUP_SESSION_REMOVE_FEATURE_BY_TYPE, <a class="indexterm" href="SoupSession.html#SOUP-SESSION-REMOVE-FEATURE-BY-TYPE:CAPS">SOUP_SESSION_REMOVE_FEATURE_BY_TYPE</a> -</dt> -<dt id="ientry-idm20815">soup_session_request, <a class="indexterm" href="SoupSession.html#soup-session-request">soup_session_request ()</a> -</dt> -<dt id="ientry-idm20945">soup_session_request_http, <a class="indexterm" href="SoupSession.html#soup-session-request-http">soup_session_request_http ()</a> -</dt> -<dt id="ientry-idm21023">soup_session_request_http_uri, <a class="indexterm" href="SoupSession.html#soup-session-request-http-uri">soup_session_request_http_uri ()</a> -</dt> -<dt id="ientry-idm20879">soup_session_request_uri, <a class="indexterm" href="SoupSession.html#soup-session-request-uri">soup_session_request_uri ()</a> -</dt> -<dt id="ientry-idm21243">soup_session_requeue_message, <a class="indexterm" href="SoupSession.html#soup-session-requeue-message">soup_session_requeue_message ()</a> -</dt> -<dt id="ientry-idm21400">soup_session_send, <a class="indexterm" href="SoupSession.html#soup-session-send">soup_session_send ()</a> -</dt> -<dt id="ientry-idm21500">soup_session_send_async, <a class="indexterm" href="SoupSession.html#soup-session-send-async">soup_session_send_async ()</a> -</dt> -<dt id="ientry-idm21592">soup_session_send_finish, <a class="indexterm" href="SoupSession.html#soup-session-send-finish">soup_session_send_finish ()</a> -</dt> -<dt id="ientry-idm21280">soup_session_send_message, <a class="indexterm" href="SoupSession.html#soup-session-send-message">soup_session_send_message ()</a> -</dt> -<dt id="ientry-idm23042">SOUP_SESSION_SSL_CA_FILE, <a class="indexterm" href="SoupSession.html#SOUP-SESSION-SSL-CA-FILE:CAPS">SOUP_SESSION_SSL_CA_FILE</a> -</dt> -<dt id="ientry-idm23050">SOUP_SESSION_SSL_STRICT, <a class="indexterm" href="SoupSession.html#SOUP-SESSION-SSL-STRICT:CAPS">SOUP_SESSION_SSL_STRICT</a> -</dt> -<dt id="ientry-idm23032">SOUP_SESSION_SSL_USE_SYSTEM_CA_FILE, <a class="indexterm" href="SoupSession.html#SOUP-SESSION-SSL-USE-SYSTEM-CA-FILE:CAPS">SOUP_SESSION_SSL_USE_SYSTEM_CA_FILE</a> -</dt> -<dt id="ientry-idm22643">soup_session_steal_connection, <a class="indexterm" href="SoupSession.html#soup-session-steal-connection">soup_session_steal_connection ()</a> -</dt> -<dt id="ientry-idm23088">SOUP_SESSION_TIMEOUT, <a class="indexterm" href="SoupSession.html#SOUP-SESSION-TIMEOUT:CAPS">SOUP_SESSION_TIMEOUT</a> -</dt> -<dt id="ientry-idm23022">SOUP_SESSION_TLS_DATABASE, <a class="indexterm" href="SoupSession.html#SOUP-SESSION-TLS-DATABASE:CAPS">SOUP_SESSION_TLS_DATABASE</a> -</dt> -<dt id="ientry-idm23060">SOUP_SESSION_TLS_INTERACTION, <a class="indexterm" href="SoupSession.html#SOUP-SESSION-TLS-INTERACTION:CAPS">SOUP_SESSION_TLS_INTERACTION</a> -</dt> -<dt id="ientry-idm22116">soup_session_unpause_message, <a class="indexterm" href="SoupSession.html#soup-session-unpause-message">soup_session_unpause_message ()</a> -</dt> -<dt id="ientry-idm23106">SOUP_SESSION_USER_AGENT, <a class="indexterm" href="SoupSession.html#SOUP-SESSION-USER-AGENT:CAPS">SOUP_SESSION_USER_AGENT</a> -</dt> -<dt id="ientry-idm23078">SOUP_SESSION_USE_THREAD_CONTEXT, <a class="indexterm" href="SoupSession.html#SOUP-SESSION-USE-THREAD-CONTEXT:CAPS">SOUP_SESSION_USE_THREAD_CONTEXT</a> -</dt> -<dt id="ientry-idm21659">soup_session_websocket_connect_async, <a class="indexterm" href="SoupSession.html#soup-session-websocket-connect-async">soup_session_websocket_connect_async ()</a> -</dt> -<dt id="ientry-idm21772">soup_session_websocket_connect_finish, <a class="indexterm" href="SoupSession.html#soup-session-websocket-connect-finish">soup_session_websocket_connect_finish ()</a> -</dt> -<dt id="ientry-idm21962">soup_session_would_redirect, <a class="indexterm" href="SoupSession.html#soup-session-would-redirect">soup_session_would_redirect ()</a> -</dt> -<dt id="ientry-idm36303">SOUP_SOCKET_ASYNC_CONTEXT, <a class="indexterm" href="SoupSocket.html#SOUP-SOCKET-ASYNC-CONTEXT:CAPS">SOUP_SOCKET_ASYNC_CONTEXT</a> -</dt> -<dt id="ientry-idm35407">soup_socket_connect_async, <a class="indexterm" href="SoupSocket.html#soup-socket-connect-async">soup_socket_connect_async ()</a> -</dt> -<dt id="ientry-idm35477">soup_socket_connect_sync, <a class="indexterm" href="SoupSocket.html#soup-socket-connect-sync">soup_socket_connect_sync ()</a> -</dt> -<dt id="ientry-idm35688">soup_socket_disconnect, <a class="indexterm" href="SoupSocket.html#soup-socket-disconnect">soup_socket_disconnect ()</a> -</dt> -<dt id="ientry-idm36279">SOUP_SOCKET_FLAG_NONBLOCKING, <a class="indexterm" href="SoupSocket.html#SOUP-SOCKET-FLAG-NONBLOCKING:CAPS">SOUP_SOCKET_FLAG_NONBLOCKING</a> -</dt> -<dt id="ientry-idm35829">soup_socket_get_fd, <a class="indexterm" href="SoupSocket.html#soup-socket-get-fd">soup_socket_get_fd ()</a> -</dt> -<dt id="ientry-idm35751">soup_socket_get_local_address, <a class="indexterm" href="SoupSocket.html#soup-socket-get-local-address">soup_socket_get_local_address ()</a> -</dt> -<dt id="ientry-idm35790">soup_socket_get_remote_address, <a class="indexterm" href="SoupSocket.html#soup-socket-get-remote-address">soup_socket_get_remote_address ()</a> -</dt> -<dt id="ientry-idm35716">soup_socket_is_connected, <a class="indexterm" href="SoupSocket.html#soup-socket-is-connected">soup_socket_is_connected ()</a> -</dt> -<dt id="ientry-idm36287">SOUP_SOCKET_IS_SERVER, <a class="indexterm" href="SoupSocket.html#SOUP-SOCKET-IS-SERVER:CAPS">SOUP_SOCKET_IS_SERVER</a> -</dt> -<dt id="ientry-idm35654">soup_socket_is_ssl, <a class="indexterm" href="SoupSocket.html#soup-socket-is-ssl">soup_socket_is_ssl ()</a> -</dt> -<dt id="ientry-idm35529">soup_socket_listen, <a class="indexterm" href="SoupSocket.html#soup-socket-listen">soup_socket_listen ()</a> -</dt> -<dt id="ientry-idm36263">SOUP_SOCKET_LOCAL_ADDRESS, <a class="indexterm" href="SoupSocket.html#SOUP-SOCKET-LOCAL-ADDRESS:CAPS">SOUP_SOCKET_LOCAL_ADDRESS</a> -</dt> -<dt id="ientry-idm35318">soup_socket_new, <a class="indexterm" href="SoupSocket.html#soup-socket-new">soup_socket_new ()</a> -</dt> -<dt id="ientry-idm35864">soup_socket_read, <a class="indexterm" href="SoupSocket.html#soup-socket-read">soup_socket_read ()</a> -</dt> -<dt id="ientry-idm35978">soup_socket_read_until, <a class="indexterm" href="SoupSocket.html#soup-socket-read-until">soup_socket_read_until ()</a> -</dt> -<dt id="ientry-idm36271">SOUP_SOCKET_REMOTE_ADDRESS, <a class="indexterm" href="SoupSocket.html#SOUP-SOCKET-REMOTE-ADDRESS:CAPS">SOUP_SOCKET_REMOTE_ADDRESS</a> -</dt> -<dt id="ientry-idm36295">SOUP_SOCKET_SSL_CREDENTIALS, <a class="indexterm" href="SoupSocket.html#SOUP-SOCKET-SSL-CREDENTIALS:CAPS">SOUP_SOCKET_SSL_CREDENTIALS</a> -</dt> -<dt id="ientry-idm36321">SOUP_SOCKET_SSL_FALLBACK, <a class="indexterm" href="SoupSocket.html#SOUP-SOCKET-SSL-FALLBACK:CAPS">SOUP_SOCKET_SSL_FALLBACK</a> -</dt> -<dt id="ientry-idm36329">SOUP_SOCKET_SSL_STRICT, <a class="indexterm" href="SoupSocket.html#SOUP-SOCKET-SSL-STRICT:CAPS">SOUP_SOCKET_SSL_STRICT</a> -</dt> -<dt id="ientry-idm35604">soup_socket_start_proxy_ssl, <a class="indexterm" href="SoupSocket.html#soup-socket-start-proxy-ssl">soup_socket_start_proxy_ssl ()</a> -</dt> -<dt id="ientry-idm35564">soup_socket_start_ssl, <a class="indexterm" href="SoupSocket.html#soup-socket-start-ssl">soup_socket_start_ssl ()</a> -</dt> -<dt id="ientry-idm36313">SOUP_SOCKET_TIMEOUT, <a class="indexterm" href="SoupSocket.html#SOUP-SOCKET-TIMEOUT:CAPS">SOUP_SOCKET_TIMEOUT</a> -</dt> -<dt id="ientry-idm36337">SOUP_SOCKET_TLS_CERTIFICATE, <a class="indexterm" href="SoupSocket.html#SOUP-SOCKET-TLS-CERTIFICATE:CAPS">SOUP_SOCKET_TLS_CERTIFICATE</a> -</dt> -<dt id="ientry-idm36347">SOUP_SOCKET_TLS_ERRORS, <a class="indexterm" href="SoupSocket.html#SOUP-SOCKET-TLS-ERRORS:CAPS">SOUP_SOCKET_TLS_ERRORS</a> -</dt> -<dt id="ientry-idm36357">SOUP_SOCKET_TRUSTED_CERTIFICATE, <a class="indexterm" href="SoupSocket.html#SOUP-SOCKET-TRUSTED-CERTIFICATE:CAPS">SOUP_SOCKET_TRUSTED_CERTIFICATE</a> -</dt> -<dt id="ientry-idm36365">SOUP_SOCKET_USE_THREAD_CONTEXT, <a class="indexterm" href="SoupSocket.html#SOUP-SOCKET-USE-THREAD-CONTEXT:CAPS">SOUP_SOCKET_USE_THREAD_CONTEXT</a> -</dt> -<dt id="ientry-idm36104">soup_socket_write, <a class="indexterm" href="SoupSocket.html#soup-socket-write">soup_socket_write ()</a> -</dt> -<dt id="ientry-idm24443">soup_status_get_phrase, <a class="indexterm" href="libsoup-2.4-soup-status.html#soup-status-get-phrase">soup_status_get_phrase ()</a> -</dt> -<dt id="ientry-idm24387">SOUP_STATUS_IS_CLIENT_ERROR, <a class="indexterm" href="libsoup-2.4-soup-status.html#SOUP-STATUS-IS-CLIENT-ERROR:CAPS">SOUP_STATUS_IS_CLIENT_ERROR()</a> -</dt> -<dt id="ientry-idm24303">SOUP_STATUS_IS_INFORMATIONAL, <a class="indexterm" href="libsoup-2.4-soup-status.html#SOUP-STATUS-IS-INFORMATIONAL:CAPS">SOUP_STATUS_IS_INFORMATIONAL()</a> -</dt> -<dt id="ientry-idm24359">SOUP_STATUS_IS_REDIRECTION, <a class="indexterm" href="libsoup-2.4-soup-status.html#SOUP-STATUS-IS-REDIRECTION:CAPS">SOUP_STATUS_IS_REDIRECTION()</a> -</dt> -<dt id="ientry-idm24415">SOUP_STATUS_IS_SERVER_ERROR, <a class="indexterm" href="libsoup-2.4-soup-status.html#SOUP-STATUS-IS-SERVER-ERROR:CAPS">SOUP_STATUS_IS_SERVER_ERROR()</a> -</dt> -<dt id="ientry-idm24331">SOUP_STATUS_IS_SUCCESSFUL, <a class="indexterm" href="libsoup-2.4-soup-status.html#SOUP-STATUS-IS-SUCCESSFUL:CAPS">SOUP_STATUS_IS_SUCCESSFUL()</a> -</dt> -<dt id="ientry-idm24275">SOUP_STATUS_IS_TRANSPORT_ERROR, <a class="indexterm" href="libsoup-2.4-soup-status.html#SOUP-STATUS-IS-TRANSPORT-ERROR:CAPS">SOUP_STATUS_IS_TRANSPORT_ERROR()</a> -</dt> -<dt id="ientry-idm24483">soup_status_proxify, <a class="indexterm" href="libsoup-2.4-soup-status.html#soup-status-proxify">soup_status_proxify ()</a> -</dt> -<dt id="ientry-idm14301">soup_str_case_equal, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-str-case-equal">soup_str_case_equal ()</a> -</dt> -<dt id="ientry-idm14342">soup_str_case_hash, <a class="indexterm" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-str-case-hash">soup_str_case_hash ()</a> -</dt> -<dt id="ientry-idm25040">soup_tld_domain_is_public_suffix, <a class="indexterm" href="libsoup-2.4-Top-Level-Domain-utils.html#soup-tld-domain-is-public-suffix">soup_tld_domain_is_public_suffix ()</a> -</dt> -<dt id="ientry-idm25079">SOUP_TLD_ERROR, <a class="indexterm" href="libsoup-2.4-Top-Level-Domain-utils.html#SOUP-TLD-ERROR:CAPS">SOUP_TLD_ERROR</a> -</dt> -<dt id="ientry-idm24985">soup_tld_get_base_domain, <a class="indexterm" href="libsoup-2.4-Top-Level-Domain-utils.html#soup-tld-get-base-domain">soup_tld_get_base_domain ()</a> -</dt> -<dt id="ientry-idm1723">SOUP_TYPE_AUTH_BASIC, <a class="indexterm" href="SoupAuth.html#SOUP-TYPE-AUTH-BASIC:CAPS">SOUP_TYPE_AUTH_BASIC</a> -</dt> -<dt id="ientry-idm1739">SOUP_TYPE_AUTH_DIGEST, <a class="indexterm" href="SoupAuth.html#SOUP-TYPE-AUTH-DIGEST:CAPS">SOUP_TYPE_AUTH_DIGEST</a> -</dt> -<dt id="ientry-idm27906">SOUP_TYPE_AUTH_MANAGER, <a class="indexterm" href="SoupAuthManager.html#SOUP-TYPE-AUTH-MANAGER:CAPS">SOUP_TYPE_AUTH_MANAGER</a> -</dt> -<dt id="ientry-idm1771">SOUP_TYPE_AUTH_NEGOTIATE, <a class="indexterm" href="SoupAuth.html#SOUP-TYPE-AUTH-NEGOTIATE:CAPS">SOUP_TYPE_AUTH_NEGOTIATE</a> -</dt> -<dt id="ientry-idm1755">SOUP_TYPE_AUTH_NTLM, <a class="indexterm" href="SoupAuth.html#SOUP-TYPE-AUTH-NTLM:CAPS">SOUP_TYPE_AUTH_NTLM</a> -</dt> -<dt id="ientry-idm25576">soup_uri_copy, <a class="indexterm" href="SoupURI.html#soup-uri-copy">soup_uri_copy ()</a> -</dt> -<dt id="ientry-idm25610">soup_uri_copy_host, <a class="indexterm" href="SoupURI.html#soup-uri-copy-host">soup_uri_copy_host ()</a> -</dt> -<dt id="ientry-idm25854">soup_uri_decode, <a class="indexterm" href="SoupURI.html#soup-uri-decode">soup_uri_decode ()</a> -</dt> -<dt id="ientry-idm25813">soup_uri_encode, <a class="indexterm" href="SoupURI.html#soup-uri-encode">soup_uri_encode ()</a> -</dt> -<dt id="ientry-idm25645">soup_uri_equal, <a class="indexterm" href="SoupURI.html#soup-uri-equal">soup_uri_equal ()</a> -</dt> -<dt id="ientry-idm25785">soup_uri_free, <a class="indexterm" href="SoupURI.html#soup-uri-free">soup_uri_free ()</a> -</dt> -<dt id="ientry-idm26722">soup_uri_get_fragment, <a class="indexterm" href="SoupURI.html#soup-uri-get-fragment">soup_uri_get_fragment ()</a> -</dt> -<dt id="ientry-idm26333">soup_uri_get_host, <a class="indexterm" href="SoupURI.html#soup-uri-get-host">soup_uri_get_host ()</a> -</dt> -<dt id="ientry-idm26250">soup_uri_get_password, <a class="indexterm" href="SoupURI.html#soup-uri-get-password">soup_uri_get_password ()</a> -</dt> -<dt id="ientry-idm26481">soup_uri_get_path, <a class="indexterm" href="SoupURI.html#soup-uri-get-path">soup_uri_get_path ()</a> -</dt> -<dt id="ientry-idm26407">soup_uri_get_port, <a class="indexterm" href="SoupURI.html#soup-uri-get-port">soup_uri_get_port ()</a> -</dt> -<dt id="ientry-idm26648">soup_uri_get_query, <a class="indexterm" href="SoupURI.html#soup-uri-get-query">soup_uri_get_query ()</a> -</dt> -<dt id="ientry-idm26098">soup_uri_get_scheme, <a class="indexterm" href="SoupURI.html#soup-uri-get-scheme">soup_uri_get_scheme ()</a> -</dt> -<dt id="ientry-idm26174">soup_uri_get_user, <a class="indexterm" href="SoupURI.html#soup-uri-get-user">soup_uri_get_user ()</a> -</dt> -<dt id="ientry-idm25692">soup_uri_host_equal, <a class="indexterm" href="SoupURI.html#soup-uri-host-equal">soup_uri_host_equal ()</a> -</dt> -<dt id="ientry-idm25747">soup_uri_host_hash, <a class="indexterm" href="SoupURI.html#soup-uri-host-hash">soup_uri_host_hash ()</a> -</dt> -<dt id="ientry-idm25980">SOUP_URI_IS_VALID, <a class="indexterm" href="SoupURI.html#SOUP-URI-IS-VALID:CAPS">SOUP_URI_IS_VALID()</a> -</dt> -<dt id="ientry-idm25479">soup_uri_new, <a class="indexterm" href="SoupURI.html#soup-uri-new">soup_uri_new ()</a> -</dt> -<dt id="ientry-idm25438">soup_uri_new_with_base, <a class="indexterm" href="SoupURI.html#soup-uri-new-with-base">soup_uri_new_with_base ()</a> -</dt> -<dt id="ientry-idm25889">soup_uri_normalize, <a class="indexterm" href="SoupURI.html#soup-uri-normalize">soup_uri_normalize ()</a> -</dt> -<dt id="ientry-idm26946">SOUP_URI_SCHEME_DATA, <a class="indexterm" href="SoupURI.html#SOUP-URI-SCHEME-DATA:CAPS">SOUP_URI_SCHEME_DATA</a> -</dt> -<dt id="ientry-idm26958">SOUP_URI_SCHEME_FILE, <a class="indexterm" href="SoupURI.html#SOUP-URI-SCHEME-FILE:CAPS">SOUP_URI_SCHEME_FILE</a> -</dt> -<dt id="ientry-idm26970">SOUP_URI_SCHEME_FTP, <a class="indexterm" href="SoupURI.html#SOUP-URI-SCHEME-FTP:CAPS">SOUP_URI_SCHEME_FTP</a> -</dt> -<dt id="ientry-idm26926">SOUP_URI_SCHEME_HTTP, <a class="indexterm" href="SoupURI.html#SOUP-URI-SCHEME-HTTP:CAPS">SOUP_URI_SCHEME_HTTP</a> -</dt> -<dt id="ientry-idm26936">SOUP_URI_SCHEME_HTTPS, <a class="indexterm" href="SoupURI.html#SOUP-URI-SCHEME-HTTPS:CAPS">SOUP_URI_SCHEME_HTTPS</a> -</dt> -<dt id="ientry-idm26982">SOUP_URI_SCHEME_RESOURCE, <a class="indexterm" href="SoupURI.html#SOUP-URI-SCHEME-RESOURCE:CAPS">SOUP_URI_SCHEME_RESOURCE</a> -</dt> -<dt id="ientry-idm26994">SOUP_URI_SCHEME_WS, <a class="indexterm" href="SoupURI.html#SOUP-URI-SCHEME-WS:CAPS">SOUP_URI_SCHEME_WS</a> -</dt> -<dt id="ientry-idm27006">SOUP_URI_SCHEME_WSS, <a class="indexterm" href="SoupURI.html#SOUP-URI-SCHEME-WSS:CAPS">SOUP_URI_SCHEME_WSS</a> -</dt> -<dt id="ientry-idm26682">soup_uri_set_fragment, <a class="indexterm" href="SoupURI.html#soup-uri-set-fragment">soup_uri_set_fragment ()</a> -</dt> -<dt id="ientry-idm26284">soup_uri_set_host, <a class="indexterm" href="SoupURI.html#soup-uri-set-host">soup_uri_set_host ()</a> -</dt> -<dt id="ientry-idm26208">soup_uri_set_password, <a class="indexterm" href="SoupURI.html#soup-uri-set-password">soup_uri_set_password ()</a> -</dt> -<dt id="ientry-idm26441">soup_uri_set_path, <a class="indexterm" href="SoupURI.html#soup-uri-set-path">soup_uri_set_path ()</a> -</dt> -<dt id="ientry-idm26367">soup_uri_set_port, <a class="indexterm" href="SoupURI.html#soup-uri-set-port">soup_uri_set_port ()</a> -</dt> -<dt id="ientry-idm26515">soup_uri_set_query, <a class="indexterm" href="SoupURI.html#soup-uri-set-query">soup_uri_set_query ()</a> -</dt> -<dt id="ientry-idm26599">soup_uri_set_query_from_fields, <a class="indexterm" href="SoupURI.html#soup-uri-set-query-from-fields">soup_uri_set_query_from_fields ()</a> -</dt> -<dt id="ientry-idm26555">soup_uri_set_query_from_form, <a class="indexterm" href="SoupURI.html#soup-uri-set-query-from-form">soup_uri_set_query_from_form ()</a> -</dt> -<dt id="ientry-idm26058">soup_uri_set_scheme, <a class="indexterm" href="SoupURI.html#soup-uri-set-scheme">soup_uri_set_scheme ()</a> -</dt> -<dt id="ientry-idm26132">soup_uri_set_user, <a class="indexterm" href="SoupURI.html#soup-uri-set-user">soup_uri_set_user ()</a> -</dt> -<dt id="ientry-idm25526">soup_uri_to_string, <a class="indexterm" href="SoupURI.html#soup-uri-to-string">soup_uri_to_string ()</a> -</dt> -<dt id="ientry-idm25945">soup_uri_uses_default_port, <a class="indexterm" href="SoupURI.html#soup-uri-uses-default-port">soup_uri_uses_default_port ()</a> -</dt> -<dt id="ientry-idm26023">SOUP_URI_VALID_FOR_HTTP, <a class="indexterm" href="SoupURI.html#SOUP-URI-VALID-FOR-HTTP:CAPS">SOUP_URI_VALID_FOR_HTTP()</a> -</dt> -<dt id="ientry-idm27372">SOUP_VERSION_2_24, <a class="indexterm" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-24:CAPS">SOUP_VERSION_2_24</a> -</dt> -<dt id="ientry-idm27384">SOUP_VERSION_2_26, <a class="indexterm" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-26:CAPS">SOUP_VERSION_2_26</a> -</dt> -<dt id="ientry-idm27396">SOUP_VERSION_2_28, <a class="indexterm" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-28:CAPS">SOUP_VERSION_2_28</a> -</dt> -<dt id="ientry-idm27408">SOUP_VERSION_2_30, <a class="indexterm" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-30:CAPS">SOUP_VERSION_2_30</a> -</dt> -<dt id="ientry-idm27420">SOUP_VERSION_2_32, <a class="indexterm" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-32:CAPS">SOUP_VERSION_2_32</a> -</dt> -<dt id="ientry-idm27432">SOUP_VERSION_2_34, <a class="indexterm" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-34:CAPS">SOUP_VERSION_2_34</a> -</dt> -<dt id="ientry-idm27444">SOUP_VERSION_2_36, <a class="indexterm" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-36:CAPS">SOUP_VERSION_2_36</a> -</dt> -<dt id="ientry-idm27456">SOUP_VERSION_2_38, <a class="indexterm" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-38:CAPS">SOUP_VERSION_2_38</a> -</dt> -<dt id="ientry-idm27468">SOUP_VERSION_2_40, <a class="indexterm" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-40:CAPS">SOUP_VERSION_2_40</a> -</dt> -<dt id="ientry-idm27480">SOUP_VERSION_2_42, <a class="indexterm" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-42:CAPS">SOUP_VERSION_2_42</a> -</dt> -<dt id="ientry-idm27492">SOUP_VERSION_2_44, <a class="indexterm" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-44:CAPS">SOUP_VERSION_2_44</a> -</dt> -<dt id="ientry-idm27504">SOUP_VERSION_2_46, <a class="indexterm" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-46:CAPS">SOUP_VERSION_2_46</a> -</dt> -<dt id="ientry-idm27516">SOUP_VERSION_2_48, <a class="indexterm" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-48:CAPS">SOUP_VERSION_2_48</a> -</dt> -<dt id="ientry-idm27528">SOUP_VERSION_2_50, <a class="indexterm" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-50:CAPS">SOUP_VERSION_2_50</a> -</dt> -<dt id="ientry-idm27540">SOUP_VERSION_2_52, <a class="indexterm" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-52:CAPS">SOUP_VERSION_2_52</a> -</dt> -<dt id="ientry-idm27351">SOUP_VERSION_MAX_ALLOWED, <a class="indexterm" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MAX-ALLOWED:CAPS">SOUP_VERSION_MAX_ALLOWED</a> -</dt> -<dt id="ientry-idm27335">SOUP_VERSION_MIN_REQUIRED, <a class="indexterm" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MIN-REQUIRED:CAPS">SOUP_VERSION_MIN_REQUIRED</a> -</dt> -<dt id="ientry-idm32350">soup_websocket_client_prepare_handshake, <a class="indexterm" href="libsoup-2.4-WebSockets.html#soup-websocket-client-prepare-handshake">soup_websocket_client_prepare_handshake ()</a> -</dt> -<dt id="ientry-idm32406">soup_websocket_client_verify_handshake, <a class="indexterm" href="libsoup-2.4-WebSockets.html#soup-websocket-client-verify-handshake">soup_websocket_client_verify_handshake ()</a> -</dt> -<dt id="ientry-idm32977">soup_websocket_connection_close, <a class="indexterm" href="libsoup-2.4-WebSockets.html#soup-websocket-connection-close">soup_websocket_connection_close ()</a> -</dt> -<dt id="ientry-idm33031">soup_websocket_connection_get_close_code, <a class="indexterm" href="libsoup-2.4-WebSockets.html#soup-websocket-connection-get-close-code">soup_websocket_connection_get_close_code ()</a> -</dt> -<dt id="ientry-idm33066">soup_websocket_connection_get_close_data, <a class="indexterm" href="libsoup-2.4-WebSockets.html#soup-websocket-connection-get-close-data">soup_websocket_connection_get_close_data ()</a> -</dt> -<dt id="ientry-idm32726">soup_websocket_connection_get_connection_type, <a class="indexterm" href="libsoup-2.4-WebSockets.html#soup-websocket-connection-get-connection-type">soup_websocket_connection_get_connection_type ()</a> -</dt> -<dt id="ientry-idm32693">soup_websocket_connection_get_io_stream, <a class="indexterm" href="libsoup-2.4-WebSockets.html#soup-websocket-connection-get-io-stream">soup_websocket_connection_get_io_stream ()</a> -</dt> -<dt id="ientry-idm32790">soup_websocket_connection_get_origin, <a class="indexterm" href="libsoup-2.4-WebSockets.html#soup-websocket-connection-get-origin">soup_websocket_connection_get_origin ()</a> -</dt> -<dt id="ientry-idm32825">soup_websocket_connection_get_protocol, <a class="indexterm" href="libsoup-2.4-WebSockets.html#soup-websocket-connection-get-protocol">soup_websocket_connection_get_protocol ()</a> -</dt> -<dt id="ientry-idm32860">soup_websocket_connection_get_state, <a class="indexterm" href="libsoup-2.4-WebSockets.html#soup-websocket-connection-get-state">soup_websocket_connection_get_state ()</a> -</dt> -<dt id="ientry-idm32756">soup_websocket_connection_get_uri, <a class="indexterm" href="libsoup-2.4-WebSockets.html#soup-websocket-connection-get-uri">soup_websocket_connection_get_uri ()</a> -</dt> -<dt id="ientry-idm32616">soup_websocket_connection_new, <a class="indexterm" href="libsoup-2.4-WebSockets.html#soup-websocket-connection-new">soup_websocket_connection_new ()</a> -</dt> -<dt id="ientry-idm32927">soup_websocket_connection_send_binary, <a class="indexterm" href="libsoup-2.4-WebSockets.html#soup-websocket-connection-send-binary">soup_websocket_connection_send_binary ()</a> -</dt> -<dt id="ientry-idm32890">soup_websocket_connection_send_text, <a class="indexterm" href="libsoup-2.4-WebSockets.html#soup-websocket-connection-send-text">soup_websocket_connection_send_text ()</a> -</dt> -<dt id="ientry-idm33338">SOUP_WEBSOCKET_ERROR, <a class="indexterm" href="libsoup-2.4-WebSockets.html#SOUP-WEBSOCKET-ERROR:CAPS">SOUP_WEBSOCKET_ERROR</a> -</dt> -<dt id="ientry-idm32459">soup_websocket_server_check_handshake, <a class="indexterm" href="libsoup-2.4-WebSockets.html#soup-websocket-server-check-handshake">soup_websocket_server_check_handshake ()</a> -</dt> -<dt id="ientry-idm32544">soup_websocket_server_process_handshake, <a class="indexterm" href="libsoup-2.4-WebSockets.html#soup-websocket-server-process-handshake">soup_websocket_server_process_handshake ()</a> -</dt> -<dt id="ientry-idm31733">soup_xmlrpc_build_fault, <a class="indexterm" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-build-fault">soup_xmlrpc_build_fault ()</a> -</dt> -<dt id="ientry-idm31113">soup_xmlrpc_build_request, <a class="indexterm" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-build-request">soup_xmlrpc_build_request ()</a> -</dt> -<dt id="ientry-idm31678">soup_xmlrpc_build_response, <a class="indexterm" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-build-response">soup_xmlrpc_build_response ()</a> -</dt> -<dt id="ientry-idm31909">SOUP_XMLRPC_ERROR, <a class="indexterm" href="libsoup-2.4-XMLRPC-Support.html#SOUP-XMLRPC-ERROR:CAPS">SOUP_XMLRPC_ERROR</a> -</dt> -<dt id="ientry-idm31936">SOUP_XMLRPC_FAULT, <a class="indexterm" href="libsoup-2.4-XMLRPC-Support.html#SOUP-XMLRPC-FAULT:CAPS">SOUP_XMLRPC_FAULT</a> -</dt> -<dt id="ientry-idm31208">soup_xmlrpc_message_new, <a class="indexterm" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-message-new">soup_xmlrpc_message_new ()</a> -</dt> -<dt id="ientry-idm31849">soup_xmlrpc_message_set_fault, <a class="indexterm" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-message-set-fault">soup_xmlrpc_message_set_fault ()</a> -</dt> -<dt id="ientry-idm31782">soup_xmlrpc_message_set_response, <a class="indexterm" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-message-set-response">soup_xmlrpc_message_set_response ()</a> -</dt> -<dt id="ientry-idm31479">soup_xmlrpc_params_free, <a class="indexterm" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-params-free">soup_xmlrpc_params_free ()</a> -</dt> -<dt id="ientry-idm31510">soup_xmlrpc_params_parse, <a class="indexterm" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-params-parse">soup_xmlrpc_params_parse ()</a> -</dt> -<dt id="ientry-idm31604">soup_xmlrpc_parse_request, <a class="indexterm" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-parse-request">soup_xmlrpc_parse_request ()</a> -</dt> -<dt id="ientry-idm31286">soup_xmlrpc_parse_response, <a class="indexterm" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-parse-response">soup_xmlrpc_parse_response ()</a> -</dt> -<dt id="ientry-idm31420">soup_xmlrpc_variant_get_datetime, <a class="indexterm" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-variant-get-datetime">soup_xmlrpc_variant_get_datetime ()</a> -</dt> -<dt id="ientry-idm31377">soup_xmlrpc_variant_new_datetime, <a class="indexterm" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-variant-new-datetime">soup_xmlrpc_variant_new_datetime ()</a> -</dt> -</dl> -</div></div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/left-insensitive.png b/docs/reference/html/left-insensitive.png Binary files differdeleted file mode 100644 index 3269393a..00000000 --- a/docs/reference/html/left-insensitive.png +++ /dev/null diff --git a/docs/reference/html/left.png b/docs/reference/html/left.png Binary files differdeleted file mode 100644 index 2abde032..00000000 --- a/docs/reference/html/left.png +++ /dev/null diff --git a/docs/reference/html/libsoup-2.4-HTML-Form-Support.html b/docs/reference/html/libsoup-2.4-HTML-Form-Support.html deleted file mode 100644 index e823d17e..00000000 --- a/docs/reference/html/libsoup-2.4-HTML-Form-Support.html +++ /dev/null @@ -1,640 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>HTML Form Support: 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="ch04.html" title="Web Services APIs"> -<link rel="prev" href="ch04.html" title="Web Services APIs"> -<link rel="next" href="libsoup-2.4-XMLRPC-Support.html" title="XMLRPC Support"> -<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="#libsoup-2.4-HTML-Form-Support.description" class="shortcut">Description</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="ch04.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="ch04.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="libsoup-2.4-XMLRPC-Support.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="libsoup-2.4-HTML-Form-Support"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="libsoup-2.4-HTML-Form-Support.top_of_page"></a>HTML Form Support</span></h2> -<p>HTML Form Support — HTML form handling</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="libsoup-2.4-HTML-Form-Support.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"> -<span class="returnvalue">GHashTable</span> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-HTML-Form-Support.html#soup-form-decode" title="soup_form_decode ()">soup_form_decode</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GHashTable</span> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-HTML-Form-Support.html#soup-form-decode-multipart" title="soup_form_decode_multipart ()">soup_form_decode_multipart</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="libsoup-2.4-HTML-Form-Support.html#soup-form-encode" title="soup_form_encode ()">soup_form_encode</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="libsoup-2.4-HTML-Form-Support.html#soup-form-encode-datalist" title="soup_form_encode_datalist ()">soup_form_encode_datalist</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="libsoup-2.4-HTML-Form-Support.html#soup-form-encode-hash" title="soup_form_encode_hash ()">soup_form_encode_hash</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="libsoup-2.4-HTML-Form-Support.html#soup-form-encode-valist" title="soup_form_encode_valist ()">soup_form_encode_valist</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="returnvalue">SoupMessage</span></a> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-HTML-Form-Support.html#soup-form-request-new" title="soup_form_request_new ()">soup_form_request_new</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="returnvalue">SoupMessage</span></a> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-HTML-Form-Support.html#soup-form-request-new-from-datalist" title="soup_form_request_new_from_datalist ()">soup_form_request_new_from_datalist</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="returnvalue">SoupMessage</span></a> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-HTML-Form-Support.html#soup-form-request-new-from-hash" title="soup_form_request_new_from_hash ()">soup_form_request_new_from_hash</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="returnvalue">SoupMessage</span></a> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-HTML-Form-Support.html#soup-form-request-new-from-multipart" title="soup_form_request_new_from_multipart ()">soup_form_request_new_from_multipart</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-HTML-Form-Support.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="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-HTML-Form-Support.html#SOUP-FORM-MIME-TYPE-MULTIPART:CAPS" title="SOUP_FORM_MIME_TYPE_MULTIPART">SOUP_FORM_MIME_TYPE_MULTIPART</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-HTML-Form-Support.html#SOUP-FORM-MIME-TYPE-URLENCODED:CAPS" title="SOUP_FORM_MIME_TYPE_URLENCODED">SOUP_FORM_MIME_TYPE_URLENCODED</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-HTML-Form-Support.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-HTML-Form-Support.description"></a><h2>Description</h2> -<p>libsoup contains several help methods for processing HTML forms as -defined by <a class="ulink" href="http://www.w3.org/TR/html401/interact/forms.html#h-17.13" target="_top">the -HTML 4.01 specification</a>.</p> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-HTML-Form-Support.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="soup-form-decode"></a><h3>soup_form_decode ()</h3> -<pre class="programlisting"><span class="returnvalue">GHashTable</span> * -soup_form_decode (<em class="parameter"><code>const <span class="type">char</span> *encoded_form</code></em>);</pre> -<p>Decodes <em class="parameter"><code>form</code></em> -, which is an urlencoded dataset as defined in the -HTML 4.01 spec.</p> -<div class="refsect3"> -<a name="soup-form-decode.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>encoded_form</p></td> -<td class="parameter_description"><p>data of type "application/x-www-form-urlencoded"</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-form-decode.returns"></a><h4>Returns</h4> -<p>a hash -table containing the name/value pairs from <em class="parameter"><code>encoded_form</code></em> -, which you -can free with <code class="function">g_hash_table_destroy()</code>. </p> -<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 utf8][<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-form-decode-multipart"></a><h3>soup_form_decode_multipart ()</h3> -<pre class="programlisting"><span class="returnvalue">GHashTable</span> * -soup_form_decode_multipart (<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>const <span class="type">char</span> *file_control_name</code></em>, - <em class="parameter"><code><span class="type">char</span> **filename</code></em>, - <em class="parameter"><code><span class="type">char</span> **content_type</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessageBody.html#SoupBuffer"><span class="type">SoupBuffer</span></a> **file</code></em>);</pre> -<p>Decodes the "multipart/form-data" request in <em class="parameter"><code>msg</code></em> -; this is a -convenience method for the case when you have a single file upload -control in a form. (Or when you don't have any file upload -controls, but are still using "multipart/form-data" anyway.) Pass -the name of the file upload control in <em class="parameter"><code>file_control_name</code></em> -, and -<a class="link" href="libsoup-2.4-HTML-Form-Support.html#soup-form-decode-multipart" title="soup_form_decode_multipart ()"><code class="function">soup_form_decode_multipart()</code></a> will extract the uploaded file data -into <em class="parameter"><code>filename</code></em> -, <em class="parameter"><code>content_type</code></em> -, and <em class="parameter"><code>file</code></em> -. All of the other form -control data will be returned (as strings, as with -<a class="link" href="libsoup-2.4-HTML-Form-Support.html#soup-form-decode" title="soup_form_decode ()"><code class="function">soup_form_decode()</code></a>) in the returned <span class="type">GHashTable</span>.</p> -<p>You may pass <code class="literal">NULL</code> for <em class="parameter"><code>filename</code></em> -, <em class="parameter"><code>content_type</code></em> - and/or <em class="parameter"><code>file</code></em> - if you do not -care about those fields. <a class="link" href="libsoup-2.4-HTML-Form-Support.html#soup-form-decode-multipart" title="soup_form_decode_multipart ()"><code class="function">soup_form_decode_multipart()</code></a> may also -return <code class="literal">NULL</code> in those fields if the client did not provide that -information. You must free the returned filename and content-type -with <code class="function">g_free()</code>, and the returned file data with <a class="link" href="SoupMessageBody.html#soup-buffer-free" title="soup_buffer_free ()"><code class="function">soup_buffer_free()</code></a>.</p> -<p>If you have a form with more than one file upload control, you will -need to decode it manually, using <a class="link" href="SoupMultipart.html#soup-multipart-new-from-message" title="soup_multipart_new_from_message ()"><code class="function">soup_multipart_new_from_message()</code></a> -and <a class="link" href="SoupMultipart.html#soup-multipart-get-part" title="soup_multipart_get_part ()"><code class="function">soup_multipart_get_part()</code></a>.</p> -<div class="refsect3"> -<a name="soup-form-decode-multipart.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>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> containing a "multipart/form-data" request body</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>file_control_name</p></td> -<td class="parameter_description"><p>the name of the HTML file upload control, or <code class="literal">NULL</code>. </p></td> -<td class="parameter_annotations"><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 class="parameter_name"><p>filename</p></td> -<td class="parameter_description"><p>return location for the name of the uploaded file, or <code class="literal">NULL</code>. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>content_type</p></td> -<td class="parameter_description"><p>return location for the MIME type of the uploaded file, or <code class="literal">NULL</code>. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>file</p></td> -<td class="parameter_description"><p>return location for the uploaded file data, or <code class="literal">NULL</code>. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</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-form-decode-multipart.returns"></a><h4>Returns</h4> -<p>a hash table containing the name/value pairs (other than -<em class="parameter"><code>file_control_name</code></em> -) from <em class="parameter"><code>msg</code></em> -, which you can free with -<code class="function">g_hash_table_destroy()</code>. On error, it will return <code class="literal">NULL</code>. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 utf8][<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-form-encode"></a><h3>soup_form_encode ()</h3> -<pre class="programlisting"><span class="returnvalue">char</span> * -soup_form_encode (<em class="parameter"><code>const <span class="type">char</span> *first_field</code></em>, - <em class="parameter"><code>...</code></em>);</pre> -<p>Encodes the given field names and values into a value of type -"application/x-www-form-urlencoded", as defined in the HTML 4.01 -spec.</p> -<p>This method requires you to know the names of the form fields (or -at the very least, the total number of fields) at compile time; for -working with dynamic forms, use <a class="link" href="libsoup-2.4-HTML-Form-Support.html#soup-form-encode-hash" title="soup_form_encode_hash ()"><code class="function">soup_form_encode_hash()</code></a> or -<a class="link" href="libsoup-2.4-HTML-Form-Support.html#soup-form-encode-datalist" title="soup_form_encode_datalist ()"><code class="function">soup_form_encode_datalist()</code></a>.</p> -<div class="refsect3"> -<a name="soup-form-encode.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>first_field</p></td> -<td class="parameter_description"><p>name of the first form field</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>...</p></td> -<td class="parameter_description"><p>value of <em class="parameter"><code>first_field</code></em> -, followed by additional field names -and values, terminated by <code class="literal">NULL</code>.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-form-encode.returns"></a><h4>Returns</h4> -<p> the encoded form</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-form-encode-datalist"></a><h3>soup_form_encode_datalist ()</h3> -<pre class="programlisting"><span class="returnvalue">char</span> * -soup_form_encode_datalist (<em class="parameter"><code><span class="type">GData</span> **form_data_set</code></em>);</pre> -<p>Encodes <em class="parameter"><code>form_data_set</code></em> - into a value of type -"application/x-www-form-urlencoded", as defined in the HTML 4.01 -spec. Unlike <a class="link" href="libsoup-2.4-HTML-Form-Support.html#soup-form-encode-hash" title="soup_form_encode_hash ()"><code class="function">soup_form_encode_hash()</code></a>, this preserves the ordering -of the form elements, which may be required in some situations.</p> -<div class="refsect3"> -<a name="soup-form-encode-datalist.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>form_data_set</p></td> -<td class="parameter_description"><p>a datalist containing name/value pairs</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-form-encode-datalist.returns"></a><h4>Returns</h4> -<p> the encoded form</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-form-encode-hash"></a><h3>soup_form_encode_hash ()</h3> -<pre class="programlisting"><span class="returnvalue">char</span> * -soup_form_encode_hash (<em class="parameter"><code><span class="type">GHashTable</span> *form_data_set</code></em>);</pre> -<p>Encodes <em class="parameter"><code>form_data_set</code></em> - into a value of type -"application/x-www-form-urlencoded", as defined in the HTML 4.01 -spec.</p> -<p>Note that the HTML spec states that "The control names/values are -listed in the order they appear in the document." Since this method -takes a hash table, it cannot enforce that; if you care about the -ordering of the form fields, use <a class="link" href="libsoup-2.4-HTML-Form-Support.html#soup-form-encode-datalist" title="soup_form_encode_datalist ()"><code class="function">soup_form_encode_datalist()</code></a>.</p> -<div class="refsect3"> -<a name="soup-form-encode-hash.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>form_data_set</p></td> -<td class="parameter_description"><p>a hash table containing -name/value pairs (as strings). </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]</span></td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-form-encode-hash.returns"></a><h4>Returns</h4> -<p> the encoded form</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-form-encode-valist"></a><h3>soup_form_encode_valist ()</h3> -<pre class="programlisting"><span class="returnvalue">char</span> * -soup_form_encode_valist (<em class="parameter"><code>const <span class="type">char</span> *first_field</code></em>, - <em class="parameter"><code><span class="type">va_list</span> args</code></em>);</pre> -<p>See <a class="link" href="libsoup-2.4-HTML-Form-Support.html#soup-form-encode" title="soup_form_encode ()"><code class="function">soup_form_encode()</code></a>. This is mostly an internal method, used by -various other methods such as <a class="link" href="SoupURI.html#soup-uri-set-query-from-fields" title="soup_uri_set_query_from_fields ()"><code class="function">soup_uri_set_query_from_fields()</code></a> and -<a class="link" href="libsoup-2.4-HTML-Form-Support.html#soup-form-request-new" title="soup_form_request_new ()"><code class="function">soup_form_request_new()</code></a>.</p> -<div class="refsect3"> -<a name="soup-form-encode-valist.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>first_field</p></td> -<td class="parameter_description"><p>name of the first form field</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>args</p></td> -<td class="parameter_description"><p>pointer to additional values, as in <a class="link" href="libsoup-2.4-HTML-Form-Support.html#soup-form-encode" title="soup_form_encode ()"><code class="function">soup_form_encode()</code></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-form-encode-valist.returns"></a><h4>Returns</h4> -<p> the encoded form</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-form-request-new"></a><h3>soup_form_request_new ()</h3> -<pre class="programlisting"><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="returnvalue">SoupMessage</span></a> * -soup_form_request_new (<em class="parameter"><code>const <span class="type">char</span> *method</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *uri</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *first_field</code></em>, - <em class="parameter"><code>...</code></em>);</pre> -<p>Creates a new <a class="link" href="SoupMessage.html" title="SoupMessage"><code class="literal">SoupMessage</code></a> and sets it up to send the given data -to <em class="parameter"><code>uri</code></em> - via <em class="parameter"><code>method</code></em> -. (That is, if <em class="parameter"><code>method</code></em> - is "GET", it will encode -the form data into <em class="parameter"><code>uri</code></em> -'s query field, and if <em class="parameter"><code>method</code></em> - is "POST", it -will encode it into the <a class="link" href="SoupMessage.html" title="SoupMessage"><code class="literal">SoupMessage</code></a>'s request_body.)</p> -<div class="refsect3"> -<a name="soup-form-request-new.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>method</p></td> -<td class="parameter_description"><p>the HTTP method, either "GET" or "POST"</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>uri</p></td> -<td class="parameter_description"><p>the URI to send the form data to</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>first_field</p></td> -<td class="parameter_description"><p>name of the first form field</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>...</p></td> -<td class="parameter_description"><p>value of <em class="parameter"><code>first_field</code></em> -, followed by additional field names -and values, terminated by <code class="literal">NULL</code>.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-form-request-new.returns"></a><h4>Returns</h4> -<p>the new <a class="link" href="SoupMessage.html" title="SoupMessage"><code class="literal">SoupMessage</code></a>. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-form-request-new-from-datalist"></a><h3>soup_form_request_new_from_datalist ()</h3> -<pre class="programlisting"><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="returnvalue">SoupMessage</span></a> * -soup_form_request_new_from_datalist (<em class="parameter"><code>const <span class="type">char</span> *method</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *uri</code></em>, - <em class="parameter"><code><span class="type">GData</span> **form_data_set</code></em>);</pre> -<p>Creates a new <a class="link" href="SoupMessage.html" title="SoupMessage"><code class="literal">SoupMessage</code></a> and sets it up to send <em class="parameter"><code>form_data_set</code></em> - to -<em class="parameter"><code>uri</code></em> - via <em class="parameter"><code>method</code></em> -, as with <a class="link" href="libsoup-2.4-HTML-Form-Support.html#soup-form-request-new" title="soup_form_request_new ()"><code class="function">soup_form_request_new()</code></a>.</p> -<div class="refsect3"> -<a name="soup-form-request-new-from-datalist.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>method</p></td> -<td class="parameter_description"><p>the HTTP method, either "GET" or "POST"</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>uri</p></td> -<td class="parameter_description"><p>the URI to send the form data to</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>form_data_set</p></td> -<td class="parameter_description"><p>the data to send to <em class="parameter"><code>uri</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-form-request-new-from-datalist.returns"></a><h4>Returns</h4> -<p>the new <a class="link" href="SoupMessage.html" title="SoupMessage"><code class="literal">SoupMessage</code></a>. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-form-request-new-from-hash"></a><h3>soup_form_request_new_from_hash ()</h3> -<pre class="programlisting"><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="returnvalue">SoupMessage</span></a> * -soup_form_request_new_from_hash (<em class="parameter"><code>const <span class="type">char</span> *method</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *uri</code></em>, - <em class="parameter"><code><span class="type">GHashTable</span> *form_data_set</code></em>);</pre> -<p>Creates a new <a class="link" href="SoupMessage.html" title="SoupMessage"><code class="literal">SoupMessage</code></a> and sets it up to send <em class="parameter"><code>form_data_set</code></em> - to -<em class="parameter"><code>uri</code></em> - via <em class="parameter"><code>method</code></em> -, as with <a class="link" href="libsoup-2.4-HTML-Form-Support.html#soup-form-request-new" title="soup_form_request_new ()"><code class="function">soup_form_request_new()</code></a>.</p> -<div class="refsect3"> -<a name="soup-form-request-new-from-hash.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>method</p></td> -<td class="parameter_description"><p>the HTTP method, either "GET" or "POST"</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>uri</p></td> -<td class="parameter_description"><p>the URI to send the form data to</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>form_data_set</p></td> -<td class="parameter_description"><p>the data to send to <em class="parameter"><code>uri</code></em> -. </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]</span></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-form-request-new-from-hash.returns"></a><h4>Returns</h4> -<p>the new <a class="link" href="SoupMessage.html" title="SoupMessage"><code class="literal">SoupMessage</code></a>. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-form-request-new-from-multipart"></a><h3>soup_form_request_new_from_multipart ()</h3> -<pre class="programlisting"><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="returnvalue">SoupMessage</span></a> * -soup_form_request_new_from_multipart (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>, - <em class="parameter"><code><a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a> *multipart</code></em>);</pre> -<p>Creates a new <a class="link" href="SoupMessage.html" title="SoupMessage"><code class="literal">SoupMessage</code></a> and sets it up to send <em class="parameter"><code>multipart</code></em> - to -<em class="parameter"><code>uri</code></em> - via POST.</p> -<p>To send a <code class="literal">"multipart/form-data"</code> POST, first -create a <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a>, using <a class="link" href="libsoup-2.4-HTML-Form-Support.html#SOUP-FORM-MIME-TYPE-MULTIPART:CAPS" title="SOUP_FORM_MIME_TYPE_MULTIPART"><code class="literal">SOUP_FORM_MIME_TYPE_MULTIPART</code></a> as -the MIME type. Then use <a class="link" href="SoupMultipart.html#soup-multipart-append-form-string" title="soup_multipart_append_form_string ()"><code class="function">soup_multipart_append_form_string()</code></a> and -<a class="link" href="SoupMultipart.html#soup-multipart-append-form-file" title="soup_multipart_append_form_file ()"><code class="function">soup_multipart_append_form_file()</code></a> to add the value of each form -control to the multipart. (These are just convenience methods, and -you can use <a class="link" href="SoupMultipart.html#soup-multipart-append-part" title="soup_multipart_append_part ()"><code class="function">soup_multipart_append_part()</code></a> if you need greater -control over the part headers.) Finally, call -<a class="link" href="libsoup-2.4-HTML-Form-Support.html#soup-form-request-new-from-multipart" title="soup_form_request_new_from_multipart ()"><code class="function">soup_form_request_new_from_multipart()</code></a> to serialize the multipart -structure and create a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>.</p> -<div class="refsect3"> -<a name="soup-form-request-new-from-multipart.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>uri</p></td> -<td class="parameter_description"><p>the URI to send the form data to</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>multipart</p></td> -<td class="parameter_description"><p>a "multipart/form-data" <a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-form-request-new-from-multipart.returns"></a><h4>Returns</h4> -<p>the new <a class="link" href="SoupMessage.html" title="SoupMessage"><code class="literal">SoupMessage</code></a>. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.26</p> -</div> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-HTML-Form-Support.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SOUP-FORM-MIME-TYPE-MULTIPART:CAPS"></a><h3>SOUP_FORM_MIME_TYPE_MULTIPART</h3> -<pre class="programlisting">#define SOUP_FORM_MIME_TYPE_MULTIPART "multipart/form-data" -</pre> -<p>A macro containing the value -<code class="literal">"multipart/form-data"</code>; the MIME type used for -posting form data that contains files to be uploaded.</p> -<p class="since">Since: 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-FORM-MIME-TYPE-URLENCODED:CAPS"></a><h3>SOUP_FORM_MIME_TYPE_URLENCODED</h3> -<pre class="programlisting">#define SOUP_FORM_MIME_TYPE_URLENCODED "application/x-www-form-urlencoded" -</pre> -<p>A macro containing the value -<code class="literal">"application/x-www-form-urlencoded"</code>; the default -MIME type for POSTing HTML form data.</p> -<p class="since">Since: 2.26</p> -</div> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-HTML-Form-Support.see-also"></a><h2>See Also</h2> -<p><a class="link" href="SoupMultipart.html" title="SoupMultipart"><span class="type">SoupMultipart</span></a></p> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/libsoup-2.4-Soup-Miscellaneous-Utilities.html b/docs/reference/html/libsoup-2.4-Soup-Miscellaneous-Utilities.html deleted file mode 100644 index 4b8511c2..00000000 --- a/docs/reference/html/libsoup-2.4-Soup-Miscellaneous-Utilities.html +++ /dev/null @@ -1,1934 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Soup Miscellaneous Utilities: 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="ch02.html" title="Core API"> -<link rel="prev" href="libsoup-2.4-soup-method.html" title="soup-method"> -<link rel="next" href="SoupMultipart.html" title="SoupMultipart"> -<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="#libsoup-2.4-Soup-Miscellaneous-Utilities.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#libsoup-2.4-Soup-Miscellaneous-Utilities.object-hierarchy" class="shortcut">Object Hierarchy</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="libsoup-2.4-soup-method.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="SoupMultipart.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="libsoup-2.4-Soup-Miscellaneous-Utilities"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="libsoup-2.4-Soup-Miscellaneous-Utilities.top_of_page"></a>Soup Miscellaneous Utilities</span></h2> -<p>Soup Miscellaneous Utilities — Miscellaneous functions</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="libsoup-2.4-Soup-Miscellaneous-Utilities.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="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="returnvalue">SoupDate</span></a> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-new" title="soup_date_new ()">soup_date_new</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="returnvalue">SoupDate</span></a> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-new-from-string" title="soup_date_new_from_string ()">soup_date_new_from_string</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="returnvalue">SoupDate</span></a> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-new-from-time-t" title="soup_date_new_from_time_t ()">soup_date_new_from_time_t</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="returnvalue">SoupDate</span></a> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-new-from-now" title="soup_date_new_from_now ()">soup_date_new_from_now</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="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-to-string" title="soup_date_to_string ()">soup_date_to_string</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">time_t</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-to-time-t" title="soup_date_to_time_t ()">soup_date_to_time_t</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-to-timeval" title="soup_date_to_timeval ()">soup_date_to_timeval</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-is-past" title="soup_date_is_past ()">soup_date_is_past</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">int</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-day" title="soup_date_get_day ()">soup_date_get_day</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">int</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-hour" title="soup_date_get_hour ()">soup_date_get_hour</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">int</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-minute" title="soup_date_get_minute ()">soup_date_get_minute</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">int</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-month" title="soup_date_get_month ()">soup_date_get_month</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">int</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-offset" title="soup_date_get_offset ()">soup_date_get_offset</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">int</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-second" title="soup_date_get_second ()">soup_date_get_second</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">int</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-utc" title="soup_date_get_utc ()">soup_date_get_utc</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">int</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-year" title="soup_date_get_year ()">soup_date_get_year</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-free" title="soup_date_free ()">soup_date_free</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">guint</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-headers-parse-request" title="soup_headers_parse_request ()">soup_headers_parse_request</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-headers-parse-response" title="soup_headers_parse_response ()">soup_headers_parse_response</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-headers-parse-status-line" title="soup_headers_parse_status_line ()">soup_headers_parse_status_line</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-headers-parse" title="soup_headers_parse ()">soup_headers_parse</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GSList</span> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-parse-list" title="soup_header_parse_list ()">soup_header_parse_list</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GSList</span> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-parse-quality-list" title="soup_header_parse_quality_list ()">soup_header_parse_quality_list</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-free-list" title="soup_header_free_list ()">soup_header_free_list</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-contains" title="soup_header_contains ()">soup_header_contains</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GHashTable</span> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-parse-param-list" title="soup_header_parse_param_list ()">soup_header_parse_param_list</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GHashTable</span> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-parse-semi-param-list" title="soup_header_parse_semi_param_list ()">soup_header_parse_semi_param_list</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-free-param-list" title="soup_header_free_param_list ()">soup_header_free_param_list</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-g-string-append-param" title="soup_header_g_string_append_param ()">soup_header_g_string_append_param</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-g-string-append-param-quoted" title="soup_header_g_string_append_param_quoted ()">soup_header_g_string_append_param_quoted</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-str-case-equal" title="soup_str_case_equal ()">soup_str_case_equal</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">guint</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-str-case-hash" title="soup_str_case_hash ()">soup_str_case_hash</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GSource</span> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-add-completion" title="soup_add_completion ()">soup_add_completion</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GSource</span> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-add-idle" title="soup_add_idle ()">soup_add_idle</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GSource</span> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-add-io-watch" title="soup_add_io_watch ()">soup_add_io_watch</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GSource</span> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-add-timeout" title="soup_add_timeout ()">soup_add_timeout</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<a name="SoupDate"></a><div class="refsect1"> -<a name="libsoup-2.4-Soup-Miscellaneous-Utilities.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="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate-struct" title="SoupDate">SoupDate</a></td> -</tr> -<tr> -<td class="datatype_keyword">enum</td> -<td class="function_name"><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDateFormat" title="enum SoupDateFormat">SoupDateFormat</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-Soup-Miscellaneous-Utilities.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> <a href="/home/claudio/gnome3/share/gtk-doc/html/gobject/gobject-Boxed-Types.html">GBoxed</a> - <span class="lineart">╰──</span> SoupDate -</pre> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-Soup-Miscellaneous-Utilities.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-Soup-Miscellaneous-Utilities.description"></a><h2>Description</h2> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-Soup-Miscellaneous-Utilities.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="soup-date-new"></a><h3>soup_date_new ()</h3> -<pre class="programlisting"><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="returnvalue">SoupDate</span></a> * -soup_date_new (<em class="parameter"><code><span class="type">int</span> year</code></em>, - <em class="parameter"><code><span class="type">int</span> month</code></em>, - <em class="parameter"><code><span class="type">int</span> day</code></em>, - <em class="parameter"><code><span class="type">int</span> hour</code></em>, - <em class="parameter"><code><span class="type">int</span> minute</code></em>, - <em class="parameter"><code><span class="type">int</span> second</code></em>);</pre> -<p>Creates a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> representing the indicated time, UTC.</p> -<div class="refsect3"> -<a name="soup-date-new.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>year</p></td> -<td class="parameter_description"><p>the year (1-9999)</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>month</p></td> -<td class="parameter_description"><p>the month (1-12)</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>day</p></td> -<td class="parameter_description"><p>the day of the month (1-31, as appropriate for <em class="parameter"><code>month</code></em> -)</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>hour</p></td> -<td class="parameter_description"><p>the hour (0-23)</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>minute</p></td> -<td class="parameter_description"><p>the minute (0-59)</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>second</p></td> -<td class="parameter_description"><p>the second (0-59, or up to 61 for leap seconds)</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-date-new.returns"></a><h4>Returns</h4> -<p> a new <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-date-new-from-string"></a><h3>soup_date_new_from_string ()</h3> -<pre class="programlisting"><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="returnvalue">SoupDate</span></a> * -soup_date_new_from_string (<em class="parameter"><code>const <span class="type">char</span> *date_string</code></em>);</pre> -<p>Parses <em class="parameter"><code>date_string</code></em> - and tries to extract a date from it. This -recognizes all of the "HTTP-date" formats from RFC 2616, all ISO -8601 formats containing both a time and a date, RFC 2822 dates, -and reasonable approximations thereof. (Eg, it is lenient about -whitespace, leading "0"s, etc.)</p> -<div class="refsect3"> -<a name="soup-date-new-from-string.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>date_string</p></td> -<td class="parameter_description"><p>the date in some plausible format</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-date-new-from-string.returns"></a><h4>Returns</h4> -<p>a new <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a>, or <code class="literal">NULL</code> if <em class="parameter"><code>date_string</code></em> -could not be parsed. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-date-new-from-time-t"></a><h3>soup_date_new_from_time_t ()</h3> -<pre class="programlisting"><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="returnvalue">SoupDate</span></a> * -soup_date_new_from_time_t (<em class="parameter"><code><span class="type">time_t</span> when</code></em>);</pre> -<p>Creates a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> corresponding to <em class="parameter"><code>when</code></em> -</p> -<div class="refsect3"> -<a name="soup-date-new-from-time-t.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>when</p></td> -<td class="parameter_description"><p>a <span class="type">time_t</span></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-date-new-from-time-t.returns"></a><h4>Returns</h4> -<p> a new <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-date-new-from-now"></a><h3>soup_date_new_from_now ()</h3> -<pre class="programlisting"><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="returnvalue">SoupDate</span></a> * -soup_date_new_from_now (<em class="parameter"><code><span class="type">int</span> offset_seconds</code></em>);</pre> -<p>Creates a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> representing a time <em class="parameter"><code>offset_seconds</code></em> - after the -current time (or before it, if <em class="parameter"><code>offset_seconds</code></em> - is negative). If -offset_seconds is 0, returns the current time.</p> -<p>If <em class="parameter"><code>offset_seconds</code></em> - would indicate a time not expressible as a</p> -<span class="type">time_t</span>, the return value will be clamped into range. -<div class="refsect3"> -<a name="soup-date-new-from-now.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>offset_seconds</p></td> -<td class="parameter_description"><p>offset from current time</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-date-new-from-now.returns"></a><h4>Returns</h4> -<p> a new <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-date-to-string"></a><h3>soup_date_to_string ()</h3> -<pre class="programlisting"><span class="returnvalue">char</span> * -soup_date_to_string (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>, - <em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDateFormat" title="enum SoupDateFormat"><span class="type">SoupDateFormat</span></a> format</code></em>);</pre> -<p>Converts <em class="parameter"><code>date</code></em> - to a string in the format described by <em class="parameter"><code>format</code></em> -.</p> -<div class="refsect3"> -<a name="soup-date-to-string.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>date</p></td> -<td class="parameter_description"><p>a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>format</p></td> -<td class="parameter_description"><p>the format to generate the date in</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-date-to-string.returns"></a><h4>Returns</h4> -<p> <em class="parameter"><code>date</code></em> -as a string</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-date-to-time-t"></a><h3>soup_date_to_time_t ()</h3> -<pre class="programlisting"><span class="returnvalue">time_t</span> -soup_date_to_time_t (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);</pre> -<p>Converts <em class="parameter"><code>date</code></em> - to a <span class="type">time_t</span>.</p> -<p>If <em class="parameter"><code>date</code></em> - is not representable as a <span class="type">time_t</span>, it will be -clamped into range. (In particular, some HTTP cookies have -expiration dates after "Y2.038k" (2038-01-19T03:14:07Z).)</p> -<div class="refsect3"> -<a name="soup-date-to-time-t.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>date</p></td> -<td class="parameter_description"><p>a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-date-to-time-t.returns"></a><h4>Returns</h4> -<p> <em class="parameter"><code>date</code></em> -as a <span class="type">time_t</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-date-to-timeval"></a><h3>soup_date_to_timeval ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_date_to_timeval (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>, - <em class="parameter"><code><span class="type">GTimeVal</span> *time</code></em>);</pre> -<p>Converts <em class="parameter"><code>date</code></em> - to a <span class="type">GTimeVal</span>.</p> -<div class="refsect3"> -<a name="soup-date-to-timeval.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>date</p></td> -<td class="parameter_description"><p>a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>time</p></td> -<td class="parameter_description"><p>a <span class="type">GTimeVal</span> structure in which to store the converted time. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-date-is-past"></a><h3>soup_date_is_past ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_date_is_past (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);</pre> -<p>Determines if <em class="parameter"><code>date</code></em> - is in the past.</p> -<div class="refsect3"> -<a name="soup-date-is-past.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>date</p></td> -<td class="parameter_description"><p>a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-date-is-past.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if <em class="parameter"><code>date</code></em> -is in the past</p> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-date-get-day"></a><h3>soup_date_get_day ()</h3> -<pre class="programlisting"><span class="returnvalue">int</span> -soup_date_get_day (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);</pre> -<p>Gets <em class="parameter"><code>date</code></em> -'s day.</p> -<div class="refsect3"> -<a name="soup-date-get-day.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>date</p></td> -<td class="parameter_description"><p>a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-date-get-day.returns"></a><h4>Returns</h4> -<p> <em class="parameter"><code>date</code></em> -'s day</p> -</div> -<p class="since">Since: 2.32</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-date-get-hour"></a><h3>soup_date_get_hour ()</h3> -<pre class="programlisting"><span class="returnvalue">int</span> -soup_date_get_hour (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);</pre> -<p>Gets <em class="parameter"><code>date</code></em> -'s hour.</p> -<div class="refsect3"> -<a name="soup-date-get-hour.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>date</p></td> -<td class="parameter_description"><p>a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-date-get-hour.returns"></a><h4>Returns</h4> -<p> <em class="parameter"><code>date</code></em> -'s hour</p> -</div> -<p class="since">Since: 2.32</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-date-get-minute"></a><h3>soup_date_get_minute ()</h3> -<pre class="programlisting"><span class="returnvalue">int</span> -soup_date_get_minute (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);</pre> -<p>Gets <em class="parameter"><code>date</code></em> -'s minute.</p> -<div class="refsect3"> -<a name="soup-date-get-minute.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>date</p></td> -<td class="parameter_description"><p>a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-date-get-minute.returns"></a><h4>Returns</h4> -<p> <em class="parameter"><code>date</code></em> -'s minute</p> -</div> -<p class="since">Since: 2.32</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-date-get-month"></a><h3>soup_date_get_month ()</h3> -<pre class="programlisting"><span class="returnvalue">int</span> -soup_date_get_month (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);</pre> -<p>Gets <em class="parameter"><code>date</code></em> -'s month.</p> -<div class="refsect3"> -<a name="soup-date-get-month.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>date</p></td> -<td class="parameter_description"><p>a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-date-get-month.returns"></a><h4>Returns</h4> -<p> <em class="parameter"><code>date</code></em> -'s month</p> -</div> -<p class="since">Since: 2.32</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-date-get-offset"></a><h3>soup_date_get_offset ()</h3> -<pre class="programlisting"><span class="returnvalue">int</span> -soup_date_get_offset (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);</pre> -<p>Gets <em class="parameter"><code>date</code></em> -'s offset from UTC.</p> -<div class="refsect3"> -<a name="soup-date-get-offset.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>date</p></td> -<td class="parameter_description"><p>a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-date-get-offset.returns"></a><h4>Returns</h4> -<p> <em class="parameter"><code>date</code></em> -'s offset from UTC. If <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-utc" title="soup_date_get_utc ()"><code class="function">soup_date_get_utc()</code></a> -returns <code class="literal">FALSE</code> but <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-offset" title="soup_date_get_offset ()"><code class="function">soup_date_get_offset()</code></a> returns 0, that means the -date is a "floating" time with no associated offset information.</p> -</div> -<p class="since">Since: 2.32</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-date-get-second"></a><h3>soup_date_get_second ()</h3> -<pre class="programlisting"><span class="returnvalue">int</span> -soup_date_get_second (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);</pre> -<p>Gets <em class="parameter"><code>date</code></em> -'s second.</p> -<div class="refsect3"> -<a name="soup-date-get-second.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>date</p></td> -<td class="parameter_description"><p>a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-date-get-second.returns"></a><h4>Returns</h4> -<p> <em class="parameter"><code>date</code></em> -'s second</p> -</div> -<p class="since">Since: 2.32</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-date-get-utc"></a><h3>soup_date_get_utc ()</h3> -<pre class="programlisting"><span class="returnvalue">int</span> -soup_date_get_utc (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);</pre> -<p>Gets <em class="parameter"><code>date</code></em> -'s UTC flag</p> -<div class="refsect3"> -<a name="soup-date-get-utc.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>date</p></td> -<td class="parameter_description"><p>a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-date-get-utc.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if <em class="parameter"><code>date</code></em> -is UTC.</p> -</div> -<p class="since">Since: 2.32</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-date-get-year"></a><h3>soup_date_get_year ()</h3> -<pre class="programlisting"><span class="returnvalue">int</span> -soup_date_get_year (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);</pre> -<p>Gets <em class="parameter"><code>date</code></em> -'s year.</p> -<div class="refsect3"> -<a name="soup-date-get-year.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>date</p></td> -<td class="parameter_description"><p>a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-date-get-year.returns"></a><h4>Returns</h4> -<p> <em class="parameter"><code>date</code></em> -'s year</p> -</div> -<p class="since">Since: 2.32</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-date-free"></a><h3>soup_date_free ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_date_free (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);</pre> -<p>Frees <em class="parameter"><code>date</code></em> -.</p> -<div class="refsect3"> -<a name="soup-date-free.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>date</p></td> -<td class="parameter_description"><p>a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-headers-parse-request"></a><h3>soup_headers_parse_request ()</h3> -<pre class="programlisting"><span class="returnvalue">guint</span> -soup_headers_parse_request (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>, - <em class="parameter"><code><span class="type">int</span> len</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *req_headers</code></em>, - <em class="parameter"><code><span class="type">char</span> **req_method</code></em>, - <em class="parameter"><code><span class="type">char</span> **req_path</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessage.html#SoupHTTPVersion" title="enum SoupHTTPVersion"><span class="type">SoupHTTPVersion</span></a> *ver</code></em>);</pre> -<p>Parses the headers of an HTTP request in <em class="parameter"><code>str</code></em> - and stores the -results in <em class="parameter"><code>req_method</code></em> -, <em class="parameter"><code>req_path</code></em> -, <em class="parameter"><code>ver</code></em> -, and <em class="parameter"><code>req_headers</code></em> -.</p> -<p>Beware that <em class="parameter"><code>req_headers</code></em> - may be modified even on failure.</p> -<div class="refsect3"> -<a name="soup-headers-parse-request.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>str</p></td> -<td class="parameter_description"><p>the headers (up to, but not including, the trailing blank line)</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>len</p></td> -<td class="parameter_description"><p>length of <em class="parameter"><code>str</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>req_headers</p></td> -<td class="parameter_description"><p><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> to store the header values in</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>req_method</p></td> -<td class="parameter_description"><p>if non-<code class="literal">NULL</code>, will be filled in with the -request method. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>req_path</p></td> -<td class="parameter_description"><p>if non-<code class="literal">NULL</code>, will be filled in with the -request path. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>ver</p></td> -<td class="parameter_description"><p>if non-<code class="literal">NULL</code>, will be filled in with the HTTP -version. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</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-headers-parse-request.returns"></a><h4>Returns</h4> -<p> <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-OK:CAPS"><code class="literal">SOUP_STATUS_OK</code></a> if the headers could be parsed, or an -HTTP error to be returned to the client if they could not be.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-headers-parse-response"></a><h3>soup_headers_parse_response ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_headers_parse_response (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>, - <em class="parameter"><code><span class="type">int</span> len</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *headers</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessage.html#SoupHTTPVersion" title="enum SoupHTTPVersion"><span class="type">SoupHTTPVersion</span></a> *ver</code></em>, - <em class="parameter"><code><span class="type">guint</span> *status_code</code></em>, - <em class="parameter"><code><span class="type">char</span> **reason_phrase</code></em>);</pre> -<p>Parses the headers of an HTTP response in <em class="parameter"><code>str</code></em> - and stores the -results in <em class="parameter"><code>ver</code></em> -, <em class="parameter"><code>status_code</code></em> -, <em class="parameter"><code>reason_phrase</code></em> -, and <em class="parameter"><code>headers</code></em> -.</p> -<p>Beware that <em class="parameter"><code>headers</code></em> - may be modified even on failure.</p> -<div class="refsect3"> -<a name="soup-headers-parse-response.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>str</p></td> -<td class="parameter_description"><p>the headers (up to, but not including, the trailing blank line)</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>len</p></td> -<td class="parameter_description"><p>length of <em class="parameter"><code>str</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>headers</p></td> -<td class="parameter_description"><p><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> to store the header values in</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>ver</p></td> -<td class="parameter_description"><p>if non-<code class="literal">NULL</code>, will be filled in with the HTTP -version. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>status_code</p></td> -<td class="parameter_description"><p>if non-<code class="literal">NULL</code>, will be filled in with -the status code. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>reason_phrase</p></td> -<td class="parameter_description"><p>if non-<code class="literal">NULL</code>, will be filled in with -the reason phrase. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</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-headers-parse-response.returns"></a><h4>Returns</h4> -<p> success or failure.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-headers-parse-status-line"></a><h3>soup_headers_parse_status_line ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_headers_parse_status_line (<em class="parameter"><code>const <span class="type">char</span> *status_line</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessage.html#SoupHTTPVersion" title="enum SoupHTTPVersion"><span class="type">SoupHTTPVersion</span></a> *ver</code></em>, - <em class="parameter"><code><span class="type">guint</span> *status_code</code></em>, - <em class="parameter"><code><span class="type">char</span> **reason_phrase</code></em>);</pre> -<p>Parses the HTTP Status-Line string in <em class="parameter"><code>status_line</code></em> - into <em class="parameter"><code>ver</code></em> -, -<em class="parameter"><code>status_code</code></em> -, and <em class="parameter"><code>reason_phrase</code></em> -. <em class="parameter"><code>status_line</code></em> - must be terminated by -either "\0" or "\r\n".</p> -<div class="refsect3"> -<a name="soup-headers-parse-status-line.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>status_line</p></td> -<td class="parameter_description"><p>an HTTP Status-Line</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>ver</p></td> -<td class="parameter_description"><p>if non-<code class="literal">NULL</code>, will be filled in with the HTTP -version. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>status_code</p></td> -<td class="parameter_description"><p>if non-<code class="literal">NULL</code>, will be filled in with -the status code. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>reason_phrase</p></td> -<td class="parameter_description"><p>if non-<code class="literal">NULL</code>, will be filled in with -the reason phrase. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</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-headers-parse-status-line.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if <em class="parameter"><code>status_line</code></em> -was parsed successfully.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-headers-parse"></a><h3>soup_headers_parse ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_headers_parse (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>, - <em class="parameter"><code><span class="type">int</span> len</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *dest</code></em>);</pre> -<p>Parses the headers of an HTTP request or response in <em class="parameter"><code>str</code></em> - and -stores the results in <em class="parameter"><code>dest</code></em> -. Beware that <em class="parameter"><code>dest</code></em> - may be modified even -on failure.</p> -<p>This is a low-level method; normally you would use -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-headers-parse-request" title="soup_headers_parse_request ()"><code class="function">soup_headers_parse_request()</code></a> or <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-headers-parse-response" title="soup_headers_parse_response ()"><code class="function">soup_headers_parse_response()</code></a>.</p> -<div class="refsect3"> -<a name="soup-headers-parse.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>str</p></td> -<td class="parameter_description"><p>the header string (including the Request-Line or Status-Line, -but not the trailing blank line)</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>len</p></td> -<td class="parameter_description"><p>length of <em class="parameter"><code>str</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>dest</p></td> -<td class="parameter_description"><p><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> to store the header values in</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-headers-parse.returns"></a><h4>Returns</h4> -<p> success or failure</p> -</div> -<p class="since">Since: 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-header-parse-list"></a><h3>soup_header_parse_list ()</h3> -<pre class="programlisting"><span class="returnvalue">GSList</span> * -soup_header_parse_list (<em class="parameter"><code>const <span class="type">char</span> *header</code></em>);</pre> -<p>Parses a header whose content is described by RFC2616 as -"<span class="type">something</span>", where "something" does not itself contain commas, -except as part of quoted-strings.</p> -<div class="refsect3"> -<a name="soup-header-parse-list.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>header</p></td> -<td class="parameter_description"><p>a header value</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-header-parse-list.returns"></a><h4>Returns</h4> -<p>a <span class="type">GSList</span> of -list elements, as allocated strings. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-header-parse-quality-list"></a><h3>soup_header_parse_quality_list ()</h3> -<pre class="programlisting"><span class="returnvalue">GSList</span> * -soup_header_parse_quality_list (<em class="parameter"><code>const <span class="type">char</span> *header</code></em>, - <em class="parameter"><code><span class="type">GSList</span> **unacceptable</code></em>);</pre> -<p>Parses a header whose content is a list of items with optional -"qvalue"s (eg, Accept, Accept-Charset, Accept-Encoding, -Accept-Language, TE).</p> -<p>If <em class="parameter"><code>unacceptable</code></em> - is not <code class="literal">NULL</code>, then on return, it will contain the -items with qvalue 0. Either way, those items will be removed from -the main list.</p> -<div class="refsect3"> -<a name="soup-header-parse-quality-list.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>header</p></td> -<td class="parameter_description"><p>a header value</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>unacceptable</p></td> -<td class="parameter_description"><p>on -return, will contain a list of unacceptable values. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-header-parse-quality-list.returns"></a><h4>Returns</h4> -<p>a <span class="type">GSList</span> of -acceptable values (as allocated strings), highest-qvalue first. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-header-free-list"></a><h3>soup_header_free_list ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_header_free_list (<em class="parameter"><code><span class="type">GSList</span> *list</code></em>);</pre> -<p>Frees <em class="parameter"><code>list</code></em> -.</p> -<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> -<div class="refsect3"> -<a name="soup-header-free-list.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>list</p></td> -<td class="parameter_description"><p>a <span class="type">GSList</span> returned from <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-parse-list" title="soup_header_parse_list ()"><code class="function">soup_header_parse_list()</code></a> or -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-parse-quality-list" title="soup_header_parse_quality_list ()"><code class="function">soup_header_parse_quality_list()</code></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-header-contains"></a><h3>soup_header_contains ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_header_contains (<em class="parameter"><code>const <span class="type">char</span> *header</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *token</code></em>);</pre> -<p>Parses <em class="parameter"><code>header</code></em> - to see if it contains the token <em class="parameter"><code>token</code></em> - (matched -case-insensitively). Note that this can't be used with lists -that have qvalues.</p> -<div class="refsect3"> -<a name="soup-header-contains.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>header</p></td> -<td class="parameter_description"><p>An HTTP header suitable for parsing with -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-parse-list" title="soup_header_parse_list ()"><code class="function">soup_header_parse_list()</code></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>token</p></td> -<td class="parameter_description"><p>a token</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-header-contains.returns"></a><h4>Returns</h4> -<p> whether or not <em class="parameter"><code>header</code></em> -contains <em class="parameter"><code>token</code></em> -</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-header-parse-param-list"></a><h3>soup_header_parse_param_list ()</h3> -<pre class="programlisting"><span class="returnvalue">GHashTable</span> * -soup_header_parse_param_list (<em class="parameter"><code>const <span class="type">char</span> *header</code></em>);</pre> -<p>Parses a header which is a comma-delimited list of something like: -<code class="literal">token [ "=" ( token | quoted-string ) ]</code>.</p> -<p>Tokens that don't have an associated value will still be added to -the resulting hash table, but with a <code class="literal">NULL</code> value.</p> -<p>This also handles RFC5987 encoding (which in HTTP is mostly used -for giving UTF8-encoded filenames in the Content-Disposition -header).</p> -<div class="refsect3"> -<a name="soup-header-parse-param-list.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>header</p></td> -<td class="parameter_description"><p>a header value</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-header-parse-param-list.returns"></a><h4>Returns</h4> -<p>a -<span class="type">GHashTable</span> of list elements, which can be freed with -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-free-param-list" title="soup_header_free_param_list ()"><code class="function">soup_header_free_param_list()</code></a>. </p> -<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 utf8][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-header-parse-semi-param-list"></a><h3>soup_header_parse_semi_param_list ()</h3> -<pre class="programlisting"><span class="returnvalue">GHashTable</span> * -soup_header_parse_semi_param_list (<em class="parameter"><code>const <span class="type">char</span> *header</code></em>);</pre> -<p>Parses a header which is a semicolon-delimited list of something -like: <code class="literal">token [ "=" ( token | quoted-string ) ]</code>.</p> -<p>Tokens that don't have an associated value will still be added to -the resulting hash table, but with a <code class="literal">NULL</code> value.</p> -<p>This also handles RFC5987 encoding (which in HTTP is mostly used -for giving UTF8-encoded filenames in the Content-Disposition -header).</p> -<div class="refsect3"> -<a name="soup-header-parse-semi-param-list.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>header</p></td> -<td class="parameter_description"><p>a header value</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-header-parse-semi-param-list.returns"></a><h4>Returns</h4> -<p>a -<span class="type">GHashTable</span> of list elements, which can be freed with -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-free-param-list" title="soup_header_free_param_list ()"><code class="function">soup_header_free_param_list()</code></a>. </p> -<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 utf8][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-header-free-param-list"></a><h3>soup_header_free_param_list ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_header_free_param_list (<em class="parameter"><code><span class="type">GHashTable</span> *param_list</code></em>);</pre> -<p>Frees <em class="parameter"><code>param_list</code></em> -.</p> -<div class="refsect3"> -<a name="soup-header-free-param-list.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>param_list</p></td> -<td class="parameter_description"><p>a <span class="type">GHashTable</span> returned from <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-parse-param-list" title="soup_header_parse_param_list ()"><code class="function">soup_header_parse_param_list()</code></a> -or <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-parse-semi-param-list" title="soup_header_parse_semi_param_list ()"><code class="function">soup_header_parse_semi_param_list()</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]</span></td> -</tr></tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-header-g-string-append-param"></a><h3>soup_header_g_string_append_param ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_header_g_string_append_param (<em class="parameter"><code><span class="type">GString</span> *string</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *name</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre> -<p>Appends something like <code class="literal"><em class="parameter"><code>name</code></em> -=<em class="parameter"><code>value</code></em> -</code> to <em class="parameter"><code>string</code></em> -, -taking care to quote <em class="parameter"><code>value</code></em> - if needed, and if so, to escape any -quotes or backslashes in <em class="parameter"><code>value</code></em> -.</p> -<p>Alternatively, if <em class="parameter"><code>value</code></em> - is a non-ASCII UTF-8 string, it will be -appended using RFC5987 syntax. Although in theory this is supposed -to work anywhere in HTTP that uses this style of parameter, in -reality, it can only be used portably with the Content-Disposition -"filename" parameter.</p> -<p>If <em class="parameter"><code>value</code></em> - is <code class="literal">NULL</code>, this will just append <em class="parameter"><code>name</code></em> - to <em class="parameter"><code>string</code></em> -.</p> -<div class="refsect3"> -<a name="soup-header-g-string-append-param.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>string</p></td> -<td class="parameter_description"><p>a <span class="type">GString</span> being used to construct an HTTP header value</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>name</p></td> -<td class="parameter_description"><p>a parameter name</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>value</p></td> -<td class="parameter_description"><p>a parameter value, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.26</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-header-g-string-append-param-quoted"></a><h3>soup_header_g_string_append_param_quoted ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_header_g_string_append_param_quoted - (<em class="parameter"><code><span class="type">GString</span> *string</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *name</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre> -<p>Appends something like <code class="literal"><em class="parameter"><code>name</code></em> -="<em class="parameter"><code>value</code></em> -"</code> to -<em class="parameter"><code>string</code></em> -, taking care to escape any quotes or backslashes in <em class="parameter"><code>value</code></em> -.</p> -<p>If <em class="parameter"><code>value</code></em> - is (non-ASCII) UTF-8, this will instead use RFC 5987 -encoding, just like <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-g-string-append-param" title="soup_header_g_string_append_param ()"><code class="function">soup_header_g_string_append_param()</code></a>.</p> -<div class="refsect3"> -<a name="soup-header-g-string-append-param-quoted.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>string</p></td> -<td class="parameter_description"><p>a <span class="type">GString</span> being used to construct an HTTP header value</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>name</p></td> -<td class="parameter_description"><p>a parameter name</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>value</p></td> -<td class="parameter_description"><p>a parameter value</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.30</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-str-case-equal"></a><h3>soup_str_case_equal ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_str_case_equal (<em class="parameter"><code><span class="type">gconstpointer</span> v1</code></em>, - <em class="parameter"><code><span class="type">gconstpointer</span> v2</code></em>);</pre> -<p>Compares <em class="parameter"><code>v1</code></em> - and <em class="parameter"><code>v2</code></em> - in a case-insensitive manner</p> -<div class="refsect3"> -<a name="soup-str-case-equal.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>v1</p></td> -<td class="parameter_description"><p>an ASCII string</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>v2</p></td> -<td class="parameter_description"><p>another ASCII string</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-str-case-equal.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if they are equal (modulo case)</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-str-case-hash"></a><h3>soup_str_case_hash ()</h3> -<pre class="programlisting"><span class="returnvalue">guint</span> -soup_str_case_hash (<em class="parameter"><code><span class="type">gconstpointer</span> key</code></em>);</pre> -<p>Hashes <em class="parameter"><code>key</code></em> - in a case-insensitive manner.</p> -<div class="refsect3"> -<a name="soup-str-case-hash.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>key</p></td> -<td class="parameter_description"><p>ASCII string to hash</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-str-case-hash.returns"></a><h4>Returns</h4> -<p> the hash code.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-add-completion"></a><h3>soup_add_completion ()</h3> -<pre class="programlisting"><span class="returnvalue">GSource</span> * -soup_add_completion (<em class="parameter"><code><span class="type">GMainContext</span> *async_context</code></em>, - <em class="parameter"><code><span class="type">GSourceFunc</span> function</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre> -<p>Adds <em class="parameter"><code>function</code></em> - to be executed from inside <em class="parameter"><code>async_context</code></em> - with the -default priority. Use this when you want to complete an action in -<em class="parameter"><code>async_context</code></em> -'s main loop, as soon as possible.</p> -<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> -<div class="refsect3"> -<a name="soup-add-completion.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>async_context</p></td> -<td class="parameter_description"><p>the <span class="type">GMainContext</span> to dispatch the I/O -watch in, or <code class="literal">NULL</code> for the default context. </p></td> -<td class="parameter_annotations"><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 class="parameter_name"><p>function</p></td> -<td class="parameter_description"><p>the callback to invoke</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>data</p></td> -<td class="parameter_description"><p>user data to pass to <em class="parameter"><code>function</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-add-completion.returns"></a><h4>Returns</h4> -<p> a <span class="type">GSource</span>, which can be removed from <em class="parameter"><code>async_context</code></em> -with <code class="function">g_source_destroy()</code>.</p> -</div> -<p class="since">Since: 2.24</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-add-idle"></a><h3>soup_add_idle ()</h3> -<pre class="programlisting"><span class="returnvalue">GSource</span> * -soup_add_idle (<em class="parameter"><code><span class="type">GMainContext</span> *async_context</code></em>, - <em class="parameter"><code><span class="type">GSourceFunc</span> function</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre> -<p>Adds an idle event as with <code class="function">g_idle_add()</code>, but using the given -<em class="parameter"><code>async_context</code></em> -.</p> -<p>If you want <em class="parameter"><code>function</code></em> - to run "right away", use -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-add-completion" title="soup_add_completion ()"><code class="function">soup_add_completion()</code></a>, since that sets a higher priority on the -<span class="type">GSource</span> than <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-add-idle" title="soup_add_idle ()"><code class="function">soup_add_idle()</code></a> does.</p> -<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> -<div class="refsect3"> -<a name="soup-add-idle.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>async_context</p></td> -<td class="parameter_description"><p>the <span class="type">GMainContext</span> to dispatch the I/O -watch in, or <code class="literal">NULL</code> for the default context. </p></td> -<td class="parameter_annotations"><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 class="parameter_name"><p>function</p></td> -<td class="parameter_description"><p>the callback to invoke at idle time</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>data</p></td> -<td class="parameter_description"><p>user data to pass to <em class="parameter"><code>function</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-add-idle.returns"></a><h4>Returns</h4> -<p> a <span class="type">GSource</span>, which can be removed from <em class="parameter"><code>async_context</code></em> -with <code class="function">g_source_destroy()</code>.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-add-io-watch"></a><h3>soup_add_io_watch ()</h3> -<pre class="programlisting"><span class="returnvalue">GSource</span> * -soup_add_io_watch (<em class="parameter"><code><span class="type">GMainContext</span> *async_context</code></em>, - <em class="parameter"><code><span class="type">GIOChannel</span> *chan</code></em>, - <em class="parameter"><code><span class="type">GIOCondition</span> condition</code></em>, - <em class="parameter"><code><span class="type">GIOFunc</span> function</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre> -<p>Adds an I/O watch as with <code class="function">g_io_add_watch()</code>, but using the given -<em class="parameter"><code>async_context</code></em> -.</p> -<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> -<div class="refsect3"> -<a name="soup-add-io-watch.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>async_context</p></td> -<td class="parameter_description"><p>the <span class="type">GMainContext</span> to dispatch the I/O -watch in, or <code class="literal">NULL</code> for the default context. </p></td> -<td class="parameter_annotations"><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 class="parameter_name"><p>chan</p></td> -<td class="parameter_description"><p>the <span class="type">GIOChannel</span> to watch</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>condition</p></td> -<td class="parameter_description"><p>the condition to watch for</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>function</p></td> -<td class="parameter_description"><p>the callback to invoke when <em class="parameter"><code>condition</code></em> -occurs</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>data</p></td> -<td class="parameter_description"><p>user data to pass to <em class="parameter"><code>function</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-add-io-watch.returns"></a><h4>Returns</h4> -<p> a <span class="type">GSource</span>, which can be removed from <em class="parameter"><code>async_context</code></em> -with <code class="function">g_source_destroy()</code>.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-add-timeout"></a><h3>soup_add_timeout ()</h3> -<pre class="programlisting"><span class="returnvalue">GSource</span> * -soup_add_timeout (<em class="parameter"><code><span class="type">GMainContext</span> *async_context</code></em>, - <em class="parameter"><code><span class="type">guint</span> interval</code></em>, - <em class="parameter"><code><span class="type">GSourceFunc</span> function</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre> -<p>Adds a timeout as with <code class="function">g_timeout_add()</code>, but using the given -<em class="parameter"><code>async_context</code></em> -.</p> -<p><span class="annotation">[<acronym title="Exposed in C code, not necessarily available in other languages."><span class="acronym">skip</span></acronym>]</span></p> -<div class="refsect3"> -<a name="soup-add-timeout.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>async_context</p></td> -<td class="parameter_description"><p>the <span class="type">GMainContext</span> to dispatch the I/O -watch in, or <code class="literal">NULL</code> for the default context. </p></td> -<td class="parameter_annotations"><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 class="parameter_name"><p>interval</p></td> -<td class="parameter_description"><p>the timeout interval, in milliseconds</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>function</p></td> -<td class="parameter_description"><p>the callback to invoke at timeout time</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>data</p></td> -<td class="parameter_description"><p>user data to pass to <em class="parameter"><code>function</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-add-timeout.returns"></a><h4>Returns</h4> -<p> a <span class="type">GSource</span>, which can be removed from <em class="parameter"><code>async_context</code></em> -with <code class="function">g_source_destroy()</code>.</p> -</div> -</div> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-Soup-Miscellaneous-Utilities.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupDate-struct"></a><h3>SoupDate</h3> -<pre class="programlisting">typedef struct { - int year; - int month; - int day; - - int hour; - int minute; - int second; - - gboolean utc; - int offset; -} SoupDate; -</pre> -<p>A date and time. The date is assumed to be in the (proleptic) -Gregorian calendar. The time is in UTC if <em class="parameter"><code>utc</code></em> - is <code class="literal">TRUE</code>. Otherwise, -the time is a local time, and <em class="parameter"><code>offset</code></em> - gives the offset from UTC in -minutes (such that adding <em class="parameter"><code>offset</code></em> - to the time would give the -correct UTC time). If <em class="parameter"><code>utc</code></em> - is <code class="literal">FALSE</code> and <em class="parameter"><code>offset</code></em> - is 0, then the -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><code class="literal">SoupDate</code></a> represents a "floating" time with no associated timezone -information.</p> -<div class="refsect3"> -<a name="SoupDate.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="struct_members_name"> -<col class="struct_members_description"> -<col width="200px" class="struct_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="struct_member_name"><p><span class="type">int</span> <em class="structfield"><code><a name="SoupDate-struct.year"></a>year</code></em>;</p></td> -<td class="struct_member_description"><p>the year, 1 to 9999</p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><span class="type">int</span> <em class="structfield"><code><a name="SoupDate-struct.month"></a>month</code></em>;</p></td> -<td class="struct_member_description"><p>the month, 1 to 12</p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><span class="type">int</span> <em class="structfield"><code><a name="SoupDate-struct.day"></a>day</code></em>;</p></td> -<td class="struct_member_description"><p>day of the month, 1 to 31</p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><span class="type">int</span> <em class="structfield"><code><a name="SoupDate-struct.hour"></a>hour</code></em>;</p></td> -<td class="struct_member_description"><p>hour of the day, 0 to 23</p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><span class="type">int</span> <em class="structfield"><code><a name="SoupDate-struct.minute"></a>minute</code></em>;</p></td> -<td class="struct_member_description"><p>minute, 0 to 59</p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><span class="type">int</span> <em class="structfield"><code><a name="SoupDate-struct.second"></a>second</code></em>;</p></td> -<td class="struct_member_description"><p>second, 0 to 59 (or up to 61 in the case of leap seconds)</p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><span class="type">gboolean</span> <em class="structfield"><code><a name="SoupDate-struct.utc"></a>utc</code></em>;</p></td> -<td class="struct_member_description"><p><code class="literal">TRUE</code> if the date is in UTC</p></td> -<td class="struct_member_annotations"> </td> -</tr> -<tr> -<td class="struct_member_name"><p><span class="type">int</span> <em class="structfield"><code><a name="SoupDate-struct.offset"></a>offset</code></em>;</p></td> -<td class="struct_member_description"><p>offset from UTC</p></td> -<td class="struct_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SoupDateFormat"></a><h3>enum SoupDateFormat</h3> -<p>Date formats that <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-to-string" title="soup_date_to_string ()"><code class="function">soup_date_to_string()</code></a> can use.</p> -<p><em class="parameter"><code>SOUP_DATE_HTTP</code></em> - and <em class="parameter"><code>SOUP_DATE_COOKIE</code></em> - always coerce the time to -UTC. <em class="parameter"><code>SOUP_DATE_ISO8601_XMLRPC</code></em> - uses the time as given, ignoring the -offset completely. <em class="parameter"><code>SOUP_DATE_RFC2822</code></em> - and the other ISO 8601 -variants use the local time, appending the offset information if -available.</p> -<p>This enum may be extended with more values in future releases.</p> -<div class="refsect3"> -<a name="SoupDateFormat.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="enum_members_name"> -<col class="enum_members_description"> -<col width="200px" class="enum_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="enum_member_name"><p><a name="SOUP-DATE-HTTP:CAPS"></a>SOUP_DATE_HTTP</p></td> -<td class="enum_member_description"> -<p>RFC 1123 format, used by the HTTP "Date" header. Eg -"Sun, 06 Nov 1994 08:49:37 GMT"</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-DATE-COOKIE:CAPS"></a>SOUP_DATE_COOKIE</p></td> -<td class="enum_member_description"> -<p>The format for the "Expires" timestamp in the -Netscape cookie specification. Eg, "Sun, 06-Nov-1994 08:49:37 GMT".</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-DATE-RFC2822:CAPS"></a>SOUP_DATE_RFC2822</p></td> -<td class="enum_member_description"> -<p>RFC 2822 format, eg "Sun, 6 Nov 1994 09:49:37 -0100"</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-DATE-ISO8601-COMPACT:CAPS"></a>SOUP_DATE_ISO8601_COMPACT</p></td> -<td class="enum_member_description"> -<p>ISO 8601 date/time with no optional -punctuation. Eg, "19941106T094937-0100".</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-DATE-ISO8601-FULL:CAPS"></a>SOUP_DATE_ISO8601_FULL</p></td> -<td class="enum_member_description"> -<p>ISO 8601 date/time with all optional -punctuation. Eg, "1994-11-06T09:49:37-01:00".</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-DATE-ISO8601:CAPS"></a>SOUP_DATE_ISO8601</p></td> -<td class="enum_member_description"> -<p>An alias for <em class="parameter"><code>SOUP_DATE_ISO8601_FULL</code></em> -.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-DATE-ISO8601-XMLRPC:CAPS"></a>SOUP_DATE_ISO8601_XMLRPC</p></td> -<td class="enum_member_description"> -<p>ISO 8601 date/time as used by XML-RPC. -Eg, "19941106T09:49:37".</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/libsoup-2.4-SoupServer-deprecated-API.html b/docs/reference/html/libsoup-2.4-SoupServer-deprecated-API.html deleted file mode 100644 index c0f4c35a..00000000 --- a/docs/reference/html/libsoup-2.4-SoupServer-deprecated-API.html +++ /dev/null @@ -1,515 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SoupServer deprecated API: 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="ch02.html" title="Core API"> -<link rel="prev" href="SoupServer.html" title="SoupServer"> -<link rel="next" href="SoupSession.html" title="SoupSession"> -<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="#libsoup-2.4-SoupServer-deprecated-API.description" class="shortcut">Description</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="SoupServer.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="SoupSession.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="libsoup-2.4-SoupServer-deprecated-API"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="libsoup-2.4-SoupServer-deprecated-API.top_of_page"></a>SoupServer deprecated API</span></h2> -<p>SoupServer deprecated API</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="libsoup-2.4-SoupServer-deprecated-API.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"> -<span class="returnvalue">guint</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-SoupServer-deprecated-API.html#soup-server-get-port" title="soup_server_get_port ()">soup_server_get_port</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupSocket.html" title="SoupSocket"><span class="returnvalue">SoupSocket</span></a> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-SoupServer-deprecated-API.html#soup-server-get-listener" title="soup_server_get_listener ()">soup_server_get_listener</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-SoupServer-deprecated-API.html#soup-server-run" title="soup_server_run ()">soup_server_run</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-SoupServer-deprecated-API.html#soup-server-run-async" title="soup_server_run_async ()">soup_server_run_async</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-SoupServer-deprecated-API.html#soup-server-quit" title="soup_server_quit ()">soup_server_quit</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GMainContext</span> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-SoupServer-deprecated-API.html#soup-server-get-async-context" title="soup_server_get_async_context ()">soup_server_get_async_context</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupSocket.html" title="SoupSocket"><span class="returnvalue">SoupSocket</span></a> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-SoupServer-deprecated-API.html#soup-client-context-get-socket" title="soup_client_context_get_socket ()">soup_client_context_get_socket</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupAddress.html" title="SoupAddress"><span class="returnvalue">SoupAddress</span></a> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-SoupServer-deprecated-API.html#soup-client-context-get-address" title="soup_client_context_get_address ()">soup_client_context_get_address</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-SoupServer-deprecated-API.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="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-SoupServer-deprecated-API.html#SOUP-SERVER-PORT:CAPS" title="SOUP_SERVER_PORT">SOUP_SERVER_PORT</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-SoupServer-deprecated-API.html#SOUP-SERVER-INTERFACE:CAPS" title="SOUP_SERVER_INTERFACE">SOUP_SERVER_INTERFACE</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-SoupServer-deprecated-API.html#SOUP-SERVER-SSL-CERT-FILE:CAPS" title="SOUP_SERVER_SSL_CERT_FILE">SOUP_SERVER_SSL_CERT_FILE</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-SoupServer-deprecated-API.html#SOUP-SERVER-SSL-KEY-FILE:CAPS" title="SOUP_SERVER_SSL_KEY_FILE">SOUP_SERVER_SSL_KEY_FILE</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-SoupServer-deprecated-API.html#SOUP-SERVER-ASYNC-CONTEXT:CAPS" title="SOUP_SERVER_ASYNC_CONTEXT">SOUP_SERVER_ASYNC_CONTEXT</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-SoupServer-deprecated-API.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-SoupServer-deprecated-API.description"></a><h2>Description</h2> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-SoupServer-deprecated-API.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="soup-server-get-port"></a><h3>soup_server_get_port ()</h3> -<pre class="programlisting"><span class="returnvalue">guint</span> -soup_server_get_port (<em class="parameter"><code><a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> *server</code></em>);</pre> -<div class="warning"> -<p><code class="literal">soup_server_get_port</code> is deprecated and should not be used in newly-written code.</p> -<p>If you are using <a class="link" href="SoupServer.html#soup-server-listen" title="soup_server_listen ()"><code class="function">soup_server_listen()</code></a>, etc, then use -<a class="link" href="SoupServer.html#soup-server-get-uris" title="soup_server_get_uris ()"><code class="function">soup_server_get_uris()</code></a> to get a list of all listening addresses.</p> -</div> -<p>Gets the TCP port that <em class="parameter"><code>server</code></em> - is listening on, if you are using -the old API.</p> -<div class="refsect3"> -<a name="soup-server-get-port.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>server</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-server-get-port.returns"></a><h4>Returns</h4> -<p> the port <em class="parameter"><code>server</code></em> -is listening on.</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-server-get-listener"></a><h3>soup_server_get_listener ()</h3> -<pre class="programlisting"><a class="link" href="SoupSocket.html" title="SoupSocket"><span class="returnvalue">SoupSocket</span></a> * -soup_server_get_listener (<em class="parameter"><code><a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> *server</code></em>);</pre> -<div class="warning"> -<p><code class="literal">soup_server_get_listener</code> is deprecated and should not be used in newly-written code.</p> -<p>If you are using <a class="link" href="SoupServer.html#soup-server-listen" title="soup_server_listen ()"><code class="function">soup_server_listen()</code></a>, etc, then use -<a class="link" href="SoupServer.html#soup-server-get-listeners" title="soup_server_get_listeners ()"><code class="function">soup_server_get_listeners()</code></a> to get a list of all listening sockets, -but note that that function returns <span class="type">GSockets</span>, not <a href="SoupSocket.html#SoupSocket-struct"><span class="type">SoupSockets</span></a>.</p> -</div> -<p>Gets <em class="parameter"><code>server</code></em> -'s listening socket, if you are using the old API.</p> -<p>You should treat this socket as read-only; writing to it or -modifiying it may cause <em class="parameter"><code>server</code></em> - to malfunction.</p> -<div class="refsect3"> -<a name="soup-server-get-listener.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>server</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-server-get-listener.returns"></a><h4>Returns</h4> -<p>the listening socket. </p> -<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-server-run"></a><h3>soup_server_run ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_server_run (<em class="parameter"><code><a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> *server</code></em>);</pre> -<div class="warning"> -<p><code class="literal">soup_server_run</code> is deprecated and should not be used in newly-written code.</p> -<p>When using <a class="link" href="SoupServer.html#soup-server-listen" title="soup_server_listen ()"><code class="function">soup_server_listen()</code></a>, etc, the server will -always listen for connections, and will process them whenever the -thread-default <span class="type">GMainContext</span> is running.</p> -</div> -<p>Starts <em class="parameter"><code>server</code></em> -, if you are using the old API, causing it to listen -for and process incoming connections. Unlike -<a class="link" href="libsoup-2.4-SoupServer-deprecated-API.html#soup-server-run-async" title="soup_server_run_async ()"><code class="function">soup_server_run_async()</code></a>, this creates a <span class="type">GMainLoop</span> and runs it, and -it will not return until someone calls <a class="link" href="libsoup-2.4-SoupServer-deprecated-API.html#soup-server-quit" title="soup_server_quit ()"><code class="function">soup_server_quit()</code></a> to stop -the server.</p> -<div class="refsect3"> -<a name="soup-server-run.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>server</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-server-run-async"></a><h3>soup_server_run_async ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_server_run_async (<em class="parameter"><code><a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> *server</code></em>);</pre> -<div class="warning"> -<p><code class="literal">soup_server_run_async</code> is deprecated and should not be used in newly-written code.</p> -<p>When using <a class="link" href="SoupServer.html#soup-server-listen" title="soup_server_listen ()"><code class="function">soup_server_listen()</code></a>, etc, the server will -always listen for connections, and will process them whenever the -thread-default <span class="type">GMainContext</span> is running.</p> -</div> -<p>Starts <em class="parameter"><code>server</code></em> -, if you are using the old API, causing it to listen -for and process incoming connections.</p> -<p>The server runs in <em class="parameter"><code>server</code></em> -'s <span class="type">GMainContext</span>. It will not actually -perform any processing unless the appropriate main loop is running. -In the simple case where you did not set the server's -<a class="link" href="libsoup-2.4-SoupServer-deprecated-API.html#SOUP-SERVER-ASYNC-CONTEXT:CAPS" title="SOUP_SERVER_ASYNC_CONTEXT"><code class="literal">SOUP_SERVER_ASYNC_CONTEXT</code></a> property, this means the server will run -whenever the glib main loop is running.</p> -<div class="refsect3"> -<a name="soup-server-run-async.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>server</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-server-quit"></a><h3>soup_server_quit ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_server_quit (<em class="parameter"><code><a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> *server</code></em>);</pre> -<div class="warning"> -<p><code class="literal">soup_server_quit</code> is deprecated and should not be used in newly-written code.</p> -<p>When using <a class="link" href="SoupServer.html#soup-server-listen" title="soup_server_listen ()"><code class="function">soup_server_listen()</code></a>, etc, the server will -always listen for connections, and will process them whenever the -thread-default <span class="type">GMainContext</span> is running.</p> -</div> -<p>Stops processing for <em class="parameter"><code>server</code></em> -, if you are using the old API. Call -this to clean up after <a class="link" href="libsoup-2.4-SoupServer-deprecated-API.html#soup-server-run-async" title="soup_server_run_async ()"><code class="function">soup_server_run_async()</code></a>, or to terminate a -call to <a class="link" href="libsoup-2.4-SoupServer-deprecated-API.html#soup-server-run" title="soup_server_run ()"><code class="function">soup_server_run()</code></a>.</p> -<p>Note that messages currently in progress will continue to be -handled, if the main loop associated with the server is resumed or -kept running.</p> -<p><em class="parameter"><code>server</code></em> - is still in a working state after this call; you can start -and stop a server as many times as you want.</p> -<div class="refsect3"> -<a name="soup-server-quit.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>server</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-server-get-async-context"></a><h3>soup_server_get_async_context ()</h3> -<pre class="programlisting"><span class="returnvalue">GMainContext</span> * -soup_server_get_async_context (<em class="parameter"><code><a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> *server</code></em>);</pre> -<div class="warning"> -<p><code class="literal">soup_server_get_async_context</code> is deprecated and should not be used in newly-written code.</p> -<p>If you are using <a class="link" href="SoupServer.html#soup-server-listen" title="soup_server_listen ()"><code class="function">soup_server_listen()</code></a>, etc, then -the server listens on the thread-default <span class="type">GMainContext</span>, and this -property is ignored.</p> -</div> -<p>Gets <em class="parameter"><code>server</code></em> -'s async_context, if you are using the old API. (With -the new API, the server runs in the thread's thread-default -<span class="type">GMainContext</span>, regardless of what this method returns.)</p> -<p>This does not add a ref to the context, so you will need to ref it -yourself if you want it to outlive its server.</p> -<div class="refsect3"> -<a name="soup-server-get-async-context.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>server</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-server-get-async-context.returns"></a><h4>Returns</h4> -<p><em class="parameter"><code>server</code></em> -'s <span class="type">GMainContext</span>, -which may be <code class="literal">NULL</code>. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-client-context-get-socket"></a><h3>soup_client_context_get_socket ()</h3> -<pre class="programlisting"><a class="link" href="SoupSocket.html" title="SoupSocket"><span class="returnvalue">SoupSocket</span></a> * -soup_client_context_get_socket (<em class="parameter"><code><a class="link" href="SoupServer.html#SoupClientContext"><span class="type">SoupClientContext</span></a> *client</code></em>);</pre> -<div class="warning"> -<p><code class="literal">soup_client_context_get_socket</code> is deprecated and should not be used in newly-written code.</p> -<p>use <a class="link" href="SoupServer.html#soup-client-context-get-gsocket" title="soup_client_context_get_gsocket ()"><code class="function">soup_client_context_get_gsocket()</code></a>, which returns -a <span class="type">GSocket</span>.</p> -</div> -<p>Retrieves the <a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a> that <em class="parameter"><code>client</code></em> - is associated with.</p> -<p>If you are using this method to observe when multiple requests are -made on the same persistent HTTP connection (eg, as the ntlm-test -test program does), you will need to pay attention to socket -destruction as well (either by using weak references, or by -connecting to the <a class="link" href="SoupSocket.html#SoupSocket-disconnected" title="The “disconnected” signal"><span class="type">“disconnected”</span></a> signal), so that you do -not get fooled when the allocator reuses the memory address of a -previously-destroyed socket to represent a new socket.</p> -<div class="refsect3"> -<a name="soup-client-context-get-socket.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>client</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html#SoupClientContext"><span class="type">SoupClientContext</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-client-context-get-socket.returns"></a><h4>Returns</h4> -<p>the <a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a> that <em class="parameter"><code>client</code></em> -is -associated with. </p> -<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-client-context-get-address"></a><h3>soup_client_context_get_address ()</h3> -<pre class="programlisting"><a class="link" href="SoupAddress.html" title="SoupAddress"><span class="returnvalue">SoupAddress</span></a> * -soup_client_context_get_address (<em class="parameter"><code><a class="link" href="SoupServer.html#SoupClientContext"><span class="type">SoupClientContext</span></a> *client</code></em>);</pre> -<div class="warning"> -<p><code class="literal">soup_client_context_get_address</code> is deprecated and should not be used in newly-written code.</p> -<p>Use <a class="link" href="SoupServer.html#soup-client-context-get-remote-address" title="soup_client_context_get_remote_address ()"><code class="function">soup_client_context_get_remote_address()</code></a>, which returns -a <span class="type">GSocketAddress</span>.</p> -</div> -<p>Retrieves the <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> associated with the remote end -of a connection.</p> -<div class="refsect3"> -<a name="soup-client-context-get-address.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>client</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupServer.html#SoupClientContext"><span class="type">SoupClientContext</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-client-context-get-address.returns"></a><h4>Returns</h4> -<p>the <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> -associated with the remote end of a connection, it may be -<code class="literal">NULL</code> if you used <a class="link" href="SoupServer.html#soup-server-accept-iostream" title="soup_server_accept_iostream ()"><code class="function">soup_server_accept_iostream()</code></a>. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> -</div> -</div> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-SoupServer-deprecated-API.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SOUP-SERVER-PORT:CAPS"></a><h3>SOUP_SERVER_PORT</h3> -<pre class="programlisting">#define SOUP_SERVER_PORT "port" -</pre> -<div class="warning"> -<p><code class="literal">SOUP_SERVER_PORT</code> is deprecated and should not be used in newly-written code.</p> -<p><a href="SoupServer.html#SoupServer-struct"><span class="type">SoupServers</span></a> can listen on multiple interfaces -at once now. Use <a class="link" href="SoupServer.html#soup-server-listen" title="soup_server_listen ()"><code class="function">soup_server_listen()</code></a>, etc, to listen on a -port, and <a class="link" href="SoupServer.html#soup-server-get-uris" title="soup_server_get_uris ()"><code class="function">soup_server_get_uris()</code></a> to see what ports are -being listened on.</p> -</div> -<p>Alias for the deprecated <a class="link" href="SoupServer.html#SoupServer--port" title="The “port” property"><span class="type">“port”</span></a> property, qv.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SERVER-INTERFACE:CAPS"></a><h3>SOUP_SERVER_INTERFACE</h3> -<pre class="programlisting">#define SOUP_SERVER_INTERFACE "interface" -</pre> -<div class="warning"> -<p><code class="literal">SOUP_SERVER_INTERFACE</code> is deprecated and should not be used in newly-written code.</p> -<p><a href="SoupServer.html#SoupServer-struct"><span class="type">SoupServers</span></a> can listen on multiple interfaces -at once now. Use <a class="link" href="SoupServer.html#soup-server-listen" title="soup_server_listen ()"><code class="function">soup_server_listen()</code></a>, etc, to listen on an -interface, and <a class="link" href="SoupServer.html#soup-server-get-uris" title="soup_server_get_uris ()"><code class="function">soup_server_get_uris()</code></a> to see what addresses -are being listened on.</p> -</div> -<p>Alias for the <a class="link" href="SoupServer.html#SoupServer--interface" title="The “interface” property"><span class="type">“interface”</span></a> property, qv.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SERVER-SSL-CERT-FILE:CAPS"></a><h3>SOUP_SERVER_SSL_CERT_FILE</h3> -<pre class="programlisting">#define SOUP_SERVER_SSL_CERT_FILE "ssl-cert-file" -</pre> -<div class="warning"> -<p><code class="literal">SOUP_SERVER_SSL_CERT_FILE</code> is deprecated and should not be used in newly-written code.</p> -<p>use <a class="link" href="SoupServer.html#SoupServer--tls-certificate" title="The “tls-certificate” property"><span class="type">“tls-certificate”</span></a> or -<code class="function">soup_server_set_ssl_certificate()</code>.</p> -</div> -<p>Alias for the <a class="link" href="SoupServer.html#SoupServer--ssl-cert-file" title="The “ssl-cert-file” property"><span class="type">“ssl-cert-file”</span></a> property, qv.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SERVER-SSL-KEY-FILE:CAPS"></a><h3>SOUP_SERVER_SSL_KEY_FILE</h3> -<pre class="programlisting">#define SOUP_SERVER_SSL_KEY_FILE "ssl-key-file" -</pre> -<div class="warning"> -<p><code class="literal">SOUP_SERVER_SSL_KEY_FILE</code> is deprecated and should not be used in newly-written code.</p> -<p>use <a class="link" href="SoupServer.html#SoupServer--tls-certificate" title="The “tls-certificate” property"><span class="type">“tls-certificate”</span></a> or -<code class="function">soup_server_set_ssl_certificate()</code>.</p> -</div> -<p>Alias for the <a class="link" href="SoupServer.html#SoupServer--ssl-key-file" title="The “ssl-key-file” property"><span class="type">“ssl-key-file”</span></a> property, qv.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-SERVER-ASYNC-CONTEXT:CAPS"></a><h3>SOUP_SERVER_ASYNC_CONTEXT</h3> -<pre class="programlisting">#define SOUP_SERVER_ASYNC_CONTEXT "async-context" -</pre> -<div class="warning"> -<p><code class="literal">SOUP_SERVER_ASYNC_CONTEXT</code> is deprecated and should not be used in newly-written code.</p> -<p>The new API uses the thread-default <span class="type">GMainContext</span> -rather than having an explicitly-specified one.</p> -</div> -<p>Alias for the deprecated <a class="link" href="SoupServer.html#SoupServer--async-context" title="The “async-context” property"><span class="type">“async-context”</span></a> -property, qv.</p> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/libsoup-2.4-Top-Level-Domain-utils.html b/docs/reference/html/libsoup-2.4-Top-Level-Domain-utils.html deleted file mode 100644 index 7f7ff961..00000000 --- a/docs/reference/html/libsoup-2.4-Top-Level-Domain-utils.html +++ /dev/null @@ -1,242 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Top Level Domain utils: 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="ch02.html" title="Core API"> -<link rel="prev" href="libsoup-2.4-soup-status.html" title="soup-status"> -<link rel="next" href="SoupURI.html" title="SoupURI"> -<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="#libsoup-2.4-Top-Level-Domain-utils.description" class="shortcut">Description</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="libsoup-2.4-soup-status.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="SoupURI.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="libsoup-2.4-Top-Level-Domain-utils"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="libsoup-2.4-Top-Level-Domain-utils.top_of_page"></a>Top Level Domain utils</span></h2> -<p>Top Level Domain utils — Top-Level Domain Utilities</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="libsoup-2.4-Top-Level-Domain-utils.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">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Top-Level-Domain-utils.html#soup-tld-get-base-domain" title="soup_tld_get_base_domain ()">soup_tld_get_base_domain</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Top-Level-Domain-utils.html#soup-tld-domain-is-public-suffix" title="soup_tld_domain_is_public_suffix ()">soup_tld_domain_is_public_suffix</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-Top-Level-Domain-utils.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="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-Top-Level-Domain-utils.html#SOUP-TLD-ERROR:CAPS" title="SOUP_TLD_ERROR">SOUP_TLD_ERROR</a></td> -</tr> -<tr> -<td class="datatype_keyword">enum</td> -<td class="function_name"><a class="link" href="libsoup-2.4-Top-Level-Domain-utils.html#SoupTLDError" title="enum SoupTLDError">SoupTLDError</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-Top-Level-Domain-utils.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-Top-Level-Domain-utils.description"></a><h2>Description</h2> -<p>These functions can be used to parse hostnames to attempt to determine -what part of the name belongs to the domain owner, and what part is -simply a "public suffix" such as ".com".</p> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-Top-Level-Domain-utils.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="soup-tld-get-base-domain"></a><h3>soup_tld_get_base_domain ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -soup_tld_get_base_domain (<em class="parameter"><code>const <span class="type">char</span> *hostname</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>Finds the base domain for a given <em class="parameter"><code>hostname</code></em> -. The base domain is -composed by the top level domain (such as .org, .com, .co.uk, etc) -plus the second level domain, for example for myhost.mydomain.com -it will return mydomain.com.</p> -<p>Note that <code class="literal">NULL</code> will be returned for private URLs (those not ending -with any well known TLD) because choosing a base domain for them -would be totally arbitrary.</p> -<p>Prior to libsoup 2.46, this function required that <em class="parameter"><code>hostname</code></em> - be in -UTF-8 if it was an IDN. From 2.46 on, the name can be in either -UTF-8 or ASCII format (and the return value will be in the same -format).</p> -<div class="refsect3"> -<a name="soup-tld-get-base-domain.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>hostname</p></td> -<td class="parameter_description"><p>a hostname</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code> to ignore -errors. See <a class="link" href="libsoup-2.4-Top-Level-Domain-utils.html#SoupTLDError" title="enum SoupTLDError"><span class="type">SoupTLDError</span></a> for the available error codes</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-tld-get-base-domain.returns"></a><h4>Returns</h4> -<p> a pointer to the start of the base domain in <em class="parameter"><code>hostname</code></em> -. If -an error occurs, <code class="literal">NULL</code> will be returned and <em class="parameter"><code>error</code></em> -set.</p> -</div> -<p class="since">Since: 2.40</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-tld-domain-is-public-suffix"></a><h3>soup_tld_domain_is_public_suffix ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_tld_domain_is_public_suffix (<em class="parameter"><code>const <span class="type">char</span> *domain</code></em>);</pre> -<p>Looks whether the <em class="parameter"><code>domain</code></em> - passed as argument is a public domain -suffix (.org, .com, .co.uk, etc) or not.</p> -<p>Prior to libsoup 2.46, this function required that <em class="parameter"><code>domain</code></em> - be in -UTF-8 if it was an IDN. From 2.46 on, the name can be in either -UTF-8 or ASCII format.</p> -<div class="refsect3"> -<a name="soup-tld-domain-is-public-suffix.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>domain</p></td> -<td class="parameter_description"><p>a domain name</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-tld-domain-is-public-suffix.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if it is a public domain, <code class="literal">FALSE</code> otherwise.</p> -</div> -<p class="since">Since: 2.40</p> -</div> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-Top-Level-Domain-utils.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SOUP-TLD-ERROR:CAPS"></a><h3>SOUP_TLD_ERROR</h3> -<pre class="programlisting">#define SOUP_TLD_ERROR soup_tld_error_quark() -</pre> -<p>The <span class="type">GError</span> domain for soup-tld-related errors.</p> -<p class="since">Since: 2.40</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupTLDError"></a><h3>enum SoupTLDError</h3> -<p>Error codes for <a class="link" href="libsoup-2.4-Top-Level-Domain-utils.html#SOUP-TLD-ERROR:CAPS" title="SOUP_TLD_ERROR"><code class="literal">SOUP_TLD_ERROR</code></a>.</p> -<div class="refsect3"> -<a name="SoupTLDError.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="enum_members_name"> -<col class="enum_members_description"> -<col width="200px" class="enum_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="enum_member_name"><p><a name="SOUP-TLD-ERROR-INVALID-HOSTNAME:CAPS"></a>SOUP_TLD_ERROR_INVALID_HOSTNAME</p></td> -<td class="enum_member_description"> -<p>A hostname was syntactically - invalid.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-TLD-ERROR-IS-IP-ADDRESS:CAPS"></a>SOUP_TLD_ERROR_IS_IP_ADDRESS</p></td> -<td class="enum_member_description"> -<p>The passed-in "hostname" was - actually an IP address (and thus has no base domain or - public suffix).</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-TLD-ERROR-NOT-ENOUGH-DOMAINS:CAPS"></a>SOUP_TLD_ERROR_NOT_ENOUGH_DOMAINS</p></td> -<td class="enum_member_description"> -<p>The passed-in hostname - did not have enough components. Eg, calling - <a class="link" href="libsoup-2.4-Top-Level-Domain-utils.html#soup-tld-get-base-domain" title="soup_tld_get_base_domain ()"><code class="function">soup_tld_get_base_domain()</code></a> on <code class="literal">"co.uk"</code>.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-TLD-ERROR-NO-BASE-DOMAIN:CAPS"></a>SOUP_TLD_ERROR_NO_BASE_DOMAIN</p></td> -<td class="enum_member_description"> -<p>The passed-in hostname has - no recognized public suffix.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.40</p> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/libsoup-2.4-Version-Information.html b/docs/reference/html/libsoup-2.4-Version-Information.html deleted file mode 100644 index 56d40df1..00000000 --- a/docs/reference/html/libsoup-2.4-Version-Information.html +++ /dev/null @@ -1,539 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Version Information: 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="ch02.html" title="Core API"> -<link rel="prev" href="SoupURI.html" title="SoupURI"> -<link rel="next" href="ch03.html" title="Additional Features"> -<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="#libsoup-2.4-Version-Information.description" class="shortcut">Description</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="SoupURI.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="ch03.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="libsoup-2.4-Version-Information"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="libsoup-2.4-Version-Information.top_of_page"></a>Version Information</span></h2> -<p>Version Information — Variables and functions to check the libsoup version</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="libsoup-2.4-Version-Information.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"> -<span class="returnvalue">guint</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Version-Information.html#soup-get-major-version" title="soup_get_major_version ()">soup_get_major_version</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">guint</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Version-Information.html#soup-get-minor-version" title="soup_get_minor_version ()">soup_get_minor_version</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">guint</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Version-Information.html#soup-get-micro-version" title="soup_get_micro_version ()">soup_get_micro_version</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Version-Information.html#soup-check-version" title="soup_check_version ()">soup_check_version</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-Version-Information.html#SOUP-CHECK-VERSION:CAPS" title="SOUP_CHECK_VERSION()">SOUP_CHECK_VERSION</a><span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-Version-Information.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="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-Version-Information.html#SOUP-MAJOR-VERSION:CAPS" title="SOUP_MAJOR_VERSION">SOUP_MAJOR_VERSION</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-Version-Information.html#SOUP-MINOR-VERSION:CAPS" title="SOUP_MINOR_VERSION">SOUP_MINOR_VERSION</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-Version-Information.html#SOUP-MICRO-VERSION:CAPS" title="SOUP_MICRO_VERSION">SOUP_MICRO_VERSION</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MIN-REQUIRED:CAPS" title="SOUP_VERSION_MIN_REQUIRED">SOUP_VERSION_MIN_REQUIRED</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MAX-ALLOWED:CAPS" title="SOUP_VERSION_MAX_ALLOWED">SOUP_VERSION_MAX_ALLOWED</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-24:CAPS" title="SOUP_VERSION_2_24">SOUP_VERSION_2_24</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-26:CAPS" title="SOUP_VERSION_2_26">SOUP_VERSION_2_26</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-28:CAPS" title="SOUP_VERSION_2_28">SOUP_VERSION_2_28</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-30:CAPS" title="SOUP_VERSION_2_30">SOUP_VERSION_2_30</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-32:CAPS" title="SOUP_VERSION_2_32">SOUP_VERSION_2_32</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-34:CAPS" title="SOUP_VERSION_2_34">SOUP_VERSION_2_34</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-36:CAPS" title="SOUP_VERSION_2_36">SOUP_VERSION_2_36</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-38:CAPS" title="SOUP_VERSION_2_38">SOUP_VERSION_2_38</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-40:CAPS" title="SOUP_VERSION_2_40">SOUP_VERSION_2_40</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-42:CAPS" title="SOUP_VERSION_2_42">SOUP_VERSION_2_42</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-44:CAPS" title="SOUP_VERSION_2_44">SOUP_VERSION_2_44</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-46:CAPS" title="SOUP_VERSION_2_46">SOUP_VERSION_2_46</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-48:CAPS" title="SOUP_VERSION_2_48">SOUP_VERSION_2_48</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-50:CAPS" title="SOUP_VERSION_2_50">SOUP_VERSION_2_50</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-52:CAPS" title="SOUP_VERSION_2_52">SOUP_VERSION_2_52</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-Version-Information.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-Version-Information.description"></a><h2>Description</h2> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-Version-Information.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="soup-get-major-version"></a><h3>soup_get_major_version ()</h3> -<pre class="programlisting"><span class="returnvalue">guint</span> -soup_get_major_version (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> -<p>Returns the major version number of the libsoup library. -(e.g. in libsoup version 2.42.0 this is 2.)</p> -<p>This function is in the library, so it represents the libsoup library -your code is running against. Contrast with the <a class="link" href="libsoup-2.4-Version-Information.html#SOUP-MAJOR-VERSION:CAPS" title="SOUP_MAJOR_VERSION"><span class="type">SOUP_MAJOR_VERSION</span></a> -macro, which represents the major version of the libsoup headers you -have included when compiling your code.</p> -<div class="refsect3"> -<a name="soup-get-major-version.returns"></a><h4>Returns</h4> -<p> the major version number of the libsoup library</p> -</div> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-get-minor-version"></a><h3>soup_get_minor_version ()</h3> -<pre class="programlisting"><span class="returnvalue">guint</span> -soup_get_minor_version (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> -<p>Returns the minor version number of the libsoup library. -(e.g. in libsoup version 2.42.0 this is 42.)</p> -<p>This function is in the library, so it represents the libsoup library -your code is running against. Contrast with the <a class="link" href="libsoup-2.4-Version-Information.html#SOUP-MINOR-VERSION:CAPS" title="SOUP_MINOR_VERSION"><span class="type">SOUP_MINOR_VERSION</span></a> -macro, which represents the minor version of the libsoup headers you -have included when compiling your code.</p> -<div class="refsect3"> -<a name="soup-get-minor-version.returns"></a><h4>Returns</h4> -<p> the minor version number of the libsoup library</p> -</div> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-get-micro-version"></a><h3>soup_get_micro_version ()</h3> -<pre class="programlisting"><span class="returnvalue">guint</span> -soup_get_micro_version (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> -<p>Returns the micro version number of the libsoup library. -(e.g. in libsoup version 2.42.0 this is 0.)</p> -<p>This function is in the library, so it represents the libsoup library -your code is running against. Contrast with the <a class="link" href="libsoup-2.4-Version-Information.html#SOUP-MICRO-VERSION:CAPS" title="SOUP_MICRO_VERSION"><span class="type">SOUP_MICRO_VERSION</span></a> -macro, which represents the micro version of the libsoup headers you -have included when compiling your code.</p> -<div class="refsect3"> -<a name="soup-get-micro-version.returns"></a><h4>Returns</h4> -<p> the micro version number of the libsoup library</p> -</div> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-check-version"></a><h3>soup_check_version ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_check_version (<em class="parameter"><code><span class="type">guint</span> major</code></em>, - <em class="parameter"><code><span class="type">guint</span> minor</code></em>, - <em class="parameter"><code><span class="type">guint</span> micro</code></em>);</pre> -<p>Like SOUP_CHECK_VERSION, but the check for soup_check_version is -at runtime instead of compile time. This is useful for compiling -against older versions of libsoup, but using features from newer -versions.</p> -<div class="refsect3"> -<a name="soup-check-version.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>major</p></td> -<td class="parameter_description"><p>the major version to check</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>minor</p></td> -<td class="parameter_description"><p>the minor version to check</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>micro</p></td> -<td class="parameter_description"><p>the micro version to check</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-check-version.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if the version of the libsoup currently loaded -is the same as or newer than the passed-in version.</p> -</div> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-CHECK-VERSION:CAPS"></a><h3>SOUP_CHECK_VERSION()</h3> -<pre class="programlisting">#define SOUP_CHECK_VERSION(major, minor, micro)</pre> -<p>Macro to test the version of libsoup being compiled against.</p> -<div class="refsect3"> -<a name="SOUP-CHECK-VERSION.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>major</p></td> -<td class="parameter_description"><p>major version (e.g. 2 for version 2.42.0)</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>minor</p></td> -<td class="parameter_description"><p>minor version (e.g. 42 for version 2.42.0)</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>micro</p></td> -<td class="parameter_description"><p>micro version (e.g. 0 for version 2.42.0)</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="SOUP-CHECK-VERSION.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if the version of the libsoup header files -is the same as or newer than the passed-in version.</p> -</div> -<p class="since">Since: 2.42</p> -</div> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-Version-Information.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SOUP-MAJOR-VERSION:CAPS"></a><h3>SOUP_MAJOR_VERSION</h3> -<pre class="programlisting">#define SOUP_MAJOR_VERSION (2) -</pre> -<p>Like <a class="link" href="libsoup-2.4-Version-Information.html#soup-get-major-version" title="soup_get_major_version ()"><code class="function">soup_get_major_version()</code></a>, but from the headers used at -application compile time, rather than from the library linked -against at application run time.</p> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-MINOR-VERSION:CAPS"></a><h3>SOUP_MINOR_VERSION</h3> -<pre class="programlisting">#define SOUP_MINOR_VERSION (61) -</pre> -<p>Like <a class="link" href="libsoup-2.4-Version-Information.html#soup-get-minor-version" title="soup_get_minor_version ()"><code class="function">soup_get_minor_version()</code></a>, but from the headers used at -application compile time, rather than from the library linked -against at application run time.</p> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-MICRO-VERSION:CAPS"></a><h3>SOUP_MICRO_VERSION</h3> -<pre class="programlisting">#define SOUP_MICRO_VERSION (90) -</pre> -<p>Like <a class="link" href="libsoup-2.4-Version-Information.html#soup-get-micro-version" title="soup_get_micro_version ()"><code class="function">soup_get_micro_version()</code></a>, but from the headers used at -application compile time, rather than from the library linked -against at application run time.</p> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-VERSION-MIN-REQUIRED:CAPS"></a><h3>SOUP_VERSION_MIN_REQUIRED</h3> -<pre class="programlisting"># define SOUP_VERSION_MIN_REQUIRED (SOUP_VERSION_CUR_STABLE) -</pre> -<p>A macro that should be defined by the user prior to including -libsoup.h. The definition should be one of the predefined libsoup -version macros: <a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-24:CAPS" title="SOUP_VERSION_2_24"><code class="literal">SOUP_VERSION_2_24</code></a>, <a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-26:CAPS" title="SOUP_VERSION_2_26"><code class="literal">SOUP_VERSION_2_26</code></a>, ...</p> -<p>This macro defines the earliest version of libsoup that the package -is required to be able to compile against.</p> -<p>If the compiler is configured to warn about the use of deprecated -functions, then using functions that were deprecated in version -<a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MIN-REQUIRED:CAPS" title="SOUP_VERSION_MIN_REQUIRED"><code class="literal">SOUP_VERSION_MIN_REQUIRED</code></a> or earlier will cause warnings (but -using functions deprecated in later releases will not).</p> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-VERSION-MAX-ALLOWED:CAPS"></a><h3>SOUP_VERSION_MAX_ALLOWED</h3> -<pre class="programlisting"># define SOUP_VERSION_MAX_ALLOWED (SOUP_VERSION_CUR_STABLE) -</pre> -<p>A macro that should be defined by the user prior to including -libsoup.h. The definition should be one of the predefined libsoup -version macros: <a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-24:CAPS" title="SOUP_VERSION_2_24"><code class="literal">SOUP_VERSION_2_24</code></a>, <a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-26:CAPS" title="SOUP_VERSION_2_26"><code class="literal">SOUP_VERSION_2_26</code></a>, ...</p> -<p>This macro defines the latest version of the libsoup API that the -package is allowed to make use of.</p> -<p>If the compiler is configured to warn about the use of deprecated -functions, then using functions added after version -<a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MAX-ALLOWED:CAPS" title="SOUP_VERSION_MAX_ALLOWED"><code class="literal">SOUP_VERSION_MAX_ALLOWED</code></a> will cause warnings.</p> -<p>Unless you are using <a class="link" href="libsoup-2.4-Version-Information.html#SOUP-CHECK-VERSION:CAPS" title="SOUP_CHECK_VERSION()"><code class="function">SOUP_CHECK_VERSION()</code></a> or the like to compile -different code depending on the libsoup version, then this should be -set to the same value as <a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MIN-REQUIRED:CAPS" title="SOUP_VERSION_MIN_REQUIRED"><code class="literal">SOUP_VERSION_MIN_REQUIRED</code></a>.</p> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-VERSION-2-24:CAPS"></a><h3>SOUP_VERSION_2_24</h3> -<pre class="programlisting">#define SOUP_VERSION_2_24 (G_ENCODE_VERSION (2, 24)) -</pre> -<p>A macro that evaluates to the 2.24 version of libsoup, in a format -that can be used by <a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MIN-REQUIRED:CAPS" title="SOUP_VERSION_MIN_REQUIRED"><code class="literal">SOUP_VERSION_MIN_REQUIRED</code></a> and -<a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MAX-ALLOWED:CAPS" title="SOUP_VERSION_MAX_ALLOWED"><code class="literal">SOUP_VERSION_MAX_ALLOWED</code></a>.</p> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-VERSION-2-26:CAPS"></a><h3>SOUP_VERSION_2_26</h3> -<pre class="programlisting">#define SOUP_VERSION_2_26 (G_ENCODE_VERSION (2, 26)) -</pre> -<p>A macro that evaluates to the 2.26 version of libsoup, in a format -that can be used by <a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MIN-REQUIRED:CAPS" title="SOUP_VERSION_MIN_REQUIRED"><code class="literal">SOUP_VERSION_MIN_REQUIRED</code></a> and -<a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MAX-ALLOWED:CAPS" title="SOUP_VERSION_MAX_ALLOWED"><code class="literal">SOUP_VERSION_MAX_ALLOWED</code></a>.</p> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-VERSION-2-28:CAPS"></a><h3>SOUP_VERSION_2_28</h3> -<pre class="programlisting">#define SOUP_VERSION_2_28 (G_ENCODE_VERSION (2, 28)) -</pre> -<p>A macro that evaluates to the 2.28 version of libsoup, in a format -that can be used by <a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MIN-REQUIRED:CAPS" title="SOUP_VERSION_MIN_REQUIRED"><code class="literal">SOUP_VERSION_MIN_REQUIRED</code></a> and -<a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MAX-ALLOWED:CAPS" title="SOUP_VERSION_MAX_ALLOWED"><code class="literal">SOUP_VERSION_MAX_ALLOWED</code></a>.</p> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-VERSION-2-30:CAPS"></a><h3>SOUP_VERSION_2_30</h3> -<pre class="programlisting">#define SOUP_VERSION_2_30 (G_ENCODE_VERSION (2, 30)) -</pre> -<p>A macro that evaluates to the 2.30 version of libsoup, in a format -that can be used by <a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MIN-REQUIRED:CAPS" title="SOUP_VERSION_MIN_REQUIRED"><code class="literal">SOUP_VERSION_MIN_REQUIRED</code></a> and -<a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MAX-ALLOWED:CAPS" title="SOUP_VERSION_MAX_ALLOWED"><code class="literal">SOUP_VERSION_MAX_ALLOWED</code></a>.</p> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-VERSION-2-32:CAPS"></a><h3>SOUP_VERSION_2_32</h3> -<pre class="programlisting">#define SOUP_VERSION_2_32 (G_ENCODE_VERSION (2, 32)) -</pre> -<p>A macro that evaluates to the 2.32 version of libsoup, in a format -that can be used by <a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MIN-REQUIRED:CAPS" title="SOUP_VERSION_MIN_REQUIRED"><code class="literal">SOUP_VERSION_MIN_REQUIRED</code></a> and -<a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MAX-ALLOWED:CAPS" title="SOUP_VERSION_MAX_ALLOWED"><code class="literal">SOUP_VERSION_MAX_ALLOWED</code></a>.</p> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-VERSION-2-34:CAPS"></a><h3>SOUP_VERSION_2_34</h3> -<pre class="programlisting">#define SOUP_VERSION_2_34 (G_ENCODE_VERSION (2, 34)) -</pre> -<p>A macro that evaluates to the 2.34 version of libsoup, in a format -that can be used by <a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MIN-REQUIRED:CAPS" title="SOUP_VERSION_MIN_REQUIRED"><code class="literal">SOUP_VERSION_MIN_REQUIRED</code></a> and -<a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MAX-ALLOWED:CAPS" title="SOUP_VERSION_MAX_ALLOWED"><code class="literal">SOUP_VERSION_MAX_ALLOWED</code></a>.</p> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-VERSION-2-36:CAPS"></a><h3>SOUP_VERSION_2_36</h3> -<pre class="programlisting">#define SOUP_VERSION_2_36 (G_ENCODE_VERSION (2, 36)) -</pre> -<p>A macro that evaluates to the 2.36 version of libsoup, in a format -that can be used by <a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MIN-REQUIRED:CAPS" title="SOUP_VERSION_MIN_REQUIRED"><code class="literal">SOUP_VERSION_MIN_REQUIRED</code></a> and -<a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MAX-ALLOWED:CAPS" title="SOUP_VERSION_MAX_ALLOWED"><code class="literal">SOUP_VERSION_MAX_ALLOWED</code></a>.</p> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-VERSION-2-38:CAPS"></a><h3>SOUP_VERSION_2_38</h3> -<pre class="programlisting">#define SOUP_VERSION_2_38 (G_ENCODE_VERSION (2, 38)) -</pre> -<p>A macro that evaluates to the 2.38 version of libsoup, in a format -that can be used by <a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MIN-REQUIRED:CAPS" title="SOUP_VERSION_MIN_REQUIRED"><code class="literal">SOUP_VERSION_MIN_REQUIRED</code></a> and -<a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MAX-ALLOWED:CAPS" title="SOUP_VERSION_MAX_ALLOWED"><code class="literal">SOUP_VERSION_MAX_ALLOWED</code></a>.</p> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-VERSION-2-40:CAPS"></a><h3>SOUP_VERSION_2_40</h3> -<pre class="programlisting">#define SOUP_VERSION_2_40 (G_ENCODE_VERSION (2, 40)) -</pre> -<p>A macro that evaluates to the 2.40 version of libsoup, in a format -that can be used by <a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MIN-REQUIRED:CAPS" title="SOUP_VERSION_MIN_REQUIRED"><code class="literal">SOUP_VERSION_MIN_REQUIRED</code></a> and -<a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MAX-ALLOWED:CAPS" title="SOUP_VERSION_MAX_ALLOWED"><code class="literal">SOUP_VERSION_MAX_ALLOWED</code></a>.</p> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-VERSION-2-42:CAPS"></a><h3>SOUP_VERSION_2_42</h3> -<pre class="programlisting">#define SOUP_VERSION_2_42 (G_ENCODE_VERSION (2, 42)) -</pre> -<p>A macro that evaluates to the 2.42 version of libsoup, in a format -that can be used by <a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MIN-REQUIRED:CAPS" title="SOUP_VERSION_MIN_REQUIRED"><code class="literal">SOUP_VERSION_MIN_REQUIRED</code></a> and -<a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MAX-ALLOWED:CAPS" title="SOUP_VERSION_MAX_ALLOWED"><code class="literal">SOUP_VERSION_MAX_ALLOWED</code></a>.</p> -<p class="since">Since: 2.42</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-VERSION-2-44:CAPS"></a><h3>SOUP_VERSION_2_44</h3> -<pre class="programlisting">#define SOUP_VERSION_2_44 (G_ENCODE_VERSION (2, 44)) -</pre> -<p>A macro that evaluates to the 2.44 version of libsoup, in a format -that can be used by <a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MIN-REQUIRED:CAPS" title="SOUP_VERSION_MIN_REQUIRED"><code class="literal">SOUP_VERSION_MIN_REQUIRED</code></a> and -<a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MAX-ALLOWED:CAPS" title="SOUP_VERSION_MAX_ALLOWED"><code class="literal">SOUP_VERSION_MAX_ALLOWED</code></a>.</p> -<p class="since">Since: 2.44</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-VERSION-2-46:CAPS"></a><h3>SOUP_VERSION_2_46</h3> -<pre class="programlisting">#define SOUP_VERSION_2_46 (G_ENCODE_VERSION (2, 46)) -</pre> -<p>A macro that evaluates to the 2.46 version of libsoup, in a format -that can be used by <a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MIN-REQUIRED:CAPS" title="SOUP_VERSION_MIN_REQUIRED"><code class="literal">SOUP_VERSION_MIN_REQUIRED</code></a> and -<a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MAX-ALLOWED:CAPS" title="SOUP_VERSION_MAX_ALLOWED"><code class="literal">SOUP_VERSION_MAX_ALLOWED</code></a>.</p> -<p class="since">Since: 2.46</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-VERSION-2-48:CAPS"></a><h3>SOUP_VERSION_2_48</h3> -<pre class="programlisting">#define SOUP_VERSION_2_48 (G_ENCODE_VERSION (2, 48)) -</pre> -<p>A macro that evaluates to the 2.48 version of libsoup, in a format -that can be used by <a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MIN-REQUIRED:CAPS" title="SOUP_VERSION_MIN_REQUIRED"><code class="literal">SOUP_VERSION_MIN_REQUIRED</code></a> and -<a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MAX-ALLOWED:CAPS" title="SOUP_VERSION_MAX_ALLOWED"><code class="literal">SOUP_VERSION_MAX_ALLOWED</code></a>.</p> -<p class="since">Since: 2.48</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-VERSION-2-50:CAPS"></a><h3>SOUP_VERSION_2_50</h3> -<pre class="programlisting">#define SOUP_VERSION_2_50 (G_ENCODE_VERSION (2, 50)) -</pre> -<p>A macro that evaluates to the 2.50 version of libsoup, in a format -that can be used by <a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MIN-REQUIRED:CAPS" title="SOUP_VERSION_MIN_REQUIRED"><code class="literal">SOUP_VERSION_MIN_REQUIRED</code></a> and -<a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MAX-ALLOWED:CAPS" title="SOUP_VERSION_MAX_ALLOWED"><code class="literal">SOUP_VERSION_MAX_ALLOWED</code></a>.</p> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-VERSION-2-52:CAPS"></a><h3>SOUP_VERSION_2_52</h3> -<pre class="programlisting">#define SOUP_VERSION_2_52 (G_ENCODE_VERSION (2, 52)) -</pre> -<p>A macro that evaluates to the 2.52 version of libsoup, in a format -that can be used by <a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MIN-REQUIRED:CAPS" title="SOUP_VERSION_MIN_REQUIRED"><code class="literal">SOUP_VERSION_MIN_REQUIRED</code></a> and -<a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MAX-ALLOWED:CAPS" title="SOUP_VERSION_MAX_ALLOWED"><code class="literal">SOUP_VERSION_MAX_ALLOWED</code></a>.</p> -<p class="since">Since: 2.52</p> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/libsoup-2.4-WebSockets.html b/docs/reference/html/libsoup-2.4-WebSockets.html deleted file mode 100644 index 3577cc5f..00000000 --- a/docs/reference/html/libsoup-2.4-WebSockets.html +++ /dev/null @@ -1,1544 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>WebSockets: 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="ch04.html" title="Web Services APIs"> -<link rel="prev" href="libsoup-2.4-XMLRPC-Support.html" title="XMLRPC Support"> -<link rel="next" href="ch05.html" title="Low-level Networking API"> -<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="#libsoup-2.4-WebSockets.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#libsoup-2.4-WebSockets.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> - <a href="#libsoup-2.4-WebSockets.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> - <a href="#libsoup-2.4-WebSockets.signals" class="shortcut">Signals</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="ch04.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="libsoup-2.4-XMLRPC-Support.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="ch05.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="libsoup-2.4-WebSockets"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="libsoup-2.4-WebSockets.top_of_page"></a>WebSockets</span></h2> -<p>WebSockets — The WebSocket Protocol</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="libsoup-2.4-WebSockets.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"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-WebSockets.html#soup-websocket-client-prepare-handshake" title="soup_websocket_client_prepare_handshake ()">soup_websocket_client_prepare_handshake</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-WebSockets.html#soup-websocket-client-verify-handshake" title="soup_websocket_client_verify_handshake ()">soup_websocket_client_verify_handshake</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-WebSockets.html#soup-websocket-server-check-handshake" title="soup_websocket_server_check_handshake ()">soup_websocket_server_check_handshake</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-WebSockets.html#soup-websocket-server-process-handshake" title="soup_websocket_server_process_handshake ()">soup_websocket_server_process_handshake</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="returnvalue">SoupWebsocketConnection</span></a> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-WebSockets.html#soup-websocket-connection-new" title="soup_websocket_connection_new ()">soup_websocket_connection_new</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GIOStream</span> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-WebSockets.html#soup-websocket-connection-get-io-stream" title="soup_websocket_connection_get_io_stream ()">soup_websocket_connection_get_io_stream</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnectionType" title="enum SoupWebsocketConnectionType"><span class="returnvalue">SoupWebsocketConnectionType</span></a> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-WebSockets.html#soup-websocket-connection-get-connection-type" title="soup_websocket_connection_get_connection_type ()">soup_websocket_connection_get_connection_type</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupURI.html" title="SoupURI"><span class="returnvalue">SoupURI</span></a> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-WebSockets.html#soup-websocket-connection-get-uri" title="soup_websocket_connection_get_uri ()">soup_websocket_connection_get_uri</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-WebSockets.html#soup-websocket-connection-get-origin" title="soup_websocket_connection_get_origin ()">soup_websocket_connection_get_origin</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-WebSockets.html#soup-websocket-connection-get-protocol" title="soup_websocket_connection_get_protocol ()">soup_websocket_connection_get_protocol</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketState" title="enum SoupWebsocketState"><span class="returnvalue">SoupWebsocketState</span></a> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-WebSockets.html#soup-websocket-connection-get-state" title="soup_websocket_connection_get_state ()">soup_websocket_connection_get_state</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-WebSockets.html#soup-websocket-connection-send-text" title="soup_websocket_connection_send_text ()">soup_websocket_connection_send_text</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-WebSockets.html#soup-websocket-connection-send-binary" title="soup_websocket_connection_send_binary ()">soup_websocket_connection_send_binary</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-WebSockets.html#soup-websocket-connection-close" title="soup_websocket_connection_close ()">soup_websocket_connection_close</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gushort</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-WebSockets.html#soup-websocket-connection-get-close-code" title="soup_websocket_connection_get_close_code ()">soup_websocket_connection_get_close_code</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-WebSockets.html#soup-websocket-connection-get-close-data" title="soup_websocket_connection_get_close_data ()">soup_websocket_connection_get_close_data</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-WebSockets.properties"></a><h2>Properties</h2> -<div class="informaltable"><table class="informaltable" border="0"> -<colgroup> -<col width="150px" class="properties_type"> -<col width="300px" class="properties_name"> -<col width="200px" class="properties_flags"> -</colgroup> -<tbody> -<tr> -<td class="property_type"><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnectionType" title="enum SoupWebsocketConnectionType"><span class="type">SoupWebsocketConnectionType</span></a></td> -<td class="property_name"><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection--connection-type" title="The “connection-type” property">connection-type</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">GIOStream</span> *</td> -<td class="property_name"><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection--io-stream" title="The “io-stream” property">io-stream</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -<tr> -<td class="property_type"><span class="type">guint</span></td> -<td class="property_name"><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection--keepalive-interval" title="The “keepalive-interval” property">keepalive-interval</a></td> -<td class="property_flags">Read / Write / Construct</td> -</tr> -<tr> -<td class="property_type"><span class="type">guint64</span></td> -<td class="property_name"><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection--max-incoming-payload-size" title="The “max-incoming-payload-size” property">max-incoming-payload-size</a></td> -<td class="property_flags">Read / Write / Construct</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">gchar</span> *</td> -<td class="property_name"><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection--origin" title="The “origin” property">origin</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -<tr> -<td class="property_type"> -<span class="type">gchar</span> *</td> -<td class="property_name"><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection--protocol" title="The “protocol” property">protocol</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -<tr> -<td class="property_type"><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketState" title="enum SoupWebsocketState"><span class="type">SoupWebsocketState</span></a></td> -<td class="property_name"><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection--state" title="The “state” property">state</a></td> -<td class="property_flags">Read</td> -</tr> -<tr> -<td class="property_type"> -<a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *</td> -<td class="property_name"><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection--uri" title="The “uri” property">uri</a></td> -<td class="property_flags">Read / Write / Construct Only</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-WebSockets.signals"></a><h2>Signals</h2> -<div class="informaltable"><table class="informaltable" border="0"> -<colgroup> -<col width="150px" class="signals_return"> -<col width="300px" class="signals_name"> -<col width="200px" class="signals_flags"> -</colgroup> -<tbody> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection-closed" title="The “closed” signal">closed</a></td> -<td class="signal_flags">Run First</td> -</tr> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection-closing" title="The “closing” signal">closing</a></td> -<td class="signal_flags">Run Last</td> -</tr> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection-error" title="The “error” signal">error</a></td> -<td class="signal_flags">Run First</td> -</tr> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection-message" title="The “message” signal">message</a></td> -<td class="signal_flags">Run First</td> -</tr> -<tr> -<td class="signal_type"><span class="returnvalue">void</span></td> -<td class="signal_name"><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection-pong" title="The “pong” signal">pong</a></td> -<td class="signal_flags">Run First</td> -</tr> -</tbody> -</table></div> -</div> -<a name="SoupWebsocketConnection"></a><div class="refsect1"> -<a name="libsoup-2.4-WebSockets.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="libsoup-2.4-WebSockets.html#SoupWebsocketConnection-struct" title="SoupWebsocketConnection">SoupWebsocketConnection</a></td> -</tr> -<tr> -<td class="datatype_keyword">enum</td> -<td class="function_name"><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnectionType" title="enum SoupWebsocketConnectionType">SoupWebsocketConnectionType</a></td> -</tr> -<tr> -<td class="datatype_keyword">enum</td> -<td class="function_name"><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketState" title="enum SoupWebsocketState">SoupWebsocketState</a></td> -</tr> -<tr> -<td class="datatype_keyword">enum</td> -<td class="function_name"><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketDataType" title="enum SoupWebsocketDataType">SoupWebsocketDataType</a></td> -</tr> -<tr> -<td class="datatype_keyword">enum</td> -<td class="function_name"><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketCloseCode" title="enum SoupWebsocketCloseCode">SoupWebsocketCloseCode</a></td> -</tr> -<tr> -<td class="datatype_keyword">enum</td> -<td class="function_name"><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketError" title="enum SoupWebsocketError">SoupWebsocketError</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-WebSockets.html#SOUP-WEBSOCKET-ERROR:CAPS" title="SOUP_WEBSOCKET_ERROR">SOUP_WEBSOCKET_ERROR</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-WebSockets.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> GObject - <span class="lineart">╰──</span> SoupWebsocketConnection -</pre> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-WebSockets.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-WebSockets.description"></a><h2>Description</h2> -<p><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="type">SoupWebsocketConnection</span></a> provides support for the <a class="ulink" href="http://tools.ietf.org/html/rfc6455" target="_top">WebSocket</a> protocol.</p> -<p>To connect to a WebSocket server, create a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> and call -<a class="link" href="SoupSession.html#soup-session-websocket-connect-async" title="soup_session_websocket_connect_async ()"><code class="function">soup_session_websocket_connect_async()</code></a>. To accept WebSocket -connections, create a <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> and add a handler to it with -<a class="link" href="SoupServer.html#soup-server-add-websocket-handler" title="soup_server_add_websocket_handler ()"><code class="function">soup_server_add_websocket_handler()</code></a>.</p> -<p>(Lower-level support is available via -<a class="link" href="libsoup-2.4-WebSockets.html#soup-websocket-client-prepare-handshake" title="soup_websocket_client_prepare_handshake ()"><code class="function">soup_websocket_client_prepare_handshake()</code></a> and -<a class="link" href="libsoup-2.4-WebSockets.html#soup-websocket-client-verify-handshake" title="soup_websocket_client_verify_handshake ()"><code class="function">soup_websocket_client_verify_handshake()</code></a>, for handling the client -side of the WebSocket handshake, and -<a class="link" href="libsoup-2.4-WebSockets.html#soup-websocket-server-process-handshake" title="soup_websocket_server_process_handshake ()"><code class="function">soup_websocket_server_process_handshake()</code></a> for handling the server -side.)</p> -<p><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="type">SoupWebsocketConnection</span></a> handles the details of WebSocket -communication. You can use <a class="link" href="libsoup-2.4-WebSockets.html#soup-websocket-connection-send-text" title="soup_websocket_connection_send_text ()"><code class="function">soup_websocket_connection_send_text()</code></a> -and <a class="link" href="libsoup-2.4-WebSockets.html#soup-websocket-connection-send-binary" title="soup_websocket_connection_send_binary ()"><code class="function">soup_websocket_connection_send_binary()</code></a> to send data, and the -<a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection-message" title="The “message” signal"><span class="type">“message”</span></a> signal to receive data. -(<a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="type">SoupWebsocketConnection</span></a> currently only supports asynchronous -I/O.)</p> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-WebSockets.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="soup-websocket-client-prepare-handshake"></a><h3>soup_websocket_client_prepare_handshake ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_websocket_client_prepare_handshake - (<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>const <span class="type">char</span> *origin</code></em>, - <em class="parameter"><code><span class="type">char</span> **protocols</code></em>);</pre> -<p>Adds the necessary headers to <em class="parameter"><code>msg</code></em> - to request a WebSocket -handshake. The message body and non-WebSocket-related headers are -not modified.</p> -<p>This is a low-level function; if you use -<a class="link" href="SoupSession.html#soup-session-websocket-connect-async" title="soup_session_websocket_connect_async ()"><code class="function">soup_session_websocket_connect_async()</code></a> to create a WebSocket -connection, it will call this for you.</p> -<div class="refsect3"> -<a name="soup-websocket-client-prepare-handshake.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>msg</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>origin</p></td> -<td class="parameter_description"><p>the "Origin" header to set. </p></td> -<td class="parameter_annotations"><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 class="parameter_name"><p>protocols</p></td> -<td class="parameter_description"><p>list of -protocols to offer. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span></td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-websocket-client-verify-handshake"></a><h3>soup_websocket_client_verify_handshake ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_websocket_client_verify_handshake - (<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><span class="type">GError</span> **error</code></em>);</pre> -<p>Looks at the response status code and headers in <em class="parameter"><code>msg</code></em> - and -determines if they contain a valid WebSocket handshake response -(given the handshake request in <em class="parameter"><code>msg</code></em> -'s request headers).</p> -<p>This is a low-level function; if you use -<a class="link" href="SoupSession.html#soup-session-websocket-connect-async" title="soup_session_websocket_connect_async ()"><code class="function">soup_session_websocket_connect_async()</code></a> to create a WebSocket -connection, it will call this for you.</p> -<div class="refsect3"> -<a name="soup-websocket-client-verify-handshake.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>msg</p></td> -<td class="parameter_description"><p><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> containing both client and server sides of a -WebSocket handshake</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>return location for a <span class="type">GError</span></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-websocket-client-verify-handshake.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if <em class="parameter"><code>msg</code></em> -contains a completed valid WebSocket -handshake, <code class="literal">FALSE</code> and an error if not.</p> -</div> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-websocket-server-check-handshake"></a><h3>soup_websocket_server_check_handshake ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_websocket_server_check_handshake (<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>const <span class="type">char</span> *origin</code></em>, - <em class="parameter"><code><span class="type">char</span> **protocols</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>Examines the method and request headers in <em class="parameter"><code>msg</code></em> - and determines -whether <em class="parameter"><code>msg</code></em> - contains a valid handshake request.</p> -<p>If <em class="parameter"><code>origin</code></em> - is non-<code class="literal">NULL</code>, then only requests containing a matching -"Origin" header will be accepted. If <em class="parameter"><code>protocols</code></em> - is non-<code class="literal">NULL</code>, then -only requests containing a compatible "Sec-WebSocket-Protocols" -header will be accepted.</p> -<p>Normally <a class="link" href="libsoup-2.4-WebSockets.html#soup-websocket-server-process-handshake" title="soup_websocket_server_process_handshake ()"><code class="function">soup_websocket_server_process_handshake()</code></a> will take care -of this for you, and if you use <a class="link" href="SoupServer.html#soup-server-add-websocket-handler" title="soup_server_add_websocket_handler ()"><code class="function">soup_server_add_websocket_handler()</code></a> -to handle accepting WebSocket connections, it will call that for -you. However, this function may be useful if you need to perform -more complicated validation; eg, accepting multiple different Origins, -or handling different protocols depending on the path.</p> -<div class="refsect3"> -<a name="soup-websocket-server-check-handshake.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>msg</p></td> -<td class="parameter_description"><p><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> containing the client side of a WebSocket handshake</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>origin</p></td> -<td class="parameter_description"><p>expected Origin header. </p></td> -<td class="parameter_annotations"><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 class="parameter_name"><p>protocols</p></td> -<td class="parameter_description"><p>allowed WebSocket -protocols. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>return location for a <span class="type">GError</span></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-websocket-server-check-handshake.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if <em class="parameter"><code>msg</code></em> -contained a valid WebSocket handshake, -<code class="literal">FALSE</code> and an error if not.</p> -</div> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-websocket-server-process-handshake"></a><h3>soup_websocket_server_process_handshake ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_websocket_server_process_handshake - (<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>const <span class="type">char</span> *expected_origin</code></em>, - <em class="parameter"><code><span class="type">char</span> **protocols</code></em>);</pre> -<p>Examines the method and request headers in <em class="parameter"><code>msg</code></em> - and (assuming <em class="parameter"><code>msg</code></em> - -contains a valid handshake request), fills in the handshake -response.</p> -<p>If <em class="parameter"><code>expected_origin</code></em> - is non-<code class="literal">NULL</code>, then only requests containing a matching -"Origin" header will be accepted. If <em class="parameter"><code>protocols</code></em> - is non-<code class="literal">NULL</code>, then -only requests containing a compatible "Sec-WebSocket-Protocols" -header will be accepted.</p> -<p>This is a low-level function; if you use -<a class="link" href="SoupServer.html#soup-server-add-websocket-handler" title="soup_server_add_websocket_handler ()"><code class="function">soup_server_add_websocket_handler()</code></a> to handle accepting WebSocket -connections, it will call this for you.</p> -<div class="refsect3"> -<a name="soup-websocket-server-process-handshake.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>msg</p></td> -<td class="parameter_description"><p><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> containing the client side of a WebSocket handshake</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>expected_origin</p></td> -<td class="parameter_description"><p>expected Origin header. </p></td> -<td class="parameter_annotations"><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 class="parameter_name"><p>protocols</p></td> -<td class="parameter_description"><p>allowed WebSocket -protocols. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-websocket-server-process-handshake.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> if <em class="parameter"><code>msg</code></em> -contained a valid WebSocket handshake -request and was updated to contain a handshake response. <code class="literal">FALSE</code> if not.</p> -</div> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-websocket-connection-new"></a><h3>soup_websocket_connection_new ()</h3> -<pre class="programlisting"><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="returnvalue">SoupWebsocketConnection</span></a> * -soup_websocket_connection_new (<em class="parameter"><code><span class="type">GIOStream</span> *stream</code></em>, - <em class="parameter"><code><a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *uri</code></em>, - <em class="parameter"><code><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnectionType" title="enum SoupWebsocketConnectionType"><span class="type">SoupWebsocketConnectionType</span></a> type</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *origin</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *protocol</code></em>);</pre> -<p>Creates a <a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="type">SoupWebsocketConnection</span></a> on <em class="parameter"><code>stream</code></em> -. This should be -called after completing the handshake to begin using the WebSocket -protocol.</p> -<div class="refsect3"> -<a name="soup-websocket-connection-new.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>stream</p></td> -<td class="parameter_description"><p>a <span class="type">GIOStream</span> connected to the WebSocket server</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>uri</p></td> -<td class="parameter_description"><p>the URI of the connection</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>type</p></td> -<td class="parameter_description"><p>the type of connection (client/side)</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>origin</p></td> -<td class="parameter_description"><p>the Origin of the client. </p></td> -<td class="parameter_annotations"><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 class="parameter_name"><p>protocol</p></td> -<td class="parameter_description"><p>the subprotocol in use. </p></td> -<td class="parameter_annotations"><span class="annotation">[<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-websocket-connection-new.returns"></a><h4>Returns</h4> -<p> a new <a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="type">SoupWebsocketConnection</span></a></p> -</div> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-websocket-connection-get-io-stream"></a><h3>soup_websocket_connection_get_io_stream ()</h3> -<pre class="programlisting"><span class="returnvalue">GIOStream</span> * -soup_websocket_connection_get_io_stream - (<em class="parameter"><code><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="type">SoupWebsocketConnection</span></a> *self</code></em>);</pre> -<p>Get the I/O stream the WebSocket is communicating over.</p> -<div class="refsect3"> -<a name="soup-websocket-connection-get-io-stream.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>self</p></td> -<td class="parameter_description"><p>the WebSocket</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-websocket-connection-get-io-stream.returns"></a><h4>Returns</h4> -<p>the WebSocket's I/O stream. </p> -<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-websocket-connection-get-connection-type"></a><h3>soup_websocket_connection_get_connection_type ()</h3> -<pre class="programlisting"><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnectionType" title="enum SoupWebsocketConnectionType"><span class="returnvalue">SoupWebsocketConnectionType</span></a> -soup_websocket_connection_get_connection_type - (<em class="parameter"><code><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="type">SoupWebsocketConnection</span></a> *self</code></em>);</pre> -<p>Get the connection type (client/server) of the connection.</p> -<div class="refsect3"> -<a name="soup-websocket-connection-get-connection-type.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>self</p></td> -<td class="parameter_description"><p>the WebSocket</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-websocket-connection-get-connection-type.returns"></a><h4>Returns</h4> -<p> the connection type</p> -</div> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-websocket-connection-get-uri"></a><h3>soup_websocket_connection_get_uri ()</h3> -<pre class="programlisting"><a class="link" href="SoupURI.html" title="SoupURI"><span class="returnvalue">SoupURI</span></a> * -soup_websocket_connection_get_uri (<em class="parameter"><code><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="type">SoupWebsocketConnection</span></a> *self</code></em>);</pre> -<p>Get the URI of the WebSocket.</p> -<p>For servers this represents the address of the WebSocket, and -for clients it is the address connected to.</p> -<div class="refsect3"> -<a name="soup-websocket-connection-get-uri.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>self</p></td> -<td class="parameter_description"><p>the WebSocket</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-websocket-connection-get-uri.returns"></a><h4>Returns</h4> -<p>the URI. </p> -<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-websocket-connection-get-origin"></a><h3>soup_websocket_connection_get_origin ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -soup_websocket_connection_get_origin (<em class="parameter"><code><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="type">SoupWebsocketConnection</span></a> *self</code></em>);</pre> -<p>Get the origin of the WebSocket.</p> -<div class="refsect3"> -<a name="soup-websocket-connection-get-origin.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>self</p></td> -<td class="parameter_description"><p>the WebSocket</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-websocket-connection-get-origin.returns"></a><h4>Returns</h4> -<p>the origin, or <code class="literal">NULL</code>. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-websocket-connection-get-protocol"></a><h3>soup_websocket_connection_get_protocol ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -soup_websocket_connection_get_protocol - (<em class="parameter"><code><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="type">SoupWebsocketConnection</span></a> *self</code></em>);</pre> -<p>Get the protocol chosen via negotiation with the peer.</p> -<div class="refsect3"> -<a name="soup-websocket-connection-get-protocol.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>self</p></td> -<td class="parameter_description"><p>the WebSocket</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-websocket-connection-get-protocol.returns"></a><h4>Returns</h4> -<p>the chosen protocol, or <code class="literal">NULL</code>. </p> -<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-websocket-connection-get-state"></a><h3>soup_websocket_connection_get_state ()</h3> -<pre class="programlisting"><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketState" title="enum SoupWebsocketState"><span class="returnvalue">SoupWebsocketState</span></a> -soup_websocket_connection_get_state (<em class="parameter"><code><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="type">SoupWebsocketConnection</span></a> *self</code></em>);</pre> -<p>Get the current state of the WebSocket.</p> -<div class="refsect3"> -<a name="soup-websocket-connection-get-state.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>self</p></td> -<td class="parameter_description"><p>the WebSocket</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-websocket-connection-get-state.returns"></a><h4>Returns</h4> -<p> the state</p> -</div> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-websocket-connection-send-text"></a><h3>soup_websocket_connection_send_text ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_websocket_connection_send_text (<em class="parameter"><code><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="type">SoupWebsocketConnection</span></a> *self</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *text</code></em>);</pre> -<p>Send a text (UTF-8) message to the peer.</p> -<p>The message is queued to be sent and will be sent when the main loop -is run.</p> -<div class="refsect3"> -<a name="soup-websocket-connection-send-text.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>self</p></td> -<td class="parameter_description"><p>the WebSocket</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>text</p></td> -<td class="parameter_description"><p>the message contents</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-websocket-connection-send-binary"></a><h3>soup_websocket_connection_send_binary ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_websocket_connection_send_binary (<em class="parameter"><code><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="type">SoupWebsocketConnection</span></a> *self</code></em>, - <em class="parameter"><code><span class="type">gconstpointer</span> data</code></em>, - <em class="parameter"><code><span class="type">gsize</span> length</code></em>);</pre> -<p>Send a binary message to the peer.</p> -<p>The message is queued to be sent and will be sent when the main loop -is run.</p> -<div class="refsect3"> -<a name="soup-websocket-connection-send-binary.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>self</p></td> -<td class="parameter_description"><p>the WebSocket</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>data</p></td> -<td class="parameter_description"><p>the message contents. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> length=length][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> guint8]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>length</p></td> -<td class="parameter_description"><p>the length of <em class="parameter"><code>data</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-websocket-connection-close"></a><h3>soup_websocket_connection_close ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_websocket_connection_close (<em class="parameter"><code><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="type">SoupWebsocketConnection</span></a> *self</code></em>, - <em class="parameter"><code><span class="type">gushort</span> code</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *data</code></em>);</pre> -<p>Close the connection in an orderly fashion.</p> -<p>Note that until the <a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection-closed" title="The “closed” signal"><span class="type">“closed”</span></a> signal fires, the connection -is not yet completely closed. The close message is not even sent until the -main loop runs.</p> -<p>The <em class="parameter"><code>code</code></em> - and <em class="parameter"><code>data</code></em> - are sent to the peer along with the close request. -Note that the <em class="parameter"><code>data</code></em> - must be UTF-8 valid.</p> -<div class="refsect3"> -<a name="soup-websocket-connection-close.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>self</p></td> -<td class="parameter_description"><p>the WebSocket</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>code</p></td> -<td class="parameter_description"><p>close code</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>data</p></td> -<td class="parameter_description"><p>close data. </p></td> -<td class="parameter_annotations"><span class="annotation">[<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> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-websocket-connection-get-close-code"></a><h3>soup_websocket_connection_get_close_code ()</h3> -<pre class="programlisting"><span class="returnvalue">gushort</span> -soup_websocket_connection_get_close_code - (<em class="parameter"><code><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="type">SoupWebsocketConnection</span></a> *self</code></em>);</pre> -<p>Get the close code received from the WebSocket peer.</p> -<p>This only becomes valid once the WebSocket is in the -<a class="link" href="libsoup-2.4-WebSockets.html#SOUP-WEBSOCKET-STATE-CLOSED:CAPS"><code class="literal">SOUP_WEBSOCKET_STATE_CLOSED</code></a> state. The value will often be in the -<a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketCloseCode" title="enum SoupWebsocketCloseCode"><span class="type">SoupWebsocketCloseCode</span></a> enumeration, but may also be an application -defined close code.</p> -<div class="refsect3"> -<a name="soup-websocket-connection-get-close-code.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>self</p></td> -<td class="parameter_description"><p>the WebSocket</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-websocket-connection-get-close-code.returns"></a><h4>Returns</h4> -<p> the close code or zero.</p> -</div> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-websocket-connection-get-close-data"></a><h3>soup_websocket_connection_get_close_data ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -soup_websocket_connection_get_close_data - (<em class="parameter"><code><a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="type">SoupWebsocketConnection</span></a> *self</code></em>);</pre> -<p>Get the close data received from the WebSocket peer.</p> -<p>This only becomes valid once the WebSocket is in the -<a class="link" href="libsoup-2.4-WebSockets.html#SOUP-WEBSOCKET-STATE-CLOSED:CAPS"><code class="literal">SOUP_WEBSOCKET_STATE_CLOSED</code></a> state. The data may be freed once -the main loop is run, so copy it if you need to keep it around.</p> -<div class="refsect3"> -<a name="soup-websocket-connection-get-close-data.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>self</p></td> -<td class="parameter_description"><p>the WebSocket</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-websocket-connection-get-close-data.returns"></a><h4>Returns</h4> -<p> the close data or <code class="literal">NULL</code></p> -</div> -<p class="since">Since: 2.50</p> -</div> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-WebSockets.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupWebsocketConnection-struct"></a><h3>SoupWebsocketConnection</h3> -<pre class="programlisting">typedef struct _SoupWebsocketConnection SoupWebsocketConnection;</pre> -<p>A class representing a WebSocket connection.</p> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupWebsocketConnectionType"></a><h3>enum SoupWebsocketConnectionType</h3> -<p>The type of a <a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="type">SoupWebsocketConnection</span></a>.</p> -<div class="refsect3"> -<a name="SoupWebsocketConnectionType.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="enum_members_name"> -<col class="enum_members_description"> -<col width="200px" class="enum_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="enum_member_name"><p><a name="SOUP-WEBSOCKET-CONNECTION-UNKNOWN:CAPS"></a>SOUP_WEBSOCKET_CONNECTION_UNKNOWN</p></td> -<td class="enum_member_description"> -<p>unknown/invalid connection</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-WEBSOCKET-CONNECTION-CLIENT:CAPS"></a>SOUP_WEBSOCKET_CONNECTION_CLIENT</p></td> -<td class="enum_member_description"> -<p>a client-side connection</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-WEBSOCKET-CONNECTION-SERVER:CAPS"></a>SOUP_WEBSOCKET_CONNECTION_SERVER</p></td> -<td class="enum_member_description"> -<p>a server-side connection</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupWebsocketState"></a><h3>enum SoupWebsocketState</h3> -<p>The state of the WebSocket connection.</p> -<div class="refsect3"> -<a name="SoupWebsocketState.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="enum_members_name"> -<col class="enum_members_description"> -<col width="200px" class="enum_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="enum_member_name"><p><a name="SOUP-WEBSOCKET-STATE-OPEN:CAPS"></a>SOUP_WEBSOCKET_STATE_OPEN</p></td> -<td class="enum_member_description"> -<p>the connection is ready to send messages</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-WEBSOCKET-STATE-CLOSING:CAPS"></a>SOUP_WEBSOCKET_STATE_CLOSING</p></td> -<td class="enum_member_description"> -<p>the connection is in the process of - closing down; messages may be received, but not sent</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-WEBSOCKET-STATE-CLOSED:CAPS"></a>SOUP_WEBSOCKET_STATE_CLOSED</p></td> -<td class="enum_member_description"> -<p>the connection is completely closed down</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupWebsocketDataType"></a><h3>enum SoupWebsocketDataType</h3> -<p>The type of data contained in a <a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection-message" title="The “message” signal"><span class="type">“message”</span></a> -signal.</p> -<div class="refsect3"> -<a name="SoupWebsocketDataType.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="enum_members_name"> -<col class="enum_members_description"> -<col width="200px" class="enum_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="enum_member_name"><p><a name="SOUP-WEBSOCKET-DATA-TEXT:CAPS"></a>SOUP_WEBSOCKET_DATA_TEXT</p></td> -<td class="enum_member_description"> -<p>UTF-8 text</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-WEBSOCKET-DATA-BINARY:CAPS"></a>SOUP_WEBSOCKET_DATA_BINARY</p></td> -<td class="enum_member_description"> -<p>binary data</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupWebsocketCloseCode"></a><h3>enum SoupWebsocketCloseCode</h3> -<p>Pre-defined close codes that can be passed to -<a class="link" href="libsoup-2.4-WebSockets.html#soup-websocket-connection-close" title="soup_websocket_connection_close ()"><code class="function">soup_websocket_connection_close()</code></a> or received from -<a class="link" href="libsoup-2.4-WebSockets.html#soup-websocket-connection-get-close-code" title="soup_websocket_connection_get_close_code ()"><code class="function">soup_websocket_connection_get_close_code()</code></a>. (However, other codes -are also allowed.)</p> -<div class="refsect3"> -<a name="SoupWebsocketCloseCode.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="enum_members_name"> -<col class="enum_members_description"> -<col width="200px" class="enum_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="enum_member_name"><p><a name="SOUP-WEBSOCKET-CLOSE-NORMAL:CAPS"></a>SOUP_WEBSOCKET_CLOSE_NORMAL</p></td> -<td class="enum_member_description"> -<p>a normal, non-error close</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-WEBSOCKET-CLOSE-GOING-AWAY:CAPS"></a>SOUP_WEBSOCKET_CLOSE_GOING_AWAY</p></td> -<td class="enum_member_description"> -<p>the client/server is going away</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-WEBSOCKET-CLOSE-PROTOCOL-ERROR:CAPS"></a>SOUP_WEBSOCKET_CLOSE_PROTOCOL_ERROR</p></td> -<td class="enum_member_description"> -<p>a protocol error occurred</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-WEBSOCKET-CLOSE-UNSUPPORTED-DATA:CAPS"></a>SOUP_WEBSOCKET_CLOSE_UNSUPPORTED_DATA</p></td> -<td class="enum_member_description"> -<p>the endpoint received data - of a type that it does not support.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-WEBSOCKET-CLOSE-NO-STATUS:CAPS"></a>SOUP_WEBSOCKET_CLOSE_NO_STATUS</p></td> -<td class="enum_member_description"> -<p>reserved value indicating that - no close code was present; must not be sent.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-WEBSOCKET-CLOSE-ABNORMAL:CAPS"></a>SOUP_WEBSOCKET_CLOSE_ABNORMAL</p></td> -<td class="enum_member_description"> -<p>reserved value indicating that - the connection was closed abnormally; must not be sent.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-WEBSOCKET-CLOSE-BAD-DATA:CAPS"></a>SOUP_WEBSOCKET_CLOSE_BAD_DATA</p></td> -<td class="enum_member_description"> -<p>the endpoint received data that - was invalid (eg, non-UTF-8 data in a text message).</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-WEBSOCKET-CLOSE-POLICY-VIOLATION:CAPS"></a>SOUP_WEBSOCKET_CLOSE_POLICY_VIOLATION</p></td> -<td class="enum_member_description"> -<p>generic error code - indicating some sort of policy violation.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-WEBSOCKET-CLOSE-TOO-BIG:CAPS"></a>SOUP_WEBSOCKET_CLOSE_TOO_BIG</p></td> -<td class="enum_member_description"> -<p>the endpoint received a message - that is too big to process.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-WEBSOCKET-CLOSE-NO-EXTENSION:CAPS"></a>SOUP_WEBSOCKET_CLOSE_NO_EXTENSION</p></td> -<td class="enum_member_description"> -<p>the client is closing the - connection because the server failed to negotiate a required - extension.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-WEBSOCKET-CLOSE-SERVER-ERROR:CAPS"></a>SOUP_WEBSOCKET_CLOSE_SERVER_ERROR</p></td> -<td class="enum_member_description"> -<p>the server is closing the - connection because it was unable to fulfill the request.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-WEBSOCKET-CLOSE-TLS-HANDSHAKE:CAPS"></a>SOUP_WEBSOCKET_CLOSE_TLS_HANDSHAKE</p></td> -<td class="enum_member_description"> -<p>reserved value indicating that - the TLS handshake failed; must not be sent.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupWebsocketError"></a><h3>enum SoupWebsocketError</h3> -<p>WebSocket-related errors.</p> -<div class="refsect3"> -<a name="SoupWebsocketError.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="enum_members_name"> -<col class="enum_members_description"> -<col width="200px" class="enum_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="enum_member_name"><p><a name="SOUP-WEBSOCKET-ERROR-FAILED:CAPS"></a>SOUP_WEBSOCKET_ERROR_FAILED</p></td> -<td class="enum_member_description"> -<p>a generic error</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-WEBSOCKET-ERROR-NOT-WEBSOCKET:CAPS"></a>SOUP_WEBSOCKET_ERROR_NOT_WEBSOCKET</p></td> -<td class="enum_member_description"> -<p>attempted to handshake with a - server that does not appear to understand WebSockets.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-WEBSOCKET-ERROR-BAD-HANDSHAKE:CAPS"></a>SOUP_WEBSOCKET_ERROR_BAD_HANDSHAKE</p></td> -<td class="enum_member_description"> -<p>the WebSocket handshake failed - because some detail was invalid (eg, incorrect accept key).</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-WEBSOCKET-ERROR-BAD-ORIGIN:CAPS"></a>SOUP_WEBSOCKET_ERROR_BAD_ORIGIN</p></td> -<td class="enum_member_description"> -<p>the WebSocket handshake failed - because the "Origin" header was not an allowed value.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-WEBSOCKET-ERROR:CAPS"></a><h3>SOUP_WEBSOCKET_ERROR</h3> -<pre class="programlisting">#define SOUP_WEBSOCKET_ERROR (soup_websocket_error_get_quark ()) -</pre> -<p>A <span class="type">GError</span> domain for WebSocket-related errors. Used with -<a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketError" title="enum SoupWebsocketError"><span class="type">SoupWebsocketError</span></a>.</p> -<p class="since">Since: 2.50</p> -</div> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-WebSockets.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> -<a name="SoupWebsocketConnection--connection-type"></a><h3>The <code class="literal">“connection-type”</code> property</h3> -<pre class="programlisting"> “connection-type” <a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnectionType" title="enum SoupWebsocketConnectionType"><span class="type">SoupWebsocketConnectionType</span></a></pre> -<p>The type of connection (client/server).</p> -<p>Flags: Read / Write / Construct Only</p> -<p>Default value: SOUP_WEBSOCKET_CONNECTION_UNKNOWN</p> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupWebsocketConnection--io-stream"></a><h3>The <code class="literal">“io-stream”</code> property</h3> -<pre class="programlisting"> “io-stream” <span class="type">GIOStream</span> *</pre> -<p>The underlying IO stream the WebSocket is communicating -over.</p> -<p>The input and output streams must be pollable streams.</p> -<p>Flags: Read / Write / Construct Only</p> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupWebsocketConnection--keepalive-interval"></a><h3>The <code class="literal">“keepalive-interval”</code> property</h3> -<pre class="programlisting"> “keepalive-interval” <span class="type">guint</span></pre> -<p>Interval in seconds on when to send a ping message which will -serve as a keepalive message. If set to 0 the keepalive message is -disabled.</p> -<p>Flags: Read / Write / Construct</p> -<p>Default value: 0</p> -<p class="since">Since: 2.58</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupWebsocketConnection--max-incoming-payload-size"></a><h3>The <code class="literal">“max-incoming-payload-size”</code> property</h3> -<pre class="programlisting"> “max-incoming-payload-size” <span class="type">guint64</span></pre> -<p>The maximum payload size for incoming packets the protocol expects -or 0 to not limit it.</p> -<p>Flags: Read / Write / Construct</p> -<p>Default value: 131072</p> -<p class="since">Since: 2.56</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupWebsocketConnection--origin"></a><h3>The <code class="literal">“origin”</code> property</h3> -<pre class="programlisting"> “origin” <span class="type">gchar</span> *</pre> -<p>The client's Origin.</p> -<p>Flags: Read / Write / Construct Only</p> -<p>Default value: NULL</p> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupWebsocketConnection--protocol"></a><h3>The <code class="literal">“protocol”</code> property</h3> -<pre class="programlisting"> “protocol” <span class="type">gchar</span> *</pre> -<p>The chosen protocol, or <code class="literal">NULL</code> if a protocol was not agreed -upon.</p> -<p>Flags: Read / Write / Construct Only</p> -<p>Default value: NULL</p> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupWebsocketConnection--state"></a><h3>The <code class="literal">“state”</code> property</h3> -<pre class="programlisting"> “state” <a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketState" title="enum SoupWebsocketState"><span class="type">SoupWebsocketState</span></a></pre> -<p>The current state of the WebSocket.</p> -<p>Flags: Read</p> -<p>Default value: SOUP_WEBSOCKET_STATE_OPEN</p> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupWebsocketConnection--uri"></a><h3>The <code class="literal">“uri”</code> property</h3> -<pre class="programlisting"> “uri” <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a> *</pre> -<p>The URI of the WebSocket.</p> -<p>For servers this represents the address of the WebSocket, -and for clients it is the address connected to.</p> -<p>Flags: Read / Write / Construct Only</p> -<p class="since">Since: 2.50</p> -</div> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-WebSockets.signal-details"></a><h2>Signal Details</h2> -<div class="refsect2"> -<a name="SoupWebsocketConnection-closed"></a><h3>The <code class="literal">“closed”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="type">SoupWebsocketConnection</span></a> *self, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted when the connection has completely closed, either -due to an orderly close from the peer, one initiated via -<a class="link" href="libsoup-2.4-WebSockets.html#soup-websocket-connection-close" title="soup_websocket_connection_close ()"><code class="function">soup_websocket_connection_close()</code></a> or a fatal error -condition that caused a close.</p> -<p>This signal will be emitted once.</p> -<div class="refsect3"> -<a name="SoupWebsocketConnection-closed.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>self</p></td> -<td class="parameter_description"><p>the WebSocket</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run First</p> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupWebsocketConnection-closing"></a><h3>The <code class="literal">“closing”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="type">SoupWebsocketConnection</span></a> *self, - <span class="type">gpointer</span> user_data)</pre> -<p>This signal will be emitted during an orderly close.</p> -<div class="refsect3"> -<a name="SoupWebsocketConnection-closing.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>self</p></td> -<td class="parameter_description"><p>the WebSocket</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run Last</p> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupWebsocketConnection-error"></a><h3>The <code class="literal">“error”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="type">SoupWebsocketConnection</span></a> *self, - <span class="type">GError</span> *error, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted when an error occurred on the WebSocket. This may -be fired multiple times. Fatal errors will be followed by -the <a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection-closed" title="The “closed” signal"><span class="type">“closed”</span></a> signal being emitted.</p> -<div class="refsect3"> -<a name="SoupWebsocketConnection-error.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>self</p></td> -<td class="parameter_description"><p>the WebSocket</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>the error that occured</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run First</p> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupWebsocketConnection-message"></a><h3>The <code class="literal">“message”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="type">SoupWebsocketConnection</span></a> *self, - <span class="type">gint</span> type, - <span class="type">GBytes</span> *message, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted when we receive a message from the peer.</p> -<p>As a convenience, the <em class="parameter"><code>message</code></em> - data will always be -NUL-terminated, but the NUL byte will not be included in -the length count.</p> -<div class="refsect3"> -<a name="SoupWebsocketConnection-message.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>self</p></td> -<td class="parameter_description"><p>the WebSocket</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>type</p></td> -<td class="parameter_description"><p>the type of message contents</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>message</p></td> -<td class="parameter_description"><p>the message data</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run First</p> -<p class="since">Since: 2.50</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupWebsocketConnection-pong"></a><h3>The <code class="literal">“pong”</code> signal</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -user_function (<a class="link" href="libsoup-2.4-WebSockets.html#SoupWebsocketConnection"><span class="type">SoupWebsocketConnection</span></a> *self, - <span class="type">GBytes</span> *message, - <span class="type">gpointer</span> user_data)</pre> -<p>Emitted when we receive a Pong frame (solicited or -unsolicited) from the peer.</p> -<p>As a convenience, the <em class="parameter"><code>message</code></em> - data will always be -NUL-terminated, but the NUL byte will not be included in -the length count.</p> -<div class="refsect3"> -<a name="SoupWebsocketConnection-pong.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>self</p></td> -<td class="parameter_description"><p>the WebSocket</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>message</p></td> -<td class="parameter_description"><p>the application data (if any)</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p>Flags: Run First</p> -<p class="since">Since: 2.60</p> -</div> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-WebSockets.see-also"></a><h2>See Also</h2> -<p>soup_session_websocket_connect_async(), - <a class="link" href="SoupServer.html#soup-server-add-websocket-handler" title="soup_server_add_websocket_handler ()"><code class="function">soup_server_add_websocket_handler()</code></a></p> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/libsoup-2.4-XMLRPC-Support.html b/docs/reference/html/libsoup-2.4-XMLRPC-Support.html deleted file mode 100644 index 52164434..00000000 --- a/docs/reference/html/libsoup-2.4-XMLRPC-Support.html +++ /dev/null @@ -1,921 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>XMLRPC Support: 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="ch04.html" title="Web Services APIs"> -<link rel="prev" href="libsoup-2.4-HTML-Form-Support.html" title="HTML Form Support"> -<link rel="next" href="libsoup-2.4-WebSockets.html" title="WebSockets"> -<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="#libsoup-2.4-XMLRPC-Support.description" class="shortcut">Description</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="ch04.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="libsoup-2.4-HTML-Form-Support.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="libsoup-2.4-WebSockets.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="libsoup-2.4-XMLRPC-Support"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="libsoup-2.4-XMLRPC-Support.top_of_page"></a>XMLRPC Support</span></h2> -<p>XMLRPC Support — XML-RPC support</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="libsoup-2.4-XMLRPC-Support.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"> -<span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-build-request" title="soup_xmlrpc_build_request ()">soup_xmlrpc_build_request</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="returnvalue">SoupMessage</span></a> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-message-new" title="soup_xmlrpc_message_new ()">soup_xmlrpc_message_new</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GVariant</span> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-parse-response" title="soup_xmlrpc_parse_response ()">soup_xmlrpc_parse_response</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GVariant</span> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-variant-new-datetime" title="soup_xmlrpc_variant_new_datetime ()">soup_xmlrpc_variant_new_datetime</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="returnvalue">SoupDate</span></a> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-variant-get-datetime" title="soup_xmlrpc_variant_get_datetime ()">soup_xmlrpc_variant_get_datetime</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-params-free" title="soup_xmlrpc_params_free ()">soup_xmlrpc_params_free</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">GVariant</span> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-params-parse" title="soup_xmlrpc_params_parse ()">soup_xmlrpc_params_parse</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="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-parse-request" title="soup_xmlrpc_parse_request ()">soup_xmlrpc_parse_request</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="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-build-response" title="soup_xmlrpc_build_response ()">soup_xmlrpc_build_response</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="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-build-fault" title="soup_xmlrpc_build_fault ()">soup_xmlrpc_build_fault</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">gboolean</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-message-set-response" title="soup_xmlrpc_message_set_response ()">soup_xmlrpc_message_set_response</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-message-set-fault" title="soup_xmlrpc_message_set_fault ()">soup_xmlrpc_message_set_fault</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-XMLRPC-Support.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="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-XMLRPC-Support.html#SOUP-XMLRPC-ERROR:CAPS" title="SOUP_XMLRPC_ERROR">SOUP_XMLRPC_ERROR</a></td> -</tr> -<tr> -<td class="datatype_keyword">enum</td> -<td class="function_name"><a class="link" href="libsoup-2.4-XMLRPC-Support.html#SoupXMLRPCError" title="enum SoupXMLRPCError">SoupXMLRPCError</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-XMLRPC-Support.html#SOUP-XMLRPC-FAULT:CAPS" title="SOUP_XMLRPC_FAULT">SOUP_XMLRPC_FAULT</a></td> -</tr> -<tr> -<td class="datatype_keyword">enum</td> -<td class="function_name"><a class="link" href="libsoup-2.4-XMLRPC-Support.html#SoupXMLRPCFault" title="enum SoupXMLRPCFault">SoupXMLRPCFault</a></td> -</tr> -<tr> -<td class="datatype_keyword"> </td> -<td class="function_name"><a class="link" href="libsoup-2.4-XMLRPC-Support.html#SoupXMLRPCParams" title="SoupXMLRPCParams">SoupXMLRPCParams</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-XMLRPC-Support.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-XMLRPC-Support.description"></a><h2>Description</h2> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-XMLRPC-Support.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="soup-xmlrpc-build-request"></a><h3>soup_xmlrpc_build_request ()</h3> -<pre class="programlisting"><span class="returnvalue">char</span> * -soup_xmlrpc_build_request (<em class="parameter"><code>const <span class="type">char</span> *method_name</code></em>, - <em class="parameter"><code><span class="type">GVariant</span> *params</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>This creates an XML-RPC methodCall and returns it as a string. -This is the low-level method that <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-message-new" title="soup_xmlrpc_message_new ()"><code class="function">soup_xmlrpc_message_new()</code></a> is -built on.</p> -<p><em class="parameter"><code>params</code></em> - is a <span class="type">GVariant</span> tuple representing the method parameters.</p> -<p>Serialization details:</p> -<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> -<li class="listitem"><p>"a{s*}" and "{s*}" are serialized as <struct></p></li> -<li class="listitem"><p>"ay" is serialized as <base64></p></li> -<li class="listitem"><p>Other arrays and tuples are serialized as <array></p></li> -<li class="listitem"><p>booleans are serialized as <boolean></p></li> -<li class="listitem"><p>byte, int16, uint16 and int32 are serialized as <int></p></li> -<li class="listitem"><p>uint32 and int64 are serialized as the nonstandard <i8> type</p></li> -<li class="listitem"><p>doubles are serialized as <double></p></li> -<li class="listitem"><p>Strings are serialized as <string></p></li> -<li class="listitem"><p>Variants (i.e. "v" type) are unwrapped and their child is serialized.</p></li> -<li class="listitem"><p><span class="type">GVariants</span> created by <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-variant-new-datetime" title="soup_xmlrpc_variant_new_datetime ()"><code class="function">soup_xmlrpc_variant_new_datetime()</code></a> are serialized as -<dateTime.iso8601></p></li> -<li class="listitem"><p>Other types are not supported and will return <code class="literal">NULL</code> and set <em class="parameter"><code>error</code></em> -. -This notably includes: object-paths, signatures, uint64, handles, maybes -and dictionaries with non-string keys.</p></li> -</ul></div> -<p>If <em class="parameter"><code>params</code></em> - is floating, it is consumed.</p> -<div class="refsect3"> -<a name="soup-xmlrpc-build-request.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>method_name</p></td> -<td class="parameter_description"><p>the name of the XML-RPC method</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>params</p></td> -<td class="parameter_description"><p>a <span class="type">GVariant</span> tuple</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-xmlrpc-build-request.returns"></a><h4>Returns</h4> -<p> the text of the methodCall, or <code class="literal">NULL</code> on error.</p> -</div> -<p class="since">Since: 2.52</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-xmlrpc-message-new"></a><h3>soup_xmlrpc_message_new ()</h3> -<pre class="programlisting"><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="returnvalue">SoupMessage</span></a> * -soup_xmlrpc_message_new (<em class="parameter"><code>const <span class="type">char</span> *uri</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *method_name</code></em>, - <em class="parameter"><code><span class="type">GVariant</span> *params</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>Creates an XML-RPC methodCall and returns a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>, ready -to send, for that method call.</p> -<p>See <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-build-request" title="soup_xmlrpc_build_request ()"><code class="function">soup_xmlrpc_build_request()</code></a> for serialization details.</p> -<p>If <em class="parameter"><code>params</code></em> - is floating, it is consumed.</p> -<div class="refsect3"> -<a name="soup-xmlrpc-message-new.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>uri</p></td> -<td class="parameter_description"><p>URI of the XML-RPC service</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>method_name</p></td> -<td class="parameter_description"><p>the name of the XML-RPC method to invoke at <em class="parameter"><code>uri</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>params</p></td> -<td class="parameter_description"><p>a <span class="type">GVariant</span> tuple</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-xmlrpc-message-new.returns"></a><h4>Returns</h4> -<p>a <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> encoding the -indicated XML-RPC request, or <code class="literal">NULL</code> on error. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.52</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-xmlrpc-parse-response"></a><h3>soup_xmlrpc_parse_response ()</h3> -<pre class="programlisting"><span class="returnvalue">GVariant</span> * -soup_xmlrpc_parse_response (<em class="parameter"><code>const <span class="type">char</span> *method_response</code></em>, - <em class="parameter"><code><span class="type">int</span> length</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *signature</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>Parses <em class="parameter"><code>method_response</code></em> - and returns the return value. If -<em class="parameter"><code>method_response</code></em> - is a fault, <code class="literal">NULL</code> is returned, and <em class="parameter"><code>error</code></em> - -will be set to an error in the <a class="link" href="libsoup-2.4-XMLRPC-Support.html#SOUP-XMLRPC-FAULT:CAPS" title="SOUP_XMLRPC_FAULT"><code class="literal">SOUP_XMLRPC_FAULT</code></a> domain, with the error -code containing the fault code, and the error message containing -the fault string. If <em class="parameter"><code>method_response</code></em> - cannot be parsed, <code class="literal">NULL</code> is returned, -and <em class="parameter"><code>error</code></em> - will be set to an error in the <a class="link" href="libsoup-2.4-XMLRPC-Support.html#SOUP-XMLRPC-ERROR:CAPS" title="SOUP_XMLRPC_ERROR"><code class="literal">SOUP_XMLRPC_ERROR</code></a> domain.</p> -<p>See <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-params-parse" title="soup_xmlrpc_params_parse ()"><code class="function">soup_xmlrpc_params_parse()</code></a> for deserialization details.</p> -<div class="refsect3"> -<a name="soup-xmlrpc-parse-response.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>method_response</p></td> -<td class="parameter_description"><p>the XML-RPC methodResponse string</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>length</p></td> -<td class="parameter_description"><p>the length of <em class="parameter"><code>method_response</code></em> -, or -1 if it is NUL-terminated</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>signature</p></td> -<td class="parameter_description"><p>A valid <span class="type">GVariant</span> type string, or <code class="literal">NULL</code>. </p></td> -<td class="parameter_annotations"><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 class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-xmlrpc-parse-response.returns"></a><h4>Returns</h4> -<p>a new (non-floating) <span class="type">GVariant</span>, or <code class="literal">NULL</code>. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.52</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-xmlrpc-variant-new-datetime"></a><h3>soup_xmlrpc_variant_new_datetime ()</h3> -<pre class="programlisting"><span class="returnvalue">GVariant</span> * -soup_xmlrpc_variant_new_datetime (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);</pre> -<p>Construct a special <span class="type">GVariant</span> used to serialize a <dateTime.iso8601> -node. See <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-build-request" title="soup_xmlrpc_build_request ()"><code class="function">soup_xmlrpc_build_request()</code></a>.</p> -<p>The actual type of the returned <span class="type">GVariant</span> is unspecified and "v" or "*" -should be used in variant format strings. For example:</p> -<div class="informalexample"> - <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> - <tbody> - <tr> - <td class="listing_lines" align="right"><pre>1</pre></td> - <td class="listing_code"><pre class="programlisting">args <span class="gtkdoc opt">=</span> <span class="function">g_variant_new</span> <span class="gtkdoc opt">(</span><span class="string">"(v)"</span><span class="gtkdoc opt">,</span> <span class="function"><a href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-variant-new-datetime">soup_xmlrpc_variant_new_datetime</a></span> <span class="gtkdoc opt">(</span>date<span class="gtkdoc opt">));</span></pre></td> - </tr> - </tbody> - </table> -</div> - -<div class="refsect3"> -<a name="soup-xmlrpc-variant-new-datetime.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>date</p></td> -<td class="parameter_description"><p>a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-xmlrpc-variant-new-datetime.returns"></a><h4>Returns</h4> -<p> a floating <span class="type">GVariant</span>.</p> -</div> -<p class="since">Since: 2.52</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-xmlrpc-variant-get-datetime"></a><h3>soup_xmlrpc_variant_get_datetime ()</h3> -<pre class="programlisting"><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="returnvalue">SoupDate</span></a> * -soup_xmlrpc_variant_get_datetime (<em class="parameter"><code><span class="type">GVariant</span> *variant</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>Get the <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> from special <span class="type">GVariant</span> created by -<a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-variant-new-datetime" title="soup_xmlrpc_variant_new_datetime ()"><code class="function">soup_xmlrpc_variant_new_datetime()</code></a> or by parsing a <dateTime.iso8601> -node. See <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-params-parse" title="soup_xmlrpc_params_parse ()"><code class="function">soup_xmlrpc_params_parse()</code></a>.</p> -<p>If <em class="parameter"><code>variant</code></em> - does not contain a datetime it will return an error but it is not -considered a programmer error because it generally means parameters received -are not in the expected type.</p> -<div class="refsect3"> -<a name="soup-xmlrpc-variant-get-datetime.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>variant</p></td> -<td class="parameter_description"><p>a <span class="type">GVariant</span></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-xmlrpc-variant-get-datetime.returns"></a><h4>Returns</h4> -<p> a new <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a>, or <code class="literal">NULL</code> on error.</p> -</div> -<p class="since">Since: 2.52</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-xmlrpc-params-free"></a><h3>soup_xmlrpc_params_free ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_xmlrpc_params_free (<em class="parameter"><code><a class="link" href="libsoup-2.4-XMLRPC-Support.html#SoupXMLRPCParams" title="SoupXMLRPCParams"><span class="type">SoupXMLRPCParams</span></a> *self</code></em>);</pre> -<p>Free a <a class="link" href="libsoup-2.4-XMLRPC-Support.html#SoupXMLRPCParams" title="SoupXMLRPCParams"><span class="type">SoupXMLRPCParams</span></a> returned by <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-parse-request" title="soup_xmlrpc_parse_request ()"><code class="function">soup_xmlrpc_parse_request()</code></a>.</p> -<div class="refsect3"> -<a name="soup-xmlrpc-params-free.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>self</p></td> -<td class="parameter_description"><p>a SoupXMLRPCParams</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<p class="since">Since: 2.52</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-xmlrpc-params-parse"></a><h3>soup_xmlrpc_params_parse ()</h3> -<pre class="programlisting"><span class="returnvalue">GVariant</span> * -soup_xmlrpc_params_parse (<em class="parameter"><code><a class="link" href="libsoup-2.4-XMLRPC-Support.html#SoupXMLRPCParams" title="SoupXMLRPCParams"><span class="type">SoupXMLRPCParams</span></a> *self</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *signature</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>Parse method parameters returned by <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-parse-request" title="soup_xmlrpc_parse_request ()"><code class="function">soup_xmlrpc_parse_request()</code></a>.</p> -<p>Deserialization details:</p> -<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> -<li class="listitem"><p>If <em class="parameter"><code>signature</code></em> - is provided, <int> and <i4> can be deserialized -to byte, int16, uint16, int32, uint32, int64 or uint64. Otherwise -it will be deserialized to int32. If the value is out of range -for the target type it will return an error.</p></li> -<li class="listitem"><p><struct> will be deserialized to "a{sv}". <em class="parameter"><code>signature</code></em> - could define -another value type (e.g. "a{ss}").</p></li> -<li class="listitem"><p><array> will be deserialized to "av". <em class="parameter"><code>signature</code></em> - could define -another element type (e.g. "as") or could be a tuple (e.g. "(ss)").</p></li> -<li class="listitem"><p><base64> will be deserialized to "ay".</p></li> -<li class="listitem"><p><string> will be deserialized to "s".</p></li> -<li class="listitem"><p><dateTime.iso8601> will be deserialized to an unspecified variant -type. If <em class="parameter"><code>signature</code></em> - is provided it must have the generic "v" type, which -means there is no guarantee that it's actually a datetime that has been -received. <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-variant-get-datetime" title="soup_xmlrpc_variant_get_datetime ()"><code class="function">soup_xmlrpc_variant_get_datetime()</code></a> must be used to parse and -type check this special variant.</p></li> -<li class="listitem"><p><em class="parameter"><code>signature</code></em> - must not have maybes, otherwise an error is returned.</p></li> -<li class="listitem"><p>Dictionaries must have string keys, otherwise an error is returned.</p></li> -</ul></div> -<div class="refsect3"> -<a name="soup-xmlrpc-params-parse.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>self</p></td> -<td class="parameter_description"><p>A <a class="link" href="libsoup-2.4-XMLRPC-Support.html#SoupXMLRPCParams" title="SoupXMLRPCParams"><span class="type">SoupXMLRPCParams</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>signature</p></td> -<td class="parameter_description"><p>A valid <span class="type">GVariant</span> type string, or <code class="literal">NULL</code>. </p></td> -<td class="parameter_annotations"><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 class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-xmlrpc-params-parse.returns"></a><h4>Returns</h4> -<p>a new (non-floating) <span class="type">GVariant</span>, or <code class="literal">NULL</code>. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.52</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-xmlrpc-parse-request"></a><h3>soup_xmlrpc_parse_request ()</h3> -<pre class="programlisting"><span class="returnvalue">char</span> * -soup_xmlrpc_parse_request (<em class="parameter"><code>const <span class="type">char</span> *method_call</code></em>, - <em class="parameter"><code><span class="type">int</span> length</code></em>, - <em class="parameter"><code><a class="link" href="libsoup-2.4-XMLRPC-Support.html#SoupXMLRPCParams" title="SoupXMLRPCParams"><span class="type">SoupXMLRPCParams</span></a> **params</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>Parses <em class="parameter"><code>method_call</code></em> - and return the method name. Method parameters can be -parsed later using <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-params-parse" title="soup_xmlrpc_params_parse ()"><code class="function">soup_xmlrpc_params_parse()</code></a>.</p> -<div class="refsect3"> -<a name="soup-xmlrpc-parse-request.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>method_call</p></td> -<td class="parameter_description"><p>the XML-RPC methodCall string</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>length</p></td> -<td class="parameter_description"><p>the length of <em class="parameter"><code>method_call</code></em> -, or -1 if it is NUL-terminated</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>params</p></td> -<td class="parameter_description"><p>on success, a new <a class="link" href="libsoup-2.4-XMLRPC-Support.html#SoupXMLRPCParams" title="SoupXMLRPCParams"><span class="type">SoupXMLRPCParams</span></a>. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-xmlrpc-parse-request.returns"></a><h4>Returns</h4> -<p>method's name, or <code class="literal">NULL</code> on error. </p> -<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> -</div> -<p class="since">Since: 2.52</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-xmlrpc-build-response"></a><h3>soup_xmlrpc_build_response ()</h3> -<pre class="programlisting"><span class="returnvalue">char</span> * -soup_xmlrpc_build_response (<em class="parameter"><code><span class="type">GVariant</span> *value</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>This creates a (successful) XML-RPC methodResponse and returns it -as a string. To create a fault response, use <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-build-fault" title="soup_xmlrpc_build_fault ()"><code class="function">soup_xmlrpc_build_fault()</code></a>. This -is the low-level method that <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-message-set-response" title="soup_xmlrpc_message_set_response ()"><code class="function">soup_xmlrpc_message_set_response()</code></a> is built on.</p> -<p>See <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-build-request" title="soup_xmlrpc_build_request ()"><code class="function">soup_xmlrpc_build_request()</code></a> for serialization details, but note -that since a method can only have a single return value, <em class="parameter"><code>value</code></em> - -should not be a tuple here (unless the return value is an array).</p> -<p>If <em class="parameter"><code>value</code></em> - is floating, it is consumed.</p> -<div class="refsect3"> -<a name="soup-xmlrpc-build-response.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>value</p></td> -<td class="parameter_description"><p>the return value</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-xmlrpc-build-response.returns"></a><h4>Returns</h4> -<p> the text of the methodResponse, or <code class="literal">NULL</code> on error.</p> -</div> -<p class="since">Since: 2.52</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-xmlrpc-build-fault"></a><h3>soup_xmlrpc_build_fault ()</h3> -<pre class="programlisting"><span class="returnvalue">char</span> * -soup_xmlrpc_build_fault (<em class="parameter"><code><span class="type">int</span> fault_code</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *fault_format</code></em>, - <em class="parameter"><code>...</code></em>);</pre> -<p>This creates an XML-RPC fault response and returns it as a string. -(To create a successful response, use -<code class="function">soup_xmlrpc_build_method_response()</code>.)</p> -<div class="refsect3"> -<a name="soup-xmlrpc-build-fault.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>fault_code</p></td> -<td class="parameter_description"><p>the fault code</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>fault_format</p></td> -<td class="parameter_description"><p>a <code class="function">printf()</code>-style format string</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>...</p></td> -<td class="parameter_description"><p>the parameters to <em class="parameter"><code>fault_format</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-xmlrpc-build-fault.returns"></a><h4>Returns</h4> -<p> the text of the fault</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-xmlrpc-message-set-response"></a><h3>soup_xmlrpc_message_set_response ()</h3> -<pre class="programlisting"><span class="returnvalue">gboolean</span> -soup_xmlrpc_message_set_response (<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><span class="type">GVariant</span> *value</code></em>, - <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre> -<p>Sets the status code and response body of <em class="parameter"><code>msg</code></em> - to indicate a -successful XML-RPC call, with a return value given by <em class="parameter"><code>value</code></em> -. To set a -fault response, use <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-message-set-fault" title="soup_xmlrpc_message_set_fault ()"><code class="function">soup_xmlrpc_message_set_fault()</code></a>.</p> -<p>See <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-build-request" title="soup_xmlrpc_build_request ()"><code class="function">soup_xmlrpc_build_request()</code></a> for serialization details.</p> -<p>If <em class="parameter"><code>value</code></em> - is floating, it is consumed.</p> -<div class="refsect3"> -<a name="soup-xmlrpc-message-set-response.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>msg</p></td> -<td class="parameter_description"><p>an XML-RPC request</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>value</p></td> -<td class="parameter_description"><p>a <span class="type">GVariant</span></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>error</p></td> -<td class="parameter_description"><p>a <span class="type">GError</span>, or <code class="literal">NULL</code></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-xmlrpc-message-set-response.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> otherwise.</p> -</div> -<p class="since">Since: 2.52</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-xmlrpc-message-set-fault"></a><h3>soup_xmlrpc_message_set_fault ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_xmlrpc_message_set_fault (<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><span class="type">int</span> fault_code</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *fault_format</code></em>, - <em class="parameter"><code>...</code></em>);</pre> -<p>Sets the status code and response body of <em class="parameter"><code>msg</code></em> - to indicate an -unsuccessful XML-RPC call, with the error described by <em class="parameter"><code>fault_code</code></em> - -and <em class="parameter"><code>fault_format</code></em> -.</p> -<div class="refsect3"> -<a name="soup-xmlrpc-message-set-fault.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>msg</p></td> -<td class="parameter_description"><p>an XML-RPC request</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>fault_code</p></td> -<td class="parameter_description"><p>the fault code</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>fault_format</p></td> -<td class="parameter_description"><p>a <code class="function">printf()</code>-style format string</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>...</p></td> -<td class="parameter_description"><p>the parameters to <em class="parameter"><code>fault_format</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<p class="since">Since: 2.52</p> -</div> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-XMLRPC-Support.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SOUP-XMLRPC-ERROR:CAPS"></a><h3>SOUP_XMLRPC_ERROR</h3> -<pre class="programlisting">#define SOUP_XMLRPC_ERROR soup_xmlrpc_error_quark() -</pre> -</div> -<hr> -<div class="refsect2"> -<a name="SoupXMLRPCError"></a><h3>enum SoupXMLRPCError</h3> -<div class="refsect3"> -<a name="SoupXMLRPCError.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="enum_members_name"> -<col class="enum_members_description"> -<col width="200px" class="enum_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="enum_member_name"><p><a name="SOUP-XMLRPC-ERROR-ARGUMENTS:CAPS"></a>SOUP_XMLRPC_ERROR_ARGUMENTS</p></td> -<td> </td> -<td> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-XMLRPC-ERROR-RETVAL:CAPS"></a>SOUP_XMLRPC_ERROR_RETVAL</p></td> -<td> </td> -<td> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-XMLRPC-FAULT:CAPS"></a><h3>SOUP_XMLRPC_FAULT</h3> -<pre class="programlisting">#define SOUP_XMLRPC_FAULT soup_xmlrpc_fault_quark() -</pre> -<p>A <span class="type">GError</span> domain representing an XML-RPC fault code. Used with -<a class="link" href="libsoup-2.4-XMLRPC-Support.html#SoupXMLRPCFault" title="enum SoupXMLRPCFault"><span class="type">SoupXMLRPCFault</span></a> (although servers may also return fault codes not -in that enumeration).</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupXMLRPCFault"></a><h3>enum SoupXMLRPCFault</h3> -<p>Pre-defined XML-RPC fault codes from <a class="ulink" href="http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php" target="_top">http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php</a>. -These are an extension, not part of the XML-RPC spec; you can't -assume servers will use them.</p> -<div class="refsect3"> -<a name="SoupXMLRPCFault.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="enum_members_name"> -<col class="enum_members_description"> -<col width="200px" class="enum_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="enum_member_name"><p><a name="SOUP-XMLRPC-FAULT-PARSE-ERROR-NOT-WELL-FORMED:CAPS"></a>SOUP_XMLRPC_FAULT_PARSE_ERROR_NOT_WELL_FORMED</p></td> -<td class="enum_member_description"> -<p>request was not - well-formed</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-XMLRPC-FAULT-PARSE-ERROR-UNSUPPORTED-ENCODING:CAPS"></a>SOUP_XMLRPC_FAULT_PARSE_ERROR_UNSUPPORTED_ENCODING</p></td> -<td class="enum_member_description"> -<p>request was in - an unsupported encoding</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-XMLRPC-FAULT-PARSE-ERROR-INVALID-CHARACTER-FOR-ENCODING:CAPS"></a>SOUP_XMLRPC_FAULT_PARSE_ERROR_INVALID_CHARACTER_FOR_ENCODING</p></td> -<td class="enum_member_description"> -<p> request contained an invalid character</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-XMLRPC-FAULT-SERVER-ERROR-INVALID-XML-RPC:CAPS"></a>SOUP_XMLRPC_FAULT_SERVER_ERROR_INVALID_XML_RPC</p></td> -<td class="enum_member_description"> -<p>request was not - valid XML-RPC</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-XMLRPC-FAULT-SERVER-ERROR-REQUESTED-METHOD-NOT-FOUND:CAPS"></a>SOUP_XMLRPC_FAULT_SERVER_ERROR_REQUESTED_METHOD_NOT_FOUND</p></td> -<td class="enum_member_description"> -<p>method - not found</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-XMLRPC-FAULT-SERVER-ERROR-INVALID-METHOD-PARAMETERS:CAPS"></a>SOUP_XMLRPC_FAULT_SERVER_ERROR_INVALID_METHOD_PARAMETERS</p></td> -<td class="enum_member_description"> -<p>invalid - parameters</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-XMLRPC-FAULT-SERVER-ERROR-INTERNAL-XML-RPC-ERROR:CAPS"></a>SOUP_XMLRPC_FAULT_SERVER_ERROR_INTERNAL_XML_RPC_ERROR</p></td> -<td class="enum_member_description"> -<p>internal - error</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-XMLRPC-FAULT-APPLICATION-ERROR:CAPS"></a>SOUP_XMLRPC_FAULT_APPLICATION_ERROR</p></td> -<td class="enum_member_description"> -<p>start of reserved range for - application error codes</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-XMLRPC-FAULT-SYSTEM-ERROR:CAPS"></a>SOUP_XMLRPC_FAULT_SYSTEM_ERROR</p></td> -<td class="enum_member_description"> -<p>start of reserved range for - system error codes</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-XMLRPC-FAULT-TRANSPORT-ERROR:CAPS"></a>SOUP_XMLRPC_FAULT_TRANSPORT_ERROR</p></td> -<td class="enum_member_description"> -<p>start of reserved range for - transport error codes</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SoupXMLRPCParams"></a><h3>SoupXMLRPCParams</h3> -<pre class="programlisting">typedef struct _SoupXMLRPCParams SoupXMLRPCParams;</pre> -<p>Opaque structure containing XML-RPC methodCall parameter values. -Can be parsed using <a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-params-parse" title="soup_xmlrpc_params_parse ()"><code class="function">soup_xmlrpc_params_parse()</code></a> and freed with -<a class="link" href="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-params-free" title="soup_xmlrpc_params_free ()"><code class="function">soup_xmlrpc_params_free()</code></a>.</p> -<p class="since">Since: 2.52</p> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/libsoup-2.4-soup-method.html b/docs/reference/html/libsoup-2.4-soup-method.html deleted file mode 100644 index 17bd5952..00000000 --- a/docs/reference/html/libsoup-2.4-soup-method.html +++ /dev/null @@ -1,254 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>soup-method: 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="ch02.html" title="Core API"> -<link rel="prev" href="SoupMessageBody.html" title="SoupMessageBody"> -<link rel="next" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html" title="Soup Miscellaneous Utilities"> -<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="#libsoup-2.4-soup-method.description" class="shortcut">Description</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="SoupMessageBody.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="libsoup-2.4-soup-method"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="libsoup-2.4-soup-method.top_of_page"></a>soup-method</span></h2> -<p>soup-method — HTTP method definitions</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="libsoup-2.4-soup-method.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="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-soup-method.html#SOUP-METHOD-OPTIONS:CAPS" title="SOUP_METHOD_OPTIONS">SOUP_METHOD_OPTIONS</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-soup-method.html#SOUP-METHOD-GET:CAPS" title="SOUP_METHOD_GET">SOUP_METHOD_GET</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-soup-method.html#SOUP-METHOD-HEAD:CAPS" title="SOUP_METHOD_HEAD">SOUP_METHOD_HEAD</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-soup-method.html#SOUP-METHOD-PUT:CAPS" title="SOUP_METHOD_PUT">SOUP_METHOD_PUT</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-soup-method.html#SOUP-METHOD-POST:CAPS" title="SOUP_METHOD_POST">SOUP_METHOD_POST</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-soup-method.html#SOUP-METHOD-DELETE:CAPS" title="SOUP_METHOD_DELETE">SOUP_METHOD_DELETE</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-soup-method.html#SOUP-METHOD-TRACE:CAPS" title="SOUP_METHOD_TRACE">SOUP_METHOD_TRACE</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-soup-method.html#SOUP-METHOD-CONNECT:CAPS" title="SOUP_METHOD_CONNECT">SOUP_METHOD_CONNECT</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-soup-method.html#SOUP-METHOD-PROPFIND:CAPS" title="SOUP_METHOD_PROPFIND">SOUP_METHOD_PROPFIND</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-soup-method.html#SOUP-METHOD-PROPPATCH:CAPS" title="SOUP_METHOD_PROPPATCH">SOUP_METHOD_PROPPATCH</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-soup-method.html#SOUP-METHOD-MKCOL:CAPS" title="SOUP_METHOD_MKCOL">SOUP_METHOD_MKCOL</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-soup-method.html#SOUP-METHOD-COPY:CAPS" title="SOUP_METHOD_COPY">SOUP_METHOD_COPY</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-soup-method.html#SOUP-METHOD-MOVE:CAPS" title="SOUP_METHOD_MOVE">SOUP_METHOD_MOVE</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-soup-method.html#SOUP-METHOD-LOCK:CAPS" title="SOUP_METHOD_LOCK">SOUP_METHOD_LOCK</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-soup-method.html#SOUP-METHOD-UNLOCK:CAPS" title="SOUP_METHOD_UNLOCK">SOUP_METHOD_UNLOCK</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-soup-method.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-soup-method.description"></a><h2>Description</h2> -<p>soup-method.h contains a number of defines for standard HTTP and -WebDAV headers. You do not need to use these defines; you can pass -arbitrary strings to <a class="link" href="SoupMessage.html#soup-message-new" title="soup_message_new ()"><code class="function">soup_message_new()</code></a> if you prefer.</p> -<p>The thing that these defines <span class="emphasis"><em>are</em></span> useful for is -performing quick comparisons against <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>'s <code class="literal">method</code> field; -because that field always contains an interned string, and these -macros return interned strings, you can compare <code class="literal">method</code> directly -against these macros rather than needing to use <code class="function">strcmp()</code>. This is -most useful in SoupServer handlers. Eg:</p> -<div class="informalexample"> - <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> - <tbody> - <tr> - <td class="listing_lines" align="right"><pre>1 -2 -3 -4</pre></td> - <td class="listing_code"><pre class="programlisting"><span class="keyword">if</span> <span class="gtkdoc opt">(</span>msg<span class="gtkdoc opt">-></span>method <span class="gtkdoc opt">!=</span> SOUP_METHOD_GET <span class="gtkdoc opt">&&</span> msg<span class="gtkdoc opt">-></span>method <span class="gtkdoc opt">!=</span> SOUP_METHOD_HEAD<span class="gtkdoc opt">) {</span> - <span class="function"><a href="SoupMessage.html#soup-message-set-status">soup_message_set_status</a></span> <span class="gtkdoc opt">(</span>msg<span class="gtkdoc opt">,</span> SOUP_METHOD_NOT_IMPLEMENTED<span class="gtkdoc opt">);</span> - <span class="keyword">return</span><span class="gtkdoc opt">;</span> -<span class="gtkdoc opt">}</span></pre></td> - </tr> - </tbody> - </table> -</div> - -</div> -<div class="refsect1"> -<a name="libsoup-2.4-soup-method.functions_details"></a><h2>Functions</h2> -<p></p> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-soup-method.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SOUP-METHOD-OPTIONS:CAPS"></a><h3>SOUP_METHOD_OPTIONS</h3> -<pre class="programlisting">#define SOUP_METHOD_OPTIONS _SOUP_INTERN_METHOD (OPTIONS) -</pre> -<p>"OPTIONS" as an interned string.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-METHOD-GET:CAPS"></a><h3>SOUP_METHOD_GET</h3> -<pre class="programlisting">#define SOUP_METHOD_GET _SOUP_INTERN_METHOD (GET) -</pre> -<p>"GET" as an interned string.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-METHOD-HEAD:CAPS"></a><h3>SOUP_METHOD_HEAD</h3> -<pre class="programlisting">#define SOUP_METHOD_HEAD _SOUP_INTERN_METHOD (HEAD) -</pre> -<p>"HEAD" as an interned string.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-METHOD-PUT:CAPS"></a><h3>SOUP_METHOD_PUT</h3> -<pre class="programlisting">#define SOUP_METHOD_PUT _SOUP_INTERN_METHOD (PUT) -</pre> -<p>"PUT" as an interned string.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-METHOD-POST:CAPS"></a><h3>SOUP_METHOD_POST</h3> -<pre class="programlisting">#define SOUP_METHOD_POST _SOUP_INTERN_METHOD (POST) -</pre> -<p>"POST" as an interned string.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-METHOD-DELETE:CAPS"></a><h3>SOUP_METHOD_DELETE</h3> -<pre class="programlisting">#define SOUP_METHOD_DELETE _SOUP_INTERN_METHOD (DELETE) -</pre> -<p>"DELETE" as an interned string.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-METHOD-TRACE:CAPS"></a><h3>SOUP_METHOD_TRACE</h3> -<pre class="programlisting">#define SOUP_METHOD_TRACE _SOUP_INTERN_METHOD (TRACE) -</pre> -<p>"TRACE" as an interned string.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-METHOD-CONNECT:CAPS"></a><h3>SOUP_METHOD_CONNECT</h3> -<pre class="programlisting">#define SOUP_METHOD_CONNECT _SOUP_INTERN_METHOD (CONNECT) -</pre> -<p>"CONNECT" as an interned string.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-METHOD-PROPFIND:CAPS"></a><h3>SOUP_METHOD_PROPFIND</h3> -<pre class="programlisting">#define SOUP_METHOD_PROPFIND _SOUP_INTERN_METHOD (PROPFIND) -</pre> -<p>"PROPFIND" as an interned string.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-METHOD-PROPPATCH:CAPS"></a><h3>SOUP_METHOD_PROPPATCH</h3> -<pre class="programlisting">#define SOUP_METHOD_PROPPATCH _SOUP_INTERN_METHOD (PROPPATCH) -</pre> -<p>"PROPPATCH" as an interned string.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-METHOD-MKCOL:CAPS"></a><h3>SOUP_METHOD_MKCOL</h3> -<pre class="programlisting">#define SOUP_METHOD_MKCOL _SOUP_INTERN_METHOD (MKCOL) -</pre> -<p>"MKCOL" as an interned string.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-METHOD-COPY:CAPS"></a><h3>SOUP_METHOD_COPY</h3> -<pre class="programlisting">#define SOUP_METHOD_COPY _SOUP_INTERN_METHOD (COPY) -</pre> -<p>"COPY" as an interned string.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-METHOD-MOVE:CAPS"></a><h3>SOUP_METHOD_MOVE</h3> -<pre class="programlisting">#define SOUP_METHOD_MOVE _SOUP_INTERN_METHOD (MOVE) -</pre> -<p>"MOVE" as an interned string.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-METHOD-LOCK:CAPS"></a><h3>SOUP_METHOD_LOCK</h3> -<pre class="programlisting">#define SOUP_METHOD_LOCK _SOUP_INTERN_METHOD (LOCK) -</pre> -<p>"LOCK" as an interned string.</p> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-METHOD-UNLOCK:CAPS"></a><h3>SOUP_METHOD_UNLOCK</h3> -<pre class="programlisting">#define SOUP_METHOD_UNLOCK _SOUP_INTERN_METHOD (UNLOCK) -</pre> -<p>"UNLOCK" as an interned string.</p> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/libsoup-2.4-soup-status.html b/docs/reference/html/libsoup-2.4-soup-status.html deleted file mode 100644 index 562c0975..00000000 --- a/docs/reference/html/libsoup-2.4-soup-status.html +++ /dev/null @@ -1,851 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>soup-status: 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="ch02.html" title="Core API"> -<link rel="prev" href="SoupSessionSync.html" title="SoupSessionSync"> -<link rel="next" href="libsoup-2.4-Top-Level-Domain-utils.html" title="Top Level Domain utils"> -<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="#libsoup-2.4-soup-status.description" class="shortcut">Description</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="SoupSessionSync.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="libsoup-2.4-Top-Level-Domain-utils.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="libsoup-2.4-soup-status"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="libsoup-2.4-soup-status.top_of_page"></a>soup-status</span></h2> -<p>soup-status — HTTP (and libsoup) status codes</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="libsoup-2.4-soup-status.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="define_keyword">#define</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-IS-TRANSPORT-ERROR:CAPS" title="SOUP_STATUS_IS_TRANSPORT_ERROR()">SOUP_STATUS_IS_TRANSPORT_ERROR</a><span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-IS-INFORMATIONAL:CAPS" title="SOUP_STATUS_IS_INFORMATIONAL()">SOUP_STATUS_IS_INFORMATIONAL</a><span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-IS-SUCCESSFUL:CAPS" title="SOUP_STATUS_IS_SUCCESSFUL()">SOUP_STATUS_IS_SUCCESSFUL</a><span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-IS-REDIRECTION:CAPS" title="SOUP_STATUS_IS_REDIRECTION()">SOUP_STATUS_IS_REDIRECTION</a><span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-IS-CLIENT-ERROR:CAPS" title="SOUP_STATUS_IS_CLIENT_ERROR()">SOUP_STATUS_IS_CLIENT_ERROR</a><span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-IS-SERVER-ERROR:CAPS" title="SOUP_STATUS_IS_SERVER_ERROR()">SOUP_STATUS_IS_SERVER_ERROR</a><span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type">const <span class="returnvalue">char</span> * -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-soup-status.html#soup-status-get-phrase" title="soup_status_get_phrase ()">soup_status_get_phrase</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">guint</span> -</td> -<td class="function_name"> -<a class="link" href="libsoup-2.4-soup-status.html#soup-status-proxify" title="soup_status_proxify ()">soup_status_proxify</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-soup-status.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">enum</td> -<td class="function_name"><a class="link" href="libsoup-2.4-soup-status.html#SoupStatus" title="enum SoupStatus">SoupStatus</a></td> -</tr> -<tr> -<td class="define_keyword">#define</td> -<td class="function_name"><a class="link" href="libsoup-2.4-soup-status.html#SOUP-HTTP-ERROR:CAPS" title="SOUP_HTTP_ERROR">SOUP_HTTP_ERROR</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-soup-status.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-soup-status.description"></a><h2>Description</h2> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-soup-status.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="SOUP-STATUS-IS-TRANSPORT-ERROR:CAPS"></a><h3>SOUP_STATUS_IS_TRANSPORT_ERROR()</h3> -<pre class="programlisting">#define SOUP_STATUS_IS_TRANSPORT_ERROR(status) ((status) > 0 && (status) < 100) -</pre> -<p>Tests if <em class="parameter"><code>status</code></em> - is a libsoup transport error.</p> -<div class="refsect3"> -<a name="SOUP-STATUS-IS-TRANSPORT-ERROR.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>status</p></td> -<td class="parameter_description"><p>a status code</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="SOUP-STATUS-IS-TRANSPORT-ERROR.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> or <code class="literal">FALSE</code></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-STATUS-IS-INFORMATIONAL:CAPS"></a><h3>SOUP_STATUS_IS_INFORMATIONAL()</h3> -<pre class="programlisting">#define SOUP_STATUS_IS_INFORMATIONAL(status) ((status) >= 100 && (status) < 200) -</pre> -<p>Tests if <em class="parameter"><code>status</code></em> - is an Informational (1xx) response.</p> -<div class="refsect3"> -<a name="SOUP-STATUS-IS-INFORMATIONAL.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>status</p></td> -<td class="parameter_description"><p>an HTTP status code</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="SOUP-STATUS-IS-INFORMATIONAL.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> or <code class="literal">FALSE</code></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-STATUS-IS-SUCCESSFUL:CAPS"></a><h3>SOUP_STATUS_IS_SUCCESSFUL()</h3> -<pre class="programlisting">#define SOUP_STATUS_IS_SUCCESSFUL(status) ((status) >= 200 && (status) < 300) -</pre> -<p>Tests if <em class="parameter"><code>status</code></em> - is a Successful (2xx) response.</p> -<div class="refsect3"> -<a name="SOUP-STATUS-IS-SUCCESSFUL.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>status</p></td> -<td class="parameter_description"><p>an HTTP status code</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="SOUP-STATUS-IS-SUCCESSFUL.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> or <code class="literal">FALSE</code></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-STATUS-IS-REDIRECTION:CAPS"></a><h3>SOUP_STATUS_IS_REDIRECTION()</h3> -<pre class="programlisting">#define SOUP_STATUS_IS_REDIRECTION(status) ((status) >= 300 && (status) < 400) -</pre> -<p>Tests if <em class="parameter"><code>status</code></em> - is a Redirection (3xx) response.</p> -<div class="refsect3"> -<a name="SOUP-STATUS-IS-REDIRECTION.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>status</p></td> -<td class="parameter_description"><p>an HTTP status code</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="SOUP-STATUS-IS-REDIRECTION.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> or <code class="literal">FALSE</code></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-STATUS-IS-CLIENT-ERROR:CAPS"></a><h3>SOUP_STATUS_IS_CLIENT_ERROR()</h3> -<pre class="programlisting">#define SOUP_STATUS_IS_CLIENT_ERROR(status) ((status) >= 400 && (status) < 500) -</pre> -<p>Tests if <em class="parameter"><code>status</code></em> - is a Client Error (4xx) response.</p> -<div class="refsect3"> -<a name="SOUP-STATUS-IS-CLIENT-ERROR.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>status</p></td> -<td class="parameter_description"><p>an HTTP status code</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="SOUP-STATUS-IS-CLIENT-ERROR.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> or <code class="literal">FALSE</code></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-STATUS-IS-SERVER-ERROR:CAPS"></a><h3>SOUP_STATUS_IS_SERVER_ERROR()</h3> -<pre class="programlisting">#define SOUP_STATUS_IS_SERVER_ERROR(status) ((status) >= 500 && (status) < 600) -</pre> -<p>Tests if <em class="parameter"><code>status</code></em> - is a Server Error (5xx) response.</p> -<div class="refsect3"> -<a name="SOUP-STATUS-IS-SERVER-ERROR.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>status</p></td> -<td class="parameter_description"><p>an HTTP status code</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="SOUP-STATUS-IS-SERVER-ERROR.returns"></a><h4>Returns</h4> -<p> <code class="literal">TRUE</code> or <code class="literal">FALSE</code></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-status-get-phrase"></a><h3>soup_status_get_phrase ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * -soup_status_get_phrase (<em class="parameter"><code><span class="type">guint</span> status_code</code></em>);</pre> -<p>Looks up the stock HTTP description of <em class="parameter"><code>status_code</code></em> -. This is used -by <a class="link" href="SoupMessage.html#soup-message-set-status" title="soup_message_set_status ()"><code class="function">soup_message_set_status()</code></a> to get the correct text to go with a -given status code.</p> -<p><span class="emphasis"><em>There is no reason for you to ever use this -function.</em></span> If you wanted the textual description for the -<a class="link" href="SoupMessage.html#SoupMessage--status-code" title="The “status-code” property"><span class="type">“status_code”</span></a> of a given <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>, you should just -look at the message's <a class="link" href="SoupMessage.html#SoupMessage--reason-phrase" title="The “reason-phrase” property"><span class="type">“reason_phrase”</span></a>. However, you -should only do that for use in debugging messages; HTTP reason -phrases are not localized, and are not generally very descriptive -anyway, and so they should never be presented to the user directly. -Instead, you should create you own error messages based on the -status code, and on what you were trying to do.</p> -<div class="refsect3"> -<a name="soup-status-get-phrase.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>status_code</p></td> -<td class="parameter_description"><p>an HTTP status code</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-status-get-phrase.returns"></a><h4>Returns</h4> -<p> the (terse, English) description of <em class="parameter"><code>status_code</code></em> -</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-status-proxify"></a><h3>soup_status_proxify ()</h3> -<pre class="programlisting"><span class="returnvalue">guint</span> -soup_status_proxify (<em class="parameter"><code><span class="type">guint</span> status_code</code></em>);</pre> -<p>Turns <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-CANT-RESOLVE:CAPS"><code class="literal">SOUP_STATUS_CANT_RESOLVE</code></a> into -<a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-CANT-RESOLVE-PROXY:CAPS"><code class="literal">SOUP_STATUS_CANT_RESOLVE_PROXY</code></a> and <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-CANT-CONNECT:CAPS"><code class="literal">SOUP_STATUS_CANT_CONNECT</code></a> into -<a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-CANT-CONNECT-PROXY:CAPS"><code class="literal">SOUP_STATUS_CANT_CONNECT_PROXY</code></a>. Other status codes are passed -through unchanged.</p> -<div class="refsect3"> -<a name="soup-status-proxify.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>status_code</p></td> -<td class="parameter_description"><p>a status code</p></td> -<td class="parameter_annotations"> </td> -</tr></tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-status-proxify.returns"></a><h4>Returns</h4> -<p> the "proxified" equivalent of <em class="parameter"><code>status_code</code></em> -.</p> -</div> -<p class="since">Since: 2.26</p> -</div> -</div> -<div class="refsect1"> -<a name="libsoup-2.4-soup-status.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupStatus"></a><h3>enum SoupStatus</h3> -<p>These represent the known HTTP status code values, plus various -network and internal errors.</p> -<p>Note that no libsoup functions take or return this type directly; -any function that works with status codes will accept unrecognized -status codes as well.</p> -<p>Prior to 2.44 this type was called -<code class="literal">SoupKnownStatusCode</code>, but the individual values -have always had the names they have now.</p> -<div class="refsect3"> -<a name="SoupStatus.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="enum_members_name"> -<col class="enum_members_description"> -<col width="200px" class="enum_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-NONE:CAPS"></a>SOUP_STATUS_NONE</p></td> -<td class="enum_member_description"> -<p>No status available. (Eg, the message has not -been sent yet)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-CANCELLED:CAPS"></a>SOUP_STATUS_CANCELLED</p></td> -<td class="enum_member_description"> -<p>Message was cancelled locally</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-CANT-RESOLVE:CAPS"></a>SOUP_STATUS_CANT_RESOLVE</p></td> -<td class="enum_member_description"> -<p>Unable to resolve destination host name</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-CANT-RESOLVE-PROXY:CAPS"></a>SOUP_STATUS_CANT_RESOLVE_PROXY</p></td> -<td class="enum_member_description"> -<p>Unable to resolve proxy host name</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-CANT-CONNECT:CAPS"></a>SOUP_STATUS_CANT_CONNECT</p></td> -<td class="enum_member_description"> -<p>Unable to connect to remote host</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-CANT-CONNECT-PROXY:CAPS"></a>SOUP_STATUS_CANT_CONNECT_PROXY</p></td> -<td class="enum_member_description"> -<p>Unable to connect to proxy</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-SSL-FAILED:CAPS"></a>SOUP_STATUS_SSL_FAILED</p></td> -<td class="enum_member_description"> -<p>SSL/TLS negotiation failed</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-IO-ERROR:CAPS"></a>SOUP_STATUS_IO_ERROR</p></td> -<td class="enum_member_description"> -<p>A network error occurred, or the other end -closed the connection unexpectedly</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-MALFORMED:CAPS"></a>SOUP_STATUS_MALFORMED</p></td> -<td class="enum_member_description"> -<p>Malformed data (usually a programmer error)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-TRY-AGAIN:CAPS"></a>SOUP_STATUS_TRY_AGAIN</p></td> -<td class="enum_member_description"> -<p>Used internally</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-TOO-MANY-REDIRECTS:CAPS"></a>SOUP_STATUS_TOO_MANY_REDIRECTS</p></td> -<td class="enum_member_description"> -<p>There were too many redirections</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-TLS-FAILED:CAPS"></a>SOUP_STATUS_TLS_FAILED</p></td> -<td class="enum_member_description"> -<p>Used internally</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-CONTINUE:CAPS"></a>SOUP_STATUS_CONTINUE</p></td> -<td class="enum_member_description"> -<p>100 Continue (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-SWITCHING-PROTOCOLS:CAPS"></a>SOUP_STATUS_SWITCHING_PROTOCOLS</p></td> -<td class="enum_member_description"> -<p>101 Switching Protocols (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-PROCESSING:CAPS"></a>SOUP_STATUS_PROCESSING</p></td> -<td class="enum_member_description"> -<p>102 Processing (WebDAV)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-OK:CAPS"></a>SOUP_STATUS_OK</p></td> -<td class="enum_member_description"> -<p>200 Success (HTTP). Also used by many lower-level -soup routines to indicate success.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-CREATED:CAPS"></a>SOUP_STATUS_CREATED</p></td> -<td class="enum_member_description"> -<p>201 Created (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-ACCEPTED:CAPS"></a>SOUP_STATUS_ACCEPTED</p></td> -<td class="enum_member_description"> -<p>202 Accepted (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-NON-AUTHORITATIVE:CAPS"></a>SOUP_STATUS_NON_AUTHORITATIVE</p></td> -<td class="enum_member_description"> -<p>203 Non-Authoritative Information -(HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-NO-CONTENT:CAPS"></a>SOUP_STATUS_NO_CONTENT</p></td> -<td class="enum_member_description"> -<p>204 No Content (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-RESET-CONTENT:CAPS"></a>SOUP_STATUS_RESET_CONTENT</p></td> -<td class="enum_member_description"> -<p>205 Reset Content (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-PARTIAL-CONTENT:CAPS"></a>SOUP_STATUS_PARTIAL_CONTENT</p></td> -<td class="enum_member_description"> -<p>206 Partial Content (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-MULTI-STATUS:CAPS"></a>SOUP_STATUS_MULTI_STATUS</p></td> -<td class="enum_member_description"> -<p>207 Multi-Status (WebDAV)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-MULTIPLE-CHOICES:CAPS"></a>SOUP_STATUS_MULTIPLE_CHOICES</p></td> -<td class="enum_member_description"> -<p>300 Multiple Choices (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-MOVED-PERMANENTLY:CAPS"></a>SOUP_STATUS_MOVED_PERMANENTLY</p></td> -<td class="enum_member_description"> -<p>301 Moved Permanently (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-FOUND:CAPS"></a>SOUP_STATUS_FOUND</p></td> -<td class="enum_member_description"> -<p>302 Found (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-MOVED-TEMPORARILY:CAPS"></a>SOUP_STATUS_MOVED_TEMPORARILY</p></td> -<td class="enum_member_description"> -<p>302 Moved Temporarily (old name, -RFC 2068)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-SEE-OTHER:CAPS"></a>SOUP_STATUS_SEE_OTHER</p></td> -<td class="enum_member_description"> -<p>303 See Other (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-NOT-MODIFIED:CAPS"></a>SOUP_STATUS_NOT_MODIFIED</p></td> -<td class="enum_member_description"> -<p>304 Not Modified (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-USE-PROXY:CAPS"></a>SOUP_STATUS_USE_PROXY</p></td> -<td class="enum_member_description"> -<p>305 Use Proxy (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-NOT-APPEARING-IN-THIS-PROTOCOL:CAPS"></a>SOUP_STATUS_NOT_APPEARING_IN_THIS_PROTOCOL</p></td> -<td class="enum_member_description"> -<p>306 [Unused] (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-TEMPORARY-REDIRECT:CAPS"></a>SOUP_STATUS_TEMPORARY_REDIRECT</p></td> -<td class="enum_member_description"> -<p>307 Temporary Redirect (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-BAD-REQUEST:CAPS"></a>SOUP_STATUS_BAD_REQUEST</p></td> -<td class="enum_member_description"> -<p>400 Bad Request (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-UNAUTHORIZED:CAPS"></a>SOUP_STATUS_UNAUTHORIZED</p></td> -<td class="enum_member_description"> -<p>401 Unauthorized (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-PAYMENT-REQUIRED:CAPS"></a>SOUP_STATUS_PAYMENT_REQUIRED</p></td> -<td class="enum_member_description"> -<p>402 Payment Required (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-FORBIDDEN:CAPS"></a>SOUP_STATUS_FORBIDDEN</p></td> -<td class="enum_member_description"> -<p>403 Forbidden (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-NOT-FOUND:CAPS"></a>SOUP_STATUS_NOT_FOUND</p></td> -<td class="enum_member_description"> -<p>404 Not Found (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-METHOD-NOT-ALLOWED:CAPS"></a>SOUP_STATUS_METHOD_NOT_ALLOWED</p></td> -<td class="enum_member_description"> -<p>405 Method Not Allowed (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-NOT-ACCEPTABLE:CAPS"></a>SOUP_STATUS_NOT_ACCEPTABLE</p></td> -<td class="enum_member_description"> -<p>406 Not Acceptable (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-PROXY-AUTHENTICATION-REQUIRED:CAPS"></a>SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED</p></td> -<td class="enum_member_description"> -<p>407 Proxy Authentication -Required (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-PROXY-UNAUTHORIZED:CAPS"></a>SOUP_STATUS_PROXY_UNAUTHORIZED</p></td> -<td class="enum_member_description"> -<p>shorter alias for -<a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-PROXY-AUTHENTICATION-REQUIRED:CAPS"><code class="literal">SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED</code></a></p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-REQUEST-TIMEOUT:CAPS"></a>SOUP_STATUS_REQUEST_TIMEOUT</p></td> -<td class="enum_member_description"> -<p>408 Request Timeout (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-CONFLICT:CAPS"></a>SOUP_STATUS_CONFLICT</p></td> -<td class="enum_member_description"> -<p>409 Conflict (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-GONE:CAPS"></a>SOUP_STATUS_GONE</p></td> -<td class="enum_member_description"> -<p>410 Gone (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-LENGTH-REQUIRED:CAPS"></a>SOUP_STATUS_LENGTH_REQUIRED</p></td> -<td class="enum_member_description"> -<p>411 Length Required (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-PRECONDITION-FAILED:CAPS"></a>SOUP_STATUS_PRECONDITION_FAILED</p></td> -<td class="enum_member_description"> -<p>412 Precondition Failed (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-REQUEST-ENTITY-TOO-LARGE:CAPS"></a>SOUP_STATUS_REQUEST_ENTITY_TOO_LARGE</p></td> -<td class="enum_member_description"> -<p>413 Request Entity Too Large -(HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-REQUEST-URI-TOO-LONG:CAPS"></a>SOUP_STATUS_REQUEST_URI_TOO_LONG</p></td> -<td class="enum_member_description"> -<p>414 Request-URI Too Long (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-UNSUPPORTED-MEDIA-TYPE:CAPS"></a>SOUP_STATUS_UNSUPPORTED_MEDIA_TYPE</p></td> -<td class="enum_member_description"> -<p>415 Unsupported Media Type -(HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-REQUESTED-RANGE-NOT-SATISFIABLE:CAPS"></a>SOUP_STATUS_REQUESTED_RANGE_NOT_SATISFIABLE</p></td> -<td class="enum_member_description"> -<p>416 Requested Range -Not Satisfiable (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-INVALID-RANGE:CAPS"></a>SOUP_STATUS_INVALID_RANGE</p></td> -<td class="enum_member_description"> -<p>shorter alias for -<a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-REQUESTED-RANGE-NOT-SATISFIABLE:CAPS"><code class="literal">SOUP_STATUS_REQUESTED_RANGE_NOT_SATISFIABLE</code></a></p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-EXPECTATION-FAILED:CAPS"></a>SOUP_STATUS_EXPECTATION_FAILED</p></td> -<td class="enum_member_description"> -<p>417 Expectation Failed (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-UNPROCESSABLE-ENTITY:CAPS"></a>SOUP_STATUS_UNPROCESSABLE_ENTITY</p></td> -<td class="enum_member_description"> -<p>422 Unprocessable Entity -(WebDAV)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-LOCKED:CAPS"></a>SOUP_STATUS_LOCKED</p></td> -<td class="enum_member_description"> -<p>423 Locked (WebDAV)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-FAILED-DEPENDENCY:CAPS"></a>SOUP_STATUS_FAILED_DEPENDENCY</p></td> -<td class="enum_member_description"> -<p>424 Failed Dependency (WebDAV)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-INTERNAL-SERVER-ERROR:CAPS"></a>SOUP_STATUS_INTERNAL_SERVER_ERROR</p></td> -<td class="enum_member_description"> -<p>500 Internal Server Error -(HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-NOT-IMPLEMENTED:CAPS"></a>SOUP_STATUS_NOT_IMPLEMENTED</p></td> -<td class="enum_member_description"> -<p>501 Not Implemented (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-BAD-GATEWAY:CAPS"></a>SOUP_STATUS_BAD_GATEWAY</p></td> -<td class="enum_member_description"> -<p>502 Bad Gateway (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-SERVICE-UNAVAILABLE:CAPS"></a>SOUP_STATUS_SERVICE_UNAVAILABLE</p></td> -<td class="enum_member_description"> -<p>503 Service Unavailable (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-GATEWAY-TIMEOUT:CAPS"></a>SOUP_STATUS_GATEWAY_TIMEOUT</p></td> -<td class="enum_member_description"> -<p>504 Gateway Timeout (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-HTTP-VERSION-NOT-SUPPORTED:CAPS"></a>SOUP_STATUS_HTTP_VERSION_NOT_SUPPORTED</p></td> -<td class="enum_member_description"> -<p>505 HTTP Version Not -Supported (HTTP)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-INSUFFICIENT-STORAGE:CAPS"></a>SOUP_STATUS_INSUFFICIENT_STORAGE</p></td> -<td class="enum_member_description"> -<p>507 Insufficient Storage -(WebDAV)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-STATUS-NOT-EXTENDED:CAPS"></a>SOUP_STATUS_NOT_EXTENDED</p></td> -<td class="enum_member_description"> -<p>510 Not Extended (RFC 2774)</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SOUP-HTTP-ERROR:CAPS"></a><h3>SOUP_HTTP_ERROR</h3> -<pre class="programlisting">#define SOUP_HTTP_ERROR soup_http_error_quark() -</pre> -<p>A <span class="type">GError</span> domain representing an HTTP status. Use a <a class="link" href="libsoup-2.4-soup-status.html#SoupStatus" title="enum SoupStatus"><span class="type">SoupStatus</span></a> for -the <em class="structfield"><code>code</code></em> value.</p> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/libsoup-2.4.devhelp2 b/docs/reference/html/libsoup-2.4.devhelp2 deleted file mode 100644 index 8301b7d1..00000000 --- a/docs/reference/html/libsoup-2.4.devhelp2 +++ /dev/null @@ -1,1057 +0,0 @@ -<?xml version="1.0" encoding="utf-8" standalone="no"?> -<book xmlns="http://www.devhelp.net/book" title="libsoup Reference Manual" link="index.html" author="" name="libsoup-2.4" version="2" language="c"> - <chapters> - <sub name="Tutorial" link="ch01.html"> - <sub name="Compiling with libsoup" link="libsoup-build-howto.html"/> - <sub name="libsoup Client Basics" link="libsoup-client-howto.html"/> - <sub name="libsoup Client SoupRequest API" link="libsoup-request-howto.html"/> - <sub name="Porting to the new SoupSession" link="libsoup-session-porting.html"/> - <sub name="libsoup Server Basics" link="libsoup-server-howto.html"/> - </sub> - <sub name="Core API" link="ch02.html"> - <sub name="SoupAuth" link="SoupAuth.html"/> - <sub name="SoupAuthDomain" link="SoupAuthDomain.html"/> - <sub name="SoupAuthDomainBasic" link="SoupAuthDomainBasic.html"/> - <sub name="SoupAuthDomainDigest" link="SoupAuthDomainDigest.html"/> - <sub name="SoupCache" link="SoupCache.html"/> - <sub name="SoupCookie" link="SoupCookie.html"/> - <sub name="SoupMessage" link="SoupMessage.html"/> - <sub name="SoupMessageHeaders" link="SoupMessageHeaders.html"/> - <sub name="SoupMessageBody" link="SoupMessageBody.html"/> - <sub name="soup-method" link="libsoup-2.4-soup-method.html"/> - <sub name="Soup Miscellaneous Utilities" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html"/> - <sub name="SoupMultipart" link="SoupMultipart.html"/> - <sub name="SoupMultipartInputStream" link="SoupMultipartInputStream.html"/> - <sub name="SoupRequest" link="SoupRequest.html"/> - <sub name="SoupRequestHTTP" link="SoupRequestHTTP.html"/> - <sub name="SoupRequestFile" link="SoupRequestFile.html"/> - <sub name="SoupRequestData" link="SoupRequestData.html"/> - <sub name="SoupServer" link="SoupServer.html"/> - <sub name="SoupServer deprecated API" link="libsoup-2.4-SoupServer-deprecated-API.html"/> - <sub name="SoupSession" link="SoupSession.html"/> - <sub name="SoupSessionAsync" link="SoupSessionAsync.html"/> - <sub name="SoupSessionSync" link="SoupSessionSync.html"/> - <sub name="soup-status" link="libsoup-2.4-soup-status.html"/> - <sub name="Top Level Domain utils" link="libsoup-2.4-Top-Level-Domain-utils.html"/> - <sub name="SoupURI" link="SoupURI.html"/> - <sub name="Version Information" link="libsoup-2.4-Version-Information.html"/> - </sub> - <sub name="Additional Features" link="ch03.html"> - <sub name="SoupSessionFeature" link="SoupSessionFeature.html"/> - <sub name="SoupAuthManager" link="SoupAuthManager.html"/> - <sub name="SoupContentDecoder" link="SoupContentDecoder.html"/> - <sub name="SoupContentSniffer" link="SoupContentSniffer.html"/> - <sub name="SoupCookieJar" link="SoupCookieJar.html"/> - <sub name="SoupCookieJarText" link="SoupCookieJarText.html"/> - <sub name="SoupCookieJarDB" link="SoupCookieJarDB.html"/> - <sub name="SoupLogger" link="SoupLogger.html"/> - <sub name="SoupProxyResolverDefault" link="SoupProxyResolverDefault.html"/> - </sub> - <sub name="Web Services APIs" link="ch04.html"> - <sub name="HTML Form Support" link="libsoup-2.4-HTML-Form-Support.html"/> - <sub name="XMLRPC Support" link="libsoup-2.4-XMLRPC-Support.html"/> - <sub name="WebSockets" link="libsoup-2.4-WebSockets.html"/> - </sub> - <sub name="Low-level Networking API" link="ch05.html"> - <sub name="SoupAddress" link="SoupAddress.html"/> - <sub name="SoupSocket" link="SoupSocket.html"/> - </sub> - <sub name="Index" link="ix01.html"/> - <sub name="Annotation Glossary" link="annotation-glossary.html"/> - </chapters> - <functions> - <keyword type="function" name="soup_auth_new ()" link="SoupAuth.html#soup-auth-new"/> - <keyword type="function" name="soup_auth_update ()" link="SoupAuth.html#soup-auth-update"/> - <keyword type="function" name="soup_auth_negotiate_supported ()" link="SoupAuth.html#soup-auth-negotiate-supported" since="2.54"/> - <keyword type="function" name="soup_auth_is_for_proxy ()" link="SoupAuth.html#soup-auth-is-for-proxy"/> - <keyword type="function" name="soup_auth_get_scheme_name ()" link="SoupAuth.html#soup-auth-get-scheme-name"/> - <keyword type="function" name="soup_auth_get_host ()" link="SoupAuth.html#soup-auth-get-host"/> - <keyword type="function" name="soup_auth_get_realm ()" link="SoupAuth.html#soup-auth-get-realm"/> - <keyword type="function" name="soup_auth_get_info ()" link="SoupAuth.html#soup-auth-get-info"/> - <keyword type="function" name="soup_auth_authenticate ()" link="SoupAuth.html#soup-auth-authenticate"/> - <keyword type="function" name="soup_auth_can_authenticate ()" link="SoupAuth.html#soup-auth-can-authenticate" since="2.54"/> - <keyword type="function" name="soup_auth_is_authenticated ()" link="SoupAuth.html#soup-auth-is-authenticated"/> - <keyword type="function" name="soup_auth_is_ready ()" link="SoupAuth.html#soup-auth-is-ready" since="2.42"/> - <keyword type="function" name="soup_auth_get_authorization ()" link="SoupAuth.html#soup-auth-get-authorization"/> - <keyword type="function" name="soup_auth_get_protection_space ()" link="SoupAuth.html#soup-auth-get-protection-space"/> - <keyword type="function" name="soup_auth_free_protection_space ()" link="SoupAuth.html#soup-auth-free-protection-space"/> - <keyword type="struct" name="SoupAuth" link="SoupAuth.html#SoupAuth-struct"/> - <keyword type="macro" name="SOUP_TYPE_AUTH_BASIC" link="SoupAuth.html#SOUP-TYPE-AUTH-BASIC:CAPS" since="2.34"/> - <keyword type="macro" name="SOUP_TYPE_AUTH_DIGEST" link="SoupAuth.html#SOUP-TYPE-AUTH-DIGEST:CAPS" since="2.34"/> - <keyword type="macro" name="SOUP_TYPE_AUTH_NTLM" link="SoupAuth.html#SOUP-TYPE-AUTH-NTLM:CAPS" since="2.34"/> - <keyword type="macro" name="SOUP_TYPE_AUTH_NEGOTIATE" link="SoupAuth.html#SOUP-TYPE-AUTH-NEGOTIATE:CAPS" since="2.54"/> - <keyword type="macro" name="SOUP_AUTH_SCHEME_NAME" link="SoupAuth.html#SOUP-AUTH-SCHEME-NAME:CAPS"/> - <keyword type="macro" name="SOUP_AUTH_REALM" link="SoupAuth.html#SOUP-AUTH-REALM:CAPS"/> - <keyword type="macro" name="SOUP_AUTH_HOST" link="SoupAuth.html#SOUP-AUTH-HOST:CAPS"/> - <keyword type="macro" name="SOUP_AUTH_IS_FOR_PROXY" link="SoupAuth.html#SOUP-AUTH-IS-FOR-PROXY:CAPS"/> - <keyword type="macro" name="SOUP_AUTH_IS_AUTHENTICATED" link="SoupAuth.html#SOUP-AUTH-IS-AUTHENTICATED:CAPS"/> - <keyword type="property" name="The “host” property" link="SoupAuth.html#SoupAuth--host"/> - <keyword type="property" name="The “is-authenticated” property" link="SoupAuth.html#SoupAuth--is-authenticated"/> - <keyword type="property" name="The “is-for-proxy” property" link="SoupAuth.html#SoupAuth--is-for-proxy"/> - <keyword type="property" name="The “realm” property" link="SoupAuth.html#SoupAuth--realm"/> - <keyword type="property" name="The “scheme-name” property" link="SoupAuth.html#SoupAuth--scheme-name"/> - <keyword type="function" name="soup_auth_domain_add_path ()" link="SoupAuthDomain.html#soup-auth-domain-add-path"/> - <keyword type="function" name="soup_auth_domain_remove_path ()" link="SoupAuthDomain.html#soup-auth-domain-remove-path"/> - <keyword type="function" name="SoupAuthDomainFilter ()" link="SoupAuthDomain.html#SoupAuthDomainFilter"/> - <keyword type="function" name="soup_auth_domain_set_filter ()" link="SoupAuthDomain.html#soup-auth-domain-set-filter"/> - <keyword type="function" name="soup_auth_domain_get_realm ()" link="SoupAuthDomain.html#soup-auth-domain-get-realm"/> - <keyword type="function" name="SoupAuthDomainGenericAuthCallback ()" link="SoupAuthDomain.html#SoupAuthDomainGenericAuthCallback"/> - <keyword type="function" name="soup_auth_domain_set_generic_auth_callback ()" link="SoupAuthDomain.html#soup-auth-domain-set-generic-auth-callback"/> - <keyword type="function" name="soup_auth_domain_check_password ()" link="SoupAuthDomain.html#soup-auth-domain-check-password"/> - <keyword type="function" name="soup_auth_domain_covers ()" link="SoupAuthDomain.html#soup-auth-domain-covers"/> - <keyword type="function" name="soup_auth_domain_accepts ()" link="SoupAuthDomain.html#soup-auth-domain-accepts"/> - <keyword type="function" name="soup_auth_domain_challenge ()" link="SoupAuthDomain.html#soup-auth-domain-challenge"/> - <keyword type="struct" name="SoupAuthDomain" link="SoupAuthDomain.html#SoupAuthDomain-struct"/> - <keyword type="macro" name="SOUP_AUTH_DOMAIN_REALM" link="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-REALM:CAPS"/> - <keyword type="macro" name="SOUP_AUTH_DOMAIN_PROXY" link="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-PROXY:CAPS"/> - <keyword type="macro" name="SOUP_AUTH_DOMAIN_ADD_PATH" link="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-ADD-PATH:CAPS"/> - <keyword type="macro" name="SOUP_AUTH_DOMAIN_REMOVE_PATH" link="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-REMOVE-PATH:CAPS"/> - <keyword type="macro" name="SOUP_AUTH_DOMAIN_FILTER" link="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-FILTER:CAPS"/> - <keyword type="macro" name="SOUP_AUTH_DOMAIN_FILTER_DATA" link="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-FILTER-DATA:CAPS"/> - <keyword type="macro" name="SOUP_AUTH_DOMAIN_GENERIC_AUTH_CALLBACK" link="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-GENERIC-AUTH-CALLBACK:CAPS"/> - <keyword type="macro" name="SOUP_AUTH_DOMAIN_GENERIC_AUTH_DATA" link="SoupAuthDomain.html#SOUP-AUTH-DOMAIN-GENERIC-AUTH-DATA:CAPS"/> - <keyword type="property" name="The “add-path” property" link="SoupAuthDomain.html#SoupAuthDomain--add-path"/> - <keyword type="property" name="The “filter” property" link="SoupAuthDomain.html#SoupAuthDomain--filter"/> - <keyword type="property" name="The “filter-data” property" link="SoupAuthDomain.html#SoupAuthDomain--filter-data"/> - <keyword type="property" name="The “generic-auth-callback” property" link="SoupAuthDomain.html#SoupAuthDomain--generic-auth-callback"/> - <keyword type="property" name="The “generic-auth-data” property" link="SoupAuthDomain.html#SoupAuthDomain--generic-auth-data"/> - <keyword type="property" name="The “proxy” property" link="SoupAuthDomain.html#SoupAuthDomain--proxy"/> - <keyword type="property" name="The “realm” property" link="SoupAuthDomain.html#SoupAuthDomain--realm"/> - <keyword type="property" name="The “remove-path” property" link="SoupAuthDomain.html#SoupAuthDomain--remove-path"/> - <keyword type="function" name="soup_auth_domain_basic_new ()" link="SoupAuthDomainBasic.html#soup-auth-domain-basic-new"/> - <keyword type="function" name="SoupAuthDomainBasicAuthCallback ()" link="SoupAuthDomainBasic.html#SoupAuthDomainBasicAuthCallback"/> - <keyword type="function" name="soup_auth_domain_basic_set_auth_callback ()" link="SoupAuthDomainBasic.html#soup-auth-domain-basic-set-auth-callback"/> - <keyword type="struct" name="SoupAuthDomainBasic" link="SoupAuthDomainBasic.html#SoupAuthDomainBasic-struct"/> - <keyword type="macro" name="SOUP_AUTH_DOMAIN_BASIC_AUTH_CALLBACK" link="SoupAuthDomainBasic.html#SOUP-AUTH-DOMAIN-BASIC-AUTH-CALLBACK:CAPS"/> - <keyword type="macro" name="SOUP_AUTH_DOMAIN_BASIC_AUTH_DATA" link="SoupAuthDomainBasic.html#SOUP-AUTH-DOMAIN-BASIC-AUTH-DATA:CAPS"/> - <keyword type="property" name="The “auth-callback” property" link="SoupAuthDomainBasic.html#SoupAuthDomainBasic--auth-callback"/> - <keyword type="property" name="The “auth-data” property" link="SoupAuthDomainBasic.html#SoupAuthDomainBasic--auth-data"/> - <keyword type="function" name="soup_auth_domain_digest_new ()" link="SoupAuthDomainDigest.html#soup-auth-domain-digest-new"/> - <keyword type="function" name="SoupAuthDomainDigestAuthCallback ()" link="SoupAuthDomainDigest.html#SoupAuthDomainDigestAuthCallback"/> - <keyword type="function" name="soup_auth_domain_digest_set_auth_callback ()" link="SoupAuthDomainDigest.html#soup-auth-domain-digest-set-auth-callback"/> - <keyword type="function" name="soup_auth_domain_digest_encode_password ()" link="SoupAuthDomainDigest.html#soup-auth-domain-digest-encode-password"/> - <keyword type="struct" name="SoupAuthDomainDigest" link="SoupAuthDomainDigest.html#SoupAuthDomainDigest-struct"/> - <keyword type="macro" name="SOUP_AUTH_DOMAIN_DIGEST_AUTH_CALLBACK" link="SoupAuthDomainDigest.html#SOUP-AUTH-DOMAIN-DIGEST-AUTH-CALLBACK:CAPS"/> - <keyword type="macro" name="SOUP_AUTH_DOMAIN_DIGEST_AUTH_DATA" link="SoupAuthDomainDigest.html#SOUP-AUTH-DOMAIN-DIGEST-AUTH-DATA:CAPS"/> - <keyword type="property" name="The “auth-callback” property" link="SoupAuthDomainDigest.html#SoupAuthDomainDigest--auth-callback"/> - <keyword type="property" name="The “auth-data” property" link="SoupAuthDomainDigest.html#SoupAuthDomainDigest--auth-data"/> - <keyword type="function" name="soup_cache_new ()" link="SoupCache.html#soup-cache-new" since="2.34"/> - <keyword type="function" name="soup_cache_flush ()" link="SoupCache.html#soup-cache-flush" since="2.34"/> - <keyword type="function" name="soup_cache_clear ()" link="SoupCache.html#soup-cache-clear" since="2.34"/> - <keyword type="function" name="soup_cache_dump ()" link="SoupCache.html#soup-cache-dump" since="2.34."/> - <keyword type="function" name="soup_cache_load ()" link="SoupCache.html#soup-cache-load" since="2.34"/> - <keyword type="function" name="soup_cache_get_max_size ()" link="SoupCache.html#soup-cache-get-max-size" since="2.34"/> - <keyword type="function" name="soup_cache_set_max_size ()" link="SoupCache.html#soup-cache-set-max-size" since="2.34"/> - <keyword type="struct" name="struct SoupCache" link="SoupCache.html#SoupCache-struct"/> - <keyword type="enum" name="enum SoupCacheType" link="SoupCache.html#SoupCacheType" since="2.34"/> - <keyword type="property" name="The “cache-dir” property" link="SoupCache.html#SoupCache--cache-dir"/> - <keyword type="property" name="The “cache-type” property" link="SoupCache.html#SoupCache--cache-type"/> - <keyword type="function" name="soup_cookie_new ()" link="SoupCookie.html#soup-cookie-new" since="2.24"/> - <keyword type="function" name="soup_cookie_parse ()" link="SoupCookie.html#soup-cookie-parse" since="2.24"/> - <keyword type="function" name="soup_cookie_copy ()" link="SoupCookie.html#soup-cookie-copy" since="2.24"/> - <keyword type="function" name="soup_cookie_free ()" link="SoupCookie.html#soup-cookie-free" since="2.24"/> - <keyword type="function" name="soup_cookie_set_name ()" link="SoupCookie.html#soup-cookie-set-name" since="2.24"/> - <keyword type="function" name="soup_cookie_get_name ()" link="SoupCookie.html#soup-cookie-get-name" since="2.32"/> - <keyword type="function" name="soup_cookie_set_value ()" link="SoupCookie.html#soup-cookie-set-value" since="2.24"/> - <keyword type="function" name="soup_cookie_get_value ()" link="SoupCookie.html#soup-cookie-get-value" since="2.32"/> - <keyword type="function" name="soup_cookie_set_domain ()" link="SoupCookie.html#soup-cookie-set-domain" since="2.24"/> - <keyword type="function" name="soup_cookie_get_domain ()" link="SoupCookie.html#soup-cookie-get-domain" since="2.32"/> - <keyword type="function" name="soup_cookie_set_path ()" link="SoupCookie.html#soup-cookie-set-path" since="2.24"/> - <keyword type="function" name="soup_cookie_get_path ()" link="SoupCookie.html#soup-cookie-get-path" since="2.32"/> - <keyword type="function" name="soup_cookie_set_max_age ()" link="SoupCookie.html#soup-cookie-set-max-age" since="2.24"/> - <keyword type="function" name="soup_cookie_set_expires ()" link="SoupCookie.html#soup-cookie-set-expires" since="2.24"/> - <keyword type="function" name="soup_cookie_get_expires ()" link="SoupCookie.html#soup-cookie-get-expires" since="2.32"/> - <keyword type="function" name="soup_cookie_set_secure ()" link="SoupCookie.html#soup-cookie-set-secure" since="2.24"/> - <keyword type="function" name="soup_cookie_get_secure ()" link="SoupCookie.html#soup-cookie-get-secure" since="2.32"/> - <keyword type="function" name="soup_cookie_set_http_only ()" link="SoupCookie.html#soup-cookie-set-http-only" since="2.24"/> - <keyword type="function" name="soup_cookie_get_http_only ()" link="SoupCookie.html#soup-cookie-get-http-only" since="2.32"/> - <keyword type="function" name="soup_cookie_applies_to_uri ()" link="SoupCookie.html#soup-cookie-applies-to-uri" since="2.24"/> - <keyword type="function" name="soup_cookie_domain_matches ()" link="SoupCookie.html#soup-cookie-domain-matches" since="2.30"/> - <keyword type="function" name="soup_cookie_to_cookie_header ()" link="SoupCookie.html#soup-cookie-to-cookie-header" since="2.24"/> - <keyword type="function" name="soup_cookie_to_set_cookie_header ()" link="SoupCookie.html#soup-cookie-to-set-cookie-header" since="2.24"/> - <keyword type="function" name="soup_cookies_from_request ()" link="SoupCookie.html#soup-cookies-from-request" since="2.24"/> - <keyword type="function" name="soup_cookies_from_response ()" link="SoupCookie.html#soup-cookies-from-response" since="2.24"/> - <keyword type="function" name="soup_cookies_to_request ()" link="SoupCookie.html#soup-cookies-to-request" since="2.24"/> - <keyword type="function" name="soup_cookies_to_response ()" link="SoupCookie.html#soup-cookies-to-response" since="2.24"/> - <keyword type="function" name="soup_cookies_to_cookie_header ()" link="SoupCookie.html#soup-cookies-to-cookie-header" since="2.24"/> - <keyword type="function" name="soup_cookies_free ()" link="SoupCookie.html#soup-cookies-free" since="2.24"/> - <keyword type="struct" name="SoupCookie" link="SoupCookie.html#SoupCookie-struct"/> - <keyword type="macro" name="SOUP_COOKIE_MAX_AGE_ONE_HOUR" link="SoupCookie.html#SOUP-COOKIE-MAX-AGE-ONE-HOUR:CAPS" since="2.24"/> - <keyword type="macro" name="SOUP_COOKIE_MAX_AGE_ONE_DAY" link="SoupCookie.html#SOUP-COOKIE-MAX-AGE-ONE-DAY:CAPS" since="2.24"/> - <keyword type="macro" name="SOUP_COOKIE_MAX_AGE_ONE_WEEK" link="SoupCookie.html#SOUP-COOKIE-MAX-AGE-ONE-WEEK:CAPS" since="2.24"/> - <keyword type="macro" name="SOUP_COOKIE_MAX_AGE_ONE_YEAR" link="SoupCookie.html#SOUP-COOKIE-MAX-AGE-ONE-YEAR:CAPS" since="2.24"/> - <keyword type="function" name="soup_message_new ()" link="SoupMessage.html#soup-message-new"/> - <keyword type="function" name="soup_message_new_from_uri ()" link="SoupMessage.html#soup-message-new-from-uri"/> - <keyword type="function" name="soup_message_set_request ()" link="SoupMessage.html#soup-message-set-request"/> - <keyword type="function" name="soup_message_set_response ()" link="SoupMessage.html#soup-message-set-response"/> - <keyword type="function" name="soup_message_set_http_version ()" link="SoupMessage.html#soup-message-set-http-version"/> - <keyword type="function" name="soup_message_get_http_version ()" link="SoupMessage.html#soup-message-get-http-version"/> - <keyword type="function" name="soup_message_get_uri ()" link="SoupMessage.html#soup-message-get-uri"/> - <keyword type="function" name="soup_message_set_uri ()" link="SoupMessage.html#soup-message-set-uri"/> - <keyword type="function" name="soup_message_get_address ()" link="SoupMessage.html#soup-message-get-address" since="2.26"/> - <keyword type="function" name="soup_message_set_status ()" link="SoupMessage.html#soup-message-set-status"/> - <keyword type="function" name="soup_message_set_status_full ()" link="SoupMessage.html#soup-message-set-status-full"/> - <keyword type="function" name="soup_message_set_redirect ()" link="SoupMessage.html#soup-message-set-redirect" since="2.38"/> - <keyword type="function" name="soup_message_is_keepalive ()" link="SoupMessage.html#soup-message-is-keepalive"/> - <keyword type="function" name="soup_message_get_https_status ()" link="SoupMessage.html#soup-message-get-https-status" since="2.34"/> - <keyword type="function" name="soup_message_set_first_party ()" link="SoupMessage.html#soup-message-set-first-party" since="2.30"/> - <keyword type="function" name="soup_message_get_first_party ()" link="SoupMessage.html#soup-message-get-first-party" since="2.30"/> - <keyword type="function" name="soup_message_add_header_handler ()" link="SoupMessage.html#soup-message-add-header-handler"/> - <keyword type="function" name="soup_message_add_status_code_handler ()" link="SoupMessage.html#soup-message-add-status-code-handler"/> - <keyword type="function" name="soup_message_set_flags ()" link="SoupMessage.html#soup-message-set-flags"/> - <keyword type="function" name="soup_message_get_flags ()" link="SoupMessage.html#soup-message-get-flags"/> - <keyword type="function" name="SoupChunkAllocator ()" link="SoupMessage.html#SoupChunkAllocator" deprecated=""/> - <keyword type="function" name="soup_message_disable_feature ()" link="SoupMessage.html#soup-message-disable-feature" since="2.28"/> - <keyword type="function" name="soup_message_get_soup_request ()" link="SoupMessage.html#soup-message-get-soup-request" since="2.42"/> - <keyword type="function" name="soup_message_get_priority ()" link="SoupMessage.html#soup-message-get-priority" since="2.44"/> - <keyword type="function" name="soup_message_set_priority ()" link="SoupMessage.html#soup-message-set-priority" since="2.44"/> - <keyword type="struct" name="SoupMessage" link="SoupMessage.html#SoupMessage-struct"/> - <keyword type="enum" name="enum SoupHTTPVersion" link="SoupMessage.html#SoupHTTPVersion"/> - <keyword type="enum" name="enum SoupMessageFlags" link="SoupMessage.html#SoupMessageFlags"/> - <keyword type="enum" name="enum SoupMessagePriority" link="SoupMessage.html#SoupMessagePriority"/> - <keyword type="macro" name="SOUP_MESSAGE_METHOD" link="SoupMessage.html#SOUP-MESSAGE-METHOD:CAPS"/> - <keyword type="macro" name="SOUP_MESSAGE_URI" link="SoupMessage.html#SOUP-MESSAGE-URI:CAPS"/> - <keyword type="macro" name="SOUP_MESSAGE_HTTP_VERSION" link="SoupMessage.html#SOUP-MESSAGE-HTTP-VERSION:CAPS"/> - <keyword type="macro" name="SOUP_MESSAGE_FLAGS" link="SoupMessage.html#SOUP-MESSAGE-FLAGS:CAPS"/> - <keyword type="macro" name="SOUP_MESSAGE_STATUS_CODE" link="SoupMessage.html#SOUP-MESSAGE-STATUS-CODE:CAPS"/> - <keyword type="macro" name="SOUP_MESSAGE_REASON_PHRASE" link="SoupMessage.html#SOUP-MESSAGE-REASON-PHRASE:CAPS"/> - <keyword type="macro" name="SOUP_MESSAGE_SERVER_SIDE" link="SoupMessage.html#SOUP-MESSAGE-SERVER-SIDE:CAPS"/> - <keyword type="macro" name="SOUP_MESSAGE_FIRST_PARTY" link="SoupMessage.html#SOUP-MESSAGE-FIRST-PARTY:CAPS" since="2.30"/> - <keyword type="macro" name="SOUP_MESSAGE_PRIORITY" link="SoupMessage.html#SOUP-MESSAGE-PRIORITY:CAPS" since="2.44"/> - <keyword type="macro" name="SOUP_MESSAGE_REQUEST_BODY" link="SoupMessage.html#SOUP-MESSAGE-REQUEST-BODY:CAPS"/> - <keyword type="macro" name="SOUP_MESSAGE_REQUEST_BODY_DATA" link="SoupMessage.html#SOUP-MESSAGE-REQUEST-BODY-DATA:CAPS" since="2.46"/> - <keyword type="macro" name="SOUP_MESSAGE_REQUEST_HEADERS" link="SoupMessage.html#SOUP-MESSAGE-REQUEST-HEADERS:CAPS"/> - <keyword type="macro" name="SOUP_MESSAGE_RESPONSE_BODY" link="SoupMessage.html#SOUP-MESSAGE-RESPONSE-BODY:CAPS"/> - <keyword type="macro" name="SOUP_MESSAGE_RESPONSE_BODY_DATA" link="SoupMessage.html#SOUP-MESSAGE-RESPONSE-BODY-DATA:CAPS" since="2.46"/> - <keyword type="macro" name="SOUP_MESSAGE_RESPONSE_HEADERS" link="SoupMessage.html#SOUP-MESSAGE-RESPONSE-HEADERS:CAPS"/> - <keyword type="macro" name="SOUP_MESSAGE_TLS_CERTIFICATE" link="SoupMessage.html#SOUP-MESSAGE-TLS-CERTIFICATE:CAPS" since="2.34"/> - <keyword type="macro" name="SOUP_MESSAGE_TLS_ERRORS" link="SoupMessage.html#SOUP-MESSAGE-TLS-ERRORS:CAPS" since="2.34"/> - <keyword type="property" name="The “first-party” property" link="SoupMessage.html#SoupMessage--first-party"/> - <keyword type="property" name="The “flags” property" link="SoupMessage.html#SoupMessage--flags"/> - <keyword type="property" name="The “http-version” property" link="SoupMessage.html#SoupMessage--http-version"/> - <keyword type="property" name="The “method” property" link="SoupMessage.html#SoupMessage--method"/> - <keyword type="property" name="The “priority” property" link="SoupMessage.html#SoupMessage--priority"/> - <keyword type="property" name="The “reason-phrase” property" link="SoupMessage.html#SoupMessage--reason-phrase"/> - <keyword type="property" name="The “request-body” property" link="SoupMessage.html#SoupMessage--request-body"/> - <keyword type="property" name="The “request-body-data” property" link="SoupMessage.html#SoupMessage--request-body-data"/> - <keyword type="property" name="The “request-headers” property" link="SoupMessage.html#SoupMessage--request-headers"/> - <keyword type="property" name="The “response-body” property" link="SoupMessage.html#SoupMessage--response-body"/> - <keyword type="property" name="The “response-body-data” property" link="SoupMessage.html#SoupMessage--response-body-data"/> - <keyword type="property" name="The “response-headers” property" link="SoupMessage.html#SoupMessage--response-headers"/> - <keyword type="property" name="The “server-side” property" link="SoupMessage.html#SoupMessage--server-side"/> - <keyword type="property" name="The “status-code” property" link="SoupMessage.html#SoupMessage--status-code"/> - <keyword type="property" name="The “tls-certificate” property" link="SoupMessage.html#SoupMessage--tls-certificate"/> - <keyword type="property" name="The “tls-errors” property" link="SoupMessage.html#SoupMessage--tls-errors"/> - <keyword type="property" name="The “uri” property" link="SoupMessage.html#SoupMessage--uri"/> - <keyword type="signal" name="The “content-sniffed” signal" link="SoupMessage.html#SoupMessage-content-sniffed"/> - <keyword type="signal" name="The “finished” signal" link="SoupMessage.html#SoupMessage-finished"/> - <keyword type="signal" name="The “got-body” signal" link="SoupMessage.html#SoupMessage-got-body"/> - <keyword type="signal" name="The “got-chunk” signal" link="SoupMessage.html#SoupMessage-got-chunk"/> - <keyword type="signal" name="The “got-headers” signal" link="SoupMessage.html#SoupMessage-got-headers"/> - <keyword type="signal" name="The “got-informational” signal" link="SoupMessage.html#SoupMessage-got-informational"/> - <keyword type="signal" name="The “network-event” signal" link="SoupMessage.html#SoupMessage-network-event"/> - <keyword type="signal" name="The “restarted” signal" link="SoupMessage.html#SoupMessage-restarted"/> - <keyword type="signal" name="The “starting” signal" link="SoupMessage.html#SoupMessage-starting"/> - <keyword type="signal" name="The “wrote-body” signal" link="SoupMessage.html#SoupMessage-wrote-body"/> - <keyword type="signal" name="The “wrote-body-data” signal" link="SoupMessage.html#SoupMessage-wrote-body-data"/> - <keyword type="signal" name="The “wrote-chunk” signal" link="SoupMessage.html#SoupMessage-wrote-chunk"/> - <keyword type="signal" name="The “wrote-headers” signal" link="SoupMessage.html#SoupMessage-wrote-headers"/> - <keyword type="signal" name="The “wrote-informational” signal" link="SoupMessage.html#SoupMessage-wrote-informational"/> - <keyword type="function" name="soup_message_headers_new ()" link="SoupMessageHeaders.html#soup-message-headers-new"/> - <keyword type="function" name="soup_message_headers_free ()" link="SoupMessageHeaders.html#soup-message-headers-free"/> - <keyword type="function" name="soup_message_headers_append ()" link="SoupMessageHeaders.html#soup-message-headers-append"/> - <keyword type="function" name="soup_message_headers_replace ()" link="SoupMessageHeaders.html#soup-message-headers-replace"/> - <keyword type="function" name="soup_message_headers_remove ()" link="SoupMessageHeaders.html#soup-message-headers-remove"/> - <keyword type="function" name="soup_message_headers_clear ()" link="SoupMessageHeaders.html#soup-message-headers-clear"/> - <keyword type="function" name="soup_message_headers_clean_connection_headers ()" link="SoupMessageHeaders.html#soup-message-headers-clean-connection-headers" since="2.36"/> - <keyword type="function" name="soup_message_headers_get_one ()" link="SoupMessageHeaders.html#soup-message-headers-get-one" since="2.28"/> - <keyword type="function" name="soup_message_headers_get_list ()" link="SoupMessageHeaders.html#soup-message-headers-get-list" since="2.28"/> - <keyword type="function" name="soup_message_headers_get_headers_type ()" link="SoupMessageHeaders.html#soup-message-headers-get-headers-type" since="2.50"/> - <keyword type="function" name="soup_message_headers_header_contains ()" link="SoupMessageHeaders.html#soup-message-headers-header-contains" since="2.50"/> - <keyword type="function" name="soup_message_headers_header_equals ()" link="SoupMessageHeaders.html#soup-message-headers-header-equals" since="2.50"/> - <keyword type="function" name="SoupMessageHeadersForeachFunc ()" link="SoupMessageHeaders.html#SoupMessageHeadersForeachFunc"/> - <keyword type="function" name="soup_message_headers_foreach ()" link="SoupMessageHeaders.html#soup-message-headers-foreach"/> - <keyword type="function" name="soup_message_headers_iter_init ()" link="SoupMessageHeaders.html#soup-message-headers-iter-init"/> - <keyword type="function" name="soup_message_headers_iter_next ()" link="SoupMessageHeaders.html#soup-message-headers-iter-next"/> - <keyword type="function" name="soup_message_headers_get_encoding ()" link="SoupMessageHeaders.html#soup-message-headers-get-encoding"/> - <keyword type="function" name="soup_message_headers_set_encoding ()" link="SoupMessageHeaders.html#soup-message-headers-set-encoding"/> - <keyword type="function" name="soup_message_headers_get_content_length ()" link="SoupMessageHeaders.html#soup-message-headers-get-content-length"/> - <keyword type="function" name="soup_message_headers_set_content_length ()" link="SoupMessageHeaders.html#soup-message-headers-set-content-length"/> - <keyword type="function" name="soup_message_headers_get_expectations ()" link="SoupMessageHeaders.html#soup-message-headers-get-expectations"/> - <keyword type="function" name="soup_message_headers_set_expectations ()" link="SoupMessageHeaders.html#soup-message-headers-set-expectations"/> - <keyword type="function" name="soup_message_headers_get_content_type ()" link="SoupMessageHeaders.html#soup-message-headers-get-content-type" since="2.26"/> - <keyword type="function" name="soup_message_headers_set_content_type ()" link="SoupMessageHeaders.html#soup-message-headers-set-content-type" since="2.26"/> - <keyword type="function" name="soup_message_headers_get_content_disposition ()" link="SoupMessageHeaders.html#soup-message-headers-get-content-disposition" since="2.26"/> - <keyword type="function" name="soup_message_headers_set_content_disposition ()" link="SoupMessageHeaders.html#soup-message-headers-set-content-disposition" since="2.26"/> - <keyword type="function" name="soup_message_headers_get_ranges ()" link="SoupMessageHeaders.html#soup-message-headers-get-ranges" since="2.26"/> - <keyword type="function" name="soup_message_headers_set_ranges ()" link="SoupMessageHeaders.html#soup-message-headers-set-ranges" since="2.26"/> - <keyword type="function" name="soup_message_headers_set_range ()" link="SoupMessageHeaders.html#soup-message-headers-set-range" since="2.26"/> - <keyword type="function" name="soup_message_headers_free_ranges ()" link="SoupMessageHeaders.html#soup-message-headers-free-ranges" since="2.26"/> - <keyword type="function" name="soup_message_headers_get_content_range ()" link="SoupMessageHeaders.html#soup-message-headers-get-content-range" since="2.26"/> - <keyword type="function" name="soup_message_headers_set_content_range ()" link="SoupMessageHeaders.html#soup-message-headers-set-content-range" since="2.26"/> - <keyword type="typedef" name="SoupMessageHeaders" link="SoupMessageHeaders.html#SoupMessageHeaders"/> - <keyword type="enum" name="enum SoupMessageHeadersType" link="SoupMessageHeaders.html#SoupMessageHeadersType"/> - <keyword type="struct" name="SoupMessageHeadersIter" link="SoupMessageHeaders.html#SoupMessageHeadersIter"/> - <keyword type="enum" name="enum SoupEncoding" link="SoupMessageHeaders.html#SoupEncoding"/> - <keyword type="enum" name="enum SoupExpectation" link="SoupMessageHeaders.html#SoupExpectation"/> - <keyword type="struct" name="SoupRange" link="SoupMessageHeaders.html#SoupRange" since="2.26"/> - <keyword type="function" name="soup_buffer_new ()" link="SoupMessageBody.html#soup-buffer-new"/> - <keyword type="function" name="soup_buffer_new_subbuffer ()" link="SoupMessageBody.html#soup-buffer-new-subbuffer"/> - <keyword type="function" name="soup_buffer_new_with_owner ()" link="SoupMessageBody.html#soup-buffer-new-with-owner"/> - <keyword type="function" name="soup_buffer_new_take ()" link="SoupMessageBody.html#soup-buffer-new-take" since="2.32"/> - <keyword type="function" name="soup_buffer_get_owner ()" link="SoupMessageBody.html#soup-buffer-get-owner"/> - <keyword type="function" name="soup_buffer_get_data ()" link="SoupMessageBody.html#soup-buffer-get-data" since="2.32"/> - <keyword type="function" name="soup_buffer_copy ()" link="SoupMessageBody.html#soup-buffer-copy"/> - <keyword type="function" name="soup_buffer_free ()" link="SoupMessageBody.html#soup-buffer-free"/> - <keyword type="function" name="soup_buffer_get_as_bytes ()" link="SoupMessageBody.html#soup-buffer-get-as-bytes" since="2.40"/> - <keyword type="function" name="soup_message_body_new ()" link="SoupMessageBody.html#soup-message-body-new"/> - <keyword type="function" name="soup_message_body_free ()" link="SoupMessageBody.html#soup-message-body-free"/> - <keyword type="function" name="soup_message_body_set_accumulate ()" link="SoupMessageBody.html#soup-message-body-set-accumulate" since="2.24"/> - <keyword type="function" name="soup_message_body_get_accumulate ()" link="SoupMessageBody.html#soup-message-body-get-accumulate" since="2.24"/> - <keyword type="function" name="soup_message_body_append ()" link="SoupMessageBody.html#soup-message-body-append"/> - <keyword type="function" name="soup_message_body_append_buffer ()" link="SoupMessageBody.html#soup-message-body-append-buffer"/> - <keyword type="function" name="soup_message_body_append_take ()" link="SoupMessageBody.html#soup-message-body-append-take" since="2.32"/> - <keyword type="function" name="soup_message_body_truncate ()" link="SoupMessageBody.html#soup-message-body-truncate"/> - <keyword type="function" name="soup_message_body_complete ()" link="SoupMessageBody.html#soup-message-body-complete"/> - <keyword type="function" name="soup_message_body_flatten ()" link="SoupMessageBody.html#soup-message-body-flatten"/> - <keyword type="function" name="soup_message_body_get_chunk ()" link="SoupMessageBody.html#soup-message-body-get-chunk"/> - <keyword type="function" name="soup_message_body_got_chunk ()" link="SoupMessageBody.html#soup-message-body-got-chunk" since="2.24"/> - <keyword type="function" name="soup_message_body_wrote_chunk ()" link="SoupMessageBody.html#soup-message-body-wrote-chunk" since="2.24"/> - <keyword type="struct" name="SoupBuffer" link="SoupMessageBody.html#SoupBuffer-struct"/> - <keyword type="enum" name="enum SoupMemoryUse" link="SoupMessageBody.html#SoupMemoryUse"/> - <keyword type="struct" name="SoupMessageBody" link="SoupMessageBody.html#SoupMessageBody-struct"/> - <keyword type="macro" name="SOUP_METHOD_OPTIONS" link="libsoup-2.4-soup-method.html#SOUP-METHOD-OPTIONS:CAPS"/> - <keyword type="macro" name="SOUP_METHOD_GET" link="libsoup-2.4-soup-method.html#SOUP-METHOD-GET:CAPS"/> - <keyword type="macro" name="SOUP_METHOD_HEAD" link="libsoup-2.4-soup-method.html#SOUP-METHOD-HEAD:CAPS"/> - <keyword type="macro" name="SOUP_METHOD_PUT" link="libsoup-2.4-soup-method.html#SOUP-METHOD-PUT:CAPS"/> - <keyword type="macro" name="SOUP_METHOD_POST" link="libsoup-2.4-soup-method.html#SOUP-METHOD-POST:CAPS"/> - <keyword type="macro" name="SOUP_METHOD_DELETE" link="libsoup-2.4-soup-method.html#SOUP-METHOD-DELETE:CAPS"/> - <keyword type="macro" name="SOUP_METHOD_TRACE" link="libsoup-2.4-soup-method.html#SOUP-METHOD-TRACE:CAPS"/> - <keyword type="macro" name="SOUP_METHOD_CONNECT" link="libsoup-2.4-soup-method.html#SOUP-METHOD-CONNECT:CAPS"/> - <keyword type="macro" name="SOUP_METHOD_PROPFIND" link="libsoup-2.4-soup-method.html#SOUP-METHOD-PROPFIND:CAPS"/> - <keyword type="macro" name="SOUP_METHOD_PROPPATCH" link="libsoup-2.4-soup-method.html#SOUP-METHOD-PROPPATCH:CAPS"/> - <keyword type="macro" name="SOUP_METHOD_MKCOL" link="libsoup-2.4-soup-method.html#SOUP-METHOD-MKCOL:CAPS"/> - <keyword type="macro" name="SOUP_METHOD_COPY" link="libsoup-2.4-soup-method.html#SOUP-METHOD-COPY:CAPS"/> - <keyword type="macro" name="SOUP_METHOD_MOVE" link="libsoup-2.4-soup-method.html#SOUP-METHOD-MOVE:CAPS"/> - <keyword type="macro" name="SOUP_METHOD_LOCK" link="libsoup-2.4-soup-method.html#SOUP-METHOD-LOCK:CAPS"/> - <keyword type="macro" name="SOUP_METHOD_UNLOCK" link="libsoup-2.4-soup-method.html#SOUP-METHOD-UNLOCK:CAPS"/> - <keyword type="function" name="soup_date_new ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-new"/> - <keyword type="function" name="soup_date_new_from_string ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-new-from-string"/> - <keyword type="function" name="soup_date_new_from_time_t ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-new-from-time-t"/> - <keyword type="function" name="soup_date_new_from_now ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-new-from-now"/> - <keyword type="function" name="soup_date_to_string ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-to-string"/> - <keyword type="function" name="soup_date_to_time_t ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-to-time-t"/> - <keyword type="function" name="soup_date_to_timeval ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-to-timeval" since="2.24"/> - <keyword type="function" name="soup_date_is_past ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-is-past" since="2.24"/> - <keyword type="function" name="soup_date_get_day ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-day" since="2.32"/> - <keyword type="function" name="soup_date_get_hour ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-hour" since="2.32"/> - <keyword type="function" name="soup_date_get_minute ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-minute" since="2.32"/> - <keyword type="function" name="soup_date_get_month ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-month" since="2.32"/> - <keyword type="function" name="soup_date_get_offset ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-offset" since="2.32"/> - <keyword type="function" name="soup_date_get_second ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-second" since="2.32"/> - <keyword type="function" name="soup_date_get_utc ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-utc" since="2.32"/> - <keyword type="function" name="soup_date_get_year ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-year" since="2.32"/> - <keyword type="function" name="soup_date_free ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-free" since="2.24"/> - <keyword type="function" name="soup_headers_parse_request ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-headers-parse-request"/> - <keyword type="function" name="soup_headers_parse_response ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-headers-parse-response"/> - <keyword type="function" name="soup_headers_parse_status_line ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-headers-parse-status-line"/> - <keyword type="function" name="soup_headers_parse ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-headers-parse" since="2.26"/> - <keyword type="function" name="soup_header_parse_list ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-parse-list"/> - <keyword type="function" name="soup_header_parse_quality_list ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-parse-quality-list"/> - <keyword type="function" name="soup_header_free_list ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-free-list"/> - <keyword type="function" name="soup_header_contains ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-contains"/> - <keyword type="function" name="soup_header_parse_param_list ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-parse-param-list"/> - <keyword type="function" name="soup_header_parse_semi_param_list ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-parse-semi-param-list" since="2.24"/> - <keyword type="function" name="soup_header_free_param_list ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-free-param-list"/> - <keyword type="function" name="soup_header_g_string_append_param ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-g-string-append-param" since="2.26"/> - <keyword type="function" name="soup_header_g_string_append_param_quoted ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-g-string-append-param-quoted" since="2.30"/> - <keyword type="function" name="soup_str_case_equal ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-str-case-equal"/> - <keyword type="function" name="soup_str_case_hash ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-str-case-hash"/> - <keyword type="function" name="soup_add_completion ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-add-completion" since="2.24"/> - <keyword type="function" name="soup_add_idle ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-add-idle"/> - <keyword type="function" name="soup_add_io_watch ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-add-io-watch"/> - <keyword type="function" name="soup_add_timeout ()" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-add-timeout"/> - <keyword type="struct" name="SoupDate" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate-struct"/> - <keyword type="enum" name="enum SoupDateFormat" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDateFormat"/> - <keyword type="function" name="soup_multipart_new ()" link="SoupMultipart.html#soup-multipart-new" since="2.26"/> - <keyword type="function" name="soup_multipart_new_from_message ()" link="SoupMultipart.html#soup-multipart-new-from-message" since="2.26"/> - <keyword type="function" name="soup_multipart_free ()" link="SoupMultipart.html#soup-multipart-free" since="2.26"/> - <keyword type="function" name="soup_multipart_get_length ()" link="SoupMultipart.html#soup-multipart-get-length" since="2.26"/> - <keyword type="function" name="soup_multipart_get_part ()" link="SoupMultipart.html#soup-multipart-get-part" since="2.26"/> - <keyword type="function" name="soup_multipart_append_part ()" link="SoupMultipart.html#soup-multipart-append-part" since="2.26"/> - <keyword type="function" name="soup_multipart_append_form_string ()" link="SoupMultipart.html#soup-multipart-append-form-string" since="2.26"/> - <keyword type="function" name="soup_multipart_append_form_file ()" link="SoupMultipart.html#soup-multipart-append-form-file" since="2.26"/> - <keyword type="function" name="soup_multipart_to_message ()" link="SoupMultipart.html#soup-multipart-to-message" since="2.26"/> - <keyword type="typedef" name="SoupMultipart" link="SoupMultipart.html#SoupMultipart" since="2.26"/> - <keyword type="function" name="soup_multipart_input_stream_new ()" link="SoupMultipartInputStream.html#soup-multipart-input-stream-new" since="2.40"/> - <keyword type="function" name="soup_multipart_input_stream_get_headers ()" link="SoupMultipartInputStream.html#soup-multipart-input-stream-get-headers" since="2.40"/> - <keyword type="function" name="soup_multipart_input_stream_next_part ()" link="SoupMultipartInputStream.html#soup-multipart-input-stream-next-part" since="2.40"/> - <keyword type="function" name="soup_multipart_input_stream_next_part_async ()" link="SoupMultipartInputStream.html#soup-multipart-input-stream-next-part-async" since="2.40"/> - <keyword type="function" name="soup_multipart_input_stream_next_part_finish ()" link="SoupMultipartInputStream.html#soup-multipart-input-stream-next-part-finish" since="2.40"/> - <keyword type="struct" name="struct SoupMultipartInputStream" link="SoupMultipartInputStream.html#SoupMultipartInputStream-struct"/> - <keyword type="property" name="The “message” property" link="SoupMultipartInputStream.html#SoupMultipartInputStream--message"/> - <keyword type="function" name="soup_request_send ()" link="SoupRequest.html#soup-request-send" since="2.42"/> - <keyword type="function" name="soup_request_send_async ()" link="SoupRequest.html#soup-request-send-async" since="2.42"/> - <keyword type="function" name="soup_request_send_finish ()" link="SoupRequest.html#soup-request-send-finish" since="2.42"/> - <keyword type="function" name="soup_request_get_content_length ()" link="SoupRequest.html#soup-request-get-content-length" since="2.42"/> - <keyword type="function" name="soup_request_get_content_type ()" link="SoupRequest.html#soup-request-get-content-type" since="2.42"/> - <keyword type="function" name="soup_request_get_session ()" link="SoupRequest.html#soup-request-get-session" since="2.42"/> - <keyword type="function" name="soup_request_get_uri ()" link="SoupRequest.html#soup-request-get-uri" since="2.42"/> - <keyword type="struct" name="SoupRequest" link="SoupRequest.html#SoupRequest-struct"/> - <keyword type="macro" name="SOUP_REQUEST_SESSION" link="SoupRequest.html#SOUP-REQUEST-SESSION:CAPS" since="2.42"/> - <keyword type="macro" name="SOUP_REQUEST_URI" link="SoupRequest.html#SOUP-REQUEST-URI:CAPS" since="2.42"/> - <keyword type="property" name="The “session” property" link="SoupRequest.html#SoupRequest--session"/> - <keyword type="property" name="The “uri” property" link="SoupRequest.html#SoupRequest--uri"/> - <keyword type="function" name="soup_request_http_get_message ()" link="SoupRequestHTTP.html#soup-request-http-get-message" since="2.40"/> - <keyword type="struct" name="SoupRequestHTTP" link="SoupRequestHTTP.html#SoupRequestHTTP-struct"/> - <keyword type="function" name="soup_request_file_get_file ()" link="SoupRequestFile.html#soup-request-file-get-file" since="2.40"/> - <keyword type="struct" name="SoupRequestFile" link="SoupRequestFile.html#SoupRequestFile-struct"/> - <keyword type="struct" name="SoupRequestData" link="SoupRequestData.html#SoupRequestData-struct"/> - <keyword type="function" name="soup_server_new ()" link="SoupServer.html#soup-server-new"/> - <keyword type="function" name="soup_server_set_ssl_cert_file ()" link="SoupServer.html#soup-server-set-ssl-cert-file" since="2.48"/> - <keyword type="function" name="soup_server_listen ()" link="SoupServer.html#soup-server-listen" since="2.48"/> - <keyword type="function" name="soup_server_listen_all ()" link="SoupServer.html#soup-server-listen-all" since="2.48"/> - <keyword type="function" name="soup_server_listen_local ()" link="SoupServer.html#soup-server-listen-local" since="2.48"/> - <keyword type="function" name="soup_server_listen_socket ()" link="SoupServer.html#soup-server-listen-socket" since="2.48"/> - <keyword type="function" name="soup_server_listen_fd ()" link="SoupServer.html#soup-server-listen-fd" since="2.48"/> - <keyword type="function" name="soup_server_get_listeners ()" link="SoupServer.html#soup-server-get-listeners"/> - <keyword type="function" name="soup_server_get_uris ()" link="SoupServer.html#soup-server-get-uris" since="2.48"/> - <keyword type="function" name="soup_server_disconnect ()" link="SoupServer.html#soup-server-disconnect"/> - <keyword type="function" name="soup_server_is_https ()" link="SoupServer.html#soup-server-is-https"/> - <keyword type="function" name="soup_server_accept_iostream ()" link="SoupServer.html#soup-server-accept-iostream" since="2.50"/> - <keyword type="function" name="SoupServerCallback ()" link="SoupServer.html#SoupServerCallback"/> - <keyword type="function" name="soup_server_add_handler ()" link="SoupServer.html#soup-server-add-handler"/> - <keyword type="function" name="soup_server_add_early_handler ()" link="SoupServer.html#soup-server-add-early-handler" since="2.50"/> - <keyword type="function" name="soup_server_remove_handler ()" link="SoupServer.html#soup-server-remove-handler"/> - <keyword type="function" name="SoupServerWebsocketCallback ()" link="SoupServer.html#SoupServerWebsocketCallback"/> - <keyword type="function" name="soup_server_add_websocket_handler ()" link="SoupServer.html#soup-server-add-websocket-handler"/> - <keyword type="function" name="soup_client_context_get_local_address ()" link="SoupServer.html#soup-client-context-get-local-address" since="2.48"/> - <keyword type="function" name="soup_client_context_get_remote_address ()" link="SoupServer.html#soup-client-context-get-remote-address" since="2.48"/> - <keyword type="function" name="soup_client_context_get_host ()" link="SoupServer.html#soup-client-context-get-host"/> - <keyword type="function" name="soup_client_context_get_auth_domain ()" link="SoupServer.html#soup-client-context-get-auth-domain"/> - <keyword type="function" name="soup_client_context_get_auth_user ()" link="SoupServer.html#soup-client-context-get-auth-user"/> - <keyword type="function" name="soup_client_context_get_gsocket ()" link="SoupServer.html#soup-client-context-get-gsocket" since="2.48"/> - <keyword type="function" name="soup_client_context_steal_connection ()" link="SoupServer.html#soup-client-context-steal-connection" since="2.50"/> - <keyword type="function" name="soup_server_add_auth_domain ()" link="SoupServer.html#soup-server-add-auth-domain"/> - <keyword type="function" name="soup_server_remove_auth_domain ()" link="SoupServer.html#soup-server-remove-auth-domain"/> - <keyword type="function" name="soup_server_pause_message ()" link="SoupServer.html#soup-server-pause-message"/> - <keyword type="function" name="soup_server_unpause_message ()" link="SoupServer.html#soup-server-unpause-message"/> - <keyword type="struct" name="SoupServer" link="SoupServer.html#SoupServer-struct"/> - <keyword type="enum" name="enum SoupServerListenOptions" link="SoupServer.html#SoupServerListenOptions" since="2.48"/> - <keyword type="typedef" name="SoupClientContext" link="SoupServer.html#SoupClientContext"/> - <keyword type="macro" name="SOUP_SERVER_TLS_CERTIFICATE" link="SoupServer.html#SOUP-SERVER-TLS-CERTIFICATE:CAPS" since="2.38"/> - <keyword type="macro" name="SOUP_SERVER_RAW_PATHS" link="SoupServer.html#SOUP-SERVER-RAW-PATHS:CAPS"/> - <keyword type="macro" name="SOUP_SERVER_SERVER_HEADER" link="SoupServer.html#SOUP-SERVER-SERVER-HEADER:CAPS"/> - <keyword type="macro" name="SOUP_SERVER_HTTP_ALIASES" link="SoupServer.html#SOUP-SERVER-HTTP-ALIASES:CAPS" since="2.44"/> - <keyword type="macro" name="SOUP_SERVER_HTTPS_ALIASES" link="SoupServer.html#SOUP-SERVER-HTTPS-ALIASES:CAPS" since="2.44"/> - <keyword type="property" name="The “async-context” property" link="SoupServer.html#SoupServer--async-context"/> - <keyword type="property" name="The “http-aliases” property" link="SoupServer.html#SoupServer--http-aliases"/> - <keyword type="property" name="The “https-aliases” property" link="SoupServer.html#SoupServer--https-aliases"/> - <keyword type="property" name="The “interface” property" link="SoupServer.html#SoupServer--interface"/> - <keyword type="property" name="The “port” property" link="SoupServer.html#SoupServer--port"/> - <keyword type="property" name="The “raw-paths” property" link="SoupServer.html#SoupServer--raw-paths"/> - <keyword type="property" name="The “server-header” property" link="SoupServer.html#SoupServer--server-header"/> - <keyword type="property" name="The “ssl-cert-file” property" link="SoupServer.html#SoupServer--ssl-cert-file"/> - <keyword type="property" name="The “ssl-key-file” property" link="SoupServer.html#SoupServer--ssl-key-file"/> - <keyword type="property" name="The “tls-certificate” property" link="SoupServer.html#SoupServer--tls-certificate"/> - <keyword type="signal" name="The “request-aborted” signal" link="SoupServer.html#SoupServer-request-aborted"/> - <keyword type="signal" name="The “request-finished” signal" link="SoupServer.html#SoupServer-request-finished"/> - <keyword type="signal" name="The “request-read” signal" link="SoupServer.html#SoupServer-request-read"/> - <keyword type="signal" name="The “request-started” signal" link="SoupServer.html#SoupServer-request-started"/> - <keyword type="function" name="soup_server_get_port ()" link="libsoup-2.4-SoupServer-deprecated-API.html#soup-server-get-port" deprecated=""/> - <keyword type="function" name="soup_server_get_listener ()" link="libsoup-2.4-SoupServer-deprecated-API.html#soup-server-get-listener" deprecated=""/> - <keyword type="function" name="soup_server_run ()" link="libsoup-2.4-SoupServer-deprecated-API.html#soup-server-run" deprecated=""/> - <keyword type="function" name="soup_server_run_async ()" link="libsoup-2.4-SoupServer-deprecated-API.html#soup-server-run-async" deprecated=""/> - <keyword type="function" name="soup_server_quit ()" link="libsoup-2.4-SoupServer-deprecated-API.html#soup-server-quit" deprecated=""/> - <keyword type="function" name="soup_server_get_async_context ()" link="libsoup-2.4-SoupServer-deprecated-API.html#soup-server-get-async-context" deprecated=""/> - <keyword type="function" name="soup_client_context_get_socket ()" link="libsoup-2.4-SoupServer-deprecated-API.html#soup-client-context-get-socket" deprecated=""/> - <keyword type="function" name="soup_client_context_get_address ()" link="libsoup-2.4-SoupServer-deprecated-API.html#soup-client-context-get-address" deprecated=""/> - <keyword type="macro" name="SOUP_SERVER_PORT" link="libsoup-2.4-SoupServer-deprecated-API.html#SOUP-SERVER-PORT:CAPS" deprecated=""/> - <keyword type="macro" name="SOUP_SERVER_INTERFACE" link="libsoup-2.4-SoupServer-deprecated-API.html#SOUP-SERVER-INTERFACE:CAPS" deprecated=""/> - <keyword type="macro" name="SOUP_SERVER_SSL_CERT_FILE" link="libsoup-2.4-SoupServer-deprecated-API.html#SOUP-SERVER-SSL-CERT-FILE:CAPS" deprecated=""/> - <keyword type="macro" name="SOUP_SERVER_SSL_KEY_FILE" link="libsoup-2.4-SoupServer-deprecated-API.html#SOUP-SERVER-SSL-KEY-FILE:CAPS" deprecated=""/> - <keyword type="macro" name="SOUP_SERVER_ASYNC_CONTEXT" link="libsoup-2.4-SoupServer-deprecated-API.html#SOUP-SERVER-ASYNC-CONTEXT:CAPS" deprecated=""/> - <keyword type="function" name="soup_session_new ()" link="SoupSession.html#soup-session-new" since="2.42"/> - <keyword type="function" name="soup_session_new_with_options ()" link="SoupSession.html#soup-session-new-with-options" since="2.42"/> - <keyword type="function" name="soup_session_request ()" link="SoupSession.html#soup-session-request" since="2.42"/> - <keyword type="function" name="soup_session_request_uri ()" link="SoupSession.html#soup-session-request-uri" since="2.42"/> - <keyword type="function" name="soup_session_request_http ()" link="SoupSession.html#soup-session-request-http" since="2.42"/> - <keyword type="function" name="soup_session_request_http_uri ()" link="SoupSession.html#soup-session-request-http-uri" since="2.42"/> - <keyword type="function" name="SoupSessionCallback ()" link="SoupSession.html#SoupSessionCallback"/> - <keyword type="function" name="soup_session_queue_message ()" link="SoupSession.html#soup-session-queue-message"/> - <keyword type="function" name="soup_session_requeue_message ()" link="SoupSession.html#soup-session-requeue-message"/> - <keyword type="function" name="soup_session_send_message ()" link="SoupSession.html#soup-session-send-message"/> - <keyword type="function" name="soup_session_cancel_message ()" link="SoupSession.html#soup-session-cancel-message"/> - <keyword type="function" name="soup_session_send ()" link="SoupSession.html#soup-session-send" since="2.42"/> - <keyword type="function" name="soup_session_send_async ()" link="SoupSession.html#soup-session-send-async" since="2.42"/> - <keyword type="function" name="soup_session_send_finish ()" link="SoupSession.html#soup-session-send-finish" since="2.42"/> - <keyword type="function" name="soup_session_websocket_connect_async ()" link="SoupSession.html#soup-session-websocket-connect-async" since="2.50"/> - <keyword type="function" name="soup_session_websocket_connect_finish ()" link="SoupSession.html#soup-session-websocket-connect-finish" since="2.50"/> - <keyword type="function" name="soup_session_prefetch_dns ()" link="SoupSession.html#soup-session-prefetch-dns" since="2.38"/> - <keyword type="function" name="soup_session_abort ()" link="SoupSession.html#soup-session-abort"/> - <keyword type="function" name="soup_session_would_redirect ()" link="SoupSession.html#soup-session-would-redirect" since="2.38"/> - <keyword type="function" name="soup_session_redirect_message ()" link="SoupSession.html#soup-session-redirect-message" since="2.38"/> - <keyword type="function" name="soup_session_pause_message ()" link="SoupSession.html#soup-session-pause-message"/> - <keyword type="function" name="soup_session_unpause_message ()" link="SoupSession.html#soup-session-unpause-message"/> - <keyword type="function" name="soup_session_get_async_context ()" link="SoupSession.html#soup-session-get-async-context"/> - <keyword type="function" name="soup_session_add_feature ()" link="SoupSession.html#soup-session-add-feature" since="2.24"/> - <keyword type="function" name="soup_session_add_feature_by_type ()" link="SoupSession.html#soup-session-add-feature-by-type" since="2.24"/> - <keyword type="function" name="soup_session_remove_feature ()" link="SoupSession.html#soup-session-remove-feature" since="2.24"/> - <keyword type="function" name="soup_session_remove_feature_by_type ()" link="SoupSession.html#soup-session-remove-feature-by-type" since="2.24"/> - <keyword type="function" name="soup_session_get_features ()" link="SoupSession.html#soup-session-get-features" since="2.26"/> - <keyword type="function" name="soup_session_get_feature ()" link="SoupSession.html#soup-session-get-feature" since="2.26"/> - <keyword type="function" name="soup_session_get_feature_for_message ()" link="SoupSession.html#soup-session-get-feature-for-message" since="2.28"/> - <keyword type="function" name="soup_session_has_feature ()" link="SoupSession.html#soup-session-has-feature" since="2.42"/> - <keyword type="function" name="soup_session_steal_connection ()" link="SoupSession.html#soup-session-steal-connection" since="2.50"/> - <keyword type="function" name="SoupSessionConnectProgressCallback ()" link="SoupSession.html#SoupSessionConnectProgressCallback" since="2.62"/> - <keyword type="function" name="soup_session_connect_async ()" link="SoupSession.html#soup-session-connect-async" since="2.62"/> - <keyword type="function" name="soup_session_connect_finish ()" link="SoupSession.html#soup-session-connect-finish" since="2.62"/> - <keyword type="struct" name="SoupSession" link="SoupSession.html#SoupSession-struct"/> - <keyword type="enum" name="enum SoupRequestError" link="SoupSession.html#SoupRequestError" since="2.42"/> - <keyword type="macro" name="SOUP_REQUEST_ERROR" link="SoupSession.html#SOUP-REQUEST-ERROR:CAPS" since="2.42"/> - <keyword type="macro" name="SOUP_SESSION_PROXY_URI" link="SoupSession.html#SOUP-SESSION-PROXY-URI:CAPS"/> - <keyword type="macro" name="SOUP_SESSION_PROXY_RESOLVER" link="SoupSession.html#SOUP-SESSION-PROXY-RESOLVER:CAPS"/> - <keyword type="macro" name="SOUP_SESSION_MAX_CONNS" link="SoupSession.html#SOUP-SESSION-MAX-CONNS:CAPS"/> - <keyword type="macro" name="SOUP_SESSION_MAX_CONNS_PER_HOST" link="SoupSession.html#SOUP-SESSION-MAX-CONNS-PER-HOST:CAPS"/> - <keyword type="macro" name="SOUP_SESSION_TLS_DATABASE" link="SoupSession.html#SOUP-SESSION-TLS-DATABASE:CAPS" since="2.38"/> - <keyword type="macro" name="SOUP_SESSION_SSL_USE_SYSTEM_CA_FILE" link="SoupSession.html#SOUP-SESSION-SSL-USE-SYSTEM-CA-FILE:CAPS" since="2.38"/> - <keyword type="macro" name="SOUP_SESSION_SSL_CA_FILE" link="SoupSession.html#SOUP-SESSION-SSL-CA-FILE:CAPS"/> - <keyword type="macro" name="SOUP_SESSION_SSL_STRICT" link="SoupSession.html#SOUP-SESSION-SSL-STRICT:CAPS" since="2.30"/> - <keyword type="macro" name="SOUP_SESSION_TLS_INTERACTION" link="SoupSession.html#SOUP-SESSION-TLS-INTERACTION:CAPS" since="2.48"/> - <keyword type="macro" name="SOUP_SESSION_ASYNC_CONTEXT" link="SoupSession.html#SOUP-SESSION-ASYNC-CONTEXT:CAPS"/> - <keyword type="macro" name="SOUP_SESSION_USE_THREAD_CONTEXT" link="SoupSession.html#SOUP-SESSION-USE-THREAD-CONTEXT:CAPS" since="2.38"/> - <keyword type="macro" name="SOUP_SESSION_TIMEOUT" link="SoupSession.html#SOUP-SESSION-TIMEOUT:CAPS"/> - <keyword type="macro" name="SOUP_SESSION_IDLE_TIMEOUT" link="SoupSession.html#SOUP-SESSION-IDLE-TIMEOUT:CAPS" since="2.24"/> - <keyword type="macro" name="SOUP_SESSION_USER_AGENT" link="SoupSession.html#SOUP-SESSION-USER-AGENT:CAPS"/> - <keyword type="macro" name="SOUP_SESSION_ADD_FEATURE" link="SoupSession.html#SOUP-SESSION-ADD-FEATURE:CAPS" since="2.24"/> - <keyword type="macro" name="SOUP_SESSION_ADD_FEATURE_BY_TYPE" link="SoupSession.html#SOUP-SESSION-ADD-FEATURE-BY-TYPE:CAPS" since="2.24"/> - <keyword type="macro" name="SOUP_SESSION_REMOVE_FEATURE_BY_TYPE" link="SoupSession.html#SOUP-SESSION-REMOVE-FEATURE-BY-TYPE:CAPS" since="2.24"/> - <keyword type="macro" name="SOUP_SESSION_ACCEPT_LANGUAGE" link="SoupSession.html#SOUP-SESSION-ACCEPT-LANGUAGE:CAPS" since="2.30"/> - <keyword type="macro" name="SOUP_SESSION_ACCEPT_LANGUAGE_AUTO" link="SoupSession.html#SOUP-SESSION-ACCEPT-LANGUAGE-AUTO:CAPS" since="2.30"/> - <keyword type="macro" name="SOUP_SESSION_HTTP_ALIASES" link="SoupSession.html#SOUP-SESSION-HTTP-ALIASES:CAPS" since="2.38"/> - <keyword type="macro" name="SOUP_SESSION_HTTPS_ALIASES" link="SoupSession.html#SOUP-SESSION-HTTPS-ALIASES:CAPS" since="2.38"/> - <keyword type="macro" name="SOUP_SESSION_LOCAL_ADDRESS" link="SoupSession.html#SOUP-SESSION-LOCAL-ADDRESS:CAPS" since="2.42"/> - <keyword type="property" name="The “accept-language” property" link="SoupSession.html#SoupSession--accept-language"/> - <keyword type="property" name="The “accept-language-auto” property" link="SoupSession.html#SoupSession--accept-language-auto"/> - <keyword type="property" name="The “add-feature” property" link="SoupSession.html#SoupSession--add-feature"/> - <keyword type="property" name="The “add-feature-by-type” property" link="SoupSession.html#SoupSession--add-feature-by-type"/> - <keyword type="property" name="The “async-context” property" link="SoupSession.html#SoupSession--async-context"/> - <keyword type="property" name="The “http-aliases” property" link="SoupSession.html#SoupSession--http-aliases"/> - <keyword type="property" name="The “https-aliases” property" link="SoupSession.html#SoupSession--https-aliases"/> - <keyword type="property" name="The “idle-timeout” property" link="SoupSession.html#SoupSession--idle-timeout"/> - <keyword type="property" name="The “local-address” property" link="SoupSession.html#SoupSession--local-address"/> - <keyword type="property" name="The “max-conns” property" link="SoupSession.html#SoupSession--max-conns"/> - <keyword type="property" name="The “max-conns-per-host” property" link="SoupSession.html#SoupSession--max-conns-per-host"/> - <keyword type="property" name="The “proxy-resolver” property" link="SoupSession.html#SoupSession--proxy-resolver"/> - <keyword type="property" name="The “proxy-uri” property" link="SoupSession.html#SoupSession--proxy-uri"/> - <keyword type="property" name="The “remove-feature-by-type” property" link="SoupSession.html#SoupSession--remove-feature-by-type"/> - <keyword type="property" name="The “ssl-ca-file” property" link="SoupSession.html#SoupSession--ssl-ca-file"/> - <keyword type="property" name="The “ssl-strict” property" link="SoupSession.html#SoupSession--ssl-strict"/> - <keyword type="property" name="The “ssl-use-system-ca-file” property" link="SoupSession.html#SoupSession--ssl-use-system-ca-file"/> - <keyword type="property" name="The “timeout” property" link="SoupSession.html#SoupSession--timeout"/> - <keyword type="property" name="The “tls-database” property" link="SoupSession.html#SoupSession--tls-database"/> - <keyword type="property" name="The “tls-interaction” property" link="SoupSession.html#SoupSession--tls-interaction"/> - <keyword type="property" name="The “use-ntlm” property" link="SoupSession.html#SoupSession--use-ntlm"/> - <keyword type="property" name="The “use-thread-context” property" link="SoupSession.html#SoupSession--use-thread-context"/> - <keyword type="property" name="The “user-agent” property" link="SoupSession.html#SoupSession--user-agent"/> - <keyword type="signal" name="The “authenticate” signal" link="SoupSession.html#SoupSession-authenticate"/> - <keyword type="signal" name="The “connection-created” signal" link="SoupSession.html#SoupSession-connection-created"/> - <keyword type="signal" name="The “request-queued” signal" link="SoupSession.html#SoupSession-request-queued"/> - <keyword type="signal" name="The “request-started” signal" link="SoupSession.html#SoupSession-request-started"/> - <keyword type="signal" name="The “request-unqueued” signal" link="SoupSession.html#SoupSession-request-unqueued"/> - <keyword type="signal" name="The “tunneling” signal" link="SoupSession.html#SoupSession-tunneling"/> - <keyword type="struct" name="SoupSessionAsync" link="SoupSessionAsync.html#SoupSessionAsync-struct"/> - <keyword type="struct" name="SoupSessionSync" link="SoupSessionSync.html#SoupSessionSync-struct"/> - <keyword type="macro" name="SOUP_STATUS_IS_TRANSPORT_ERROR()" link="libsoup-2.4-soup-status.html#SOUP-STATUS-IS-TRANSPORT-ERROR:CAPS"/> - <keyword type="macro" name="SOUP_STATUS_IS_INFORMATIONAL()" link="libsoup-2.4-soup-status.html#SOUP-STATUS-IS-INFORMATIONAL:CAPS"/> - <keyword type="macro" name="SOUP_STATUS_IS_SUCCESSFUL()" link="libsoup-2.4-soup-status.html#SOUP-STATUS-IS-SUCCESSFUL:CAPS"/> - <keyword type="macro" name="SOUP_STATUS_IS_REDIRECTION()" link="libsoup-2.4-soup-status.html#SOUP-STATUS-IS-REDIRECTION:CAPS"/> - <keyword type="macro" name="SOUP_STATUS_IS_CLIENT_ERROR()" link="libsoup-2.4-soup-status.html#SOUP-STATUS-IS-CLIENT-ERROR:CAPS"/> - <keyword type="macro" name="SOUP_STATUS_IS_SERVER_ERROR()" link="libsoup-2.4-soup-status.html#SOUP-STATUS-IS-SERVER-ERROR:CAPS"/> - <keyword type="function" name="soup_status_get_phrase ()" link="libsoup-2.4-soup-status.html#soup-status-get-phrase"/> - <keyword type="function" name="soup_status_proxify ()" link="libsoup-2.4-soup-status.html#soup-status-proxify" since="2.26"/> - <keyword type="enum" name="enum SoupStatus" link="libsoup-2.4-soup-status.html#SoupStatus"/> - <keyword type="macro" name="SOUP_HTTP_ERROR" link="libsoup-2.4-soup-status.html#SOUP-HTTP-ERROR:CAPS"/> - <keyword type="function" name="soup_tld_get_base_domain ()" link="libsoup-2.4-Top-Level-Domain-utils.html#soup-tld-get-base-domain" since="2.40"/> - <keyword type="function" name="soup_tld_domain_is_public_suffix ()" link="libsoup-2.4-Top-Level-Domain-utils.html#soup-tld-domain-is-public-suffix" since="2.40"/> - <keyword type="macro" name="SOUP_TLD_ERROR" link="libsoup-2.4-Top-Level-Domain-utils.html#SOUP-TLD-ERROR:CAPS" since="2.40"/> - <keyword type="enum" name="enum SoupTLDError" link="libsoup-2.4-Top-Level-Domain-utils.html#SoupTLDError" since="2.40"/> - <keyword type="function" name="soup_uri_new_with_base ()" link="SoupURI.html#soup-uri-new-with-base"/> - <keyword type="function" name="soup_uri_new ()" link="SoupURI.html#soup-uri-new"/> - <keyword type="function" name="soup_uri_to_string ()" link="SoupURI.html#soup-uri-to-string"/> - <keyword type="function" name="soup_uri_copy ()" link="SoupURI.html#soup-uri-copy"/> - <keyword type="function" name="soup_uri_copy_host ()" link="SoupURI.html#soup-uri-copy-host" since="2.28"/> - <keyword type="function" name="soup_uri_equal ()" link="SoupURI.html#soup-uri-equal"/> - <keyword type="function" name="soup_uri_host_equal ()" link="SoupURI.html#soup-uri-host-equal" since="2.28"/> - <keyword type="function" name="soup_uri_host_hash ()" link="SoupURI.html#soup-uri-host-hash" since="2.28"/> - <keyword type="function" name="soup_uri_free ()" link="SoupURI.html#soup-uri-free"/> - <keyword type="function" name="soup_uri_encode ()" link="SoupURI.html#soup-uri-encode"/> - <keyword type="function" name="soup_uri_decode ()" link="SoupURI.html#soup-uri-decode"/> - <keyword type="function" name="soup_uri_normalize ()" link="SoupURI.html#soup-uri-normalize"/> - <keyword type="function" name="soup_uri_uses_default_port ()" link="SoupURI.html#soup-uri-uses-default-port"/> - <keyword type="macro" name="SOUP_URI_IS_VALID()" link="SoupURI.html#SOUP-URI-IS-VALID:CAPS" since="2.38"/> - <keyword type="macro" name="SOUP_URI_VALID_FOR_HTTP()" link="SoupURI.html#SOUP-URI-VALID-FOR-HTTP:CAPS" since="2.24"/> - <keyword type="function" name="soup_uri_set_scheme ()" link="SoupURI.html#soup-uri-set-scheme"/> - <keyword type="function" name="soup_uri_get_scheme ()" link="SoupURI.html#soup-uri-get-scheme" since="2.32"/> - <keyword type="function" name="soup_uri_set_user ()" link="SoupURI.html#soup-uri-set-user"/> - <keyword type="function" name="soup_uri_get_user ()" link="SoupURI.html#soup-uri-get-user" since="2.32"/> - <keyword type="function" name="soup_uri_set_password ()" link="SoupURI.html#soup-uri-set-password"/> - <keyword type="function" name="soup_uri_get_password ()" link="SoupURI.html#soup-uri-get-password" since="2.32"/> - <keyword type="function" name="soup_uri_set_host ()" link="SoupURI.html#soup-uri-set-host"/> - <keyword type="function" name="soup_uri_get_host ()" link="SoupURI.html#soup-uri-get-host" since="2.32"/> - <keyword type="function" name="soup_uri_set_port ()" link="SoupURI.html#soup-uri-set-port"/> - <keyword type="function" name="soup_uri_get_port ()" link="SoupURI.html#soup-uri-get-port" since="2.32"/> - <keyword type="function" name="soup_uri_set_path ()" link="SoupURI.html#soup-uri-set-path"/> - <keyword type="function" name="soup_uri_get_path ()" link="SoupURI.html#soup-uri-get-path" since="2.32"/> - <keyword type="function" name="soup_uri_set_query ()" link="SoupURI.html#soup-uri-set-query"/> - <keyword type="function" name="soup_uri_set_query_from_form ()" link="SoupURI.html#soup-uri-set-query-from-form"/> - <keyword type="function" name="soup_uri_set_query_from_fields ()" link="SoupURI.html#soup-uri-set-query-from-fields"/> - <keyword type="function" name="soup_uri_get_query ()" link="SoupURI.html#soup-uri-get-query" since="2.32"/> - <keyword type="function" name="soup_uri_set_fragment ()" link="SoupURI.html#soup-uri-set-fragment"/> - <keyword type="function" name="soup_uri_get_fragment ()" link="SoupURI.html#soup-uri-get-fragment" since="2.32"/> - <keyword type="struct" name="SoupURI" link="SoupURI.html#SoupURI-struct"/> - <keyword type="macro" name="SOUP_URI_SCHEME_HTTP" link="SoupURI.html#SOUP-URI-SCHEME-HTTP:CAPS"/> - <keyword type="macro" name="SOUP_URI_SCHEME_HTTPS" link="SoupURI.html#SOUP-URI-SCHEME-HTTPS:CAPS"/> - <keyword type="macro" name="SOUP_URI_SCHEME_DATA" link="SoupURI.html#SOUP-URI-SCHEME-DATA:CAPS" since="2.30"/> - <keyword type="macro" name="SOUP_URI_SCHEME_FILE" link="SoupURI.html#SOUP-URI-SCHEME-FILE:CAPS" since="2.30"/> - <keyword type="macro" name="SOUP_URI_SCHEME_FTP" link="SoupURI.html#SOUP-URI-SCHEME-FTP:CAPS" since="2.30"/> - <keyword type="macro" name="SOUP_URI_SCHEME_RESOURCE" link="SoupURI.html#SOUP-URI-SCHEME-RESOURCE:CAPS" since="2.42"/> - <keyword type="macro" name="SOUP_URI_SCHEME_WS" link="SoupURI.html#SOUP-URI-SCHEME-WS:CAPS" since="2.50"/> - <keyword type="macro" name="SOUP_URI_SCHEME_WSS" link="SoupURI.html#SOUP-URI-SCHEME-WSS:CAPS" since="2.50"/> - <keyword type="function" name="soup_get_major_version ()" link="libsoup-2.4-Version-Information.html#soup-get-major-version" since="2.42"/> - <keyword type="function" name="soup_get_minor_version ()" link="libsoup-2.4-Version-Information.html#soup-get-minor-version" since="2.42"/> - <keyword type="function" name="soup_get_micro_version ()" link="libsoup-2.4-Version-Information.html#soup-get-micro-version" since="2.42"/> - <keyword type="function" name="soup_check_version ()" link="libsoup-2.4-Version-Information.html#soup-check-version" since="2.42"/> - <keyword type="macro" name="SOUP_CHECK_VERSION()" link="libsoup-2.4-Version-Information.html#SOUP-CHECK-VERSION:CAPS" since="2.42"/> - <keyword type="macro" name="SOUP_MAJOR_VERSION" link="libsoup-2.4-Version-Information.html#SOUP-MAJOR-VERSION:CAPS" since="2.42"/> - <keyword type="macro" name="SOUP_MINOR_VERSION" link="libsoup-2.4-Version-Information.html#SOUP-MINOR-VERSION:CAPS" since="2.42"/> - <keyword type="macro" name="SOUP_MICRO_VERSION" link="libsoup-2.4-Version-Information.html#SOUP-MICRO-VERSION:CAPS" since="2.42"/> - <keyword type="macro" name="SOUP_VERSION_MIN_REQUIRED" link="libsoup-2.4-Version-Information.html#SOUP-VERSION-MIN-REQUIRED:CAPS" since="2.42"/> - <keyword type="macro" name="SOUP_VERSION_MAX_ALLOWED" link="libsoup-2.4-Version-Information.html#SOUP-VERSION-MAX-ALLOWED:CAPS" since="2.42"/> - <keyword type="macro" name="SOUP_VERSION_2_24" link="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-24:CAPS" since="2.42"/> - <keyword type="macro" name="SOUP_VERSION_2_26" link="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-26:CAPS" since="2.42"/> - <keyword type="macro" name="SOUP_VERSION_2_28" link="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-28:CAPS" since="2.42"/> - <keyword type="macro" name="SOUP_VERSION_2_30" link="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-30:CAPS" since="2.42"/> - <keyword type="macro" name="SOUP_VERSION_2_32" link="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-32:CAPS" since="2.42"/> - <keyword type="macro" name="SOUP_VERSION_2_34" link="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-34:CAPS" since="2.42"/> - <keyword type="macro" name="SOUP_VERSION_2_36" link="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-36:CAPS" since="2.42"/> - <keyword type="macro" name="SOUP_VERSION_2_38" link="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-38:CAPS" since="2.42"/> - <keyword type="macro" name="SOUP_VERSION_2_40" link="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-40:CAPS" since="2.42"/> - <keyword type="macro" name="SOUP_VERSION_2_42" link="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-42:CAPS" since="2.42"/> - <keyword type="macro" name="SOUP_VERSION_2_44" link="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-44:CAPS" since="2.44"/> - <keyword type="macro" name="SOUP_VERSION_2_46" link="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-46:CAPS" since="2.46"/> - <keyword type="macro" name="SOUP_VERSION_2_48" link="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-48:CAPS" since="2.48"/> - <keyword type="macro" name="SOUP_VERSION_2_50" link="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-50:CAPS" since="2.50"/> - <keyword type="macro" name="SOUP_VERSION_2_52" link="libsoup-2.4-Version-Information.html#SOUP-VERSION-2-52:CAPS" since="2.52"/> - <keyword type="struct" name="SoupSessionFeature" link="SoupSessionFeature.html#SoupSessionFeature-struct"/> - <keyword type="struct" name="SoupSessionFeatureInterface" link="SoupSessionFeature.html#SoupSessionFeatureInterface" since="2.24"/> - <keyword type="function" name="soup_auth_manager_use_auth ()" link="SoupAuthManager.html#soup-auth-manager-use-auth" since="2.42"/> - <keyword type="function" name="soup_auth_manager_clear_cached_credentials ()" link="SoupAuthManager.html#soup-auth-manager-clear-cached-credentials" since="2.58"/> - <keyword type="struct" name="SoupAuthManager" link="SoupAuthManager.html#SoupAuthManager-struct"/> - <keyword type="macro" name="SOUP_TYPE_AUTH_MANAGER" link="SoupAuthManager.html#SOUP-TYPE-AUTH-MANAGER:CAPS" since="2.42"/> - <keyword type="signal" name="The “authenticate” signal" link="SoupAuthManager.html#SoupAuthManager-authenticate"/> - <keyword type="struct" name="SoupContentDecoder" link="SoupContentDecoder.html#SoupContentDecoder-struct"/> - <keyword type="function" name="soup_content_sniffer_new ()" link="SoupContentSniffer.html#soup-content-sniffer-new" since="2.28"/> - <keyword type="function" name="soup_content_sniffer_sniff ()" link="SoupContentSniffer.html#soup-content-sniffer-sniff" since="2.28"/> - <keyword type="function" name="soup_content_sniffer_get_buffer_size ()" link="SoupContentSniffer.html#soup-content-sniffer-get-buffer-size" since="2.28"/> - <keyword type="struct" name="SoupContentSniffer" link="SoupContentSniffer.html#SoupContentSniffer-struct"/> - <keyword type="function" name="soup_cookie_jar_new ()" link="SoupCookieJar.html#soup-cookie-jar-new" since="2.24"/> - <keyword type="function" name="soup_cookie_jar_get_cookies ()" link="SoupCookieJar.html#soup-cookie-jar-get-cookies" since="2.24"/> - <keyword type="function" name="soup_cookie_jar_get_cookie_list ()" link="SoupCookieJar.html#soup-cookie-jar-get-cookie-list" since="2.40"/> - <keyword type="function" name="soup_cookie_jar_set_cookie ()" link="SoupCookieJar.html#soup-cookie-jar-set-cookie" since="2.24"/> - <keyword type="function" name="soup_cookie_jar_set_cookie_with_first_party ()" link="SoupCookieJar.html#soup-cookie-jar-set-cookie-with-first-party" since="2.30"/> - <keyword type="function" name="soup_cookie_jar_add_cookie ()" link="SoupCookieJar.html#soup-cookie-jar-add-cookie" since="2.26"/> - <keyword type="function" name="soup_cookie_jar_add_cookie_with_first_party ()" link="SoupCookieJar.html#soup-cookie-jar-add-cookie-with-first-party" since="2.40"/> - <keyword type="function" name="soup_cookie_jar_delete_cookie ()" link="SoupCookieJar.html#soup-cookie-jar-delete-cookie" since="2.26"/> - <keyword type="function" name="soup_cookie_jar_all_cookies ()" link="SoupCookieJar.html#soup-cookie-jar-all-cookies" since="2.26"/> - <keyword type="function" name="soup_cookie_jar_get_accept_policy ()" link="SoupCookieJar.html#soup-cookie-jar-get-accept-policy" since="2.30"/> - <keyword type="function" name="soup_cookie_jar_set_accept_policy ()" link="SoupCookieJar.html#soup-cookie-jar-set-accept-policy" since="2.30"/> - <keyword type="function" name="soup_cookie_jar_is_persistent ()" link="SoupCookieJar.html#soup-cookie-jar-is-persistent" since="2.40"/> - <keyword type="struct" name="SoupCookieJar" link="SoupCookieJar.html#SoupCookieJar-struct"/> - <keyword type="enum" name="enum SoupCookieJarAcceptPolicy" link="SoupCookieJar.html#SoupCookieJarAcceptPolicy" since="2.30"/> - <keyword type="macro" name="SOUP_COOKIE_JAR_READ_ONLY" link="SoupCookieJar.html#SOUP-COOKIE-JAR-READ-ONLY:CAPS"/> - <keyword type="macro" name="SOUP_COOKIE_JAR_ACCEPT_POLICY" link="SoupCookieJar.html#SOUP-COOKIE-JAR-ACCEPT-POLICY:CAPS" since="2.30"/> - <keyword type="property" name="The “accept-policy” property" link="SoupCookieJar.html#SoupCookieJar--accept-policy"/> - <keyword type="property" name="The “read-only” property" link="SoupCookieJar.html#SoupCookieJar--read-only"/> - <keyword type="signal" name="The “changed” signal" link="SoupCookieJar.html#SoupCookieJar-changed"/> - <keyword type="function" name="soup_cookie_jar_text_new ()" link="SoupCookieJarText.html#soup-cookie-jar-text-new" since="2.26"/> - <keyword type="struct" name="SoupCookieJarText" link="SoupCookieJarText.html#SoupCookieJarText-struct"/> - <keyword type="macro" name="SOUP_COOKIE_JAR_TEXT_FILENAME" link="SoupCookieJarText.html#SOUP-COOKIE-JAR-TEXT-FILENAME:CAPS"/> - <keyword type="property" name="The “filename” property" link="SoupCookieJarText.html#SoupCookieJarText--filename"/> - <keyword type="function" name="soup_cookie_jar_db_new ()" link="SoupCookieJarDB.html#soup-cookie-jar-db-new" since="2.42"/> - <keyword type="struct" name="SoupCookieJarDB" link="SoupCookieJarDB.html#SoupCookieJarDB-struct"/> - <keyword type="macro" name="SOUP_COOKIE_JAR_DB_FILENAME" link="SoupCookieJarDB.html#SOUP-COOKIE-JAR-DB-FILENAME:CAPS"/> - <keyword type="property" name="The “filename” property" link="SoupCookieJarDB.html#SoupCookieJarDB--filename"/> - <keyword type="function" name="soup_logger_new ()" link="SoupLogger.html#soup-logger-new"/> - <keyword type="function" name="SoupLoggerFilter ()" link="SoupLogger.html#SoupLoggerFilter"/> - <keyword type="function" name="soup_logger_set_request_filter ()" link="SoupLogger.html#soup-logger-set-request-filter"/> - <keyword type="function" name="soup_logger_set_response_filter ()" link="SoupLogger.html#soup-logger-set-response-filter"/> - <keyword type="function" name="SoupLoggerPrinter ()" link="SoupLogger.html#SoupLoggerPrinter"/> - <keyword type="function" name="soup_logger_set_printer ()" link="SoupLogger.html#soup-logger-set-printer"/> - <keyword type="struct" name="SoupLogger" link="SoupLogger.html#SoupLogger-struct"/> - <keyword type="enum" name="enum SoupLoggerLogLevel" link="SoupLogger.html#SoupLoggerLogLevel"/> - <keyword type="property" name="The “level” property" link="SoupLogger.html#SoupLogger--level"/> - <keyword type="property" name="The “max-body-size” property" link="SoupLogger.html#SoupLogger--max-body-size"/> - <keyword type="struct" name="SoupProxyResolverDefault" link="SoupProxyResolverDefault.html#SoupProxyResolverDefault-struct"/> - <keyword type="property" name="The “gproxy-resolver” property" link="SoupProxyResolverDefault.html#SoupProxyResolverDefault--gproxy-resolver"/> - <keyword type="function" name="soup_form_decode ()" link="libsoup-2.4-HTML-Form-Support.html#soup-form-decode"/> - <keyword type="function" name="soup_form_decode_multipart ()" link="libsoup-2.4-HTML-Form-Support.html#soup-form-decode-multipart" since="2.26"/> - <keyword type="function" name="soup_form_encode ()" link="libsoup-2.4-HTML-Form-Support.html#soup-form-encode"/> - <keyword type="function" name="soup_form_encode_datalist ()" link="libsoup-2.4-HTML-Form-Support.html#soup-form-encode-datalist"/> - <keyword type="function" name="soup_form_encode_hash ()" link="libsoup-2.4-HTML-Form-Support.html#soup-form-encode-hash"/> - <keyword type="function" name="soup_form_encode_valist ()" link="libsoup-2.4-HTML-Form-Support.html#soup-form-encode-valist"/> - <keyword type="function" name="soup_form_request_new ()" link="libsoup-2.4-HTML-Form-Support.html#soup-form-request-new"/> - <keyword type="function" name="soup_form_request_new_from_datalist ()" link="libsoup-2.4-HTML-Form-Support.html#soup-form-request-new-from-datalist"/> - <keyword type="function" name="soup_form_request_new_from_hash ()" link="libsoup-2.4-HTML-Form-Support.html#soup-form-request-new-from-hash"/> - <keyword type="function" name="soup_form_request_new_from_multipart ()" link="libsoup-2.4-HTML-Form-Support.html#soup-form-request-new-from-multipart" since="2.26"/> - <keyword type="macro" name="SOUP_FORM_MIME_TYPE_MULTIPART" link="libsoup-2.4-HTML-Form-Support.html#SOUP-FORM-MIME-TYPE-MULTIPART:CAPS" since="2.26"/> - <keyword type="macro" name="SOUP_FORM_MIME_TYPE_URLENCODED" link="libsoup-2.4-HTML-Form-Support.html#SOUP-FORM-MIME-TYPE-URLENCODED:CAPS" since="2.26"/> - <keyword type="function" name="soup_xmlrpc_build_request ()" link="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-build-request" since="2.52"/> - <keyword type="function" name="soup_xmlrpc_message_new ()" link="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-message-new" since="2.52"/> - <keyword type="function" name="soup_xmlrpc_parse_response ()" link="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-parse-response" since="2.52"/> - <keyword type="function" name="soup_xmlrpc_variant_new_datetime ()" link="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-variant-new-datetime" since="2.52"/> - <keyword type="function" name="soup_xmlrpc_variant_get_datetime ()" link="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-variant-get-datetime" since="2.52"/> - <keyword type="function" name="soup_xmlrpc_params_free ()" link="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-params-free" since="2.52"/> - <keyword type="function" name="soup_xmlrpc_params_parse ()" link="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-params-parse" since="2.52"/> - <keyword type="function" name="soup_xmlrpc_parse_request ()" link="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-parse-request" since="2.52"/> - <keyword type="function" name="soup_xmlrpc_build_response ()" link="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-build-response" since="2.52"/> - <keyword type="function" name="soup_xmlrpc_build_fault ()" link="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-build-fault"/> - <keyword type="function" name="soup_xmlrpc_message_set_response ()" link="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-message-set-response" since="2.52"/> - <keyword type="function" name="soup_xmlrpc_message_set_fault ()" link="libsoup-2.4-XMLRPC-Support.html#soup-xmlrpc-message-set-fault" since="2.52"/> - <keyword type="macro" name="SOUP_XMLRPC_ERROR" link="libsoup-2.4-XMLRPC-Support.html#SOUP-XMLRPC-ERROR:CAPS"/> - <keyword type="enum" name="enum SoupXMLRPCError" link="libsoup-2.4-XMLRPC-Support.html#SoupXMLRPCError"/> - <keyword type="macro" name="SOUP_XMLRPC_FAULT" link="libsoup-2.4-XMLRPC-Support.html#SOUP-XMLRPC-FAULT:CAPS"/> - <keyword type="enum" name="enum SoupXMLRPCFault" link="libsoup-2.4-XMLRPC-Support.html#SoupXMLRPCFault"/> - <keyword type="struct" name="SoupXMLRPCParams" link="libsoup-2.4-XMLRPC-Support.html#SoupXMLRPCParams" since="2.52"/> - <keyword type="function" name="soup_websocket_client_prepare_handshake ()" link="libsoup-2.4-WebSockets.html#soup-websocket-client-prepare-handshake" since="2.50"/> - <keyword type="function" name="soup_websocket_client_verify_handshake ()" link="libsoup-2.4-WebSockets.html#soup-websocket-client-verify-handshake" since="2.50"/> - <keyword type="function" name="soup_websocket_server_check_handshake ()" link="libsoup-2.4-WebSockets.html#soup-websocket-server-check-handshake" since="2.50"/> - <keyword type="function" name="soup_websocket_server_process_handshake ()" link="libsoup-2.4-WebSockets.html#soup-websocket-server-process-handshake" since="2.50"/> - <keyword type="function" name="soup_websocket_connection_new ()" link="libsoup-2.4-WebSockets.html#soup-websocket-connection-new" since="2.50"/> - <keyword type="function" name="soup_websocket_connection_get_io_stream ()" link="libsoup-2.4-WebSockets.html#soup-websocket-connection-get-io-stream" since="2.50"/> - <keyword type="function" name="soup_websocket_connection_get_connection_type ()" link="libsoup-2.4-WebSockets.html#soup-websocket-connection-get-connection-type" since="2.50"/> - <keyword type="function" name="soup_websocket_connection_get_uri ()" link="libsoup-2.4-WebSockets.html#soup-websocket-connection-get-uri" since="2.50"/> - <keyword type="function" name="soup_websocket_connection_get_origin ()" link="libsoup-2.4-WebSockets.html#soup-websocket-connection-get-origin" since="2.50"/> - <keyword type="function" name="soup_websocket_connection_get_protocol ()" link="libsoup-2.4-WebSockets.html#soup-websocket-connection-get-protocol" since="2.50"/> - <keyword type="function" name="soup_websocket_connection_get_state ()" link="libsoup-2.4-WebSockets.html#soup-websocket-connection-get-state" since="2.50"/> - <keyword type="function" name="soup_websocket_connection_send_text ()" link="libsoup-2.4-WebSockets.html#soup-websocket-connection-send-text" since="2.50"/> - <keyword type="function" name="soup_websocket_connection_send_binary ()" link="libsoup-2.4-WebSockets.html#soup-websocket-connection-send-binary" since="2.50"/> - <keyword type="function" name="soup_websocket_connection_close ()" link="libsoup-2.4-WebSockets.html#soup-websocket-connection-close" since="2.50"/> - <keyword type="function" name="soup_websocket_connection_get_close_code ()" link="libsoup-2.4-WebSockets.html#soup-websocket-connection-get-close-code" since="2.50"/> - <keyword type="function" name="soup_websocket_connection_get_close_data ()" link="libsoup-2.4-WebSockets.html#soup-websocket-connection-get-close-data" since="2.50"/> - <keyword type="struct" name="SoupWebsocketConnection" link="libsoup-2.4-WebSockets.html#SoupWebsocketConnection-struct"/> - <keyword type="enum" name="enum SoupWebsocketConnectionType" link="libsoup-2.4-WebSockets.html#SoupWebsocketConnectionType" since="2.50"/> - <keyword type="enum" name="enum SoupWebsocketState" link="libsoup-2.4-WebSockets.html#SoupWebsocketState" since="2.50"/> - <keyword type="enum" name="enum SoupWebsocketDataType" link="libsoup-2.4-WebSockets.html#SoupWebsocketDataType" since="2.50"/> - <keyword type="enum" name="enum SoupWebsocketCloseCode" link="libsoup-2.4-WebSockets.html#SoupWebsocketCloseCode" since="2.50"/> - <keyword type="enum" name="enum SoupWebsocketError" link="libsoup-2.4-WebSockets.html#SoupWebsocketError" since="2.50"/> - <keyword type="macro" name="SOUP_WEBSOCKET_ERROR" link="libsoup-2.4-WebSockets.html#SOUP-WEBSOCKET-ERROR:CAPS" since="2.50"/> - <keyword type="property" name="The “connection-type” property" link="libsoup-2.4-WebSockets.html#SoupWebsocketConnection--connection-type"/> - <keyword type="property" name="The “io-stream” property" link="libsoup-2.4-WebSockets.html#SoupWebsocketConnection--io-stream"/> - <keyword type="property" name="The “keepalive-interval” property" link="libsoup-2.4-WebSockets.html#SoupWebsocketConnection--keepalive-interval"/> - <keyword type="property" name="The “max-incoming-payload-size” property" link="libsoup-2.4-WebSockets.html#SoupWebsocketConnection--max-incoming-payload-size"/> - <keyword type="property" name="The “origin” property" link="libsoup-2.4-WebSockets.html#SoupWebsocketConnection--origin"/> - <keyword type="property" name="The “protocol” property" link="libsoup-2.4-WebSockets.html#SoupWebsocketConnection--protocol"/> - <keyword type="property" name="The “state” property" link="libsoup-2.4-WebSockets.html#SoupWebsocketConnection--state"/> - <keyword type="property" name="The “uri” property" link="libsoup-2.4-WebSockets.html#SoupWebsocketConnection--uri"/> - <keyword type="signal" name="The “closed” signal" link="libsoup-2.4-WebSockets.html#SoupWebsocketConnection-closed"/> - <keyword type="signal" name="The “closing” signal" link="libsoup-2.4-WebSockets.html#SoupWebsocketConnection-closing"/> - <keyword type="signal" name="The “error” signal" link="libsoup-2.4-WebSockets.html#SoupWebsocketConnection-error"/> - <keyword type="signal" name="The “message” signal" link="libsoup-2.4-WebSockets.html#SoupWebsocketConnection-message"/> - <keyword type="signal" name="The “pong” signal" link="libsoup-2.4-WebSockets.html#SoupWebsocketConnection-pong"/> - <keyword type="function" name="soup_address_new ()" link="SoupAddress.html#soup-address-new"/> - <keyword type="function" name="soup_address_new_from_sockaddr ()" link="SoupAddress.html#soup-address-new-from-sockaddr"/> - <keyword type="function" name="soup_address_new_any ()" link="SoupAddress.html#soup-address-new-any"/> - <keyword type="function" name="SoupAddressCallback ()" link="SoupAddress.html#SoupAddressCallback"/> - <keyword type="function" name="soup_address_resolve_async ()" link="SoupAddress.html#soup-address-resolve-async"/> - <keyword type="function" name="soup_address_resolve_sync ()" link="SoupAddress.html#soup-address-resolve-sync"/> - <keyword type="function" name="soup_address_is_resolved ()" link="SoupAddress.html#soup-address-is-resolved"/> - <keyword type="function" name="soup_address_get_name ()" link="SoupAddress.html#soup-address-get-name"/> - <keyword type="function" name="soup_address_get_sockaddr ()" link="SoupAddress.html#soup-address-get-sockaddr"/> - <keyword type="function" name="soup_address_get_gsockaddr ()" link="SoupAddress.html#soup-address-get-gsockaddr" since="2.32"/> - <keyword type="function" name="soup_address_get_physical ()" link="SoupAddress.html#soup-address-get-physical"/> - <keyword type="function" name="soup_address_get_port ()" link="SoupAddress.html#soup-address-get-port"/> - <keyword type="function" name="soup_address_equal_by_name ()" link="SoupAddress.html#soup-address-equal-by-name" since="2.26"/> - <keyword type="function" name="soup_address_hash_by_name ()" link="SoupAddress.html#soup-address-hash-by-name" since="2.26"/> - <keyword type="function" name="soup_address_equal_by_ip ()" link="SoupAddress.html#soup-address-equal-by-ip" since="2.26"/> - <keyword type="function" name="soup_address_hash_by_ip ()" link="SoupAddress.html#soup-address-hash-by-ip" since="2.26"/> - <keyword type="struct" name="SoupAddress" link="SoupAddress.html#SoupAddress-struct"/> - <keyword type="enum" name="enum SoupAddressFamily" link="SoupAddress.html#SoupAddressFamily"/> - <keyword type="macro" name="SOUP_ADDRESS_ANY_PORT" link="SoupAddress.html#SOUP-ADDRESS-ANY-PORT:CAPS"/> - <keyword type="macro" name="SOUP_ADDRESS_FAMILY" link="SoupAddress.html#SOUP-ADDRESS-FAMILY:CAPS"/> - <keyword type="macro" name="SOUP_ADDRESS_NAME" link="SoupAddress.html#SOUP-ADDRESS-NAME:CAPS"/> - <keyword type="macro" name="SOUP_ADDRESS_PHYSICAL" link="SoupAddress.html#SOUP-ADDRESS-PHYSICAL:CAPS"/> - <keyword type="macro" name="SOUP_ADDRESS_PORT" link="SoupAddress.html#SOUP-ADDRESS-PORT:CAPS"/> - <keyword type="macro" name="SOUP_ADDRESS_SOCKADDR" link="SoupAddress.html#SOUP-ADDRESS-SOCKADDR:CAPS"/> - <keyword type="macro" name="SOUP_ADDRESS_PROTOCOL" link="SoupAddress.html#SOUP-ADDRESS-PROTOCOL:CAPS"/> - <keyword type="property" name="The “family” property" link="SoupAddress.html#SoupAddress--family"/> - <keyword type="property" name="The “name” property" link="SoupAddress.html#SoupAddress--name"/> - <keyword type="property" name="The “physical” property" link="SoupAddress.html#SoupAddress--physical"/> - <keyword type="property" name="The “port” property" link="SoupAddress.html#SoupAddress--port"/> - <keyword type="property" name="The “protocol” property" link="SoupAddress.html#SoupAddress--protocol"/> - <keyword type="property" name="The “sockaddr” property" link="SoupAddress.html#SoupAddress--sockaddr"/> - <keyword type="function" name="soup_socket_new ()" link="SoupSocket.html#soup-socket-new"/> - <keyword type="function" name="SoupSocketCallback ()" link="SoupSocket.html#SoupSocketCallback"/> - <keyword type="function" name="soup_socket_connect_async ()" link="SoupSocket.html#soup-socket-connect-async"/> - <keyword type="function" name="soup_socket_connect_sync ()" link="SoupSocket.html#soup-socket-connect-sync"/> - <keyword type="function" name="soup_socket_listen ()" link="SoupSocket.html#soup-socket-listen"/> - <keyword type="function" name="soup_socket_start_ssl ()" link="SoupSocket.html#soup-socket-start-ssl"/> - <keyword type="function" name="soup_socket_start_proxy_ssl ()" link="SoupSocket.html#soup-socket-start-proxy-ssl"/> - <keyword type="function" name="soup_socket_is_ssl ()" link="SoupSocket.html#soup-socket-is-ssl"/> - <keyword type="function" name="soup_socket_disconnect ()" link="SoupSocket.html#soup-socket-disconnect"/> - <keyword type="function" name="soup_socket_is_connected ()" link="SoupSocket.html#soup-socket-is-connected"/> - <keyword type="function" name="soup_socket_get_local_address ()" link="SoupSocket.html#soup-socket-get-local-address"/> - <keyword type="function" name="soup_socket_get_remote_address ()" link="SoupSocket.html#soup-socket-get-remote-address"/> - <keyword type="function" name="soup_socket_get_fd ()" link="SoupSocket.html#soup-socket-get-fd"/> - <keyword type="function" name="soup_socket_read ()" link="SoupSocket.html#soup-socket-read"/> - <keyword type="function" name="soup_socket_read_until ()" link="SoupSocket.html#soup-socket-read-until"/> - <keyword type="function" name="soup_socket_write ()" link="SoupSocket.html#soup-socket-write"/> - <keyword type="struct" name="SoupSocket" link="SoupSocket.html#SoupSocket-struct"/> - <keyword type="enum" name="enum SoupSocketIOStatus" link="SoupSocket.html#SoupSocketIOStatus"/> - <keyword type="macro" name="SOUP_SOCKET_LOCAL_ADDRESS" link="SoupSocket.html#SOUP-SOCKET-LOCAL-ADDRESS:CAPS"/> - <keyword type="macro" name="SOUP_SOCKET_REMOTE_ADDRESS" link="SoupSocket.html#SOUP-SOCKET-REMOTE-ADDRESS:CAPS"/> - <keyword type="macro" name="SOUP_SOCKET_FLAG_NONBLOCKING" link="SoupSocket.html#SOUP-SOCKET-FLAG-NONBLOCKING:CAPS"/> - <keyword type="macro" name="SOUP_SOCKET_IS_SERVER" link="SoupSocket.html#SOUP-SOCKET-IS-SERVER:CAPS"/> - <keyword type="macro" name="SOUP_SOCKET_SSL_CREDENTIALS" link="SoupSocket.html#SOUP-SOCKET-SSL-CREDENTIALS:CAPS"/> - <keyword type="macro" name="SOUP_SOCKET_ASYNC_CONTEXT" link="SoupSocket.html#SOUP-SOCKET-ASYNC-CONTEXT:CAPS"/> - <keyword type="macro" name="SOUP_SOCKET_TIMEOUT" link="SoupSocket.html#SOUP-SOCKET-TIMEOUT:CAPS"/> - <keyword type="macro" name="SOUP_SOCKET_SSL_FALLBACK" link="SoupSocket.html#SOUP-SOCKET-SSL-FALLBACK:CAPS"/> - <keyword type="macro" name="SOUP_SOCKET_SSL_STRICT" link="SoupSocket.html#SOUP-SOCKET-SSL-STRICT:CAPS"/> - <keyword type="macro" name="SOUP_SOCKET_TLS_CERTIFICATE" link="SoupSocket.html#SOUP-SOCKET-TLS-CERTIFICATE:CAPS" since="2.34"/> - <keyword type="macro" name="SOUP_SOCKET_TLS_ERRORS" link="SoupSocket.html#SOUP-SOCKET-TLS-ERRORS:CAPS" since="2.34"/> - <keyword type="macro" name="SOUP_SOCKET_TRUSTED_CERTIFICATE" link="SoupSocket.html#SOUP-SOCKET-TRUSTED-CERTIFICATE:CAPS"/> - <keyword type="macro" name="SOUP_SOCKET_USE_THREAD_CONTEXT" link="SoupSocket.html#SOUP-SOCKET-USE-THREAD-CONTEXT:CAPS" since="2.38"/> - <keyword type="property" name="The “async-context” property" link="SoupSocket.html#SoupSocket--async-context"/> - <keyword type="property" name="The “fd” property" link="SoupSocket.html#SoupSocket--fd"/> - <keyword type="property" name="The “gsocket” property" link="SoupSocket.html#SoupSocket--gsocket"/> - <keyword type="property" name="The “iostream” property" link="SoupSocket.html#SoupSocket--iostream"/> - <keyword type="property" name="The “ipv6-only” property" link="SoupSocket.html#SoupSocket--ipv6-only"/> - <keyword type="property" name="The “is-server” property" link="SoupSocket.html#SoupSocket--is-server"/> - <keyword type="property" name="The “local-address” property" link="SoupSocket.html#SoupSocket--local-address"/> - <keyword type="property" name="The “non-blocking” property" link="SoupSocket.html#SoupSocket--non-blocking"/> - <keyword type="property" name="The “remote-address” property" link="SoupSocket.html#SoupSocket--remote-address"/> - <keyword type="property" name="The “socket-properties” property" link="SoupSocket.html#SoupSocket--socket-properties"/> - <keyword type="property" name="The “ssl-creds” property" link="SoupSocket.html#SoupSocket--ssl-creds"/> - <keyword type="property" name="The “ssl-fallback” property" link="SoupSocket.html#SoupSocket--ssl-fallback"/> - <keyword type="property" name="The “ssl-strict” property" link="SoupSocket.html#SoupSocket--ssl-strict"/> - <keyword type="property" name="The “timeout” property" link="SoupSocket.html#SoupSocket--timeout"/> - <keyword type="property" name="The “tls-certificate” property" link="SoupSocket.html#SoupSocket--tls-certificate"/> - <keyword type="property" name="The “tls-errors” property" link="SoupSocket.html#SoupSocket--tls-errors"/> - <keyword type="property" name="The “trusted-certificate” property" link="SoupSocket.html#SoupSocket--trusted-certificate"/> - <keyword type="property" name="The “use-thread-context” property" link="SoupSocket.html#SoupSocket--use-thread-context"/> - <keyword type="signal" name="The “disconnected” signal" link="SoupSocket.html#SoupSocket-disconnected"/> - <keyword type="signal" name="The “event” signal" link="SoupSocket.html#SoupSocket-event"/> - <keyword type="signal" name="The “new-connection” signal" link="SoupSocket.html#SoupSocket-new-connection"/> - <keyword type="signal" name="The “readable” signal" link="SoupSocket.html#SoupSocket-readable"/> - <keyword type="signal" name="The “writable” signal" link="SoupSocket.html#SoupSocket-writable"/> - <keyword type="constant" name="SOUP_CACHE_SINGLE_USER" link="SoupCache.html#SOUP-CACHE-SINGLE-USER:CAPS"/> - <keyword type="constant" name="SOUP_CACHE_SHARED" link="SoupCache.html#SOUP-CACHE-SHARED:CAPS"/> - <keyword type="constant" name="SOUP_HTTP_1_0" link="SoupMessage.html#SOUP-HTTP-1-0:CAPS"/> - <keyword type="constant" name="SOUP_HTTP_1_1" link="SoupMessage.html#SOUP-HTTP-1-1:CAPS"/> - <keyword type="constant" name="SOUP_MESSAGE_NO_REDIRECT" link="SoupMessage.html#SOUP-MESSAGE-NO-REDIRECT:CAPS"/> - <keyword type="constant" name="SOUP_MESSAGE_CAN_REBUILD" link="SoupMessage.html#SOUP-MESSAGE-CAN-REBUILD:CAPS"/> - <keyword type="constant" name="SOUP_MESSAGE_OVERWRITE_CHUNKS" link="SoupMessage.html#SOUP-MESSAGE-OVERWRITE-CHUNKS:CAPS"/> - <keyword type="constant" name="SOUP_MESSAGE_CONTENT_DECODED" link="SoupMessage.html#SOUP-MESSAGE-CONTENT-DECODED:CAPS"/> - <keyword type="constant" name="SOUP_MESSAGE_CERTIFICATE_TRUSTED" link="SoupMessage.html#SOUP-MESSAGE-CERTIFICATE-TRUSTED:CAPS"/> - <keyword type="constant" name="SOUP_MESSAGE_NEW_CONNECTION" link="SoupMessage.html#SOUP-MESSAGE-NEW-CONNECTION:CAPS"/> - <keyword type="constant" name="SOUP_MESSAGE_IDEMPOTENT" link="SoupMessage.html#SOUP-MESSAGE-IDEMPOTENT:CAPS"/> - <keyword type="constant" name="SOUP_MESSAGE_IGNORE_CONNECTION_LIMITS" link="SoupMessage.html#SOUP-MESSAGE-IGNORE-CONNECTION-LIMITS:CAPS"/> - <keyword type="constant" name="SOUP_MESSAGE_DO_NOT_USE_AUTH_CACHE" link="SoupMessage.html#SOUP-MESSAGE-DO-NOT-USE-AUTH-CACHE:CAPS"/> - <keyword type="constant" name="SOUP_MESSAGE_PRIORITY_VERY_LOW" link="SoupMessage.html#SOUP-MESSAGE-PRIORITY-VERY-LOW:CAPS"/> - <keyword type="constant" name="SOUP_MESSAGE_PRIORITY_LOW" link="SoupMessage.html#SOUP-MESSAGE-PRIORITY-LOW:CAPS"/> - <keyword type="constant" name="SOUP_MESSAGE_PRIORITY_NORMAL" link="SoupMessage.html#SOUP-MESSAGE-PRIORITY-NORMAL:CAPS"/> - <keyword type="constant" name="SOUP_MESSAGE_PRIORITY_HIGH" link="SoupMessage.html#SOUP-MESSAGE-PRIORITY-HIGH:CAPS"/> - <keyword type="constant" name="SOUP_MESSAGE_PRIORITY_VERY_HIGH" link="SoupMessage.html#SOUP-MESSAGE-PRIORITY-VERY-HIGH:CAPS"/> - <keyword type="constant" name="SOUP_MESSAGE_HEADERS_REQUEST" link="SoupMessageHeaders.html#SOUP-MESSAGE-HEADERS-REQUEST:CAPS"/> - <keyword type="constant" name="SOUP_MESSAGE_HEADERS_RESPONSE" link="SoupMessageHeaders.html#SOUP-MESSAGE-HEADERS-RESPONSE:CAPS"/> - <keyword type="constant" name="SOUP_MESSAGE_HEADERS_MULTIPART" link="SoupMessageHeaders.html#SOUP-MESSAGE-HEADERS-MULTIPART:CAPS"/> - <keyword type="constant" name="SOUP_ENCODING_UNRECOGNIZED" link="SoupMessageHeaders.html#SOUP-ENCODING-UNRECOGNIZED:CAPS"/> - <keyword type="constant" name="SOUP_ENCODING_NONE" link="SoupMessageHeaders.html#SOUP-ENCODING-NONE:CAPS"/> - <keyword type="constant" name="SOUP_ENCODING_CONTENT_LENGTH" link="SoupMessageHeaders.html#SOUP-ENCODING-CONTENT-LENGTH:CAPS"/> - <keyword type="constant" name="SOUP_ENCODING_EOF" link="SoupMessageHeaders.html#SOUP-ENCODING-EOF:CAPS"/> - <keyword type="constant" name="SOUP_ENCODING_CHUNKED" link="SoupMessageHeaders.html#SOUP-ENCODING-CHUNKED:CAPS"/> - <keyword type="constant" name="SOUP_ENCODING_BYTERANGES" link="SoupMessageHeaders.html#SOUP-ENCODING-BYTERANGES:CAPS"/> - <keyword type="constant" name="SOUP_EXPECTATION_UNRECOGNIZED" link="SoupMessageHeaders.html#SOUP-EXPECTATION-UNRECOGNIZED:CAPS"/> - <keyword type="constant" name="SOUP_EXPECTATION_CONTINUE" link="SoupMessageHeaders.html#SOUP-EXPECTATION-CONTINUE:CAPS"/> - <keyword type="constant" name="SOUP_MEMORY_STATIC" link="SoupMessageBody.html#SOUP-MEMORY-STATIC:CAPS"/> - <keyword type="constant" name="SOUP_MEMORY_TAKE" link="SoupMessageBody.html#SOUP-MEMORY-TAKE:CAPS"/> - <keyword type="constant" name="SOUP_MEMORY_COPY" link="SoupMessageBody.html#SOUP-MEMORY-COPY:CAPS"/> - <keyword type="constant" name="SOUP_MEMORY_TEMPORARY" link="SoupMessageBody.html#SOUP-MEMORY-TEMPORARY:CAPS"/> - <keyword type="constant" name="SOUP_DATE_HTTP" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SOUP-DATE-HTTP:CAPS"/> - <keyword type="constant" name="SOUP_DATE_COOKIE" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SOUP-DATE-COOKIE:CAPS"/> - <keyword type="constant" name="SOUP_DATE_RFC2822" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SOUP-DATE-RFC2822:CAPS"/> - <keyword type="constant" name="SOUP_DATE_ISO8601_COMPACT" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SOUP-DATE-ISO8601-COMPACT:CAPS"/> - <keyword type="constant" name="SOUP_DATE_ISO8601_FULL" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SOUP-DATE-ISO8601-FULL:CAPS"/> - <keyword type="constant" name="SOUP_DATE_ISO8601" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SOUP-DATE-ISO8601:CAPS"/> - <keyword type="constant" name="SOUP_DATE_ISO8601_XMLRPC" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SOUP-DATE-ISO8601-XMLRPC:CAPS"/> - <keyword type="constant" name="SOUP_SERVER_LISTEN_HTTPS" link="SoupServer.html#SOUP-SERVER-LISTEN-HTTPS:CAPS"/> - <keyword type="constant" name="SOUP_SERVER_LISTEN_IPV4_ONLY" link="SoupServer.html#SOUP-SERVER-LISTEN-IPV4-ONLY:CAPS"/> - <keyword type="constant" name="SOUP_SERVER_LISTEN_IPV6_ONLY" link="SoupServer.html#SOUP-SERVER-LISTEN-IPV6-ONLY:CAPS"/> - <keyword type="constant" name="SOUP_REQUEST_ERROR_BAD_URI" link="SoupSession.html#SOUP-REQUEST-ERROR-BAD-URI:CAPS"/> - <keyword type="constant" name="SOUP_REQUEST_ERROR_UNSUPPORTED_URI_SCHEME" link="SoupSession.html#SOUP-REQUEST-ERROR-UNSUPPORTED-URI-SCHEME:CAPS"/> - <keyword type="constant" name="SOUP_REQUEST_ERROR_PARSING" link="SoupSession.html#SOUP-REQUEST-ERROR-PARSING:CAPS"/> - <keyword type="constant" name="SOUP_REQUEST_ERROR_ENCODING" link="SoupSession.html#SOUP-REQUEST-ERROR-ENCODING:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_NONE" link="libsoup-2.4-soup-status.html#SOUP-STATUS-NONE:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_CANCELLED" link="libsoup-2.4-soup-status.html#SOUP-STATUS-CANCELLED:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_CANT_RESOLVE" link="libsoup-2.4-soup-status.html#SOUP-STATUS-CANT-RESOLVE:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_CANT_RESOLVE_PROXY" link="libsoup-2.4-soup-status.html#SOUP-STATUS-CANT-RESOLVE-PROXY:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_CANT_CONNECT" link="libsoup-2.4-soup-status.html#SOUP-STATUS-CANT-CONNECT:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_CANT_CONNECT_PROXY" link="libsoup-2.4-soup-status.html#SOUP-STATUS-CANT-CONNECT-PROXY:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_SSL_FAILED" link="libsoup-2.4-soup-status.html#SOUP-STATUS-SSL-FAILED:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_IO_ERROR" link="libsoup-2.4-soup-status.html#SOUP-STATUS-IO-ERROR:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_MALFORMED" link="libsoup-2.4-soup-status.html#SOUP-STATUS-MALFORMED:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_TRY_AGAIN" link="libsoup-2.4-soup-status.html#SOUP-STATUS-TRY-AGAIN:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_TOO_MANY_REDIRECTS" link="libsoup-2.4-soup-status.html#SOUP-STATUS-TOO-MANY-REDIRECTS:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_TLS_FAILED" link="libsoup-2.4-soup-status.html#SOUP-STATUS-TLS-FAILED:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_CONTINUE" link="libsoup-2.4-soup-status.html#SOUP-STATUS-CONTINUE:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_SWITCHING_PROTOCOLS" link="libsoup-2.4-soup-status.html#SOUP-STATUS-SWITCHING-PROTOCOLS:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_PROCESSING" link="libsoup-2.4-soup-status.html#SOUP-STATUS-PROCESSING:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_OK" link="libsoup-2.4-soup-status.html#SOUP-STATUS-OK:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_CREATED" link="libsoup-2.4-soup-status.html#SOUP-STATUS-CREATED:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_ACCEPTED" link="libsoup-2.4-soup-status.html#SOUP-STATUS-ACCEPTED:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_NON_AUTHORITATIVE" link="libsoup-2.4-soup-status.html#SOUP-STATUS-NON-AUTHORITATIVE:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_NO_CONTENT" link="libsoup-2.4-soup-status.html#SOUP-STATUS-NO-CONTENT:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_RESET_CONTENT" link="libsoup-2.4-soup-status.html#SOUP-STATUS-RESET-CONTENT:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_PARTIAL_CONTENT" link="libsoup-2.4-soup-status.html#SOUP-STATUS-PARTIAL-CONTENT:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_MULTI_STATUS" link="libsoup-2.4-soup-status.html#SOUP-STATUS-MULTI-STATUS:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_MULTIPLE_CHOICES" link="libsoup-2.4-soup-status.html#SOUP-STATUS-MULTIPLE-CHOICES:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_MOVED_PERMANENTLY" link="libsoup-2.4-soup-status.html#SOUP-STATUS-MOVED-PERMANENTLY:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_FOUND" link="libsoup-2.4-soup-status.html#SOUP-STATUS-FOUND:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_MOVED_TEMPORARILY" link="libsoup-2.4-soup-status.html#SOUP-STATUS-MOVED-TEMPORARILY:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_SEE_OTHER" link="libsoup-2.4-soup-status.html#SOUP-STATUS-SEE-OTHER:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_NOT_MODIFIED" link="libsoup-2.4-soup-status.html#SOUP-STATUS-NOT-MODIFIED:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_USE_PROXY" link="libsoup-2.4-soup-status.html#SOUP-STATUS-USE-PROXY:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_NOT_APPEARING_IN_THIS_PROTOCOL" link="libsoup-2.4-soup-status.html#SOUP-STATUS-NOT-APPEARING-IN-THIS-PROTOCOL:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_TEMPORARY_REDIRECT" link="libsoup-2.4-soup-status.html#SOUP-STATUS-TEMPORARY-REDIRECT:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_BAD_REQUEST" link="libsoup-2.4-soup-status.html#SOUP-STATUS-BAD-REQUEST:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_UNAUTHORIZED" link="libsoup-2.4-soup-status.html#SOUP-STATUS-UNAUTHORIZED:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_PAYMENT_REQUIRED" link="libsoup-2.4-soup-status.html#SOUP-STATUS-PAYMENT-REQUIRED:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_FORBIDDEN" link="libsoup-2.4-soup-status.html#SOUP-STATUS-FORBIDDEN:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_NOT_FOUND" link="libsoup-2.4-soup-status.html#SOUP-STATUS-NOT-FOUND:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_METHOD_NOT_ALLOWED" link="libsoup-2.4-soup-status.html#SOUP-STATUS-METHOD-NOT-ALLOWED:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_NOT_ACCEPTABLE" link="libsoup-2.4-soup-status.html#SOUP-STATUS-NOT-ACCEPTABLE:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED" link="libsoup-2.4-soup-status.html#SOUP-STATUS-PROXY-AUTHENTICATION-REQUIRED:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_PROXY_UNAUTHORIZED" link="libsoup-2.4-soup-status.html#SOUP-STATUS-PROXY-UNAUTHORIZED:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_REQUEST_TIMEOUT" link="libsoup-2.4-soup-status.html#SOUP-STATUS-REQUEST-TIMEOUT:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_CONFLICT" link="libsoup-2.4-soup-status.html#SOUP-STATUS-CONFLICT:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_GONE" link="libsoup-2.4-soup-status.html#SOUP-STATUS-GONE:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_LENGTH_REQUIRED" link="libsoup-2.4-soup-status.html#SOUP-STATUS-LENGTH-REQUIRED:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_PRECONDITION_FAILED" link="libsoup-2.4-soup-status.html#SOUP-STATUS-PRECONDITION-FAILED:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_REQUEST_ENTITY_TOO_LARGE" link="libsoup-2.4-soup-status.html#SOUP-STATUS-REQUEST-ENTITY-TOO-LARGE:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_REQUEST_URI_TOO_LONG" link="libsoup-2.4-soup-status.html#SOUP-STATUS-REQUEST-URI-TOO-LONG:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_UNSUPPORTED_MEDIA_TYPE" link="libsoup-2.4-soup-status.html#SOUP-STATUS-UNSUPPORTED-MEDIA-TYPE:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_REQUESTED_RANGE_NOT_SATISFIABLE" link="libsoup-2.4-soup-status.html#SOUP-STATUS-REQUESTED-RANGE-NOT-SATISFIABLE:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_INVALID_RANGE" link="libsoup-2.4-soup-status.html#SOUP-STATUS-INVALID-RANGE:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_EXPECTATION_FAILED" link="libsoup-2.4-soup-status.html#SOUP-STATUS-EXPECTATION-FAILED:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_UNPROCESSABLE_ENTITY" link="libsoup-2.4-soup-status.html#SOUP-STATUS-UNPROCESSABLE-ENTITY:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_LOCKED" link="libsoup-2.4-soup-status.html#SOUP-STATUS-LOCKED:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_FAILED_DEPENDENCY" link="libsoup-2.4-soup-status.html#SOUP-STATUS-FAILED-DEPENDENCY:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_INTERNAL_SERVER_ERROR" link="libsoup-2.4-soup-status.html#SOUP-STATUS-INTERNAL-SERVER-ERROR:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_NOT_IMPLEMENTED" link="libsoup-2.4-soup-status.html#SOUP-STATUS-NOT-IMPLEMENTED:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_BAD_GATEWAY" link="libsoup-2.4-soup-status.html#SOUP-STATUS-BAD-GATEWAY:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_SERVICE_UNAVAILABLE" link="libsoup-2.4-soup-status.html#SOUP-STATUS-SERVICE-UNAVAILABLE:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_GATEWAY_TIMEOUT" link="libsoup-2.4-soup-status.html#SOUP-STATUS-GATEWAY-TIMEOUT:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_HTTP_VERSION_NOT_SUPPORTED" link="libsoup-2.4-soup-status.html#SOUP-STATUS-HTTP-VERSION-NOT-SUPPORTED:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_INSUFFICIENT_STORAGE" link="libsoup-2.4-soup-status.html#SOUP-STATUS-INSUFFICIENT-STORAGE:CAPS"/> - <keyword type="constant" name="SOUP_STATUS_NOT_EXTENDED" link="libsoup-2.4-soup-status.html#SOUP-STATUS-NOT-EXTENDED:CAPS"/> - <keyword type="constant" name="SOUP_TLD_ERROR_INVALID_HOSTNAME" link="libsoup-2.4-Top-Level-Domain-utils.html#SOUP-TLD-ERROR-INVALID-HOSTNAME:CAPS"/> - <keyword type="constant" name="SOUP_TLD_ERROR_IS_IP_ADDRESS" link="libsoup-2.4-Top-Level-Domain-utils.html#SOUP-TLD-ERROR-IS-IP-ADDRESS:CAPS"/> - <keyword type="constant" name="SOUP_TLD_ERROR_NOT_ENOUGH_DOMAINS" link="libsoup-2.4-Top-Level-Domain-utils.html#SOUP-TLD-ERROR-NOT-ENOUGH-DOMAINS:CAPS"/> - <keyword type="constant" name="SOUP_TLD_ERROR_NO_BASE_DOMAIN" link="libsoup-2.4-Top-Level-Domain-utils.html#SOUP-TLD-ERROR-NO-BASE-DOMAIN:CAPS"/> - <keyword type="constant" name="SOUP_COOKIE_JAR_ACCEPT_ALWAYS" link="SoupCookieJar.html#SOUP-COOKIE-JAR-ACCEPT-ALWAYS:CAPS"/> - <keyword type="constant" name="SOUP_COOKIE_JAR_ACCEPT_NEVER" link="SoupCookieJar.html#SOUP-COOKIE-JAR-ACCEPT-NEVER:CAPS"/> - <keyword type="constant" name="SOUP_COOKIE_JAR_ACCEPT_NO_THIRD_PARTY" link="SoupCookieJar.html#SOUP-COOKIE-JAR-ACCEPT-NO-THIRD-PARTY:CAPS"/> - <keyword type="constant" name="SOUP_LOGGER_LOG_NONE" link="SoupLogger.html#SOUP-LOGGER-LOG-NONE:CAPS"/> - <keyword type="constant" name="SOUP_LOGGER_LOG_MINIMAL" link="SoupLogger.html#SOUP-LOGGER-LOG-MINIMAL:CAPS"/> - <keyword type="constant" name="SOUP_LOGGER_LOG_HEADERS" link="SoupLogger.html#SOUP-LOGGER-LOG-HEADERS:CAPS"/> - <keyword type="constant" name="SOUP_LOGGER_LOG_BODY" link="SoupLogger.html#SOUP-LOGGER-LOG-BODY:CAPS"/> - <keyword type="constant" name="SOUP_XMLRPC_ERROR_ARGUMENTS" link="libsoup-2.4-XMLRPC-Support.html#SOUP-XMLRPC-ERROR-ARGUMENTS:CAPS"/> - <keyword type="constant" name="SOUP_XMLRPC_ERROR_RETVAL" link="libsoup-2.4-XMLRPC-Support.html#SOUP-XMLRPC-ERROR-RETVAL:CAPS"/> - <keyword type="constant" name="SOUP_XMLRPC_FAULT_PARSE_ERROR_NOT_WELL_FORMED" link="libsoup-2.4-XMLRPC-Support.html#SOUP-XMLRPC-FAULT-PARSE-ERROR-NOT-WELL-FORMED:CAPS"/> - <keyword type="constant" name="SOUP_XMLRPC_FAULT_PARSE_ERROR_UNSUPPORTED_ENCODING" link="libsoup-2.4-XMLRPC-Support.html#SOUP-XMLRPC-FAULT-PARSE-ERROR-UNSUPPORTED-ENCODING:CAPS"/> - <keyword type="constant" name="SOUP_XMLRPC_FAULT_PARSE_ERROR_INVALID_CHARACTER_FOR_ENCODING" link="libsoup-2.4-XMLRPC-Support.html#SOUP-XMLRPC-FAULT-PARSE-ERROR-INVALID-CHARACTER-FOR-ENCODING:CAPS"/> - <keyword type="constant" name="SOUP_XMLRPC_FAULT_SERVER_ERROR_INVALID_XML_RPC" link="libsoup-2.4-XMLRPC-Support.html#SOUP-XMLRPC-FAULT-SERVER-ERROR-INVALID-XML-RPC:CAPS"/> - <keyword type="constant" name="SOUP_XMLRPC_FAULT_SERVER_ERROR_REQUESTED_METHOD_NOT_FOUND" link="libsoup-2.4-XMLRPC-Support.html#SOUP-XMLRPC-FAULT-SERVER-ERROR-REQUESTED-METHOD-NOT-FOUND:CAPS"/> - <keyword type="constant" name="SOUP_XMLRPC_FAULT_SERVER_ERROR_INVALID_METHOD_PARAMETERS" link="libsoup-2.4-XMLRPC-Support.html#SOUP-XMLRPC-FAULT-SERVER-ERROR-INVALID-METHOD-PARAMETERS:CAPS"/> - <keyword type="constant" name="SOUP_XMLRPC_FAULT_SERVER_ERROR_INTERNAL_XML_RPC_ERROR" link="libsoup-2.4-XMLRPC-Support.html#SOUP-XMLRPC-FAULT-SERVER-ERROR-INTERNAL-XML-RPC-ERROR:CAPS"/> - <keyword type="constant" name="SOUP_XMLRPC_FAULT_APPLICATION_ERROR" link="libsoup-2.4-XMLRPC-Support.html#SOUP-XMLRPC-FAULT-APPLICATION-ERROR:CAPS"/> - <keyword type="constant" name="SOUP_XMLRPC_FAULT_SYSTEM_ERROR" link="libsoup-2.4-XMLRPC-Support.html#SOUP-XMLRPC-FAULT-SYSTEM-ERROR:CAPS"/> - <keyword type="constant" name="SOUP_XMLRPC_FAULT_TRANSPORT_ERROR" link="libsoup-2.4-XMLRPC-Support.html#SOUP-XMLRPC-FAULT-TRANSPORT-ERROR:CAPS"/> - <keyword type="constant" name="SOUP_WEBSOCKET_CONNECTION_UNKNOWN" link="libsoup-2.4-WebSockets.html#SOUP-WEBSOCKET-CONNECTION-UNKNOWN:CAPS"/> - <keyword type="constant" name="SOUP_WEBSOCKET_CONNECTION_CLIENT" link="libsoup-2.4-WebSockets.html#SOUP-WEBSOCKET-CONNECTION-CLIENT:CAPS"/> - <keyword type="constant" name="SOUP_WEBSOCKET_CONNECTION_SERVER" link="libsoup-2.4-WebSockets.html#SOUP-WEBSOCKET-CONNECTION-SERVER:CAPS"/> - <keyword type="constant" name="SOUP_WEBSOCKET_STATE_OPEN" link="libsoup-2.4-WebSockets.html#SOUP-WEBSOCKET-STATE-OPEN:CAPS"/> - <keyword type="constant" name="SOUP_WEBSOCKET_STATE_CLOSING" link="libsoup-2.4-WebSockets.html#SOUP-WEBSOCKET-STATE-CLOSING:CAPS"/> - <keyword type="constant" name="SOUP_WEBSOCKET_STATE_CLOSED" link="libsoup-2.4-WebSockets.html#SOUP-WEBSOCKET-STATE-CLOSED:CAPS"/> - <keyword type="constant" name="SOUP_WEBSOCKET_DATA_TEXT" link="libsoup-2.4-WebSockets.html#SOUP-WEBSOCKET-DATA-TEXT:CAPS"/> - <keyword type="constant" name="SOUP_WEBSOCKET_DATA_BINARY" link="libsoup-2.4-WebSockets.html#SOUP-WEBSOCKET-DATA-BINARY:CAPS"/> - <keyword type="constant" name="SOUP_WEBSOCKET_CLOSE_NORMAL" link="libsoup-2.4-WebSockets.html#SOUP-WEBSOCKET-CLOSE-NORMAL:CAPS"/> - <keyword type="constant" name="SOUP_WEBSOCKET_CLOSE_GOING_AWAY" link="libsoup-2.4-WebSockets.html#SOUP-WEBSOCKET-CLOSE-GOING-AWAY:CAPS"/> - <keyword type="constant" name="SOUP_WEBSOCKET_CLOSE_PROTOCOL_ERROR" link="libsoup-2.4-WebSockets.html#SOUP-WEBSOCKET-CLOSE-PROTOCOL-ERROR:CAPS"/> - <keyword type="constant" name="SOUP_WEBSOCKET_CLOSE_UNSUPPORTED_DATA" link="libsoup-2.4-WebSockets.html#SOUP-WEBSOCKET-CLOSE-UNSUPPORTED-DATA:CAPS"/> - <keyword type="constant" name="SOUP_WEBSOCKET_CLOSE_NO_STATUS" link="libsoup-2.4-WebSockets.html#SOUP-WEBSOCKET-CLOSE-NO-STATUS:CAPS"/> - <keyword type="constant" name="SOUP_WEBSOCKET_CLOSE_ABNORMAL" link="libsoup-2.4-WebSockets.html#SOUP-WEBSOCKET-CLOSE-ABNORMAL:CAPS"/> - <keyword type="constant" name="SOUP_WEBSOCKET_CLOSE_BAD_DATA" link="libsoup-2.4-WebSockets.html#SOUP-WEBSOCKET-CLOSE-BAD-DATA:CAPS"/> - <keyword type="constant" name="SOUP_WEBSOCKET_CLOSE_POLICY_VIOLATION" link="libsoup-2.4-WebSockets.html#SOUP-WEBSOCKET-CLOSE-POLICY-VIOLATION:CAPS"/> - <keyword type="constant" name="SOUP_WEBSOCKET_CLOSE_TOO_BIG" link="libsoup-2.4-WebSockets.html#SOUP-WEBSOCKET-CLOSE-TOO-BIG:CAPS"/> - <keyword type="constant" name="SOUP_WEBSOCKET_CLOSE_NO_EXTENSION" link="libsoup-2.4-WebSockets.html#SOUP-WEBSOCKET-CLOSE-NO-EXTENSION:CAPS"/> - <keyword type="constant" name="SOUP_WEBSOCKET_CLOSE_SERVER_ERROR" link="libsoup-2.4-WebSockets.html#SOUP-WEBSOCKET-CLOSE-SERVER-ERROR:CAPS"/> - <keyword type="constant" name="SOUP_WEBSOCKET_CLOSE_TLS_HANDSHAKE" link="libsoup-2.4-WebSockets.html#SOUP-WEBSOCKET-CLOSE-TLS-HANDSHAKE:CAPS"/> - <keyword type="constant" name="SOUP_WEBSOCKET_ERROR_FAILED" link="libsoup-2.4-WebSockets.html#SOUP-WEBSOCKET-ERROR-FAILED:CAPS"/> - <keyword type="constant" name="SOUP_WEBSOCKET_ERROR_NOT_WEBSOCKET" link="libsoup-2.4-WebSockets.html#SOUP-WEBSOCKET-ERROR-NOT-WEBSOCKET:CAPS"/> - <keyword type="constant" name="SOUP_WEBSOCKET_ERROR_BAD_HANDSHAKE" link="libsoup-2.4-WebSockets.html#SOUP-WEBSOCKET-ERROR-BAD-HANDSHAKE:CAPS"/> - <keyword type="constant" name="SOUP_WEBSOCKET_ERROR_BAD_ORIGIN" link="libsoup-2.4-WebSockets.html#SOUP-WEBSOCKET-ERROR-BAD-ORIGIN:CAPS"/> - <keyword type="constant" name="SOUP_ADDRESS_FAMILY_INVALID" link="SoupAddress.html#SOUP-ADDRESS-FAMILY-INVALID:CAPS"/> - <keyword type="constant" name="SOUP_ADDRESS_FAMILY_IPV4" link="SoupAddress.html#SOUP-ADDRESS-FAMILY-IPV4:CAPS"/> - <keyword type="constant" name="SOUP_ADDRESS_FAMILY_IPV6" link="SoupAddress.html#SOUP-ADDRESS-FAMILY-IPV6:CAPS"/> - <keyword type="constant" name="SOUP_SOCKET_OK" link="SoupSocket.html#SOUP-SOCKET-OK:CAPS"/> - <keyword type="constant" name="SOUP_SOCKET_WOULD_BLOCK" link="SoupSocket.html#SOUP-SOCKET-WOULD-BLOCK:CAPS"/> - <keyword type="constant" name="SOUP_SOCKET_EOF" link="SoupSocket.html#SOUP-SOCKET-EOF:CAPS"/> - <keyword type="constant" name="SOUP_SOCKET_ERROR" link="SoupSocket.html#SOUP-SOCKET-ERROR:CAPS"/> - <keyword type="member" name="SoupCookie-struct.name" link="SoupCookie.html#SoupCookie-struct.name"/> - <keyword type="member" name="SoupCookie-struct.value" link="SoupCookie.html#SoupCookie-struct.value"/> - <keyword type="member" name="SoupCookie-struct.domain" link="SoupCookie.html#SoupCookie-struct.domain"/> - <keyword type="member" name="SoupCookie-struct.path" link="SoupCookie.html#SoupCookie-struct.path"/> - <keyword type="member" name="SoupCookie-struct.expires" link="SoupCookie.html#SoupCookie-struct.expires"/> - <keyword type="member" name="SoupCookie-struct.secure" link="SoupCookie.html#SoupCookie-struct.secure"/> - <keyword type="member" name="SoupCookie-struct.http-only" link="SoupCookie.html#SoupCookie-struct.http-only"/> - <keyword type="member" name="SoupMessage-struct.method" link="SoupMessage.html#SoupMessage-struct.method"/> - <keyword type="member" name="SoupMessage-struct.status-code" link="SoupMessage.html#SoupMessage-struct.status-code"/> - <keyword type="member" name="SoupMessage-struct.reason-phrase" link="SoupMessage.html#SoupMessage-struct.reason-phrase"/> - <keyword type="member" name="SoupMessage-struct.request-body" link="SoupMessage.html#SoupMessage-struct.request-body"/> - <keyword type="member" name="SoupMessage-struct.request-headers" link="SoupMessage.html#SoupMessage-struct.request-headers"/> - <keyword type="member" name="SoupMessage-struct.response-body" link="SoupMessage.html#SoupMessage-struct.response-body"/> - <keyword type="member" name="SoupMessage-struct.response-headers" link="SoupMessage.html#SoupMessage-struct.response-headers"/> - <keyword type="member" name="SoupRange.start" link="SoupMessageHeaders.html#SoupRange.start"/> - <keyword type="member" name="SoupRange.end" link="SoupMessageHeaders.html#SoupRange.end"/> - <keyword type="member" name="SoupBuffer-struct.data" link="SoupMessageBody.html#SoupBuffer-struct.data"/> - <keyword type="member" name="SoupBuffer-struct.length" link="SoupMessageBody.html#SoupBuffer-struct.length"/> - <keyword type="member" name="SoupMessageBody-struct.data" link="SoupMessageBody.html#SoupMessageBody-struct.data"/> - <keyword type="member" name="SoupMessageBody-struct.length" link="SoupMessageBody.html#SoupMessageBody-struct.length"/> - <keyword type="member" name="SoupDate-struct.year" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate-struct.year"/> - <keyword type="member" name="SoupDate-struct.month" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate-struct.month"/> - <keyword type="member" name="SoupDate-struct.day" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate-struct.day"/> - <keyword type="member" name="SoupDate-struct.hour" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate-struct.hour"/> - <keyword type="member" name="SoupDate-struct.minute" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate-struct.minute"/> - <keyword type="member" name="SoupDate-struct.second" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate-struct.second"/> - <keyword type="member" name="SoupDate-struct.utc" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate-struct.utc"/> - <keyword type="member" name="SoupDate-struct.offset" link="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate-struct.offset"/> - <keyword type="member" name="SoupURI-struct.scheme" link="SoupURI.html#SoupURI-struct.scheme"/> - <keyword type="member" name="SoupURI-struct.user" link="SoupURI.html#SoupURI-struct.user"/> - <keyword type="member" name="SoupURI-struct.password" link="SoupURI.html#SoupURI-struct.password"/> - <keyword type="member" name="SoupURI-struct.host" link="SoupURI.html#SoupURI-struct.host"/> - <keyword type="member" name="SoupURI-struct.port" link="SoupURI.html#SoupURI-struct.port"/> - <keyword type="member" name="SoupURI-struct.path" link="SoupURI.html#SoupURI-struct.path"/> - <keyword type="member" name="SoupURI-struct.query" link="SoupURI.html#SoupURI-struct.query"/> - <keyword type="member" name="SoupURI-struct.fragment" link="SoupURI.html#SoupURI-struct.fragment"/> - <keyword type="member" name="SoupSessionFeatureInterface.parent" link="SoupSessionFeature.html#SoupSessionFeatureInterface.parent"/> - <keyword type="member" name="SoupSessionFeatureInterface.attach" link="SoupSessionFeature.html#SoupSessionFeatureInterface.attach"/> - <keyword type="member" name="SoupSessionFeatureInterface.detach" link="SoupSessionFeature.html#SoupSessionFeatureInterface.detach"/> - <keyword type="member" name="SoupSessionFeatureInterface.request-queued" link="SoupSessionFeature.html#SoupSessionFeatureInterface.request-queued"/> - <keyword type="member" name="SoupSessionFeatureInterface.request-started" link="SoupSessionFeature.html#SoupSessionFeatureInterface.request-started"/> - <keyword type="member" name="SoupSessionFeatureInterface.request-unqueued" link="SoupSessionFeature.html#SoupSessionFeatureInterface.request-unqueued"/> - <keyword type="member" name="SoupSessionFeatureInterface.add-feature" link="SoupSessionFeature.html#SoupSessionFeatureInterface.add-feature"/> - <keyword type="member" name="SoupSessionFeatureInterface.remove-feature" link="SoupSessionFeature.html#SoupSessionFeatureInterface.remove-feature"/> - <keyword type="member" name="SoupSessionFeatureInterface.has-feature" link="SoupSessionFeature.html#SoupSessionFeatureInterface.has-feature"/> - </functions> -</book> diff --git a/docs/reference/html/libsoup-build-howto.html b/docs/reference/html/libsoup-build-howto.html deleted file mode 100644 index c98f6809..00000000 --- a/docs/reference/html/libsoup-build-howto.html +++ /dev/null @@ -1,135 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Compiling with libsoup: 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="ch01.html" title="Tutorial"> -<link rel="prev" href="ch01.html" title="Tutorial"> -<link rel="next" href="libsoup-client-howto.html" title="libsoup Client Basics"> -<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"></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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="libsoup-client-howto.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="libsoup-build-howto"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle">Compiling with libsoup</span></h2> -<p>Compiling with libsoup — Notes on compiling</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect2"> -<a name="id-1.2.2.3"></a><h3>Using pkg-config</h3> -<p> -Like other GNOME libraries, <span class="application">libsoup</span> uses -<span class="application">pkg-config</span> to provide compiler options. The -package name is "<code class="literal">libsoup-2.4</code>". So in your -<code class="literal">configure</code> script, you might specify something like: -</p> -<div class="informalexample"> - <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> - <tbody> - <tr> - <td class="listing_lines" align="right"><pre>1 -2 -3</pre></td> - <td class="listing_code"><pre class="programlisting"><span class="function">PKG_CHECK_MODULES</span><span class="gtkdoc opt">(</span>LIBSOUP<span class="gtkdoc opt">, [</span>libsoup<span class="gtkdoc opt">-</span><span class="number">2.4</span> <span class="gtkdoc opt">>=</span> <span class="number">2.26</span><span class="gtkdoc opt">])</span> -<span class="function">AC_SUBST</span><span class="gtkdoc opt">(</span>LIBSOUP_CFLAGS<span class="gtkdoc opt">)</span> -<span class="function">AC_SUBST</span><span class="gtkdoc opt">(</span>LIBSOUP_LIBS<span class="gtkdoc opt">)</span></pre></td> - </tr> - </tbody> - </table> -</div> - -<p> -The "<code class="literal">2.4</code>" in the package name is the "API version" -(indicating "the version of the <span class="application">libsoup</span> API -that first appeared in version 2.4") and is essentially just part of -the package name. -</p> -</div> -<hr> -<div class="refsect2"> -<a name="id-1.2.2.4"></a><h3>API Availability and Deprecation Warnings</h3> -<p> -If you want to restrict your program to a particular -<span class="application">libsoup</span> version or range of versions, you -can define <a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MIN-REQUIRED:CAPS" title="SOUP_VERSION_MIN_REQUIRED"><code class="literal">SOUP_VERSION_MIN_REQUIRED</code></a> -and/or <a class="link" href="libsoup-2.4-Version-Information.html#SOUP-VERSION-MAX-ALLOWED:CAPS" title="SOUP_VERSION_MAX_ALLOWED"><code class="literal">SOUP_VERSION_MAX_ALLOWED</code></a>. -Eg: -</p> -<div class="informalexample"> - <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> - <tbody> - <tr> - <td class="listing_lines" align="right"><pre>1 -2</pre></td> - <td class="listing_code"><pre class="programlisting">LIBSOUP_CFLAGS<span class="gtkdoc opt">=</span><span class="string">"$LIBSOUP_CFLAGS -DSOUP_VERSION_MIN_REQUIRED=SOUP_VERSION_2_36"</span> -LIBSOUP_CFLAGS<span class="gtkdoc opt">=</span><span class="string">"$LIBSOUP_CFLAGS -DSOUP_VERSION_MAX_ALLOWED=SOUP_VERSION_2_40"</span></pre></td> - </tr> - </tbody> - </table> -</div> - -<p> -The <code class="literal">SOUP_VERSION_MIN_REQUIRED</code> declaration states -that the code is not expected to compile on versions of -<span class="application">libsoup</span> older than the indicated version -(here, 2.36), and so the compiler should print warnings if the code -uses functions that were deprecated as of that release. -</p> -<p> -The <code class="literal">SOUP_VERSION_MAX_ALLOWED</code> declaration states -that the code <span class="emphasis"><em>is</em></span> expected to compile on versions -of <span class="application">libsoup</span> up to the indicated version -(here, 2.40), and so, when compiling the program against a newer -version than that, the compiler should print warnings if the code uses -functions that did not yet exist in the max-allowed release. -</p> -<p> -You can use <a class="link" href="libsoup-2.4-Version-Information.html#SOUP-CHECK-VERSION:CAPS" title="SOUP_CHECK_VERSION()"><code class="literal">SOUP_CHECK_VERSION</code></a> -to check the version of libsoup at compile time, to compile different -code for different <span class="application">libsoup</span> versions. (If -you are setting <code class="literal">SOUP_VERSION_MIN_REQUIRED</code> and -<code class="literal">SOUP_VERSION_MAX_ALLOWED</code> to different versions, as -in the example above, then you almost certainly need to be doing -this.) -</p> -</div> -<hr> -<div class="refsect2"> -<a name="id-1.2.2.5"></a><h3>Headers</h3> -<p> -Code using <span class="application">libsoup</span> should do: -</p> -<div class="informalexample"> - <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> - <tbody> - <tr> - <td class="listing_lines" align="right"><pre>1</pre></td> - <td class="listing_code"><pre class="programlisting"><span class="gtkdoc ppc">#include <libsoup/soup.h></span></pre></td> - </tr> - </tbody> - </table> -</div> - -<p> -Including individual headers rather than <code class="literal">soup.h</code> is not -recommended. -</p> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/libsoup-client-howto.html b/docs/reference/html/libsoup-client-howto.html deleted file mode 100644 index df2524f9..00000000 --- a/docs/reference/html/libsoup-client-howto.html +++ /dev/null @@ -1,603 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>libsoup Client Basics: 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="ch01.html" title="Tutorial"> -<link rel="prev" href="libsoup-build-howto.html" title="Compiling with libsoup"> -<link rel="next" href="libsoup-request-howto.html" title="libsoup Client SoupRequest API"> -<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"></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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="libsoup-build-howto.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="libsoup-request-howto.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="libsoup-client-howto"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle">libsoup Client Basics</span></h2> -<p>libsoup Client Basics — Client-side tutorial</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect2"> -<a name="id-1.2.3.3"></a><p> -This section explains how to use <span class="application">libsoup</span> as -an HTTP client using several new APIs introduced in version 2.42. If -you want to be compatible with older versions of -<span class="application">libsoup</span>, consult the documentation for that -version. -</p> -</div> -<hr> -<div class="refsect2"> -<a name="id-1.2.3.4"></a><h3>Creating a <span class="type">SoupSession</span> -</h3> -<p> -The first step in using the client API is to create a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a>. The session object -encapsulates all of the state that <span class="application">libsoup</span> -is keeping on behalf of your program; cached HTTP connections, -authentication information, etc. -</p> -<p> -When you create the session with <a class="link" href="SoupSession.html#soup-session-new-with-options" title="soup_session_new_with_options ()"><code class="function">soup_session_new_with_options</code></a>, -you can specify various additional options: -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><a class="link" href="SoupSession.html#SOUP-SESSION-MAX-CONNS:CAPS" title="SOUP_SESSION_MAX_CONNS"><code class="literal">SOUP_SESSION_MAX_CONNS</code></a></span></p></td> -<td><p> - Allows you to set the maximum total number of connections - the session will have open at one time. (Once it reaches - this limit, it will either close idle connections, or - wait for existing connections to free up before starting - new requests.) The default value is 10. - </p></td> -</tr> -<tr> -<td><p><span class="term"><a class="link" href="SoupSession.html#SOUP-SESSION-MAX-CONNS-PER-HOST:CAPS" title="SOUP_SESSION_MAX_CONNS_PER_HOST"><code class="literal">SOUP_SESSION_MAX_CONNS_PER_HOST</code></a></span></p></td> -<td><p> - Allows you to set the maximum total number of connections - the session will have open <span class="emphasis"><em>to a single - host</em></span> at one time. The default value is 2. - </p></td> -</tr> -<tr> -<td><p><span class="term"><a class="link" href="SoupSession.html#SOUP-SESSION-USER-AGENT:CAPS" title="SOUP_SESSION_USER_AGENT"><code class="literal">SOUP_SESSION_USER_AGENT</code></a></span></p></td> -<td><p> - Allows you to set a User-Agent string that will be sent - on all outgoing requests. - </p></td> -</tr> -<tr> -<td><p><span class="term"><a class="link" href="SoupSession.html#SOUP-SESSION-ACCEPT-LANGUAGE:CAPS" title="SOUP_SESSION_ACCEPT_LANGUAGE"><code class="literal">SOUP_SESSION_ACCEPT_LANGUAGE</code></a> - and <a class="link" href="SoupSession.html#SOUP-SESSION-ACCEPT-LANGUAGE-AUTO:CAPS" title="SOUP_SESSION_ACCEPT_LANGUAGE_AUTO"><code class="literal">SOUP_SESSION_ACCEPT_LANGUAGE_AUTO</code></a></span></p></td> -<td><p> - Allow you to set an Accept-Language header on all outgoing - requests. <code class="literal">SOUP_SESSION_ACCEPT_LANGUAGE</code> - takes a list of language tags to use, while - <code class="literal">SOUP_SESSION_ACCEPT_LANGUAGE_AUTO</code> - automatically generates the list from the user's locale - settings. - </p></td> -</tr> -<tr> -<td><p><span class="term"><a class="link" href="SoupSession.html#SOUP-SESSION-HTTP-ALIASES:CAPS" title="SOUP_SESSION_HTTP_ALIASES"><code class="literal">SOUP_SESSION_HTTP_ALIASES</code></a> - and <a class="link" href="SoupSession.html#SOUP-SESSION-HTTPS-ALIASES:CAPS" title="SOUP_SESSION_HTTPS_ALIASES"><code class="literal">SOUP_SESSION_HTTPS_ALIASES</code></a></span></p></td> -<td><p> - Allow you to tell the session to recognize additional URI - schemes as aliases for "<code class="literal">http</code>" or - <code class="literal">https</code>. You can set this if you are - using URIs with schemes like "<code class="literal">dav</code>" or - "<code class="literal">webcal</code>" (and in particular, you need - to set this if the server you are talking to might return - redirects with such a scheme). - </p></td> -</tr> -<tr> -<td><p><span class="term"><a class="link" href="SoupSession.html#SOUP-SESSION-PROXY-RESOLVER:CAPS" title="SOUP_SESSION_PROXY_RESOLVER"><code class="literal">SOUP_SESSION_PROXY_RESOLVER</code></a> and <a class="link" href="SoupSession.html#SOUP-SESSION-PROXY-URI:CAPS" title="SOUP_SESSION_PROXY_URI"><code class="literal">SOUP_SESSION_PROXY_URI</code></a></span></p></td> -<td> -<p> - <a class="link" href="SoupSession.html#SOUP-SESSION-PROXY-RESOLVER:CAPS" title="SOUP_SESSION_PROXY_RESOLVER"><code class="literal">SOUP_SESSION_PROXY_RESOLVER</code></a> - specifies a <span class="type">GProxyResolver</span> - to use to determine the HTTP proxies to use. By default, - this is set to the resolver returned by <code class="function">g_proxy_resolver_get_default</code>, - so you do not need to set it yourself. - </p> -<p> - Alternatively, if you want all requests to go through a - single proxy, you can set <a class="link" href="SoupSession.html#SOUP-SESSION-PROXY-URI:CAPS" title="SOUP_SESSION_PROXY_URI"><code class="literal">SOUP_SESSION_PROXY_URI</code></a>. - </p> -</td> -</tr> -<tr> -<td><p><span class="term"><a class="link" href="SoupSession.html#SOUP-SESSION-ADD-FEATURE:CAPS" title="SOUP_SESSION_ADD_FEATURE"><code class="literal">SOUP_SESSION_ADD_FEATURE</code></a> and <a class="link" href="SoupSession.html#SOUP-SESSION-ADD-FEATURE-BY-TYPE:CAPS" title="SOUP_SESSION_ADD_FEATURE_BY_TYPE"><code class="literal">SOUP_SESSION_ADD_FEATURE_BY_TYPE</code></a></span></p></td> -<td><p> - These allow you to specify <a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature"><span class="type">SoupSessionFeature</span></a>s - (discussed <a class="link" href="libsoup-client-howto.html#session-features" title="Session features">below</a>) - to add at construct-time. - </p></td> -</tr> -</tbody> -</table></div> -<p> -Other properties are also available; see the <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> documentation for -more details. -</p> -<p> -If you don't need to specify any options, you can just use <a class="link" href="SoupSession.html#soup-session-new" title="soup_session_new ()"><code class="function">soup_session_new</code></a>, -which takes no arguments. -</p> -</div> -<hr> -<div class="refsect2"> -<a name="session-features"></a><h3>Session features</h3> -<p> -Additional session functionality is provided as <a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature"><span class="type">SoupSessionFeature</span></a>s, -which can be added to a session, via the <a class="link" href="SoupSession.html#SOUP-SESSION-ADD-FEATURE:CAPS" title="SOUP_SESSION_ADD_FEATURE"><code class="literal">SOUP_SESSION_ADD_FEATURE</code></a> -and <a class="link" href="SoupSession.html#SOUP-SESSION-ADD-FEATURE-BY-TYPE:CAPS" title="SOUP_SESSION_ADD_FEATURE_BY_TYPE"><code class="literal">SOUP_SESSION_ADD_FEATURE_BY_TYPE</code></a> -options at session-construction-time, or afterward via the <a class="link" href="SoupSession.html#soup-session-add-feature" title="soup_session_add_feature ()"><code class="function">soup_session_add_feature</code></a> -and <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> -functions. -</p> -<p> -A <a class="link" href="SoupContentDecoder.html" title="SoupContentDecoder"><span class="type">SoupContentDecoder</span></a> is -added for you automatically. This advertises to servers that the -client supports compression, and automatically decompresses compressed -responses. -</p> -<p> -Some other available features that you can add include: -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a></span></p></td> -<td><p> - A debugging aid, which logs all of libsoup's HTTP traffic - to <code class="literal">stdout</code> (or another place you specify). - </p></td> -</tr> -<tr> -<td><p><span class="term"> - <a class="link" href="SoupCookieJar.html" title="SoupCookieJar"><span class="type">SoupCookieJar</span></a>, - <a class="link" href="SoupCookieJarText.html" title="SoupCookieJarText"><span class="type">SoupCookieJarText</span></a>, - and <a class="link" href="SoupCookieJarDB.html" title="SoupCookieJarDB"><span class="type">SoupCookieJarDB</span></a> - </span></p></td> -<td><p> - Support for HTTP cookies. <span class="type">SoupCookieJar</span> - provides non-persistent cookie storage, while - <span class="type">SoupCookieJarText</span> uses a text file to keep - track of cookies between sessions, and - <span class="type">SoupCookieJarDB</span> uses a - <span class="application">SQLite</span> database. - </p></td> -</tr> -<tr> -<td><p><span class="term"><a class="link" href="SoupContentSniffer.html" title="SoupContentSniffer"><span class="type">SoupContentSniffer</span></a></span></p></td> -<td><p> - Uses the HTML5 sniffing rules to attempt to - determine the Content-Type of a response when the - server does not identify the Content-Type, or appears to - have provided an incorrect one. - </p></td> -</tr> -</tbody> -</table></div> -<p> -Use the "add_feature_by_type" property/function to add features that -don't require any configuration (such as <a class="link" href="SoupContentSniffer.html" title="SoupContentSniffer"><span class="type">SoupContentSniffer</span></a>), -and the "add_feature" property/function to add features that must be -constructed first (such as <a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a>). For example, an -application might do something like the following: -</p> -<div class="informalexample"> - <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> - <tbody> - <tr> - <td class="listing_lines" align="right"><pre>1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11</pre></td> - <td class="listing_code"><pre class="programlisting">session <span class="gtkdoc opt">=</span> <span class="function"><a href="SoupSession.html#soup-session-new-with-options">soup_session_new_with_options</a></span> <span class="gtkdoc opt">(</span> - SOUP_SESSION_ADD_FEATURE_BY_TYPE<span class="gtkdoc opt">,</span> SOUP_TYPE_CONTENT_SNIFFER<span class="gtkdoc opt">,</span> - NULL<span class="gtkdoc opt">);</span> - -<span class="keyword">if</span> <span class="gtkdoc opt">(</span>debug_level<span class="gtkdoc opt">) {</span> - SoupLogger <span class="gtkdoc opt">*</span>logger<span class="gtkdoc opt">;</span> - - logger <span class="gtkdoc opt">=</span> <span class="function"><a href="SoupLogger.html#soup-logger-new">soup_logger_new</a></span> <span class="gtkdoc opt">(</span>debug_level<span class="gtkdoc opt">, -</span><span class="number">1</span><span class="gtkdoc opt">);</span> - <span class="function"><a href="SoupSession.html#soup-session-add-feature">soup_session_add_feature</a></span> <span class="gtkdoc opt">(</span>session<span class="gtkdoc opt">,</span> <span class="function">SOUP_SESSION_FEATURE</span> <span class="gtkdoc opt">(</span>logger<span class="gtkdoc opt">));</span> - <span class="function">g_object_unref</span> <span class="gtkdoc opt">(</span>logger<span class="gtkdoc opt">);</span> -<span class="gtkdoc opt">}</span></pre></td> - </tr> - </tbody> - </table> -</div> - -</div> -<hr> -<div class="refsect2"> -<a name="id-1.2.3.6"></a><h3>Creating and Sending SoupMessages</h3> -<p> -Once you have a session, you send HTTP requests using <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>. In the simplest -case, you only need to create the message and it's ready to send: -</p> -<div class="informalexample"> - <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> - <tbody> - <tr> - <td class="listing_lines" align="right"><pre>1 -2 -3</pre></td> - <td class="listing_code"><pre class="programlisting">SoupMessage <span class="gtkdoc opt">*</span>msg<span class="gtkdoc opt">;</span> - -msg <span class="gtkdoc opt">=</span> <span class="function"><a href="SoupMessage.html#soup-message-new">soup_message_new</a></span> <span class="gtkdoc opt">(</span><span class="string">"GET"</span><span class="gtkdoc opt">,</span> <span class="string">"http://example.com/"</span><span class="gtkdoc opt">);</span></pre></td> - </tr> - </tbody> - </table> -</div> - -<p> -In more complicated cases, you can use various <a class="link" href="SoupMessage.html" title="SoupMessage">SoupMessage</a>, <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders">SoupMessageHeaders</a>, and <a class="link" href="SoupMessageBody.html" title="SoupMessageBody">SoupMessageBody</a> methods to set the -request headers and body of the message: -</p> -<div class="informalexample"> - <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> - <tbody> - <tr> - <td class="listing_lines" align="right"><pre>1 -2 -3 -4 -5 -6</pre></td> - <td class="listing_code"><pre class="programlisting">SoupMessage <span class="gtkdoc opt">*</span>msg<span class="gtkdoc opt">;</span> - -msg <span class="gtkdoc opt">=</span> <span class="function"><a href="SoupMessage.html#soup-message-new">soup_message_new</a></span> <span class="gtkdoc opt">(</span><span class="string">"POST"</span><span class="gtkdoc opt">,</span> <span class="string">"http://example.com/form.cgi"</span><span class="gtkdoc opt">);</span> -<span class="function"><a href="SoupMessage.html#soup-message-set-request">soup_message_set_request</a></span> <span class="gtkdoc opt">(</span>msg<span class="gtkdoc opt">,</span> <span class="string">"application/x-www-form-urlencoded"</span><span class="gtkdoc opt">,</span> - SOUP_MEMORY_COPY<span class="gtkdoc opt">,</span> formdata<span class="gtkdoc opt">,</span> <span class="function">strlen</span> <span class="gtkdoc opt">(</span>formdata<span class="gtkdoc opt">));</span> -<span class="function"><a href="SoupMessageHeaders.html#soup-message-headers-append">soup_message_headers_append</a></span> <span class="gtkdoc opt">(</span>msg<span class="gtkdoc opt">-></span>request_headers<span class="gtkdoc opt">,</span> <span class="string">"Referer"</span><span class="gtkdoc opt">,</span> referring_url<span class="gtkdoc opt">);</span></pre></td> - </tr> - </tbody> - </table> -</div> - -<p> -(Although this is a bad example, because -<span class="application">libsoup</span> actually has convenience methods -for dealing with <a class="link" href="libsoup-2.4-HTML-Form-Support.html" title="HTML Form Support">HTML -forms</a>, as well as <a class="link" href="libsoup-2.4-XMLRPC-Support.html" title="XMLRPC Support">XML-RPC</a>.) -</p> -<p> -You can also use <a class="link" href="SoupMessage.html#soup-message-set-flags" title="soup_message_set_flags ()"><code class="function">soup_message_set_flags</code></a> -to change some default behaviors. For example, by default, -<span class="type">SoupSession</span> automatically handles responses from the -server that redirect to another URL. If you would like to handle these -yourself, you can set the <a class="link" href="SoupMessage.html#SOUP-MESSAGE-NO-REDIRECT:CAPS"><code class="literal">SOUP_MESSAGE_NO_REDIRECT</code></a> -flag. -</p> -<div class="refsect3"> -<a name="id-1.2.3.6.8"></a><h4>Sending a Message Synchronously</h4> -<p> -To send a message and wait for the response, use <a class="link" href="SoupSession.html#soup-session-send" title="soup_session_send ()"><code class="function">soup_session_send</code></a>: -</p> -<div class="informalexample"> - <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> - <tbody> - <tr> - <td class="listing_lines" align="right"><pre>1 -2 -3 -4</pre></td> - <td class="listing_code"><pre class="programlisting">GInputStream <span class="gtkdoc opt">*</span>stream<span class="gtkdoc opt">;</span> -GError <span class="gtkdoc opt">*</span>error <span class="gtkdoc opt">=</span> NULL<span class="gtkdoc opt">;</span> - -stream <span class="gtkdoc opt">=</span> <span class="function"><a href="SoupSession.html#soup-session-send">soup_session_send</a></span> <span class="gtkdoc opt">(</span>session<span class="gtkdoc opt">,</span> msg<span class="gtkdoc opt">,</span> cancellable<span class="gtkdoc opt">, &</span>error<span class="gtkdoc opt">);</span></pre></td> - </tr> - </tbody> - </table> -</div> - -<p> -At the point when <code class="function">soup_session_send</code> returns, the -request will have been sent, and the response headers read back in; -you can examine the message's <em class="structfield"><code>status_code</code></em>, -<em class="structfield"><code>reason_phrase</code></em>, and -<em class="structfield"><code>response_headers</code></em> fields to see the response -metadata. To get the response body, read from the returned <span class="type">GInputStream</span>, and close it -when you are done. -</p> -<p> -Note that <code class="function">soup_session_send</code> only returns an error -if a transport-level problem occurs (eg, it could not connect to the -host, or the request was cancelled). Use the message's -<em class="structfield"><code>status_code</code></em> field to determine whether the -request was successful or not at the HTTP level (ie, "<code class="literal">200 -OK</code>" vs "<code class="literal">401 Bad Request</code>"). -</p> -<p> -If you would prefer to have <span class="application">libsoup</span> gather -the response body for you and then return it all at once, you can use -the older -<a class="link" href="SoupSession.html#soup-session-send-message" title="soup_session_send_message ()"><code class="function">soup_session_send_message</code></a> -API: -</p> -<div class="informalexample"> - <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> - <tbody> - <tr> - <td class="listing_lines" align="right"><pre>1 -2 -3</pre></td> - <td class="listing_code"><pre class="programlisting">guint status<span class="gtkdoc opt">;</span> - -status <span class="gtkdoc opt">=</span> <span class="function"><a href="SoupSession.html#soup-session-send-message">soup_session_send_message</a></span> <span class="gtkdoc opt">(</span>session<span class="gtkdoc opt">,</span> msg<span class="gtkdoc opt">);</span></pre></td> - </tr> - </tbody> - </table> -</div> - -<p> -In this case, the response body will be available in the message's -<em class="structfield"><code>response_body</code></em> field, and transport-level -errors will be indicated in the <em class="structfield"><code>status_code</code></em> -field via special pseudo-HTTP-status codes like <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-CANT-CONNECT:CAPS"><code class="literal">SOUP_STATUS_CANT_CONNECT</code></a>. -</p> -</div> -<div class="refsect3"> -<a name="id-1.2.3.6.9"></a><h4>Sending a Message Asynchronously</h4> -<p> -To send a message asynchronously, use <a class="link" href="SoupSession.html#soup-session-send-async" title="soup_session_send_async ()"><code class="function">soup_session_send_async</code></a>: -</p> -<div class="informalexample"> - <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> - <tbody> - <tr> - <td class="listing_lines" align="right"><pre>1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15</pre></td> - <td class="listing_code"><pre class="programlisting"><span class="gtkdoc opt">{</span> - <span class="gtkdoc opt">...</span> - <span class="function"><a href="SoupSession.html#soup-session-send-async">soup_session_send_async</a></span> <span class="gtkdoc opt">(</span>session<span class="gtkdoc opt">,</span> msg<span class="gtkdoc opt">,</span> cancellable<span class="gtkdoc opt">,</span> my_callback<span class="gtkdoc opt">,</span> my_callback_data<span class="gtkdoc opt">);</span> - <span class="gtkdoc opt">...</span> -<span class="gtkdoc opt">}</span> - -<span class="gtkdoc kwb">static void</span> -<span class="function">my_callback</span> <span class="gtkdoc opt">(</span>GObject <span class="gtkdoc opt">*</span>object<span class="gtkdoc opt">,</span> GAsyncResult <span class="gtkdoc opt">*</span>result<span class="gtkdoc opt">,</span> gpointer user_data<span class="gtkdoc opt">)</span> -<span class="gtkdoc opt">{</span> - GInputStream <span class="gtkdoc opt">*</span>stream<span class="gtkdoc opt">;</span> - GError <span class="gtkdoc opt">*</span>error <span class="gtkdoc opt">=</span> NULL<span class="gtkdoc opt">;</span> - - stream <span class="gtkdoc opt">=</span> <span class="function"><a href="SoupSession.html#soup-session-send-finish">soup_session_send_finish</a></span> <span class="gtkdoc opt">(</span><span class="function">SOUP_SESSION</span> <span class="gtkdoc opt">(</span>object<span class="gtkdoc opt">),</span> result<span class="gtkdoc opt">, &</span>error<span class="gtkdoc opt">);</span> - <span class="gtkdoc opt">...</span> -<span class="gtkdoc opt">}</span></pre></td> - </tr> - </tbody> - </table> -</div> - -<p> -The message will be added to the session's queue, and eventually (when -control is returned back to the main loop), it will be sent and the -response be will be read. When the message has been sent, and its -headers received, the callback will be invoked, in the standard -<span class="type">GAsyncReadyCallback</span> -style. -</p> -<p> -As with synchronous sending, there is also an alternate API, <a class="link" href="SoupSession.html#soup-session-queue-message" title="soup_session_queue_message ()"><code class="function">soup_session_queue_message</code></a>, -in which your callback is not invoked until the response has been -completely read: -</p> -<div class="informalexample"> - <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> - <tbody> - <tr> - <td class="listing_lines" align="right"><pre>1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11</pre></td> - <td class="listing_code"><pre class="programlisting"><span class="gtkdoc opt">{</span> - <span class="gtkdoc opt">...</span> - <span class="function"><a href="SoupSession.html#soup-session-queue-message">soup_session_queue_message</a></span> <span class="gtkdoc opt">(</span>session<span class="gtkdoc opt">,</span> msg<span class="gtkdoc opt">,</span> my_callback<span class="gtkdoc opt">,</span> my_callback_data<span class="gtkdoc opt">);</span> - <span class="gtkdoc opt">...</span> -<span class="gtkdoc opt">}</span> - -<span class="gtkdoc kwb">static void</span> -<span class="function">my_callback</span> <span class="gtkdoc opt">(</span>SoupSession <span class="gtkdoc opt">*</span>session<span class="gtkdoc opt">,</span> SoupMessage <span class="gtkdoc opt">*</span>msg<span class="gtkdoc opt">,</span> gpointer user_data<span class="gtkdoc opt">)</span> -<span class="gtkdoc opt">{</span> - <span class="comment">/* msg->response_body contains the response */</span> -<span class="gtkdoc opt">}</span></pre></td> - </tr> - </tbody> - </table> -</div> - -<p> -<a class="link" href="SoupSession.html#soup-session-queue-message" title="soup_session_queue_message ()"><code class="function">soup_session_queue_message</code></a> -is slightly unusual in that it steals a reference to the message -object, and unrefs it after the last callback is invoked on it. So -when using this API, you should not unref the message yourself. -</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="id-1.2.3.7"></a><h3>Processing the Response</h3> -<p> -Once you have received the initial response from the server, -synchronously or asynchronously, streaming or not, you can look at the -response fields in the <code class="literal">SoupMessage</code> to decide what -to do next. The <em class="structfield"><code>status_code</code></em> and -<em class="structfield"><code>reason_phrase</code></em> fields contain the numeric -status and textual status response from the server. -<em class="structfield"><code>response_headers</code></em> contains the response -headers, which you can investigate using <code class="function">soup_message_headers_get</code> -and <a class="link" href="SoupMessageHeaders.html#soup-message-headers-foreach" title="soup_message_headers_foreach ()"><code class="function">soup_message_headers_foreach</code></a>. -</p> -<p> -<a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> -automatically parses several important headers in -<em class="structfield"><code>response_headers</code></em> for you and provides -specialized accessors for them. Eg, <a class="link" href="SoupMessageHeaders.html#soup-message-headers-get-content-type" title="soup_message_headers_get_content_type ()"><code class="function">soup_message_headers_get_content_type</code></a>. -There are several generic methods such as <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-parse-param-list" title="soup_header_parse_param_list ()"><code class="function">soup_header_parse_param_list</code></a> -(for parsing an attribute-list-type header) and <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-contains" title="soup_header_contains ()"><code class="function">soup_header_contains</code></a> -(for quickly testing if a list-type header contains a particular -token). These handle the various syntactical oddities of parsing HTTP -headers much better than functions like -<code class="function">g_strsplit</code> or <code class="function">strstr</code>. -</p> -</div> -<hr> -<div class="refsect2"> -<a name="id-1.2.3.8"></a><h3>Handling Authentication</h3> -<p> -<span class="type">SoupSession</span> handles most of the details of HTTP -authentication for you. If it receives a 401 ("Unauthorized") or 407 -("Proxy Authentication Required") response, the session will emit the -<a class="link" href="SoupSession.html#SoupSession-authenticate" title="The “authenticate” signal">authenticate</a> signal, -providing you with a <a class="link" href="SoupAuth.html" title="SoupAuth"><span class="type">SoupAuth</span></a> object indicating the -authentication type ("Basic", "Digest", or "NTLM") and the realm name -provided by the server. If you have a username and password available -(or can generate one), call <a class="link" href="SoupAuth.html#soup-auth-authenticate" title="soup_auth_authenticate ()"><code class="function">soup_auth_authenticate</code></a> -to give the information to libsoup. The session will automatically -requeue the message and try it again with that authentication -information. (If you don't call -<code class="function">soup_auth_authenticate</code>, the session will just -return the message to the application with its 401 or 407 status.) -</p> -<p> -If the server doesn't accept the username and password provided, the -session will emit <a class="link" href="SoupSession.html#SoupSession-authenticate" title="The “authenticate” signal">authenticate</a> again, with the -<code class="literal">retrying</code> parameter set to <code class="literal">TRUE</code>. This lets the -application know that the information it provided earlier was -incorrect, and gives it a chance to try again. If this -username/password pair also doesn't work, the session will contine to -emit <code class="literal">authenticate</code> again and again until the -provided username/password successfully authenticates, or until the -signal handler fails to call <a class="link" href="SoupAuth.html#soup-auth-authenticate" title="soup_auth_authenticate ()"><code class="function">soup_auth_authenticate</code></a>, -at which point <span class="application">libsoup</span> will allow the -message to fail (with status 401 or 407). -</p> -<p> -If you need to handle authentication asynchronously (eg, to pop up a -password dialog without recursively entering the main loop), you can -do that as well. Just call <a class="link" href="SoupSession.html#soup-session-pause-message" title="soup_session_pause_message ()"><code class="function">soup_session_pause_message</code></a> -on the message before returning from the signal handler, and -<code class="function">g_object_ref</code> the <span class="type">SoupAuth</span>. Then, -later on, after calling <code class="function">soup_auth_authenticate</code> -(or deciding not to), call <a class="link" href="SoupSession.html#soup-session-unpause-message" title="soup_session_unpause_message ()"><code class="function">soup_session_unpause_message</code></a> -to resume the paused message. -</p> -<p> -By default, NTLM authentication is not enabled. To add NTLM support to -a session, call: -</p> -<div class="informalexample"> - <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> - <tbody> - <tr> - <td class="listing_lines" align="right"><pre>1</pre></td> - <td class="listing_code"><pre class="programlisting"><span class="function"><a href="SoupSession.html#soup-session-add-feature-by-type">soup_session_add_feature_by_type</a></span> <span class="gtkdoc opt">(</span>session<span class="gtkdoc opt">,</span> SOUP_TYPE_AUTH_NTLM<span class="gtkdoc opt">);</span></pre></td> - </tr> - </tbody> - </table> -</div> - -<p> -(You can also disable Basic or Digest authentication by calling <a class="link" href="SoupSession.html#soup-session-remove-feature-by-type" title="soup_session_remove_feature_by_type ()"><code class="function">soup_session_remove_feature_by_type</code></a> -on <a class="link" href="SoupAuth.html#SOUP-TYPE-AUTH-BASIC:CAPS" title="SOUP_TYPE_AUTH_BASIC"><code class="literal">SOUP_TYPE_AUTH_BASIC</code></a> -or <a class="link" href="SoupAuth.html#SOUP-TYPE-AUTH-DIGEST:CAPS" title="SOUP_TYPE_AUTH_DIGEST"><code class="literal">SOUP_TYPE_AUTH_DIGEST</code></a>.) -</p> -</div> -<hr> -<div class="refsect2"> -<a name="id-1.2.3.9"></a><h3>Multi-threaded usage</h3> -<p> -A <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> can be -used from multiple threads. However, if you are using the async APIs, -then each thread you use the session from must have its own -thread-default <span class="type">GMainContext</span>. -</p> -<p> -<a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> is -<span class="emphasis"><em>not</em></span> thread-safe, so once you send a message on -the session, you must not interact with it from any thread other than -the one where it was sent. -</p> -</div> -<hr> -<div class="refsect2"> -<a name="id-1.2.3.10"></a><h3>Sample Programs</h3> -<p> -A few sample programs are available in the -<span class="application">libsoup</span> sources, in the -<code class="literal">examples</code> directory: -</p> -<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> -<li class="listitem"><p> - <span class="bold"><strong><code class="literal">get</code></strong></span> is a simple command-line - HTTP GET utility using the asynchronous API. - </p></li> -<li class="listitem"><p> - <span class="bold"><strong><code class="literal">simple-proxy</code></strong></span> uses both the - client and server APIs to create a simple (and not very - RFC-compliant) proxy server. It shows how to use the <a class="link" href="SoupMessage.html#SoupMessageFlags" title="enum SoupMessageFlags"><code class="literal">SOUP_MESSAGE_OVERWRITE_CHUNKS</code></a> - flag when reading a message to save memory by processing each - chunk of the message as it is read, rather than accumulating - them all into a single buffer to process all at the end. - </p></li> -</ul></div> -<p> -More complicated examples are available in GNOME git. -</p> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/libsoup-request-howto.html b/docs/reference/html/libsoup-request-howto.html deleted file mode 100644 index 3403daf7..00000000 --- a/docs/reference/html/libsoup-request-howto.html +++ /dev/null @@ -1,171 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>libsoup Client SoupRequest API: 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="ch01.html" title="Tutorial"> -<link rel="prev" href="libsoup-client-howto.html" title="libsoup Client Basics"> -<link rel="next" href="libsoup-session-porting.html" title="Porting to the new SoupSession"> -<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"></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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="libsoup-client-howto.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="libsoup-session-porting.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="libsoup-request-howto"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle">libsoup Client SoupRequest API</span></h2> -<p>libsoup Client SoupRequest API — Using -libsoup with a mix of <code class="literal">http</code> and non-<code class="literal">http</code> URIs.</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect2"> -<a name="id-1.2.4.3"></a><h3><span class="type">SoupRequest</span></h3> -<p> -<a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a> is an -abstract type representing a request for a particular URI. The -<span class="type">SoupRequest</span> API is an alternative to the <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>-based <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> APIs which may be -useful to programs that want to deal with multiple kinds of URIs. -</p> -<p> -<span class="type">SoupRequest</span> officially became part of the -<span class="application">libsoup</span> API in 2.42 with the addition of -<a class="link" href="SoupSession.html#soup-session-request" title="soup_session_request ()"><code class="function">soup_session_request</code></a> -and the related functions. However, parts of it are also available as -far back as <span class="application">libsoup</span> 2.34 via the -(now-deprecated) <span class="type">SoupRequester</span> session feature, if you -define <code class="literal">LIBSOUP_USE_UNSTABLE_REQUEST_API</code> before -including the <span class="application">libsoup</span> headers. -</p> -<p> -Additionally, before <span class="application">libsoup</span> 2.42, the -<span class="type">SoupRequest</span> API was the only way to stream an HTTP -response body via <span class="type">GInputStream</span>. As of 2.42, -there are streaming APIs based on <span class="type">SoupMessage</span> (<a class="link" href="SoupSession.html#soup-session-send" title="soup_session_send ()"><code class="function">soup_session_send</code></a> -and <a class="link" href="SoupSession.html#soup-session-send-async" title="soup_session_send_async ()"><code class="function">soup_session_send_async</code></a>), -so applications that are using <span class="type">SoupRequest</span> with only -<code class="literal">http</code> and <code class="literal">https</code> URIs can be -ported to those APIs now. -</p> -</div> -<hr> -<div class="refsect2"> -<a name="id-1.2.4.4"></a><h3>Creating a SoupRequest</h3> -<p> -There are four <span class="type">SoupSession</span> methods for creating -<span class="type">SoupRequest</span>s: -</p> -<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> -<li class="listitem"><p> - <a class="link" href="SoupSession.html#soup-session-request" title="soup_session_request ()"><code class="function">soup_session_request</code></a> - takes an arbitrary URI as a string, and returns a <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a>. - </p></li> -<li class="listitem"><p> - <a class="link" href="SoupSession.html#soup-session-request-uri" title="soup_session_request_uri ()"><code class="function">soup_session_request_uri</code></a> - takes an arbitrary URI as a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a>, - and returns a <a class="link" href="SoupRequest.html" title="SoupRequest"><span class="type">SoupRequest</span></a>. - </p></li> -<li class="listitem"><p> - <a class="link" href="SoupSession.html#soup-session-request-http" title="soup_session_request_http ()"><code class="function">soup_session_request_http</code></a> - takes an HTTP method and an <code class="literal">http</code> or <code class="literal">https</code> URI as a string, and returns a <a class="link" href="SoupRequestHTTP.html" title="SoupRequestHTTP"><span class="type">SoupRequestHTTP</span></a>. - </p></li> -<li class="listitem"><p> - <a class="link" href="SoupSession.html#soup-session-request-http-uri" title="soup_session_request_http_uri ()"><code class="function">soup_session_request_http_uri</code></a> - takes an HTTP method and an <code class="literal">http</code> or <code class="literal">https</code> URI as a <a class="link" href="SoupURI.html" title="SoupURI"><span class="type">SoupURI</span></a>, - and returns a <a class="link" href="SoupRequestHTTP.html" title="SoupRequestHTTP"><span class="type">SoupRequestHTTP</span></a>. - </p></li> -</ul></div> -</div> -<hr> -<div class="refsect2"> -<a name="id-1.2.4.5"></a><h3>Sending a SoupRequest</h3> -<p> -Once you have created a <span class="type">SoupRequest</span>, you can send it with -either <a class="link" href="SoupRequest.html#soup-request-send" title="soup_request_send ()"><code class="function">soup_request_send</code></a> -or <a class="link" href="SoupRequest.html#soup-request-send-async" title="soup_request_send_async ()"><code class="function">soup_request_send_async</code></a>. -This will provide you with a <span class="type">GInputStream</span> which you can -read to get the response body. -</p> -<p> -After sending, you can use <a class="link" href="SoupRequest.html#soup-request-get-content-length" title="soup_request_get_content_length ()"><code class="function">soup_request_get_content_length</code></a> -and <a class="link" href="SoupRequest.html#soup-request-get-content-type" title="soup_request_get_content_type ()"><code class="function">soup_request_get_content_type</code></a> -to get information about the response body. -</p> -<p> -As with the streaming <span class="type">SoupMessage</span>-based APIs, -<code class="function">soup_request_send</code> and -<code class="function">soup_request_send_async</code> only return errors if a -transport-level problem occurs (eg, it could not connect to the host, -or the request was cancelled). In the case of an HTTP request, use the -message's <em class="structfield"><code>status_code</code></em> field to determine -whether the request was successful or not at the HTTP level (ie, "<code class="literal">200 -OK</code>" vs "<code class="literal">401 Bad Request</code>"). (You can call <a class="link" href="SoupRequestHTTP.html#soup-request-http-get-message" title="soup_request_http_get_message ()"><code class="function">soup_request_http_get_message</code></a> -to get the request's corresponding <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>, to look at the -status code or other HTTP metadata.) -</p> -</div> -<hr> -<div class="refsect2"> -<a name="id-1.2.4.6"></a><h3>Supported URI types, and adding your own</h3> -<p> -Different URI types are implemented by different subclasses of -<span class="type">SoupRequest</span>. <span class="application">libsoup</span> currently -implements three <span class="type">SoupRequest</span> classes: -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><a class="link" href="SoupRequestHTTP.html" title="SoupRequestHTTP"><span class="type">SoupRequestHTTP</span></a></span></p></td> -<td><p> - Handles <code class="literal">http</code> and - <code class="literal">https</code> URI. - </p></td> -</tr> -<tr> -<td><p><span class="term"><a class="link" href="SoupRequestData.html" title="SoupRequestData"><span class="type">SoupRequestData</span></a></span></p></td> -<td><p> - Handles <code class="literal">data</code> URIs containing inline data. - </p></td> -</tr> -<tr> -<td><p><span class="term"><a class="link" href="SoupRequestFile.html" title="SoupRequestFile"><span class="type">SoupRequestFile</span></a></span></p></td> -<td><p> - Handles <code class="literal">file</code> and - <code class="literal">resource</code> URIs. - If you request a URI corresponding to a directory, this - will generate an HTML listing of the directory. - </p></td> -</tr> -</tbody> -</table></div> -<p> -You can add additional URI types by implementing your own -<span class="type">SoupRequest</span> subclass; set the -<span class="type">SoupRequestClass</span>'s <em class="structfield"><code>schemes</code></em> -field to point to a <code class="literal">NULL</code>-terminated array of scheme -names, implement the various <span class="type">SoupRequest</span> methods, and -then register the type with your <span class="type">SoupSession</span> by calling -<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> -and passing the <span class="type">GType</span> of -your request class. -</p> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/libsoup-server-howto.html b/docs/reference/html/libsoup-server-howto.html deleted file mode 100644 index 80d4649d..00000000 --- a/docs/reference/html/libsoup-server-howto.html +++ /dev/null @@ -1,484 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>libsoup Server Basics: 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="ch01.html" title="Tutorial"> -<link rel="prev" href="libsoup-session-porting.html" title="Porting to the new SoupSession"> -<link rel="next" href="ch02.html" title="Core API"> -<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"></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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="libsoup-session-porting.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="ch02.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="libsoup-server-howto"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle">libsoup Server Basics</span></h2> -<p>libsoup Server Basics — Server-side tutorial</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect2"> -<a name="id-1.2.6.3"></a><h3>Creating a SoupServer</h3> -<p> -As with the client API, there is a single object that will encapsulate -most of your interactions with libsoup. In this case, <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a>. -</p> -<p> -You create the server with <a class="link" href="SoupServer.html#soup-server-new" title="soup_server_new ()"><code class="function">soup_server_new</code></a>, -and as with the <span class="type">SoupSession</span> constructor, you can specify -a few additional options: -</p> -<div class="variablelist"><table border="0" class="variablelist"> -<colgroup> -<col align="left" valign="top"> -<col> -</colgroup> -<tbody> -<tr> -<td><p><span class="term"><a class="link" href="SoupServer.html#SOUP-SERVER-TLS-CERTIFICATE:CAPS" title="SOUP_SERVER_TLS_CERTIFICATE"><code class="literal">SOUP_SERVER_TLS_CERTIFICATE</code></a></span></p></td> -<td><p> - A <span class="type">GTlsCertificate</span> - (containing a private key) that will be used when handling - HTTPS requests on the server. - </p></td> -</tr> -<tr> -<td><p><span class="term"><a class="link" href="SoupServer.html#SOUP-SERVER-RAW-PATHS:CAPS" title="SOUP_SERVER_RAW_PATHS"><code class="literal">SOUP_SERVER_RAW_PATHS</code></a></span></p></td> -<td><p> - Set this to <code class="literal">TRUE</code> if you don't want - <span class="application">libsoup</span> to decode %-encoding - in the Request-URI. (Eg, because you need to treat - <code class="literal">"/foo/bar"</code> and - <code class="literal">"/foo%2Fbar"</code> as different paths. - </p></td> -</tr> -<tr> -<td><p><span class="term"><a class="link" href="SoupServer.html#SOUP-SERVER-SERVER-HEADER:CAPS" title="SOUP_SERVER_SERVER_HEADER"><code class="literal">SOUP_SERVER_SERVER_HEADER</code></a></span></p></td> -<td><p> - Allows you to set a Server header string that will be sent - on all responses. - </p></td> -</tr> -<tr> -<td><p><span class="term"><a class="link" href="SoupServer.html#SOUP-SERVER-HTTP-ALIASES:CAPS" title="SOUP_SERVER_HTTP_ALIASES"><code class="literal">SOUP_SERVER_HTTP_ALIASES</code></a> - and <a class="link" href="SoupServer.html#SOUP-SERVER-HTTPS-ALIASES:CAPS" title="SOUP_SERVER_HTTPS_ALIASES"><code class="literal">SOUP_SERVER_HTTPS_ALIASES</code></a></span></p></td> -<td><p> - Allow you to tell the server to recognize additional URI - schemes as aliases for "<code class="literal">http</code>" or - <code class="literal">https</code>. You can set this if you are - serving URIs with schemes like "<code class="literal">dav</code>" or - "<code class="literal">webcal</code>". - </p></td> -</tr> -</tbody> -</table></div> -</div> -<hr> -<div class="refsect2"> -<a name="id-1.2.6.4"></a><h3>Adding Listening Sockets</h3> -<p> - To tell the server where to listen, call <a class="link" href="SoupServer.html#soup-server-listen" title="soup_server_listen ()"><code class="function">soup_server_listen</code></a> - (to listen on a specific <span class="type">GSocketAddress</span>), <a class="link" href="SoupServer.html#soup-server-listen-all" title="soup_server_listen_all ()"><code class="function">soup_server_listen_all</code></a> - (to listen on a given port on all network interfaces), or <a class="link" href="SoupServer.html#soup-server-listen-local" title="soup_server_listen_local ()"><code class="function">soup_server_listen_local</code></a> - (to listen to a given port on the loopback interface only). You can - call any of these functions multiple times, to set up multiple - listening sockets. -</p> -<p> - To set up an HTTPS server, you must first either set the <a class="link" href="SoupServer.html#SOUP-SERVER-TLS-CERTIFICATE:CAPS" title="SOUP_SERVER_TLS_CERTIFICATE"><code class="literal">SOUP_SERVER_TLS_CERTIFICATE</code></a> - property, or else call <a class="link" href="SoupServer.html#soup-server-set-ssl-cert-file" title="soup_server_set_ssl_cert_file ()"><code class="function">soup_server_set_ssl_cert_file</code></a>. - After that you can pass the <a class="link" href="SoupServer.html#SOUP-SERVER-LISTEN-HTTPS:CAPS"><code class="literal">SOUP_SERVER_LISTEN_HTTPS</code></a> - option to <a class="link" href="SoupServer.html#soup-server-listen" title="soup_server_listen ()"><code class="function">soup_server_listen</code></a>, - etc. -</p> -<p> - By default, servers listen for both IPv4 and IPv6 connections; if - you don't want this, use the <a class="link" href="SoupServer.html#SOUP-SERVER-LISTEN-IPV4-ONLY:CAPS"><code class="literal">SOUP_SERVER_LISTEN_IPV4_ONLY</code></a> - or <a class="link" href="SoupServer.html#SOUP-SERVER-LISTEN-IPV6-ONLY:CAPS"><code class="literal">SOUP_SERVER_LISTEN_IPV6_ONLY</code></a> - options. -</p> -<p> - The server runs asynchronously, in the thread-default - <span class="type">GMainContext</span> of the - thread in which the "listen" calls were made. -</p> -</div> -<hr> -<div class="refsect2"> -<a name="soup-server-old-api"></a><h3>The Old SoupServer Listening API</h3> -<p> -<a class="link" href="SoupServer.html#soup-server-listen" title="soup_server_listen ()"><code class="function">soup_server_listen</code></a>, -etc, are available only in <span class="application">libsoup</span> 2.46 and -later. In earlier versions, there was a simpler API, in which a server -could only listen on a single port, determined at construct time -either by passing the <a class="link" href="libsoup-2.4-SoupServer-deprecated-API.html#SOUP-SERVER-INTERFACE:CAPS" title="SOUP_SERVER_INTERFACE"><code class="literal">SOUP_SERVER_INTERFACE</code></a> -property (to specify a <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> to listen on), -or the <a class="link" href="libsoup-2.4-SoupServer-deprecated-API.html#SOUP-SERVER-PORT:CAPS" title="SOUP_SERVER_PORT"><code class="literal">SOUP_SERVER_PORT</code></a> -property (to specify a port to listen on, on all interfaces). The <a class="link" href="libsoup-2.4-SoupServer-deprecated-API.html#SOUP-SERVER-SSL-CERT-FILE:CAPS" title="SOUP_SERVER_SSL_CERT_FILE"><code class="literal">SOUP_SERVER_SSL_CERT_FILE</code></a> -and <a class="link" href="libsoup-2.4-SoupServer-deprecated-API.html#SOUP-SERVER-SSL-KEY-FILE:CAPS" title="SOUP_SERVER_SSL_KEY_FILE"><code class="literal">SOUP_SERVER_SSL_KEY_FILE</code></a> -properties could be used to create an HTTP server. -</p> -<p> -When using this API, if <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> is unable to bind -the listening socket, or unable to read the provided certificate or -key files, then it will return <code class="literal">NULL</code> from its -constructor (with no further indication of what exactly went wrong). -</p> -<p> -Additionally, when using this API, it is necessary to call <a class="link" href="libsoup-2.4-SoupServer-deprecated-API.html#soup-server-run" title="soup_server_run ()"><code class="function">soup_server_run</code></a> -or <a class="link" href="libsoup-2.4-SoupServer-deprecated-API.html#soup-server-run-async" title="soup_server_run_async ()"><code class="function">soup_server_run_async</code></a> -to start the server after creating it. -</p> -</div> -<hr> -<div class="refsect2"> -<a name="id-1.2.6.6"></a><h3>Adding Handlers</h3> -<p> -By default, <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> -returns "404 Not Found" in response to all requests (except ones that -it can't parse, which get "400 Bad Request"). To override this -behavior, call <a class="link" href="SoupServer.html#soup-server-add-handler" title="soup_server_add_handler ()"><code class="function">soup_server_add_handler</code></a> -to set a callback to handle certain URI paths. -</p> -<div class="informalexample"> - <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> - <tbody> - <tr> - <td class="listing_lines" align="right"><pre>1 -2</pre></td> - <td class="listing_code"><pre class="programlisting"><span class="function"><a href="SoupServer.html#soup-server-add-handler">soup_server_add_handler</a></span> <span class="gtkdoc opt">(</span>server<span class="gtkdoc opt">,</span> <span class="string">"/foo"</span><span class="gtkdoc opt">,</span> server_callback<span class="gtkdoc opt">,</span> - data<span class="gtkdoc opt">,</span> destroy_notify<span class="gtkdoc opt">);</span></pre></td> - </tr> - </tbody> - </table> -</div> - -<p> -The <code class="literal">"/foo"</code> indicates the base path for this -handler. When a request comes in, if there is a handler registered for -exactly the path in the request's <code class="literal">Request-URI</code>, then -that handler will be called. Otherwise -<span class="application">libsoup</span> will strip path components one by -one until it finds a matching handler. So for example, a request of -the form -"<code class="literal">GET /foo/bar/baz.html?a=1&b=2 HTTP/1.1</code>" -would look for handlers for "<code class="literal">/foo/bar/baz.html</code>", -"<code class="literal">/foo/bar</code>", and "<code class="literal">/foo</code>". If a -handler has been registered with a <code class="literal">NULL</code> base path, -then it is used as the default handler for any request that doesn't -match any other handler. -</p> -</div> -<hr> -<div class="refsect2"> -<a name="id-1.2.6.7"></a><h3>Responding to Requests</h3> -<p> -A handler callback looks something like this: -</p> -<div class="informalexample"> - <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> - <tbody> - <tr> - <td class="listing_lines" align="right"><pre>1 -2 -3 -4 -5 -6 -7 -8 -9 -10</pre></td> - <td class="listing_code"><pre class="programlisting"><span class="gtkdoc kwb">static void</span> -<span class="function">server_callback</span> <span class="gtkdoc opt">(</span>SoupServer <span class="gtkdoc opt">*</span>server<span class="gtkdoc opt">,</span> - SoupMessage <span class="gtkdoc opt">*</span>msg<span class="gtkdoc opt">,</span> - <span class="gtkdoc kwb">const char</span> <span class="gtkdoc opt">*</span>path<span class="gtkdoc opt">,</span> - GHashTable <span class="gtkdoc opt">*</span>query<span class="gtkdoc opt">,</span> - SoupClientContext <span class="gtkdoc opt">*</span>client<span class="gtkdoc opt">,</span> - gpointer user_data<span class="gtkdoc opt">)</span> -<span class="gtkdoc opt">{</span> - <span class="gtkdoc opt">...</span> -<span class="gtkdoc opt">}</span></pre></td> - </tr> - </tbody> - </table> -</div> - -<p> -<code class="literal">msg</code> is the request that has been received and -<code class="literal">user_data</code> is the data that was passed to <a class="link" href="SoupServer.html#soup-server-add-handler" title="soup_server_add_handler ()"><code class="function">soup_server_add_handler</code></a>. -<code class="literal">path</code> is the path (from <code class="literal">msg</code>'s -URI), and <code class="literal">query</code> contains the result of parsing the -URI query field. (It is <code class="literal">NULL</code> if there was no -query.) <code class="literal">client</code> is a <a class="link" href="SoupServer.html#SoupClientContext"><span class="type">SoupClientContext</span></a>, -which contains additional information about the client (including its -IP address, and whether or not it used HTTP authentication). -</p> -<p> -By default, <span class="application">libsoup</span> assumes that you have -completely finished processing the message when you return from the -callback, and that it can therefore begin sending the response. If you -are not ready to send a response immediately (eg, you have to contact -another server, or wait for data from a database), you must call <a class="link" href="SoupServer.html#soup-server-pause-message" title="soup_server_pause_message ()"><code class="function">soup_server_pause_message</code></a> -on the message before returning from the callback. This will delay -sending a response until you call <a class="link" href="SoupServer.html#soup-server-unpause-message" title="soup_server_unpause_message ()"><code class="function">soup_server_unpause_message</code></a>. -(You must also connect to the <a class="link" href="SoupMessage.html#SoupMessage-finished" title="The “finished” signal">finished</a> signal on the message -in this case, so that you can break off processing if the client -unexpectedly disconnects before you start sending the data.) -</p> -<p> -To set the response status, call <a class="link" href="SoupMessage.html#soup-message-set-status" title="soup_message_set_status ()"><code class="function">soup_message_set_status</code></a> -or <a class="link" href="SoupMessage.html#soup-message-set-status-full" title="soup_message_set_status_full ()"><code class="function">soup_message_set_status_full</code></a>. -If the response requires a body, you must decide whether to use -<code class="literal">Content-Length</code> encoding (the default), or -<code class="literal">chunked</code> encoding. -</p> -<div class="refsect3"> -<a name="id-1.2.6.7.7"></a><h4>Responding with <code class="literal">Content-Length</code> -Encoding</h4> -<p> -This is the simpler way to set a response body, if you have all of the -data available at once. -</p> -<div class="informalexample"> - <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> - <tbody> - <tr> - <td class="listing_lines" align="right"><pre>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</pre></td> - <td class="listing_code"><pre class="programlisting"><span class="gtkdoc kwb">static void</span> -<span class="function">server_callback</span> <span class="gtkdoc opt">(</span>SoupServer <span class="gtkdoc opt">*</span>server<span class="gtkdoc opt">,</span> - SoupMessage <span class="gtkdoc opt">*</span>msg<span class="gtkdoc opt">,</span> - <span class="gtkdoc kwb">const char</span> <span class="gtkdoc opt">*</span>path<span class="gtkdoc opt">,</span> - GHashTable <span class="gtkdoc opt">*</span>query<span class="gtkdoc opt">,</span> - SoupClientContext <span class="gtkdoc opt">*</span>client<span class="gtkdoc opt">,</span> - gpointer user_data<span class="gtkdoc opt">)</span> -<span class="gtkdoc opt">{</span> - MyServerData <span class="gtkdoc opt">*</span>server_data <span class="gtkdoc opt">=</span> user_data<span class="gtkdoc opt">;</span> - <span class="gtkdoc kwb">const char</span> <span class="gtkdoc opt">*</span>mime_type<span class="gtkdoc opt">;</span> - GByteArray <span class="gtkdoc opt">*</span>body<span class="gtkdoc opt">;</span> - - <span class="keyword">if</span> <span class="gtkdoc opt">(</span>msg<span class="gtkdoc opt">-></span>method <span class="gtkdoc opt">!=</span> SOUP_METHOD_GET<span class="gtkdoc opt">) {</span> - <span class="function"><a href="SoupMessage.html#soup-message-set-status">soup_message_set_status</a></span> <span class="gtkdoc opt">(</span>msg<span class="gtkdoc opt">,</span> SOUP_STATUS_NOT_IMPLEMENTED<span class="gtkdoc opt">);</span> - <span class="keyword">return</span><span class="gtkdoc opt">;</span> - <span class="gtkdoc opt">}</span> - - <span class="comment">/* This is somewhat silly. Presumably your server will do</span> -<span class="comment"> * something more interesting.</span> -<span class="comment"> */</span> - body <span class="gtkdoc opt">=</span> <span class="function">g_hash_table_lookup</span> <span class="gtkdoc opt">(</span>server_data<span class="gtkdoc opt">-></span>bodies<span class="gtkdoc opt">,</span> path<span class="gtkdoc opt">);</span> - mime_type <span class="gtkdoc opt">=</span> <span class="function">g_hash_table_lookup</span> <span class="gtkdoc opt">(</span>server_data<span class="gtkdoc opt">-></span>mime_types<span class="gtkdoc opt">,</span> path<span class="gtkdoc opt">);</span> - <span class="keyword">if</span> <span class="gtkdoc opt">(!</span>body <span class="gtkdoc opt">|| !</span>mime_type<span class="gtkdoc opt">) {</span> - <span class="function"><a href="SoupMessage.html#soup-message-set-status">soup_message_set_status</a></span> <span class="gtkdoc opt">(</span>msg<span class="gtkdoc opt">,</span> SOUP_STATUS_NOT_FOUND<span class="gtkdoc opt">);</span> - <span class="keyword">return</span><span class="gtkdoc opt">;</span> - <span class="gtkdoc opt">}</span> - - <span class="function"><a href="SoupMessage.html#soup-message-set-status">soup_message_set_status</a></span> <span class="gtkdoc opt">(</span>msg<span class="gtkdoc opt">,</span> SOUP_STATUS_OK<span class="gtkdoc opt">);</span> - <span class="function"><a href="SoupMessage.html#soup-message-set-response">soup_message_set_response</a></span> <span class="gtkdoc opt">(</span>msg<span class="gtkdoc opt">,</span> mime_type<span class="gtkdoc opt">,</span> SOUP_MEMORY_COPY<span class="gtkdoc opt">,</span> - body<span class="gtkdoc opt">-></span>data<span class="gtkdoc opt">,</span> body<span class="gtkdoc opt">-></span>len<span class="gtkdoc opt">);</span> -<span class="gtkdoc opt">}</span></pre></td> - </tr> - </tbody> - </table> -</div> - -</div> -<div class="refsect3"> -<a name="id-1.2.6.7.8"></a><h4>Responding with <code class="literal">chunked</code> Encoding</h4> -<p> -If you want to supply the response body in chunks as it becomes -available, use <code class="literal">chunked</code> encoding instead. In this -case, first call <a class="link" href="SoupMessageHeaders.html#soup-message-headers-set-encoding" title="soup_message_headers_set_encoding ()"><code class="function">soup_message_headers_set_encoding</code></a> <code class="literal">(msg->response_headers, <a class="link" href="SoupMessageHeaders.html#SoupEncoding" title="enum SoupEncoding">SOUP_ENCODING_CHUNKED</a>)</code> -to tell <span class="application">libsoup</span> that you'll be using -chunked encoding. Then call <a class="link" href="SoupMessageBody.html#soup-message-body-append" title="soup_message_body_append ()"><code class="function">soup_message_body_append</code></a> -(or <a class="link" href="SoupMessageBody.html#soup-message-body-append-buffer" title="soup_message_body_append_buffer ()"><code class="function">soup_message_body_append_buffer</code></a>) -on <code class="literal">msg->response_body</code> with each chunk of the -response body as it becomes available, and call <a class="link" href="SoupMessageBody.html#soup-message-body-complete" title="soup_message_body_complete ()"><code class="function">soup_message_body_complete</code></a> -when the response is complete. After each of these calls, you must -also call <a class="link" href="SoupServer.html#soup-server-unpause-message" title="soup_server_unpause_message ()"><code class="function">soup_server_unpause_message</code></a> -to cause the chunk to be sent. (You do not normally need to call <a class="link" href="SoupServer.html#soup-server-pause-message" title="soup_server_pause_message ()"><code class="function">soup_server_pause_message</code></a>, -because I/O is automatically paused when doing a -<code class="literal">chunked</code> transfer if no chunks are available.) -</p> -<p> -When using chunked encoding, you must also connect to the <a class="link" href="SoupMessage.html#SoupMessage-finished" title="The “finished” signal">finished</a> signal on the message, -so that you will be notified if the client disconnects between two -chunks; <span class="type">SoupServer</span> will unref the message if that -happens, so you must stop adding new chunks to the response at that -point. (An alternate possibility is to write each new chunk only when -the <a class="link" href="SoupMessage.html#SoupMessage-wrote-chunk" title="The “wrote-chunk” signal">wrote_chunk</a> signal -is emitted indicating that the previous one was written successfully.) -</p> -<p> -The <span class="bold"><strong><code class="literal">simple-proxy</code></strong></span> -example in the <code class="literal">examples/</code> directory gives an example of -using <code class="literal">chunked</code> encoding. -</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="id-1.2.6.8"></a><h3>Handling Authentication</h3> -<p> -To have <a class="link" href="SoupServer.html" title="SoupServer"><span class="type">SoupServer</span></a> -handle HTTP authentication for you, create a <a class="link" href="SoupAuthDomainBasic.html" title="SoupAuthDomainBasic"><span class="type">SoupAuthDomainBasic</span></a> -or <a class="link" href="SoupAuthDomainDigest.html" title="SoupAuthDomainDigest"><span class="type">SoupAuthDomainDigest</span></a>, -and pass it to <a class="link" href="SoupServer.html#soup-server-add-auth-domain" title="soup_server_add_auth_domain ()"><code class="function">soup_server_add_auth_domain</code></a>: -</p> -<div class="informalexample"> - <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> - <tbody> - <tr> - <td class="listing_lines" align="right"><pre>1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11</pre></td> - <td class="listing_code"><pre class="programlisting">SoupAuthDomain <span class="gtkdoc opt">*</span>domain<span class="gtkdoc opt">;</span> - -domain <span class="gtkdoc opt">=</span> <span class="function"><a href="SoupAuthDomainBasic.html#soup-auth-domain-basic-new">soup_auth_domain_basic_new</a></span> <span class="gtkdoc opt">(</span> - SOUP_AUTH_DOMAIN_REALM<span class="gtkdoc opt">,</span> <span class="string">"My Realm"</span><span class="gtkdoc opt">,</span> - SOUP_AUTH_DOMAIN_BASIC_AUTH_CALLBACK<span class="gtkdoc opt">,</span> auth_callback<span class="gtkdoc opt">,</span> - SOUP_AUTH_DOMAIN_BASIC_AUTH_DATA<span class="gtkdoc opt">,</span> auth_data<span class="gtkdoc opt">,</span> - SOUP_AUTH_DOMAIN_ADD_PATH<span class="gtkdoc opt">,</span> <span class="string">"/foo"</span><span class="gtkdoc opt">,</span> - SOUP_AUTH_DOMAIN_ADD_PATH<span class="gtkdoc opt">,</span> <span class="string">"/bar/private"</span><span class="gtkdoc opt">,</span> - NULL<span class="gtkdoc opt">);</span> -<span class="function"><a href="SoupServer.html#soup-server-add-auth-domain">soup_server_add_auth_domain</a></span> <span class="gtkdoc opt">(</span>server<span class="gtkdoc opt">,</span> domain<span class="gtkdoc opt">);</span> -<span class="function">g_object_unref</span> <span class="gtkdoc opt">(</span>domain<span class="gtkdoc opt">);</span></pre></td> - </tr> - </tbody> - </table> -</div> - -<p> -Then, every request under one of the auth domain's paths will be -passed to the <code class="literal">auth_callback</code> first before being -passed to the <code class="literal">server_callback</code>: -</p> -<div class="informalexample"> - <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> - <tbody> - <tr> - <td class="listing_lines" align="right"><pre>1 -2 -3 -4 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -16 -17</pre></td> - <td class="listing_code"><pre class="programlisting"><span class="gtkdoc kwb">static</span> gboolean -<span class="function">auth_callback</span> <span class="gtkdoc opt">(</span>SoupAuthDomain <span class="gtkdoc opt">*</span>domain<span class="gtkdoc opt">,</span> SoupMessage <span class="gtkdoc opt">*</span>msg<span class="gtkdoc opt">,</span> - <span class="gtkdoc kwb">const char</span> <span class="gtkdoc opt">*</span>username<span class="gtkdoc opt">,</span> <span class="gtkdoc kwb">const char</span> <span class="gtkdoc opt">*</span>password<span class="gtkdoc opt">,</span> - gpointer user_data<span class="gtkdoc opt">)</span> -<span class="gtkdoc opt">{</span> - MyServerData <span class="gtkdoc opt">*</span>server_data <span class="gtkdoc opt">=</span> user_data<span class="gtkdoc opt">;</span> - MyUserData <span class="gtkdoc opt">*</span>user<span class="gtkdoc opt">;</span> - - user <span class="gtkdoc opt">=</span> <span class="function">my_server_data_lookup_user</span> <span class="gtkdoc opt">(</span>server_data<span class="gtkdoc opt">,</span> username<span class="gtkdoc opt">);</span> - <span class="keyword">if</span> <span class="gtkdoc opt">(!</span>user<span class="gtkdoc opt">)</span> - <span class="keyword">return</span> FALSE<span class="gtkdoc opt">;</span> - - <span class="comment">/* FIXME: Don't do this. Keeping a cleartext password database</span> -<span class="comment"> * is bad.</span> -<span class="comment"> */</span> - <span class="keyword">return</span> <span class="function">strcmp</span> <span class="gtkdoc opt">(</span>password<span class="gtkdoc opt">,</span> user<span class="gtkdoc opt">-></span>password<span class="gtkdoc opt">) ==</span> <span class="number">0</span><span class="gtkdoc opt">;</span> -<span class="gtkdoc opt">}</span></pre></td> - </tr> - </tbody> - </table> -</div> - -<p> -The <a class="link" href="SoupAuthDomainBasic.html#SoupAuthDomainBasicAuthCallback" title="SoupAuthDomainBasicAuthCallback ()"><span class="type">SoupAuthDomainBasicAuthCallback</span></a> -is given the username and password from the -<code class="literal">Authorization</code> header and must determine, in some -server-specific manner, whether or not to accept them. (In this -example we compare the password against a cleartext password database, -but it would be better to store the password somehow encoded, as in -the UNIX password database. Alternatively, you may need to delegate -the password check to PAM or some other service.) -</p> -<p> -If you are using Digest authentication, note that <a class="link" href="SoupAuthDomainDigest.html#SoupAuthDomainDigestAuthCallback" title="SoupAuthDomainDigestAuthCallback ()"><span class="type">SoupAuthDomainDigestAuthCallback</span></a> -works completely differently (since the server doesn't receive the -cleartext password from the client in that case, so there's no way to -compare it directly). See the documentation for <a class="link" href="SoupAuthDomainDigest.html" title="SoupAuthDomainDigest"><span class="type">SoupAuthDomainDigest</span></a> -for more details. -</p> -<p> -You can have multiple <span class="type">SoupAuthDomain</span>s attached to a -<code class="literal">SoupServer</code>, either in separate parts of the path -hierarchy, or overlapping. (Eg, you might want to accept either Basic -or Digest authentication for a given path.) When more than one auth -domain covers a given path, the request will be accepted if the user -authenticates successfully against <span class="emphasis"><em>any</em></span> of the -domains. -</p> -<p> -If you want to require authentication for some requests under a -certain path, but not all of them (eg, you want to authenticate -<code class="literal">PUT</code> requests, but not <code class="literal">GET</code> -requests), use a <a class="link" href="SoupAuthDomain.html#SoupAuthDomainFilter" title="SoupAuthDomainFilter ()"><span class="type">SoupAuthDomainFilter</span></a>. -</p> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/libsoup-session-porting.html b/docs/reference/html/libsoup-session-porting.html deleted file mode 100644 index a177034a..00000000 --- a/docs/reference/html/libsoup-session-porting.html +++ /dev/null @@ -1,217 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Porting to the new SoupSession: 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="ch01.html" title="Tutorial"> -<link rel="prev" href="libsoup-request-howto.html" title="libsoup Client SoupRequest API"> -<link rel="next" href="libsoup-server-howto.html" title="libsoup Server Basics"> -<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"></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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="libsoup-request-howto.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="libsoup-server-howto.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="libsoup-session-porting"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle">Porting to the new SoupSession</span></h2> -<p>Porting to the new SoupSession — Notes on -porting from SoupSessionAsync and SoupSessionSync to SoupSession</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect2"> -<a name="intro"></a><h3>Introduction</h3> -<p> -As of libsoup 2.42, <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> is no longer an -abstract class, and the base <span class="type">SoupSession</span> class is now -preferred over its traditional subclasses, <a class="link" href="SoupSessionAsync.html" title="SoupSessionAsync"><span class="type">SoupSessionAsync</span></a> and -<a class="link" href="SoupSessionSync.html" title="SoupSessionSync"><span class="type">SoupSessionSync</span></a>. -</p> -<p> -There are several changes in behavior between the old and new sessions -to be aware of. -</p> -</div> -<hr> -<div class="refsect2"> -<a name="defaults"></a><h3>Different defaults</h3> -<p> -The new <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> -has different (and hopefully better) defaults than <a class="link" href="SoupSessionAsync.html" title="SoupSessionAsync"><span class="type">SoupSessionAsync</span></a> and -<a class="link" href="SoupSessionSync.html" title="SoupSessionSync"><span class="type">SoupSessionSync</span></a>: -</p> -<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> -<li class="listitem"> -<p> - The system TLS/SSL certificate database is used by default to - validate https certificates, and sites with invalid certificates - will refuse to load with a - <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-SSL-FAILED:CAPS"><code class="literal">SOUP_STATUS_SSL_FAILED</code></a> - error. - </p> -<p> - You can still override the CA database as before, by setting the - <a class="link" href="SoupSession.html#SoupSession--ssl-ca-file" title="The “ssl-ca-file” property"><span class="type">"ssl-ca-file"</span></a> - property, although the - <a class="link" href="SoupSession.html#SoupSession--tls-database" title="The “tls-database” property"><span class="type">"tls-database"</span></a> - property is preferred, since it allows you to do proper error - handling. - </p> -<p> - If you want to accept all certificates, set - <a class="link" href="SoupSession.html#SoupSession--ssl-strict" title="The “ssl-strict” property"><span class="type">"ssl-strict"</span></a> to - <code class="literal">FALSE</code>. Note that libsoup will still check - certificates, it will just continue with the HTTP request even - if the certificate fails to validate. You can use - <a class="link" href="SoupMessage.html#soup-message-get-https-status" title="soup_message_get_https_status ()"><code class="function">soup_message_get_https_status()</code></a> - to look at the certificate after the fact. - </p> -</li> -<li class="listitem"><p> - The - <a class="link" href="SoupSession.html#SoupSession--timeout" title="The “timeout” property"><span class="type">"timeout"</span></a> - and - <a class="link" href="SoupSession.html#SoupSession--idle-timeout" title="The “idle-timeout” property"><span class="type">"idle-timeout"</span></a> - properties both default to 60 seconds. - </p></li> -<li class="listitem"><p> - The - <a class="link" href="SoupSession.html#SoupSession--http-aliases" title="The “http-aliases” property"><span class="type">"http-aliases"</span></a> - property defaults to <code class="literal">NULL</code>, meaning that URI - schemes like "<code class="literal">webcal</code>" and - "<code class="literal">dav</code>" (and "<code class="literal">ftp</code>") are not - considered to be aliases for "<code class="literal">http</code>", and so - libsoup will not accept requests for such URIs, and will not - follow redirects to such URIs. - </p></li> -<li class="listitem"><p> - The new - <a class="link" href="SoupSession.html#SoupSession--proxy-resolver" title="The “proxy-resolver” property"><span class="type">"proxy-resolver"</span></a> - property is now initialized to the default - <span class="type">GProxyResolver</span>, - meaning that it will automatically use the user's system proxy - configuration. This replaces the use of the - <a class="link" href="SoupProxyResolverDefault.html" title="SoupProxyResolverDefault"><span class="type">SoupProxyResolverDefault</span></a>, - session feature in earlier releases. You can set this property to - <code class="literal">NULL</code> if you don't want to use proxies, and the - <a class="link" href="SoupSession.html#SoupSession--proxy-uri" title="The “proxy-uri” property"><span class="type">"proxy-uri"</span></a> - property still works if you want to use a single proxy for all requests. - </p></li> -<li class="listitem"><p> - Every session gets a - <a class="link" href="SoupContentDecoder.html" title="SoupContentDecoder"><span class="type">SoupContentDecoder</span></a> - attached to it by default, meaning that it will automatically - handle (and request) "gzip"- and "deflate"-encoded response - bodies. - </p></li> -</ul></div> -</div> -<hr> -<div class="refsect2"> -<a name="behavior"></a><h3>Differences in feature behavior</h3> -<p> -If you are using NTLM authentication, the new <span class="type">SoupSession</span> -behaves slightly differently from the old session types. -</p> -<p> -First, the deprecated <code class="literal">SOUP_SESSION_USE_NTLM</code> -property is no longer supported. If you want to add support for NTLM -to a session, call <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>, -passing <a class="link" href="SoupAuth.html#SOUP-TYPE-AUTH-NTLM:CAPS" title="SOUP_TYPE_AUTH_NTLM"><code class="literal">SOUP_TYPE_AUTH_NTLM</code></a>. -</p> -<p> -Second, with the old session types, enabling NTLM would cause all -(otherwise-unauthenticated) requests to be sent with an NTLM request -in the <code class="literal">Authorization</code> header. That is, libsoup would -assume that all servers supported NTLM, and would attempt to begin -negotiating NTLM authentication before the server ever returned a 401 -response. With the plain <span class="type">SoupSession</span>, this no longer -happens. If you want the old behavior, you need to call <a class="link" href="SoupAuthManager.html#soup-auth-manager-use-auth" title="soup_auth_manager_use_auth ()"><code class="function">soup_auth_manager_use_auth()</code></a> -for each host to "preload" the NTLM authentication: -</p> -<div class="informalexample"> - <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> - <tbody> - <tr> - <td class="listing_lines" align="right"><pre>1 -2 -3 -4 -5 -6 -7 -8 -9 -10</pre></td> - <td class="listing_code"><pre class="programlisting">SoupAuthManager <span class="gtkdoc opt">*</span>auth_manager<span class="gtkdoc opt">;</span> -SoupAuth <span class="gtkdoc opt">*</span>auth<span class="gtkdoc opt">;</span> -SoupURI <span class="gtkdoc opt">*</span>uri<span class="gtkdoc opt">;</span> - -auth_manager <span class="gtkdoc opt">=</span> <span class="function">SOUP_AUTH_MANAGER</span> <span class="gtkdoc opt">(</span><span class="function"><a href="SoupSession.html#soup-session-get-feature">soup_session_get_feature</a></span> <span class="gtkdoc opt">(</span>session<span class="gtkdoc opt">,</span> SOUP_TYPE_AUTH_MANAGER<span class="gtkdoc opt">));</span> -auth <span class="gtkdoc opt">=</span> <span class="function">g_object_new</span> <span class="gtkdoc opt">(</span>SOUP_TYPE_AUTH_NTLM<span class="gtkdoc opt">,</span> NULL<span class="gtkdoc opt">);</span> -uri <span class="gtkdoc opt">=</span> <span class="function"><a href="SoupURI.html#soup-uri-new">soup_uri_new</a></span> <span class="gtkdoc opt">(</span><span class="string">"http://ntlm-using-host.example.com/"</span><span class="gtkdoc opt">);</span> -<span class="function"><a href="SoupAuthManager.html#soup-auth-manager-use-auth">soup_auth_manager_use_auth</a></span> <span class="gtkdoc opt">(</span>auth_manager<span class="gtkdoc opt">,</span> uri<span class="gtkdoc opt">,</span> auth<span class="gtkdoc opt">);</span> -<span class="function">g_object_unref</span> <span class="gtkdoc opt">(</span>auth<span class="gtkdoc opt">);</span> -<span class="function"><a href="SoupURI.html#soup-uri-free">soup_uri_free</a></span> <span class="gtkdoc opt">(</span>auth<span class="gtkdoc opt">);</span></pre></td> - </tr> - </tbody> - </table> -</div> - -</div> -<hr> -<div class="refsect2"> -<a name="apis"></a><h3>Differences in SoupMessage-sending APIs</h3> -<p> -<span class="type">SoupSessionAsync</span> always uses asynchronous I/O, and -<span class="type">SoupSessionSync</span> always uses blocking I/O, regardless of -the operation. In the new <span class="type">SoupSession</span>, <a class="link" href="SoupSession.html#soup-session-queue-message" title="soup_session_queue_message ()"><code class="function">soup_session_queue_message()</code></a> -uses asynchronous I/O (like <span class="type">SoupSessionAsync</span>), and <a class="link" href="SoupSession.html#soup-session-send-message" title="soup_session_send_message ()"><code class="function">soup_session_send_message()</code></a> -uses blocking I/O (like <span class="type">SoupSessionSync</span>). There is no API -on the plain <span class="type">SoupSession</span> that simulates the effect of -calling <code class="function">soup_session_send_message()</code> on a -<span class="type">SoupSessionAsync</span> (ie, running the main loop internally), -or of calling <code class="function">soup_session_queue_message()</code> on a -<span class="type">SoupSessionSync</span> (ie, automatically sending the request in -another thread). -</p> -</div> -<hr> -<div class="refsect2"> -<a name="async"></a><h3>Differences in Asynchronous I/O</h3> -<p> -As compared to <a class="link" href="SoupSessionAsync.html" title="SoupSessionAsync"><span class="type">SoupSessionAsync</span></a>, <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> behaves more -like gio with respect to asynchronous I/O. -</p> -<p> -In particular, the <a class="link" href="SoupSession.html#SoupSession--async-context" title="The “async-context” property"><span class="type">"async-context"</span></a> -and <a class="link" href="SoupSession.html#SoupSession--use-thread-context" title="The “use-thread-context” property"><span class="type">"use-thread-context"</span></a> -properties are now effectively unused, and the session always queues -asynchronous requests in the <span class="type">GMainContext</span> that was is -the thread default when the asynchronous operation is started. Session -bookkeeping tasks (like closing idle connections) happen in the -context that was thread default when the session was created. -</p> -<p> -Additionally, <a class="link" href="SoupSession.html#soup-session-cancel-message" title="soup_session_cancel_message ()"><code class="function">soup_session_cancel_message()</code></a> -now acts asynchronously when you cancel an asynchronous request; -rather than having the request's callback be called from inside -<code class="function">soup_session_cancel_message()</code>, it just gets called -when you need return to the main loop. -</p> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file diff --git a/docs/reference/html/right-insensitive.png b/docs/reference/html/right-insensitive.png Binary files differdeleted file mode 100644 index 4c95785b..00000000 --- a/docs/reference/html/right-insensitive.png +++ /dev/null diff --git a/docs/reference/html/right.png b/docs/reference/html/right.png Binary files differdeleted file mode 100644 index 76260ec8..00000000 --- a/docs/reference/html/right.png +++ /dev/null diff --git a/docs/reference/html/style.css b/docs/reference/html/style.css deleted file mode 100644 index 4be4ede1..00000000 --- a/docs/reference/html/style.css +++ /dev/null @@ -1,483 +0,0 @@ -body -{ - font-family: cantarell, sans-serif; -} -.synopsis, .classsynopsis -{ - /* tango:aluminium 1/2 */ - background: #eeeeec; - background: rgba(238, 238, 236, 0.5); - border: solid 1px rgb(238, 238, 236); - padding: 0.5em; -} -.programlisting -{ - /* tango:sky blue 0/1 */ - /* fallback for no rgba support */ - background: #e6f3ff; - border: solid 1px #729fcf; - background: rgba(114, 159, 207, 0.1); - border: solid 1px rgba(114, 159, 207, 0.2); - padding: 0.5em; -} -.variablelist -{ - padding: 4px; - margin-left: 3em; -} -.variablelist td:first-child -{ - vertical-align: top; -} - -span.nowrap { - white-space: nowrap; -} - -div.gallery-float -{ - float: left; - padding: 10px; -} -div.gallery-float img -{ - border-style: none; -} -div.gallery-spacer -{ - clear: both; -} - -a, a:visited -{ - text-decoration: none; - /* tango:sky blue 2 */ - color: #3465a4; -} -a:hover -{ - text-decoration: underline; - /* tango:sky blue 1 */ - color: #729fcf; -} - -div.informaltable table -{ - border-collapse: separate; - border-spacing: 1em 0.3em; - border: none; -} - -div.informaltable table td, div.informaltable table th -{ - vertical-align: top; -} - -.function_type, -.variable_type, -.property_type, -.signal_type, -.parameter_name, -.struct_member_name, -.union_member_name, -.define_keyword, -.datatype_keyword, -.typedef_keyword -{ - text-align: right; -} - -/* dim non-primary columns */ -.c_punctuation, -.function_type, -.variable_type, -.property_type, -.signal_type, -.define_keyword, -.datatype_keyword, -.typedef_keyword, -.property_flags, -.signal_flags, -.parameter_annotations, -.enum_member_annotations, -.struct_member_annotations, -.union_member_annotations -{ - color: #888a85; -} - -.function_type a, -.function_type a:visited, -.function_type a:hover, -.property_type a, -.property_type a:visited, -.property_type a:hover, -.signal_type a, -.signal_type a:visited, -.signal_type a:hover, -.signal_flags a, -.signal_flags a:visited, -.signal_flags a:hover -{ - color: #729fcf; -} - -td p -{ - margin: 0.25em; -} - -div.table table -{ - border-collapse: collapse; - border-spacing: 0px; - /* tango:aluminium 3 */ - border: solid 1px #babdb6; -} - -div.table table td, div.table table th -{ - /* tango:aluminium 3 */ - border: solid 1px #babdb6; - padding: 3px; - vertical-align: top; -} - -div.table table th -{ - /* tango:aluminium 2 */ - background-color: #d3d7cf; -} - -h4 -{ - color: #555753; - margin-top: 1em; - margin-bottom: 1em; -} - -hr -{ - /* tango:aluminium 1 */ - color: #d3d7cf; - background: #d3d7cf; - border: none 0px; - height: 1px; - clear: both; - margin: 2.0em 0em 2.0em 0em; -} - -dl.toc dt -{ - padding-bottom: 0.25em; -} - -dl.toc > dt -{ - padding-top: 0.25em; - padding-bottom: 0.25em; - font-weight: bold; -} - -dl.toc > dl -{ - padding-bottom: 0.5em; -} - -.parameter -{ - font-style: normal; -} - -.footer -{ - padding-top: 3.5em; - /* tango:aluminium 3 */ - color: #babdb6; - text-align: center; - font-size: 80%; -} - -.informalfigure, -.figure -{ - margin: 1em; -} - -.informalexample, -.example -{ - margin-top: 1em; - margin-bottom: 1em; -} - -.warning -{ - /* tango:orange 0/1 */ - background: #ffeed9; - background: rgba(252, 175, 62, 0.1); - border-color: #ffb04f; - border-color: rgba(252, 175, 62, 0.2); -} -.note -{ - /* tango:chameleon 0/0.5 */ - background: #d8ffb2; - background: rgba(138, 226, 52, 0.1); - border-color: #abf562; - border-color: rgba(138, 226, 52, 0.2); -} -div.blockquote -{ - border-color: #eeeeec; -} -.note, .warning, div.blockquote -{ - padding: 0.5em; - border-width: 1px; - border-style: solid; - margin: 2em; -} -.note p, .warning p -{ - margin: 0; -} - -div.warning h3.title, -div.note h3.title -{ - display: none; -} - -p + div.section -{ - margin-top: 1em; -} - -div.refnamediv, -div.refsynopsisdiv, -div.refsect1, -div.refsect2, -div.toc, -div.section -{ - margin-bottom: 1em; -} - -/* blob links */ -h2 .extralinks, h3 .extralinks -{ - float: right; - /* tango:aluminium 3 */ - color: #babdb6; - font-size: 80%; - font-weight: normal; -} - -.lineart -{ - color: #d3d7cf; - font-weight: normal; -} - -.annotation -{ - /* tango:aluminium 5 */ - color: #555753; - font-weight: normal; -} - -.structfield -{ - font-style: normal; - font-weight: normal; -} - -acronym,abbr -{ - border-bottom: 1px dotted gray; -} - -/* code listings */ - -.listing_code .programlisting .normal, -.listing_code .programlisting .normal a, -.listing_code .programlisting .number, -.listing_code .programlisting .cbracket, -.listing_code .programlisting .symbol { color: #555753; } -.listing_code .programlisting .comment, -.listing_code .programlisting .linenum { color: #babdb6; } /* tango: aluminium 3 */ -.listing_code .programlisting .function, -.listing_code .programlisting .function a, -.listing_code .programlisting .preproc { color: #204a87; } /* tango: sky blue 3 */ -.listing_code .programlisting .string { color: #ad7fa8; } /* tango: plum */ -.listing_code .programlisting .keyword, -.listing_code .programlisting .usertype, -.listing_code .programlisting .type, -.listing_code .programlisting .type a { color: #4e9a06; } /* tango: chameleon 3 */ - -.listing_frame { - /* tango:sky blue 1 */ - border: solid 1px #729fcf; - border: solid 1px rgba(114, 159, 207, 0.2); - padding: 0px; -} - -.listing_lines, .listing_code { - margin-top: 0px; - margin-bottom: 0px; - padding: 0.5em; -} -.listing_lines { - /* tango:sky blue 0.5 */ - background: #a6c5e3; - background: rgba(114, 159, 207, 0.2); - /* tango:aluminium 6 */ - color: #2e3436; -} -.listing_code { - /* tango:sky blue 0 */ - background: #e6f3ff; - background: rgba(114, 159, 207, 0.1); -} -.listing_code .programlisting { - /* override from previous */ - border: none 0px; - padding: 0px; - background: none; -} -.listing_lines pre, .listing_code pre { - margin: 0px; -} - -@media screen { - /* these have a <sup> as a first child, but since there are no parent selectors - * we can't use that. */ - a.footnote - { - position: relative; - top: 0em ! important; - } - /* this is needed so that the local anchors are displayed below the naviagtion */ - div.footnote a[name], div.refnamediv a[name], div.refsect1 a[name], div.refsect2 a[name], div.index a[name], div.glossary a[name], div.sect1 a[name] - { - display: inline-block; - position: relative; - top:-5em; - } - /* this seems to be a bug in the xsl style sheets when generating indexes */ - div.index div.index - { - top: 0em; - } - /* make space for the fixed navigation bar and add space at the bottom so that - * link targets appear somewhat close to top - */ - body - { - padding-top: 2.5em; - padding-bottom: 500px; - max-width: 60em; - } - p - { - max-width: 60em; - } - /* style and size the navigation bar */ - table.navigation#top - { - position: fixed; - background: #e2e2e2; - border-bottom: solid 1px #babdb6; - border-spacing: 5px; - margin-top: 0; - margin-bottom: 0; - top: 0; - left: 0; - z-index: 10; - } - table.navigation#top td - { - padding-left: 6px; - padding-right: 6px; - } - .navigation a, .navigation a:visited - { - /* tango:sky blue 3 */ - color: #204a87; - } - .navigation a:hover - { - /* tango:sky blue 2 */ - color: #3465a4; - } - td.shortcuts - { - /* tango:sky blue 2 */ - color: #3465a4; - font-size: 80%; - white-space: nowrap; - } - td.shortcuts .dim - { - color: #babdb6; - } - .navigation .title - { - font-size: 80%; - max-width: none; - margin: 0px; - font-weight: normal; - } -} -@media screen and (min-width: 60em) { - /* screen larger than 60em */ - body { margin: auto; } -} -@media screen and (max-width: 60em) { - /* screen less than 60em */ - #nav_hierarchy { display: none; } - #nav_interfaces { display: none; } - #nav_prerequisites { display: none; } - #nav_derived_interfaces { display: none; } - #nav_implementations { display: none; } - #nav_child_properties { display: none; } - #nav_style_properties { display: none; } - #nav_index { display: none; } - #nav_glossary { display: none; } - .gallery_image { display: none; } - .property_flags { display: none; } - .signal_flags { display: none; } - .parameter_annotations { display: none; } - .enum_member_annotations { display: none; } - .struct_member_annotations { display: none; } - .union_member_annotations { display: none; } - /* now that a column is hidden, optimize space */ - col.parameters_name { width: auto; } - col.parameters_description { width: auto; } - col.struct_members_name { width: auto; } - col.struct_members_description { width: auto; } - col.enum_members_name { width: auto; } - col.enum_members_description { width: auto; } - col.union_members_name { width: auto; } - col.union_members_description { width: auto; } - .listing_lines { display: none; } -} -@media print { - table.navigation { - visibility: collapse; - display: none; - } - div.titlepage table.navigation { - visibility: visible; - display: table; - background: #e2e2e2; - border: solid 1px #babdb6; - margin-top: 0; - margin-bottom: 0; - top: 0; - left: 0; - height: 3em; - } -} - diff --git a/docs/reference/html/up-insensitive.png b/docs/reference/html/up-insensitive.png Binary files differdeleted file mode 100644 index f4049860..00000000 --- a/docs/reference/html/up-insensitive.png +++ /dev/null diff --git a/docs/reference/html/up.png b/docs/reference/html/up.png Binary files differdeleted file mode 100644 index 80b4b37e..00000000 --- a/docs/reference/html/up.png +++ /dev/null |
