source-git / libsoup

Clone
Source Code
GIT

Files

  1.   ca38770256bd1a9efc9df9ccd2142073bdffe766
  2.   docs
  3.   reference
  4.   html
  5.   SoupMessage.html
Blob Blame History Raw 
<!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 &lt;libsoup/soup.h&gt;
</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: &lt;= 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>

Powered by Pagure 5.14.1

SSH Hostkey/Fingerprint | Documentation