diff options
Diffstat (limited to 'docs/reference/html/SoupLogger.html')
| -rw-r--r-- | docs/reference/html/SoupLogger.html | 595 |
1 files changed, 0 insertions, 595 deletions
diff --git a/docs/reference/html/SoupLogger.html b/docs/reference/html/SoupLogger.html deleted file mode 100644 index 7ed95d3a..00000000 --- a/docs/reference/html/SoupLogger.html +++ /dev/null @@ -1,595 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>SoupLogger: libsoup Reference Manual</title> -<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> -<link rel="home" href="index.html" title="libsoup Reference Manual"> -<link rel="up" href="ch03.html" title="Additional Features"> -<link rel="prev" href="SoupCookieJarDB.html" title="SoupCookieJarDB"> -<link rel="next" href="SoupProxyResolverDefault.html" title="SoupProxyResolverDefault"> -<meta name="generator" content="GTK-Doc V1.28.1 (XML mode)"> -<link rel="stylesheet" href="style.css" type="text/css"> -</head> -<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> -<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> -<td width="100%" align="left" class="shortcuts"> -<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> - <a href="#SoupLogger.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#SoupLogger.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> - <a href="#SoupLogger.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> - <a href="#SoupLogger.properties" class="shortcut">Properties</a></span> -</td> -<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> -<td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="SoupCookieJarDB.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="SoupProxyResolverDefault.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> -</tr></table> -<div class="refentry"> -<a name="SoupLogger"></a><div class="titlepage"></div> -<div class="refnamediv"><table width="100%"><tr> -<td valign="top"> -<h2><span class="refentrytitle"><a name="SoupLogger.top_of_page"></a>SoupLogger</span></h2> -<p>SoupLogger — Debug logging support</p> -</td> -<td class="gallery_image" valign="top" align="right"></td> -</tr></table></div> -<div class="refsect1"> -<a name="SoupLogger.functions"></a><h2>Functions</h2> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="150px" class="functions_return"> -<col class="functions_name"> -</colgroup> -<tbody> -<tr> -<td class="function_type"> -<a class="link" href="SoupLogger.html" title="SoupLogger"><span class="returnvalue">SoupLogger</span></a> * -</td> -<td class="function_name"> -<a class="link" href="SoupLogger.html#soup-logger-new" title="soup_logger_new ()">soup_logger_new</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<a class="link" href="SoupLogger.html#SoupLoggerLogLevel" title="enum SoupLoggerLogLevel"><span class="returnvalue">SoupLoggerLogLevel</span></a> -</td> -<td class="function_name"> -<span class="c_punctuation">(</span><a class="link" href="SoupLogger.html#SoupLoggerFilter" title="SoupLoggerFilter ()">*SoupLoggerFilter</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupLogger.html#soup-logger-set-request-filter" title="soup_logger_set_request_filter ()">soup_logger_set_request_filter</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupLogger.html#soup-logger-set-response-filter" title="soup_logger_set_response_filter ()">soup_logger_set_response_filter</a> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<span class="c_punctuation">(</span><a class="link" href="SoupLogger.html#SoupLoggerPrinter" title="SoupLoggerPrinter ()">*SoupLoggerPrinter</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span> -</td> -</tr> -<tr> -<td class="function_type"> -<span class="returnvalue">void</span> -</td> -<td class="function_name"> -<a class="link" href="SoupLogger.html#soup-logger-set-printer" title="soup_logger_set_printer ()">soup_logger_set_printer</a> <span class="c_punctuation">()</span> -</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupLogger.properties"></a><h2>Properties</h2> -<div class="informaltable"><table class="informaltable" border="0"> -<colgroup> -<col width="150px" class="properties_type"> -<col width="300px" class="properties_name"> -<col width="200px" class="properties_flags"> -</colgroup> -<tbody> -<tr> -<td class="property_type"><a class="link" href="SoupLogger.html#SoupLoggerLogLevel" title="enum SoupLoggerLogLevel"><span class="type">SoupLoggerLogLevel</span></a></td> -<td class="property_name"><a class="link" href="SoupLogger.html#SoupLogger--level" title="The “level” property">level</a></td> -<td class="property_flags">Read / Write</td> -</tr> -<tr> -<td class="property_type"><span class="type">gint</span></td> -<td class="property_name"><a class="link" href="SoupLogger.html#SoupLogger--max-body-size" title="The “max-body-size” property">max-body-size</a></td> -<td class="property_flags">Read / Write</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupLogger.other"></a><h2>Types and Values</h2> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="150px" class="name"> -<col class="description"> -</colgroup> -<tbody> -<tr> -<td class="datatype_keyword"> </td> -<td class="function_name"><a class="link" href="SoupLogger.html#SoupLogger-struct" title="SoupLogger">SoupLogger</a></td> -</tr> -<tr> -<td class="datatype_keyword">enum</td> -<td class="function_name"><a class="link" href="SoupLogger.html#SoupLoggerLogLevel" title="enum SoupLoggerLogLevel">SoupLoggerLogLevel</a></td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> -<a name="SoupLogger.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> GObject - <span class="lineart">╰──</span> SoupLogger -</pre> -</div> -<div class="refsect1"> -<a name="SoupLogger.implemented-interfaces"></a><h2>Implemented Interfaces</h2> -<p> -SoupLogger implements - <a class="link" href="SoupSessionFeature.html" title="SoupSessionFeature">SoupSessionFeature</a>.</p> -</div> -<div class="refsect1"> -<a name="SoupLogger.includes"></a><h2>Includes</h2> -<pre class="synopsis">#include <libsoup/soup.h> -</pre> -</div> -<div class="refsect1"> -<a name="SoupLogger.description"></a><h2>Description</h2> -<p><a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a> watches a <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a> and logs the HTTP traffic that -it generates, for debugging purposes. Many applications use an -environment variable to determine whether or not to use -<a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a>, and to determine the amount of debugging output.</p> -<p>To use <a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a>, first create a logger with <a class="link" href="SoupLogger.html#soup-logger-new" title="soup_logger_new ()"><code class="function">soup_logger_new()</code></a>, -optionally configure it with <a class="link" href="SoupLogger.html#soup-logger-set-request-filter" title="soup_logger_set_request_filter ()"><code class="function">soup_logger_set_request_filter()</code></a>, -<a class="link" href="SoupLogger.html#soup-logger-set-response-filter" title="soup_logger_set_response_filter ()"><code class="function">soup_logger_set_response_filter()</code></a>, and <a class="link" href="SoupLogger.html#soup-logger-set-printer" title="soup_logger_set_printer ()"><code class="function">soup_logger_set_printer()</code></a>, -and then attach it to a session (or multiple sessions) with -<a class="link" href="SoupSession.html#soup-session-add-feature" title="soup_session_add_feature ()"><code class="function">soup_session_add_feature()</code></a>.</p> -<p>By default, the debugging output is sent to -<code class="literal">stdout</code>, and looks something like:</p> -<div class="informalexample"><pre class="screen"> -> POST /unauth HTTP/1.1 -> Soup-Debug-Timestamp: 1200171744 -> Soup-Debug: SoupSessionAsync 1 (0x612190), SoupMessage 1 (0x617000), SoupSocket 1 (0x612220) -> Host: localhost -> Content-Type: text/plain -> Connection: close -> -> This is a test. - -< HTTP/1.1 201 Created -< Soup-Debug-Timestamp: 1200171744 -< Soup-Debug: SoupMessage 1 (0x617000) -< Date: Sun, 12 Jan 2008 21:02:24 GMT -< Content-Length: 0 -</pre></div> -<p>The <code class="literal">Soup-Debug-Timestamp</code> line gives the time (as -a <span class="type">time_t</span>) when the request was sent, or the response fully -received.</p> -<p>The <code class="literal">Soup-Debug</code> line gives further debugging -information about the <a class="link" href="SoupSession.html" title="SoupSession"><span class="type">SoupSession</span></a>, <a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a>, and <a class="link" href="SoupSocket.html" title="SoupSocket"><span class="type">SoupSocket</span></a> -involved; the hex numbers are the addresses of the objects in -question (which may be useful if you are running in a debugger). -The decimal IDs are simply counters that uniquely identify objects -across the lifetime of the <a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a>. In particular, this can be -used to identify when multiple messages are sent across the same -connection.</p> -<p>Currently, the request half of the message is logged just before -the first byte of the request gets written to the network (from the -<a class="link" href="SoupMessage.html#SoupMessage-starting" title="The “starting” signal"><span class="type">“starting”</span></a> signal), which means that if you have -not made the complete request body available at that point, it will -not be logged.</p> -<p>The response is logged just after the last byte of the response -body is read from the network (from the <a class="link" href="SoupMessage.html#SoupMessage-got-body" title="The “got-body” signal"><span class="type">“got_body”</span></a> or -<a class="link" href="SoupMessage.html#SoupMessage-got-informational" title="The “got-informational” signal"><span class="type">“got_informational”</span></a> signal), which means that the -<a class="link" href="SoupMessage.html#SoupMessage-got-headers" title="The “got-headers” signal"><span class="type">“got_headers”</span></a> signal, and anything triggered off it -(such as <a class="link" href="SoupSession.html#SoupSession-authenticate" title="The “authenticate” signal"><span class="type">“authenticate”</span></a>) will be emitted -<span class="emphasis"><em>before</em></span> the response headers are actually -logged.</p> -<p>If the response doesn't happen to trigger the -<a class="link" href="SoupMessage.html#SoupMessage-got-body" title="The “got-body” signal"><span class="type">“got_body”</span></a> nor <a class="link" href="SoupMessage.html#SoupMessage-got-informational" title="The “got-informational” signal"><span class="type">“got_informational”</span></a> signals -due to, for example, a cancellation before receiving the last byte -of the response body, the response will still be logged on the -event of the <a class="link" href="SoupMessage.html#SoupMessage-finished" title="The “finished” signal"><span class="type">“finished”</span></a> signal.</p> -</div> -<div class="refsect1"> -<a name="SoupLogger.functions_details"></a><h2>Functions</h2> -<div class="refsect2"> -<a name="soup-logger-new"></a><h3>soup_logger_new ()</h3> -<pre class="programlisting"><a class="link" href="SoupLogger.html" title="SoupLogger"><span class="returnvalue">SoupLogger</span></a> * -soup_logger_new (<em class="parameter"><code><a class="link" href="SoupLogger.html#SoupLoggerLogLevel" title="enum SoupLoggerLogLevel"><span class="type">SoupLoggerLogLevel</span></a> level</code></em>, - <em class="parameter"><code><span class="type">int</span> max_body_size</code></em>);</pre> -<p>Creates a new <a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a> with the given debug level. If <em class="parameter"><code>level</code></em> - is -<a class="link" href="SoupLogger.html#SOUP-LOGGER-LOG-BODY:CAPS"><code class="literal">SOUP_LOGGER_LOG_BODY</code></a>, <em class="parameter"><code>max_body_size</code></em> - gives the maximum number of -bytes of the body that will be logged. (-1 means "no limit".)</p> -<p>If you need finer control over what message parts are and aren't -logged, use <a class="link" href="SoupLogger.html#soup-logger-set-request-filter" title="soup_logger_set_request_filter ()"><code class="function">soup_logger_set_request_filter()</code></a> and -<a class="link" href="SoupLogger.html#soup-logger-set-response-filter" title="soup_logger_set_response_filter ()"><code class="function">soup_logger_set_response_filter()</code></a>.</p> -<div class="refsect3"> -<a name="soup-logger-new.parameters"></a><h4>Parameters</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="150px" class="parameters_name"> -<col class="parameters_description"> -<col width="200px" class="parameters_annotations"> -</colgroup> -<tbody> -<tr> -<td class="parameter_name"><p>level</p></td> -<td class="parameter_description"><p>the debug level</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>max_body_size</p></td> -<td class="parameter_description"><p>the maximum body size to output, or -1</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="soup-logger-new.returns"></a><h4>Returns</h4> -<p> a new <a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a></p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SoupLoggerFilter"></a><h3>SoupLoggerFilter ()</h3> -<pre class="programlisting"><a class="link" href="SoupLogger.html#SoupLoggerLogLevel" title="enum SoupLoggerLogLevel"><span class="returnvalue">SoupLoggerLogLevel</span></a> -<span class="c_punctuation">(</span>*SoupLoggerFilter<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a> *logger</code></em>, - <em class="parameter"><code><a class="link" href="SoupMessage.html" title="SoupMessage"><span class="type">SoupMessage</span></a> *msg</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> -<p>The prototype for a logging filter. The filter callback will be -invoked for each request or response, and should analyze it and -return a <a class="link" href="SoupLogger.html#SoupLoggerLogLevel" title="enum SoupLoggerLogLevel"><span class="type">SoupLoggerLogLevel</span></a> value indicating how much of the -message to log. Eg, it might choose between <a class="link" href="SoupLogger.html#SOUP-LOGGER-LOG-BODY:CAPS"><code class="literal">SOUP_LOGGER_LOG_BODY</code></a> -and <a class="link" href="SoupLogger.html#SOUP-LOGGER-LOG-HEADERS:CAPS"><code class="literal">SOUP_LOGGER_LOG_HEADERS</code></a> depending on the Content-Type.</p> -<div class="refsect3"> -<a name="SoupLoggerFilter.parameters"></a><h4>Parameters</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="150px" class="parameters_name"> -<col class="parameters_description"> -<col width="200px" class="parameters_annotations"> -</colgroup> -<tbody> -<tr> -<td class="parameter_name"><p>logger</p></td> -<td class="parameter_description"><p>the <a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>msg</p></td> -<td class="parameter_description"><p>the message being logged</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>the data passed to <a class="link" href="SoupLogger.html#soup-logger-set-request-filter" title="soup_logger_set_request_filter ()"><code class="function">soup_logger_set_request_filter()</code></a> -or <a class="link" href="SoupLogger.html#soup-logger-set-response-filter" title="soup_logger_set_response_filter ()"><code class="function">soup_logger_set_response_filter()</code></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect3"> -<a name="SoupLoggerFilter.returns"></a><h4>Returns</h4> -<p> a <a class="link" href="SoupLogger.html#SoupLoggerLogLevel" title="enum SoupLoggerLogLevel"><span class="type">SoupLoggerLogLevel</span></a> value indicating how much of -the message to log</p> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-logger-set-request-filter"></a><h3>soup_logger_set_request_filter ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_logger_set_request_filter (<em class="parameter"><code><a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a> *logger</code></em>, - <em class="parameter"><code><a class="link" href="SoupLogger.html#SoupLoggerFilter" title="SoupLoggerFilter ()"><span class="type">SoupLoggerFilter</span></a> request_filter</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> filter_data</code></em>, - <em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>);</pre> -<p>Sets up a filter to determine the log level for a given request. -For each HTTP request <em class="parameter"><code>logger</code></em> - will invoke <em class="parameter"><code>request_filter</code></em> - to -determine how much (if any) of that request to log. (If you do not -set a request filter, <em class="parameter"><code>logger</code></em> - will just always log requests at the -level passed to <a class="link" href="SoupLogger.html#soup-logger-new" title="soup_logger_new ()"><code class="function">soup_logger_new()</code></a>.)</p> -<div class="refsect3"> -<a name="soup-logger-set-request-filter.parameters"></a><h4>Parameters</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="150px" class="parameters_name"> -<col class="parameters_description"> -<col width="200px" class="parameters_annotations"> -</colgroup> -<tbody> -<tr> -<td class="parameter_name"><p>logger</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>request_filter</p></td> -<td class="parameter_description"><p>the callback for request debugging</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>filter_data</p></td> -<td class="parameter_description"><p>data to pass to the callback</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>destroy</p></td> -<td class="parameter_description"><p>a <span class="type">GDestroyNotify</span> to free <em class="parameter"><code>filter_data</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-logger-set-response-filter"></a><h3>soup_logger_set_response_filter ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_logger_set_response_filter (<em class="parameter"><code><a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a> *logger</code></em>, - <em class="parameter"><code><a class="link" href="SoupLogger.html#SoupLoggerFilter" title="SoupLoggerFilter ()"><span class="type">SoupLoggerFilter</span></a> response_filter</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> filter_data</code></em>, - <em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>);</pre> -<p>Sets up a filter to determine the log level for a given response. -For each HTTP response <em class="parameter"><code>logger</code></em> - will invoke <em class="parameter"><code>response_filter</code></em> - to -determine how much (if any) of that response to log. (If you do not -set a response filter, <em class="parameter"><code>logger</code></em> - will just always log responses at -the level passed to <a class="link" href="SoupLogger.html#soup-logger-new" title="soup_logger_new ()"><code class="function">soup_logger_new()</code></a>.)</p> -<div class="refsect3"> -<a name="soup-logger-set-response-filter.parameters"></a><h4>Parameters</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="150px" class="parameters_name"> -<col class="parameters_description"> -<col width="200px" class="parameters_annotations"> -</colgroup> -<tbody> -<tr> -<td class="parameter_name"><p>logger</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>response_filter</p></td> -<td class="parameter_description"><p>the callback for response debugging</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>filter_data</p></td> -<td class="parameter_description"><p>data to pass to the callback</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>destroy</p></td> -<td class="parameter_description"><p>a <span class="type">GDestroyNotify</span> to free <em class="parameter"><code>filter_data</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="SoupLoggerPrinter"></a><h3>SoupLoggerPrinter ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -<span class="c_punctuation">(</span>*SoupLoggerPrinter<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a> *logger</code></em>, - <em class="parameter"><code><a class="link" href="SoupLogger.html#SoupLoggerLogLevel" title="enum SoupLoggerLogLevel"><span class="type">SoupLoggerLogLevel</span></a> level</code></em>, - <em class="parameter"><code><span class="type">char</span> direction</code></em>, - <em class="parameter"><code>const <span class="type">char</span> *data</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre> -<p>The prototype for a custom printing callback.</p> -<p><em class="parameter"><code>level</code></em> - indicates what kind of information is being printed. Eg, it -will be <a class="link" href="SoupLogger.html#SOUP-LOGGER-LOG-HEADERS:CAPS"><code class="literal">SOUP_LOGGER_LOG_HEADERS</code></a> if <em class="parameter"><code>data</code></em> - is header data.</p> -<p><em class="parameter"><code>direction</code></em> - is either '<', '>', or ' ', and <em class="parameter"><code>data</code></em> - is the single line -to print; the printer is expected to add a terminating newline.</p> -<p>To get the effect of the default printer, you would do:</p> -<div class="informalexample"> - <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> - <tbody> - <tr> - <td class="listing_lines" align="right"><pre>1</pre></td> - <td class="listing_code"><pre class="programlisting"><span class="function">printf</span> <span class="gtkdoc opt">(</span><span class="string">"%c %s</span><span class="gtkdoc esc">\n</span><span class="string">"</span><span class="gtkdoc opt">,</span> direction<span class="gtkdoc opt">,</span> data<span class="gtkdoc opt">);</span></pre></td> - </tr> - </tbody> - </table> -</div> - -<div class="refsect3"> -<a name="SoupLoggerPrinter.parameters"></a><h4>Parameters</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="150px" class="parameters_name"> -<col class="parameters_description"> -<col width="200px" class="parameters_annotations"> -</colgroup> -<tbody> -<tr> -<td class="parameter_name"><p>logger</p></td> -<td class="parameter_description"><p>the <a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>level</p></td> -<td class="parameter_description"><p>the level of the information being printed.</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>direction</p></td> -<td class="parameter_description"><p>a single-character prefix to <em class="parameter"><code>data</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>data</p></td> -<td class="parameter_description"><p>data to print</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>the data passed to <a class="link" href="SoupLogger.html#soup-logger-set-printer" title="soup_logger_set_printer ()"><code class="function">soup_logger_set_printer()</code></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -<hr> -<div class="refsect2"> -<a name="soup-logger-set-printer"></a><h3>soup_logger_set_printer ()</h3> -<pre class="programlisting"><span class="returnvalue">void</span> -soup_logger_set_printer (<em class="parameter"><code><a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a> *logger</code></em>, - <em class="parameter"><code><a class="link" href="SoupLogger.html#SoupLoggerPrinter" title="SoupLoggerPrinter ()"><span class="type">SoupLoggerPrinter</span></a> printer</code></em>, - <em class="parameter"><code><span class="type">gpointer</span> printer_data</code></em>, - <em class="parameter"><code><span class="type">GDestroyNotify</span> destroy</code></em>);</pre> -<p>Sets up an alternate log printing routine, if you don't want -the log to go to <code class="literal">stdout</code>.</p> -<div class="refsect3"> -<a name="soup-logger-set-printer.parameters"></a><h4>Parameters</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="150px" class="parameters_name"> -<col class="parameters_description"> -<col width="200px" class="parameters_annotations"> -</colgroup> -<tbody> -<tr> -<td class="parameter_name"><p>logger</p></td> -<td class="parameter_description"><p>a <a class="link" href="SoupLogger.html" title="SoupLogger"><span class="type">SoupLogger</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>printer</p></td> -<td class="parameter_description"><p>the callback for printing logging output</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>printer_data</p></td> -<td class="parameter_description"><p>data to pass to the callback</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>destroy</p></td> -<td class="parameter_description"><p>a <span class="type">GDestroyNotify</span> to free <em class="parameter"><code>printer_data</code></em> -</p></td> -<td class="parameter_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -</div> -<div class="refsect1"> -<a name="SoupLogger.other_details"></a><h2>Types and Values</h2> -<div class="refsect2"> -<a name="SoupLogger-struct"></a><h3>SoupLogger</h3> -<pre class="programlisting">typedef struct _SoupLogger SoupLogger;</pre> -</div> -<hr> -<div class="refsect2"> -<a name="SoupLoggerLogLevel"></a><h3>enum SoupLoggerLogLevel</h3> -<p>Describes the level of logging output to provide.</p> -<div class="refsect3"> -<a name="SoupLoggerLogLevel.members"></a><h4>Members</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="300px" class="enum_members_name"> -<col class="enum_members_description"> -<col width="200px" class="enum_members_annotations"> -</colgroup> -<tbody> -<tr> -<td class="enum_member_name"><p><a name="SOUP-LOGGER-LOG-NONE:CAPS"></a>SOUP_LOGGER_LOG_NONE</p></td> -<td class="enum_member_description"> -<p>No logging</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-LOGGER-LOG-MINIMAL:CAPS"></a>SOUP_LOGGER_LOG_MINIMAL</p></td> -<td class="enum_member_description"> -<p>Log the Request-Line or Status-Line and -the Soup-Debug pseudo-headers</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-LOGGER-LOG-HEADERS:CAPS"></a>SOUP_LOGGER_LOG_HEADERS</p></td> -<td class="enum_member_description"> -<p>Log the full request/response headers</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -<tr> -<td class="enum_member_name"><p><a name="SOUP-LOGGER-LOG-BODY:CAPS"></a>SOUP_LOGGER_LOG_BODY</p></td> -<td class="enum_member_description"> -<p>Log the full headers and request/response -bodies.</p> -</td> -<td class="enum_member_annotations"> </td> -</tr> -</tbody> -</table></div> -</div> -</div> -</div> -<div class="refsect1"> -<a name="SoupLogger.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> -<a name="SoupLogger--level"></a><h3>The <code class="literal">“level”</code> property</h3> -<pre class="programlisting"> “level” <a class="link" href="SoupLogger.html#SoupLoggerLogLevel" title="enum SoupLoggerLogLevel"><span class="type">SoupLoggerLogLevel</span></a></pre> -<p>The level of logging output</p> -<p>Flags: Read / Write</p> -<p>Default value: SOUP_LOGGER_LOG_MINIMAL</p> -<p class="since">Since: 2.56</p> -</div> -<hr> -<div class="refsect2"> -<a name="SoupLogger--max-body-size"></a><h3>The <code class="literal">“max-body-size”</code> property</h3> -<pre class="programlisting"> “max-body-size” <span class="type">gint</span></pre> -<p>If <a class="link" href="SoupLogger.html#SoupLogger--level" title="The “level” property"><span class="type">“level”</span></a> is <a class="link" href="SoupLogger.html#SOUP-LOGGER-LOG-BODY:CAPS"><code class="literal">SOUP_LOGGER_LOG_BODY</code></a>, this gives -the maximum number of bytes of the body that will be logged. -(-1 means "no limit".)</p> -<p>Flags: Read / Write</p> -<p>Allowed values: >= -1</p> -<p>Default value: -1</p> -<p class="since">Since: 2.56</p> -</div> -</div> -</div> -<div class="footer"> -<hr>Generated by GTK-Doc V1.28.1</div> -</body> -</html>
\ No newline at end of file |