756c5fc020acbf393513b4c83d10afab967e2619
[profile/ivi/libsoup2.4.git] / docs / reference / html / libsoup-2.4-Soup-Miscellaneous-Utilities.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>Soup Miscellaneous Utilities</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="libsoup Reference Manual">
8 <link rel="up" href="ch02.html" title="Core API">
9 <link rel="prev" href="SoupURI.html" title="SoupURI">
10 <link rel="next" href="ch03.html" title="Additional Features">
11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16 <tr valign="middle">
17 <td><a accesskey="p" href="SoupURI.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">libsoup Reference Manual</th>
21 <td><a accesskey="n" href="ch03.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22 </tr>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#libsoup-2.4-Soup-Miscellaneous-Utilities.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#libsoup-2.4-Soup-Miscellaneous-Utilities.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#libsoup-2.4-Soup-Miscellaneous-Utilities.object-hierarchy" class="shortcut">Object Hierarchy</a>
29 </td></tr>
30 </table>
31 <div class="refentry">
32 <a name="libsoup-2.4-Soup-Miscellaneous-Utilities"></a><div class="titlepage"></div>
33 <div class="refnamediv"><table width="100%"><tr>
34 <td valign="top">
35 <h2><span class="refentrytitle"><a name="libsoup-2.4-Soup-Miscellaneous-Utilities.top_of_page"></a>Soup Miscellaneous Utilities</span></h2>
36 <p>Soup Miscellaneous Utilities — Miscellaneous functions</p>
37 </td>
38 <td valign="top" align="right"></td>
39 </tr></table></div>
40 <div class="refsynopsisdiv">
41 <a name="libsoup-2.4-Soup-Miscellaneous-Utilities.synopsis"></a><h2>Synopsis</h2>
42 <a name="SoupDate"></a><pre class="synopsis">
43 #include &lt;libsoup/soup.h&gt;
44
45                     <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate-struct" title="SoupDate">SoupDate</a>;
46 enum                <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDateFormat" title="enum SoupDateFormat">SoupDateFormat</a>;
47 <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="returnvalue">SoupDate</span></a> *          <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-new" title="soup_date_new ()">soup_date_new</a>                       (<em class="parameter"><code><span class="type">int</span> year</code></em>,
48                                                          <em class="parameter"><code><span class="type">int</span> month</code></em>,
49                                                          <em class="parameter"><code><span class="type">int</span> day</code></em>,
50                                                          <em class="parameter"><code><span class="type">int</span> hour</code></em>,
51                                                          <em class="parameter"><code><span class="type">int</span> minute</code></em>,
52                                                          <em class="parameter"><code><span class="type">int</span> second</code></em>);
53 <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="returnvalue">SoupDate</span></a> *          <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-new-from-string" title="soup_date_new_from_string ()">soup_date_new_from_string</a>           (<em class="parameter"><code>const <span class="type">char</span> *date_string</code></em>);
54 <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="returnvalue">SoupDate</span></a> *          <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-new-from-time-t" title="soup_date_new_from_time_t ()">soup_date_new_from_time_t</a>           (<em class="parameter"><code><span class="type">time_t</span> when</code></em>);
55 <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="returnvalue">SoupDate</span></a> *          <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-new-from-now" title="soup_date_new_from_now ()">soup_date_new_from_now</a>              (<em class="parameter"><code><span class="type">int</span> offset_seconds</code></em>);
56 <span class="returnvalue">char</span> *              <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-to-string" title="soup_date_to_string ()">soup_date_to_string</a>                 (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>,
57                                                          <em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDateFormat" title="enum SoupDateFormat"><span class="type">SoupDateFormat</span></a> format</code></em>);
58 <span class="returnvalue">time_t</span>              <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-to-time-t" title="soup_date_to_time_t ()">soup_date_to_time_t</a>                 (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);
59 <span class="returnvalue">void</span>                <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-to-timeval" title="soup_date_to_timeval ()">soup_date_to_timeval</a>                (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>,
60                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Date-and-Time-Functions.html#GTimeVal"><span class="type">GTimeVal</span></a> *time</code></em>);
61 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-is-past" title="soup_date_is_past ()">soup_date_is_past</a>                   (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);
62 <span class="returnvalue">int</span>                 <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-day" title="soup_date_get_day ()">soup_date_get_day</a>                   (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);
63 <span class="returnvalue">int</span>                 <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-hour" title="soup_date_get_hour ()">soup_date_get_hour</a>                  (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);
64 <span class="returnvalue">int</span>                 <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-minute" title="soup_date_get_minute ()">soup_date_get_minute</a>                (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);
65 <span class="returnvalue">int</span>                 <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-month" title="soup_date_get_month ()">soup_date_get_month</a>                 (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);
66 <span class="returnvalue">int</span>                 <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-offset" title="soup_date_get_offset ()">soup_date_get_offset</a>                (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);
67 <span class="returnvalue">int</span>                 <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-second" title="soup_date_get_second ()">soup_date_get_second</a>                (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);
68 <span class="returnvalue">int</span>                 <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-utc" title="soup_date_get_utc ()">soup_date_get_utc</a>                   (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);
69 <span class="returnvalue">int</span>                 <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-year" title="soup_date_get_year ()">soup_date_get_year</a>                  (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);
70 <span class="returnvalue">void</span>                <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-free" title="soup_date_free ()">soup_date_free</a>                      (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);
71
72 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-headers-parse-request" title="soup_headers_parse_request ()">soup_headers_parse_request</a>          (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>,
73                                                          <em class="parameter"><code><span class="type">int</span> len</code></em>,
74                                                          <em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *req_headers</code></em>,
75                                                          <em class="parameter"><code><span class="type">char</span> **req_method</code></em>,
76                                                          <em class="parameter"><code><span class="type">char</span> **req_path</code></em>,
77                                                          <em class="parameter"><code><a class="link" href="SoupMessage.html#SoupHTTPVersion" title="enum SoupHTTPVersion"><span class="type">SoupHTTPVersion</span></a> *ver</code></em>);
78 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-headers-parse-response" title="soup_headers_parse_response ()">soup_headers_parse_response</a>         (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>,
79                                                          <em class="parameter"><code><span class="type">int</span> len</code></em>,
80                                                          <em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *headers</code></em>,
81                                                          <em class="parameter"><code><a class="link" href="SoupMessage.html#SoupHTTPVersion" title="enum SoupHTTPVersion"><span class="type">SoupHTTPVersion</span></a> *ver</code></em>,
82                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *status_code</code></em>,
83                                                          <em class="parameter"><code><span class="type">char</span> **reason_phrase</code></em>);
84 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-headers-parse-status-line" title="soup_headers_parse_status_line ()">soup_headers_parse_status_line</a>      (<em class="parameter"><code>const <span class="type">char</span> *status_line</code></em>,
85                                                          <em class="parameter"><code><a class="link" href="SoupMessage.html#SoupHTTPVersion" title="enum SoupHTTPVersion"><span class="type">SoupHTTPVersion</span></a> *ver</code></em>,
86                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *status_code</code></em>,
87                                                          <em class="parameter"><code><span class="type">char</span> **reason_phrase</code></em>);
88 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-headers-parse" title="soup_headers_parse ()">soup_headers_parse</a>                  (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>,
89                                                          <em class="parameter"><code><span class="type">int</span> len</code></em>,
90                                                          <em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *dest</code></em>);
91
92 <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *            <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-parse-list" title="soup_header_parse_list ()">soup_header_parse_list</a>              (<em class="parameter"><code>const <span class="type">char</span> *header</code></em>);
93 <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *            <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-parse-quality-list" title="soup_header_parse_quality_list ()">soup_header_parse_quality_list</a>      (<em class="parameter"><code>const <span class="type">char</span> *header</code></em>,
94                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> **unacceptable</code></em>);
95 <span class="returnvalue">void</span>                <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-free-list" title="soup_header_free_list ()">soup_header_free_list</a>               (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *list</code></em>);
96 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-contains" title="soup_header_contains ()">soup_header_contains</a>                (<em class="parameter"><code>const <span class="type">char</span> *header</code></em>,
97                                                          <em class="parameter"><code>const <span class="type">char</span> *token</code></em>);
98 <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> *        <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-parse-param-list" title="soup_header_parse_param_list ()">soup_header_parse_param_list</a>        (<em class="parameter"><code>const <span class="type">char</span> *header</code></em>);
99 <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> *        <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-parse-semi-param-list" title="soup_header_parse_semi_param_list ()">soup_header_parse_semi_param_list</a>   (<em class="parameter"><code>const <span class="type">char</span> *header</code></em>);
100 <span class="returnvalue">void</span>                <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-free-param-list" title="soup_header_free_param_list ()">soup_header_free_param_list</a>         (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *param_list</code></em>);
101 <span class="returnvalue">void</span>                <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-g-string-append-param" title="soup_header_g_string_append_param ()">soup_header_g_string_append_param</a>   (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Strings.html#GString"><span class="type">GString</span></a> *string</code></em>,
102                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
103                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);
104 <span class="returnvalue">void</span>                <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-g-string-append-param-quoted" title="soup_header_g_string_append_param_quoted ()">soup_header_g_string_append_param_quoted</a>
105                                                         (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Strings.html#GString"><span class="type">GString</span></a> *string</code></em>,
106                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
107                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);
108
109 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-str-case-equal" title="soup_str_case_equal ()">soup_str_case_equal</a>                 (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> v1</code></em>,
110                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> v2</code></em>);
111 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-str-case-hash" title="soup_str_case_hash ()">soup_str_case_hash</a>                  (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> key</code></em>);
112
113 <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSource"><span class="returnvalue">GSource</span></a> *           <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-add-completion" title="soup_add_completion ()">soup_add_completion</a>                 (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> *async_context</code></em>,
114                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSourceFunc"><span class="type">GSourceFunc</span></a> function</code></em>,
115                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
116 <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSource"><span class="returnvalue">GSource</span></a> *           <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-add-idle" title="soup_add_idle ()">soup_add_idle</a>                       (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> *async_context</code></em>,
117                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSourceFunc"><span class="type">GSourceFunc</span></a> function</code></em>,
118                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
119 <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSource"><span class="returnvalue">GSource</span></a> *           <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-add-io-watch" title="soup_add_io_watch ()">soup_add_io_watch</a>                   (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> *async_context</code></em>,
120                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#GIOChannel"><span class="type">GIOChannel</span></a> *chan</code></em>,
121                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#GIOCondition"><span class="type">GIOCondition</span></a> condition</code></em>,
122                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#GIOFunc"><span class="type">GIOFunc</span></a> function</code></em>,
123                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
124 <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSource"><span class="returnvalue">GSource</span></a> *           <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-add-timeout" title="soup_add_timeout ()">soup_add_timeout</a>                    (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> *async_context</code></em>,
125                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> interval</code></em>,
126                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSourceFunc"><span class="type">GSourceFunc</span></a> function</code></em>,
127                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
128
129 extern const gboolean <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-ssl-supported" title="soup_ssl_supported">soup_ssl_supported</a>;
130 </pre>
131 </div>
132 <div class="refsect1">
133 <a name="libsoup-2.4-Soup-Miscellaneous-Utilities.object-hierarchy"></a><h2>Object Hierarchy</h2>
134 <pre class="synopsis">
135   GBoxed
136    +----SoupDate
137 </pre>
138 </div>
139 <div class="refsect1">
140 <a name="libsoup-2.4-Soup-Miscellaneous-Utilities.description"></a><h2>Description</h2>
141 </div>
142 <div class="refsect1">
143 <a name="libsoup-2.4-Soup-Miscellaneous-Utilities.details"></a><h2>Details</h2>
144 <div class="refsect2">
145 <a name="SoupDate-struct"></a><h3>SoupDate</h3>
146 <pre class="programlisting">typedef struct {
147         int      year;
148         int      month;
149         int      day;
150
151         int      hour;
152         int      minute;
153         int      second;
154
155         gboolean utc;
156         int      offset;
157 } SoupDate;
158 </pre>
159 <p>
160 A date and time. The date is assumed to be in the (proleptic)
161 Gregorian calendar. The time is in UTC if <em class="parameter"><code>utc</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>. Otherwise,
162 the time is a local time, and <em class="parameter"><code>offset</code></em> gives the offset from UTC in
163 minutes (such that adding <em class="parameter"><code>offset</code></em> to the time would give the
164 correct UTC time). If <em class="parameter"><code>utc</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> and <em class="parameter"><code>offset</code></em> is 0, then the
165 <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><code class="literal">SoupDate</code></a> represents a "floating" time with no associated timezone
166 information.
167 </p>
168 <div class="variablelist"><table border="0">
169 <col align="left" valign="top">
170 <tbody>
171 <tr>
172 <td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="SoupDate-struct.year"></a>year</code></em>;</span></p></td>
173 <td>the year, 1 to 9999</td>
174 </tr>
175 <tr>
176 <td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="SoupDate-struct.month"></a>month</code></em>;</span></p></td>
177 <td>the month, 1 to 12</td>
178 </tr>
179 <tr>
180 <td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="SoupDate-struct.day"></a>day</code></em>;</span></p></td>
181 <td>day of the month, 1 to 31</td>
182 </tr>
183 <tr>
184 <td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="SoupDate-struct.hour"></a>hour</code></em>;</span></p></td>
185 <td>hour of the day, 0 to 23</td>
186 </tr>
187 <tr>
188 <td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="SoupDate-struct.minute"></a>minute</code></em>;</span></p></td>
189 <td>minute, 0 to 59</td>
190 </tr>
191 <tr>
192 <td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="SoupDate-struct.second"></a>second</code></em>;</span></p></td>
193 <td>second, 0 to 59 (or up to 61 in the case of leap seconds)</td>
194 </tr>
195 <tr>
196 <td><p><span class="term"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> <em class="structfield"><code><a name="SoupDate-struct.utc"></a>utc</code></em>;</span></p></td>
197 <td>
198 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the date is in UTC</td>
199 </tr>
200 <tr>
201 <td><p><span class="term"><span class="type">int</span> <em class="structfield"><code><a name="SoupDate-struct.offset"></a>offset</code></em>;</span></p></td>
202 <td>offset from UTC</td>
203 </tr>
204 </tbody>
205 </table></div>
206 </div>
207 <hr>
208 <div class="refsect2">
209 <a name="SoupDateFormat"></a><h3>enum SoupDateFormat</h3>
210 <pre class="programlisting">typedef enum {
211         SOUP_DATE_HTTP = 1,
212         SOUP_DATE_COOKIE,
213         SOUP_DATE_RFC2822,
214         SOUP_DATE_ISO8601_COMPACT,
215         SOUP_DATE_ISO8601_FULL,
216         SOUP_DATE_ISO8601 = SOUP_DATE_ISO8601_FULL,
217         SOUP_DATE_ISO8601_XMLRPC
218 } SoupDateFormat;
219 </pre>
220 <p>
221 Date formats that <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-to-string" title="soup_date_to_string ()"><code class="function">soup_date_to_string()</code></a> can use.
222 </p>
223 <p>
224 <em class="parameter"><code>SOUP_DATE_HTTP</code></em> and <em class="parameter"><code>SOUP_DATE_COOKIE</code></em> always coerce the time to
225 UTC. <em class="parameter"><code>SOUP_DATE_ISO8601_XMLRPC</code></em> uses the time as given, ignoring the
226 offset completely. <em class="parameter"><code>SOUP_DATE_RFC2822</code></em> and the other ISO 8601
227 variants use the local time, appending the offset information if
228 available.
229 </p>
230 <p>
231 This enum may be extended with more values in future releases.
232 </p>
233 <div class="variablelist"><table border="0">
234 <col align="left" valign="top">
235 <tbody>
236 <tr>
237 <td><p><a name="SOUP-DATE-HTTP:CAPS"></a><span class="term"><code class="literal">SOUP_DATE_HTTP</code></span></p></td>
238 <td>RFC 1123 format, used by the HTTP "Date" header. Eg
239 "Sun, 06 Nov 1994 08:49:37 GMT"
240 </td>
241 </tr>
242 <tr>
243 <td><p><a name="SOUP-DATE-COOKIE:CAPS"></a><span class="term"><code class="literal">SOUP_DATE_COOKIE</code></span></p></td>
244 <td>The format for the "Expires" timestamp in the
245 Netscape cookie specification. Eg, "Sun, 06-Nov-1994 08:49:37 GMT".
246 </td>
247 </tr>
248 <tr>
249 <td><p><a name="SOUP-DATE-RFC2822:CAPS"></a><span class="term"><code class="literal">SOUP_DATE_RFC2822</code></span></p></td>
250 <td>RFC 2822 format, eg "Sun, 6 Nov 1994 09:49:37 -0100"
251 </td>
252 </tr>
253 <tr>
254 <td><p><a name="SOUP-DATE-ISO8601-COMPACT:CAPS"></a><span class="term"><code class="literal">SOUP_DATE_ISO8601_COMPACT</code></span></p></td>
255 <td>ISO 8601 date/time with no optional
256 punctuation. Eg, "19941106T094937-0100".
257 </td>
258 </tr>
259 <tr>
260 <td><p><a name="SOUP-DATE-ISO8601-FULL:CAPS"></a><span class="term"><code class="literal">SOUP_DATE_ISO8601_FULL</code></span></p></td>
261 <td>ISO 8601 date/time with all optional
262 punctuation. Eg, "1994-11-06T09:49:37-01:00".
263 </td>
264 </tr>
265 <tr>
266 <td><p><a name="SOUP-DATE-ISO8601:CAPS"></a><span class="term"><code class="literal">SOUP_DATE_ISO8601</code></span></p></td>
267 <td>An alias for <em class="parameter"><code>SOUP_DATE_ISO8601_FULL</code></em>.
268 </td>
269 </tr>
270 <tr>
271 <td><p><a name="SOUP-DATE-ISO8601-XMLRPC:CAPS"></a><span class="term"><code class="literal">SOUP_DATE_ISO8601_XMLRPC</code></span></p></td>
272 <td>ISO 8601 date/time as used by XML-RPC.
273 Eg, "19941106T09:49:37".
274 </td>
275 </tr>
276 </tbody>
277 </table></div>
278 </div>
279 <hr>
280 <div class="refsect2">
281 <a name="soup-date-new"></a><h3>soup_date_new ()</h3>
282 <pre class="programlisting"><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="returnvalue">SoupDate</span></a> *          soup_date_new                       (<em class="parameter"><code><span class="type">int</span> year</code></em>,
283                                                          <em class="parameter"><code><span class="type">int</span> month</code></em>,
284                                                          <em class="parameter"><code><span class="type">int</span> day</code></em>,
285                                                          <em class="parameter"><code><span class="type">int</span> hour</code></em>,
286                                                          <em class="parameter"><code><span class="type">int</span> minute</code></em>,
287                                                          <em class="parameter"><code><span class="type">int</span> second</code></em>);</pre>
288 <p>
289 Creates a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> representing the indicated time, UTC.
290 </p>
291 <div class="variablelist"><table border="0">
292 <col align="left" valign="top">
293 <tbody>
294 <tr>
295 <td><p><span class="term"><em class="parameter"><code>year</code></em> :</span></p></td>
296 <td>the year (1-9999)</td>
297 </tr>
298 <tr>
299 <td><p><span class="term"><em class="parameter"><code>month</code></em> :</span></p></td>
300 <td>the month (1-12)</td>
301 </tr>
302 <tr>
303 <td><p><span class="term"><em class="parameter"><code>day</code></em> :</span></p></td>
304 <td>the day of the month (1-31, as appropriate for <em class="parameter"><code>month</code></em>)</td>
305 </tr>
306 <tr>
307 <td><p><span class="term"><em class="parameter"><code>hour</code></em> :</span></p></td>
308 <td>the hour (0-23)</td>
309 </tr>
310 <tr>
311 <td><p><span class="term"><em class="parameter"><code>minute</code></em> :</span></p></td>
312 <td>the minute (0-59)</td>
313 </tr>
314 <tr>
315 <td><p><span class="term"><em class="parameter"><code>second</code></em> :</span></p></td>
316 <td>the second (0-59, or up to 61 for leap seconds)</td>
317 </tr>
318 <tr>
319 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
320 <td>a new <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a>
321 </td>
322 </tr>
323 </tbody>
324 </table></div>
325 </div>
326 <hr>
327 <div class="refsect2">
328 <a name="soup-date-new-from-string"></a><h3>soup_date_new_from_string ()</h3>
329 <pre class="programlisting"><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="returnvalue">SoupDate</span></a> *          soup_date_new_from_string           (<em class="parameter"><code>const <span class="type">char</span> *date_string</code></em>);</pre>
330 <p>
331 Parses <em class="parameter"><code>date_string</code></em> and tries to extract a date from it. This
332 recognizes all of the "HTTP-date" formats from RFC 2616, all ISO
333 8601 formats containing both a time and a date, RFC 2822 dates,
334 and reasonable approximations thereof. (Eg, it is lenient about
335 whitespace, leading "0"s, etc.)
336 </p>
337 <div class="variablelist"><table border="0">
338 <col align="left" valign="top">
339 <tbody>
340 <tr>
341 <td><p><span class="term"><em class="parameter"><code>date_string</code></em> :</span></p></td>
342 <td>the date in some plausible format</td>
343 </tr>
344 <tr>
345 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
346 <td>a new <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>date_string</code></em> could not
347 be parsed.</td>
348 </tr>
349 </tbody>
350 </table></div>
351 </div>
352 <hr>
353 <div class="refsect2">
354 <a name="soup-date-new-from-time-t"></a><h3>soup_date_new_from_time_t ()</h3>
355 <pre class="programlisting"><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="returnvalue">SoupDate</span></a> *          soup_date_new_from_time_t           (<em class="parameter"><code><span class="type">time_t</span> when</code></em>);</pre>
356 <p>
357 Creates a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> corresponding to <em class="parameter"><code>when</code></em>
358 </p>
359 <div class="variablelist"><table border="0">
360 <col align="left" valign="top">
361 <tbody>
362 <tr>
363 <td><p><span class="term"><em class="parameter"><code>when</code></em> :</span></p></td>
364 <td>a <span class="type">time_t</span>
365 </td>
366 </tr>
367 <tr>
368 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
369 <td>a new <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a>
370 </td>
371 </tr>
372 </tbody>
373 </table></div>
374 </div>
375 <hr>
376 <div class="refsect2">
377 <a name="soup-date-new-from-now"></a><h3>soup_date_new_from_now ()</h3>
378 <pre class="programlisting"><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="returnvalue">SoupDate</span></a> *          soup_date_new_from_now              (<em class="parameter"><code><span class="type">int</span> offset_seconds</code></em>);</pre>
379 <p>
380 Creates a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> representing a time <em class="parameter"><code>offset_seconds</code></em> after the
381 current time (or before it, if <em class="parameter"><code>offset_seconds</code></em> is negative). If
382 offset_seconds is 0, returns the current time.
383 </p>
384 <p>
385 If <em class="parameter"><code>offset_seconds</code></em> would indicate a time not expressible as a
386 <span class="type">time_t</span>, the return value will be clamped into range.
387 </p>
388 <div class="variablelist"><table border="0">
389 <col align="left" valign="top">
390 <tbody>
391 <tr>
392 <td><p><span class="term"><em class="parameter"><code>offset_seconds</code></em> :</span></p></td>
393 <td>offset from current time</td>
394 </tr>
395 <tr>
396 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
397 <td>a new <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a>
398 </td>
399 </tr>
400 </tbody>
401 </table></div>
402 </div>
403 <hr>
404 <div class="refsect2">
405 <a name="soup-date-to-string"></a><h3>soup_date_to_string ()</h3>
406 <pre class="programlisting"><span class="returnvalue">char</span> *              soup_date_to_string                 (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>,
407                                                          <em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDateFormat" title="enum SoupDateFormat"><span class="type">SoupDateFormat</span></a> format</code></em>);</pre>
408 <p>
409 Converts <em class="parameter"><code>date</code></em> to a string in the format described by <em class="parameter"><code>format</code></em>.
410 </p>
411 <div class="variablelist"><table border="0">
412 <col align="left" valign="top">
413 <tbody>
414 <tr>
415 <td><p><span class="term"><em class="parameter"><code>date</code></em> :</span></p></td>
416 <td>a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a>
417 </td>
418 </tr>
419 <tr>
420 <td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
421 <td>the format to generate the date in</td>
422 </tr>
423 <tr>
424 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
425 <td>
426 <em class="parameter"><code>date</code></em> as a string</td>
427 </tr>
428 </tbody>
429 </table></div>
430 </div>
431 <hr>
432 <div class="refsect2">
433 <a name="soup-date-to-time-t"></a><h3>soup_date_to_time_t ()</h3>
434 <pre class="programlisting"><span class="returnvalue">time_t</span>              soup_date_to_time_t                 (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);</pre>
435 <p>
436 Converts <em class="parameter"><code>date</code></em> to a <code class="literal">time_t</code>.
437 </p>
438 <p>
439 If <em class="parameter"><code>date</code></em> is not representable as a <code class="literal">time_t</code>, it will be clamped into
440 range. (In particular, some HTTP cookies have expiration dates
441 after "Y2.038k" (2038-01-19T03:14:07Z).)
442 </p>
443 <div class="variablelist"><table border="0">
444 <col align="left" valign="top">
445 <tbody>
446 <tr>
447 <td><p><span class="term"><em class="parameter"><code>date</code></em> :</span></p></td>
448 <td>a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a>
449 </td>
450 </tr>
451 <tr>
452 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
453 <td>
454 <em class="parameter"><code>date</code></em> as a <code class="literal">time_t</code>
455 </td>
456 </tr>
457 </tbody>
458 </table></div>
459 </div>
460 <hr>
461 <div class="refsect2">
462 <a name="soup-date-to-timeval"></a><h3>soup_date_to_timeval ()</h3>
463 <pre class="programlisting"><span class="returnvalue">void</span>                soup_date_to_timeval                (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>,
464                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Date-and-Time-Functions.html#GTimeVal"><span class="type">GTimeVal</span></a> *time</code></em>);</pre>
465 <p>
466 Converts <em class="parameter"><code>date</code></em> to a <a href="http://library.gnome.org/devel/glib/unstable/glib-Date-and-Time-Functions.html#GTimeVal"><span class="type">GTimeVal</span></a>.
467 </p>
468 <div class="variablelist"><table border="0">
469 <col align="left" valign="top">
470 <tbody>
471 <tr>
472 <td><p><span class="term"><em class="parameter"><code>date</code></em> :</span></p></td>
473 <td>a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a>
474 </td>
475 </tr>
476 <tr>
477 <td><p><span class="term"><em class="parameter"><code>time</code></em> :</span></p></td>
478 <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Date-and-Time-Functions.html#GTimeVal"><span class="type">GTimeVal</span></a> structure in which to store the converted time. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
479 </td>
480 </tr>
481 </tbody>
482 </table></div>
483 <p class="since">Since 2.24</p>
484 </div>
485 <hr>
486 <div class="refsect2">
487 <a name="soup-date-is-past"></a><h3>soup_date_is_past ()</h3>
488 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            soup_date_is_past                   (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);</pre>
489 <p>
490 Determines if <em class="parameter"><code>date</code></em> is in the past.
491 </p>
492 <div class="variablelist"><table border="0">
493 <col align="left" valign="top">
494 <tbody>
495 <tr>
496 <td><p><span class="term"><em class="parameter"><code>date</code></em> :</span></p></td>
497 <td>a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a>
498 </td>
499 </tr>
500 <tr>
501 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
502 <td>
503 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>date</code></em> is in the past</td>
504 </tr>
505 </tbody>
506 </table></div>
507 <p class="since">Since 2.24</p>
508 </div>
509 <hr>
510 <div class="refsect2">
511 <a name="soup-date-get-day"></a><h3>soup_date_get_day ()</h3>
512 <pre class="programlisting"><span class="returnvalue">int</span>                 soup_date_get_day                   (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);</pre>
513 <p>
514 Gets <em class="parameter"><code>date</code></em>'s day.
515 </p>
516 <div class="variablelist"><table border="0">
517 <col align="left" valign="top">
518 <tbody>
519 <tr>
520 <td><p><span class="term"><em class="parameter"><code>date</code></em> :</span></p></td>
521 <td>a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a>
522 </td>
523 </tr>
524 <tr>
525 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
526 <td>
527 <em class="parameter"><code>date</code></em>'s day</td>
528 </tr>
529 </tbody>
530 </table></div>
531 <p class="since">Since 2.32</p>
532 </div>
533 <hr>
534 <div class="refsect2">
535 <a name="soup-date-get-hour"></a><h3>soup_date_get_hour ()</h3>
536 <pre class="programlisting"><span class="returnvalue">int</span>                 soup_date_get_hour                  (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);</pre>
537 <p>
538 Gets <em class="parameter"><code>date</code></em>'s hour.
539 </p>
540 <div class="variablelist"><table border="0">
541 <col align="left" valign="top">
542 <tbody>
543 <tr>
544 <td><p><span class="term"><em class="parameter"><code>date</code></em> :</span></p></td>
545 <td>a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a>
546 </td>
547 </tr>
548 <tr>
549 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
550 <td>
551 <em class="parameter"><code>date</code></em>'s hour</td>
552 </tr>
553 </tbody>
554 </table></div>
555 <p class="since">Since 2.32</p>
556 </div>
557 <hr>
558 <div class="refsect2">
559 <a name="soup-date-get-minute"></a><h3>soup_date_get_minute ()</h3>
560 <pre class="programlisting"><span class="returnvalue">int</span>                 soup_date_get_minute                (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);</pre>
561 <p>
562 Gets <em class="parameter"><code>date</code></em>'s minute.
563 </p>
564 <div class="variablelist"><table border="0">
565 <col align="left" valign="top">
566 <tbody>
567 <tr>
568 <td><p><span class="term"><em class="parameter"><code>date</code></em> :</span></p></td>
569 <td>a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a>
570 </td>
571 </tr>
572 <tr>
573 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
574 <td>
575 <em class="parameter"><code>date</code></em>'s minute</td>
576 </tr>
577 </tbody>
578 </table></div>
579 <p class="since">Since 2.32</p>
580 </div>
581 <hr>
582 <div class="refsect2">
583 <a name="soup-date-get-month"></a><h3>soup_date_get_month ()</h3>
584 <pre class="programlisting"><span class="returnvalue">int</span>                 soup_date_get_month                 (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);</pre>
585 <p>
586 Gets <em class="parameter"><code>date</code></em>'s month.
587 </p>
588 <div class="variablelist"><table border="0">
589 <col align="left" valign="top">
590 <tbody>
591 <tr>
592 <td><p><span class="term"><em class="parameter"><code>date</code></em> :</span></p></td>
593 <td>a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a>
594 </td>
595 </tr>
596 <tr>
597 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
598 <td>
599 <em class="parameter"><code>date</code></em>'s month</td>
600 </tr>
601 </tbody>
602 </table></div>
603 <p class="since">Since 2.32</p>
604 </div>
605 <hr>
606 <div class="refsect2">
607 <a name="soup-date-get-offset"></a><h3>soup_date_get_offset ()</h3>
608 <pre class="programlisting"><span class="returnvalue">int</span>                 soup_date_get_offset                (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);</pre>
609 <p>
610 Gets <em class="parameter"><code>date</code></em>'s offset from UTC.
611 </p>
612 <div class="variablelist"><table border="0">
613 <col align="left" valign="top">
614 <tbody>
615 <tr>
616 <td><p><span class="term"><em class="parameter"><code>date</code></em> :</span></p></td>
617 <td>a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a>
618 </td>
619 </tr>
620 <tr>
621 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
622 <td>
623 <em class="parameter"><code>date</code></em>'s offset from UTC. If <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-utc" title="soup_date_get_utc ()"><code class="function">soup_date_get_utc()</code></a>
624 returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> but <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-date-get-offset" title="soup_date_get_offset ()"><code class="function">soup_date_get_offset()</code></a> returns 0, that means the
625 date is a "floating" time with no associated offset information.</td>
626 </tr>
627 </tbody>
628 </table></div>
629 <p class="since">Since 2.32</p>
630 </div>
631 <hr>
632 <div class="refsect2">
633 <a name="soup-date-get-second"></a><h3>soup_date_get_second ()</h3>
634 <pre class="programlisting"><span class="returnvalue">int</span>                 soup_date_get_second                (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);</pre>
635 <p>
636 Gets <em class="parameter"><code>date</code></em>'s second.
637 </p>
638 <div class="variablelist"><table border="0">
639 <col align="left" valign="top">
640 <tbody>
641 <tr>
642 <td><p><span class="term"><em class="parameter"><code>date</code></em> :</span></p></td>
643 <td>a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a>
644 </td>
645 </tr>
646 <tr>
647 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
648 <td>
649 <em class="parameter"><code>date</code></em>'s second</td>
650 </tr>
651 </tbody>
652 </table></div>
653 <p class="since">Since 2.32</p>
654 </div>
655 <hr>
656 <div class="refsect2">
657 <a name="soup-date-get-utc"></a><h3>soup_date_get_utc ()</h3>
658 <pre class="programlisting"><span class="returnvalue">int</span>                 soup_date_get_utc                   (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);</pre>
659 <p>
660 Gets <em class="parameter"><code>date</code></em>'s UTC flag
661 </p>
662 <div class="variablelist"><table border="0">
663 <col align="left" valign="top">
664 <tbody>
665 <tr>
666 <td><p><span class="term"><em class="parameter"><code>date</code></em> :</span></p></td>
667 <td>a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a>
668 </td>
669 </tr>
670 <tr>
671 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
672 <td>
673 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>date</code></em> is UTC.</td>
674 </tr>
675 </tbody>
676 </table></div>
677 <p class="since">Since 2.32</p>
678 </div>
679 <hr>
680 <div class="refsect2">
681 <a name="soup-date-get-year"></a><h3>soup_date_get_year ()</h3>
682 <pre class="programlisting"><span class="returnvalue">int</span>                 soup_date_get_year                  (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);</pre>
683 <p>
684 Gets <em class="parameter"><code>date</code></em>'s year.
685 </p>
686 <div class="variablelist"><table border="0">
687 <col align="left" valign="top">
688 <tbody>
689 <tr>
690 <td><p><span class="term"><em class="parameter"><code>date</code></em> :</span></p></td>
691 <td>a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a>
692 </td>
693 </tr>
694 <tr>
695 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
696 <td>
697 <em class="parameter"><code>date</code></em>'s year</td>
698 </tr>
699 </tbody>
700 </table></div>
701 <p class="since">Since 2.32</p>
702 </div>
703 <hr>
704 <div class="refsect2">
705 <a name="soup-date-free"></a><h3>soup_date_free ()</h3>
706 <pre class="programlisting"><span class="returnvalue">void</span>                soup_date_free                      (<em class="parameter"><code><a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a> *date</code></em>);</pre>
707 <p>
708 Frees <em class="parameter"><code>date</code></em>.
709 </p>
710 <div class="variablelist"><table border="0">
711 <col align="left" valign="top">
712 <tbody><tr>
713 <td><p><span class="term"><em class="parameter"><code>date</code></em> :</span></p></td>
714 <td>a <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#SoupDate"><span class="type">SoupDate</span></a>
715 </td>
716 </tr></tbody>
717 </table></div>
718 </div>
719 <hr>
720 <div class="refsect2">
721 <a name="soup-headers-parse-request"></a><h3>soup_headers_parse_request ()</h3>
722 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               soup_headers_parse_request          (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>,
723                                                          <em class="parameter"><code><span class="type">int</span> len</code></em>,
724                                                          <em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *req_headers</code></em>,
725                                                          <em class="parameter"><code><span class="type">char</span> **req_method</code></em>,
726                                                          <em class="parameter"><code><span class="type">char</span> **req_path</code></em>,
727                                                          <em class="parameter"><code><a class="link" href="SoupMessage.html#SoupHTTPVersion" title="enum SoupHTTPVersion"><span class="type">SoupHTTPVersion</span></a> *ver</code></em>);</pre>
728 <p>
729 Parses the headers of an HTTP request in <em class="parameter"><code>str</code></em> and stores the
730 results in <em class="parameter"><code>req_method</code></em>, <em class="parameter"><code>req_path</code></em>, <em class="parameter"><code>ver</code></em>, and <em class="parameter"><code>req_headers</code></em>.
731 </p>
732 <p>
733 Beware that <em class="parameter"><code>req_headers</code></em> may be modified even on failure.
734 </p>
735 <div class="variablelist"><table border="0">
736 <col align="left" valign="top">
737 <tbody>
738 <tr>
739 <td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
740 <td>the headers (up to, but not including, the trailing blank line)</td>
741 </tr>
742 <tr>
743 <td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td>
744 <td>length of <em class="parameter"><code>str</code></em>
745 </td>
746 </tr>
747 <tr>
748 <td><p><span class="term"><em class="parameter"><code>req_headers</code></em> :</span></p></td>
749 <td>
750 <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> to store the header values in</td>
751 </tr>
752 <tr>
753 <td><p><span class="term"><em class="parameter"><code>req_method</code></em> :</span></p></td>
754 <td>if non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, will be filled in with the
755 request method. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
756 </td>
757 </tr>
758 <tr>
759 <td><p><span class="term"><em class="parameter"><code>req_path</code></em> :</span></p></td>
760 <td>if non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, will be filled in with the
761 request path. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
762 </td>
763 </tr>
764 <tr>
765 <td><p><span class="term"><em class="parameter"><code>ver</code></em> :</span></p></td>
766 <td>if non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, will be filled in with the HTTP
767 version. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
768 </td>
769 </tr>
770 <tr>
771 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
772 <td>
773 <a class="link" href="libsoup-2.4-soup-status.html#SOUP-STATUS-OK:CAPS"><code class="literal">SOUP_STATUS_OK</code></a> if the headers could be parsed, or an
774 HTTP error to be returned to the client if they could not be.</td>
775 </tr>
776 </tbody>
777 </table></div>
778 </div>
779 <hr>
780 <div class="refsect2">
781 <a name="soup-headers-parse-response"></a><h3>soup_headers_parse_response ()</h3>
782 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            soup_headers_parse_response         (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>,
783                                                          <em class="parameter"><code><span class="type">int</span> len</code></em>,
784                                                          <em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *headers</code></em>,
785                                                          <em class="parameter"><code><a class="link" href="SoupMessage.html#SoupHTTPVersion" title="enum SoupHTTPVersion"><span class="type">SoupHTTPVersion</span></a> *ver</code></em>,
786                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *status_code</code></em>,
787                                                          <em class="parameter"><code><span class="type">char</span> **reason_phrase</code></em>);</pre>
788 <p>
789 Parses the headers of an HTTP response in <em class="parameter"><code>str</code></em> and stores the
790 results in <em class="parameter"><code>ver</code></em>, <em class="parameter"><code>status_code</code></em>, <em class="parameter"><code>reason_phrase</code></em>, and <em class="parameter"><code>headers</code></em>.
791 </p>
792 <p>
793 Beware that <em class="parameter"><code>headers</code></em> may be modified even on failure.
794 </p>
795 <div class="variablelist"><table border="0">
796 <col align="left" valign="top">
797 <tbody>
798 <tr>
799 <td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
800 <td>the headers (up to, but not including, the trailing blank line)</td>
801 </tr>
802 <tr>
803 <td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td>
804 <td>length of <em class="parameter"><code>str</code></em>
805 </td>
806 </tr>
807 <tr>
808 <td><p><span class="term"><em class="parameter"><code>headers</code></em> :</span></p></td>
809 <td>
810 <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> to store the header values in</td>
811 </tr>
812 <tr>
813 <td><p><span class="term"><em class="parameter"><code>ver</code></em> :</span></p></td>
814 <td>if non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, will be filled in with the HTTP
815 version. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
816 </td>
817 </tr>
818 <tr>
819 <td><p><span class="term"><em class="parameter"><code>status_code</code></em> :</span></p></td>
820 <td>if non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, will be filled in with
821 the status code. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
822 </td>
823 </tr>
824 <tr>
825 <td><p><span class="term"><em class="parameter"><code>reason_phrase</code></em> :</span></p></td>
826 <td>if non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, will be filled in with
827 the reason phrase. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
828 </td>
829 </tr>
830 <tr>
831 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
832 <td>success or failure.</td>
833 </tr>
834 </tbody>
835 </table></div>
836 </div>
837 <hr>
838 <div class="refsect2">
839 <a name="soup-headers-parse-status-line"></a><h3>soup_headers_parse_status_line ()</h3>
840 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            soup_headers_parse_status_line      (<em class="parameter"><code>const <span class="type">char</span> *status_line</code></em>,
841                                                          <em class="parameter"><code><a class="link" href="SoupMessage.html#SoupHTTPVersion" title="enum SoupHTTPVersion"><span class="type">SoupHTTPVersion</span></a> *ver</code></em>,
842                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *status_code</code></em>,
843                                                          <em class="parameter"><code><span class="type">char</span> **reason_phrase</code></em>);</pre>
844 <p>
845 Parses the HTTP Status-Line string in <em class="parameter"><code>status_line</code></em> into <em class="parameter"><code>ver</code></em>,
846 <em class="parameter"><code>status_code</code></em>, and <em class="parameter"><code>reason_phrase</code></em>. <em class="parameter"><code>status_line</code></em> must be terminated by
847 either "\0" or "\r\n".
848 </p>
849 <div class="variablelist"><table border="0">
850 <col align="left" valign="top">
851 <tbody>
852 <tr>
853 <td><p><span class="term"><em class="parameter"><code>status_line</code></em> :</span></p></td>
854 <td>an HTTP Status-Line</td>
855 </tr>
856 <tr>
857 <td><p><span class="term"><em class="parameter"><code>ver</code></em> :</span></p></td>
858 <td>if non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, will be filled in with the HTTP
859 version. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
860 </td>
861 </tr>
862 <tr>
863 <td><p><span class="term"><em class="parameter"><code>status_code</code></em> :</span></p></td>
864 <td>if non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, will be filled in with
865 the status code. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
866 </td>
867 </tr>
868 <tr>
869 <td><p><span class="term"><em class="parameter"><code>reason_phrase</code></em> :</span></p></td>
870 <td>if non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, will be filled in with
871 the reason phrase. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
872 </td>
873 </tr>
874 <tr>
875 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
876 <td>
877 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>status_line</code></em> was parsed successfully.</td>
878 </tr>
879 </tbody>
880 </table></div>
881 </div>
882 <hr>
883 <div class="refsect2">
884 <a name="soup-headers-parse"></a><h3>soup_headers_parse ()</h3>
885 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            soup_headers_parse                  (<em class="parameter"><code>const <span class="type">char</span> *str</code></em>,
886                                                          <em class="parameter"><code><span class="type">int</span> len</code></em>,
887                                                          <em class="parameter"><code><a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> *dest</code></em>);</pre>
888 <p>
889 Parses the headers of an HTTP request or response in <em class="parameter"><code>str</code></em> and
890 stores the results in <em class="parameter"><code>dest</code></em>. Beware that <em class="parameter"><code>dest</code></em> may be modified even
891 on failure.
892 </p>
893 <p>
894 This is a low-level method; normally you would use
895 <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-headers-parse-request" title="soup_headers_parse_request ()"><code class="function">soup_headers_parse_request()</code></a> or <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-headers-parse-response" title="soup_headers_parse_response ()"><code class="function">soup_headers_parse_response()</code></a>.
896 </p>
897 <div class="variablelist"><table border="0">
898 <col align="left" valign="top">
899 <tbody>
900 <tr>
901 <td><p><span class="term"><em class="parameter"><code>str</code></em> :</span></p></td>
902 <td>the header string (including the Request-Line or Status-Line,
903 but not the trailing blank line)</td>
904 </tr>
905 <tr>
906 <td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td>
907 <td>length of <em class="parameter"><code>str</code></em>
908 </td>
909 </tr>
910 <tr>
911 <td><p><span class="term"><em class="parameter"><code>dest</code></em> :</span></p></td>
912 <td>
913 <a class="link" href="SoupMessageHeaders.html" title="SoupMessageHeaders"><span class="type">SoupMessageHeaders</span></a> to store the header values in</td>
914 </tr>
915 <tr>
916 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
917 <td>success or failure</td>
918 </tr>
919 </tbody>
920 </table></div>
921 <p class="since">Since 2.26</p>
922 </div>
923 <hr>
924 <div class="refsect2">
925 <a name="soup-header-parse-list"></a><h3>soup_header_parse_list ()</h3>
926 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *            soup_header_parse_list              (<em class="parameter"><code>const <span class="type">char</span> *header</code></em>);</pre>
927 <p>
928 Parses a header whose content is described by RFC2616 as
929 "<span class="type">something</span>", where "something" does not itself contain commas,
930 except as part of quoted-strings.
931 </p>
932 <div class="variablelist"><table border="0">
933 <col align="left" valign="top">
934 <tbody>
935 <tr>
936 <td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
937 <td>a header value</td>
938 </tr>
939 <tr>
940 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
941 <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of
942 list elements, as allocated strings. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span>
943 </td>
944 </tr>
945 </tbody>
946 </table></div>
947 </div>
948 <hr>
949 <div class="refsect2">
950 <a name="soup-header-parse-quality-list"></a><h3>soup_header_parse_quality_list ()</h3>
951 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *            soup_header_parse_quality_list      (<em class="parameter"><code>const <span class="type">char</span> *header</code></em>,
952                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> **unacceptable</code></em>);</pre>
953 <p>
954 Parses a header whose content is a list of items with optional
955 "qvalue"s (eg, Accept, Accept-Charset, Accept-Encoding,
956 Accept-Language, TE).
957 </p>
958 <p>
959 If <em class="parameter"><code>unacceptable</code></em> is not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then on return, it will contain the
960 items with qvalue 0. Either way, those items will be removed from
961 the main list.
962 </p>
963 <div class="variablelist"><table border="0">
964 <col align="left" valign="top">
965 <tbody>
966 <tr>
967 <td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
968 <td>a header value</td>
969 </tr>
970 <tr>
971 <td><p><span class="term"><em class="parameter"><code>unacceptable</code></em> :</span></p></td>
972 <td>on
973 return, will contain a list of unacceptable values. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span>
974 </td>
975 </tr>
976 <tr>
977 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
978 <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of
979 acceptable values (as allocated strings), highest-qvalue first. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span>
980 </td>
981 </tr>
982 </tbody>
983 </table></div>
984 </div>
985 <hr>
986 <div class="refsect2">
987 <a name="soup-header-free-list"></a><h3>soup_header_free_list ()</h3>
988 <pre class="programlisting"><span class="returnvalue">void</span>                soup_header_free_list               (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *list</code></em>);</pre>
989 <p>
990 Frees <em class="parameter"><code>list</code></em>.
991 </p>
992 <div class="variablelist"><table border="0">
993 <col align="left" valign="top">
994 <tbody><tr>
995 <td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
996 <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> returned from <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-parse-list" title="soup_header_parse_list ()"><code class="function">soup_header_parse_list()</code></a> or
997 <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-parse-quality-list" title="soup_header_parse_quality_list ()"><code class="function">soup_header_parse_quality_list()</code></a>
998 </td>
999 </tr></tbody>
1000 </table></div>
1001 </div>
1002 <hr>
1003 <div class="refsect2">
1004 <a name="soup-header-contains"></a><h3>soup_header_contains ()</h3>
1005 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            soup_header_contains                (<em class="parameter"><code>const <span class="type">char</span> *header</code></em>,
1006                                                          <em class="parameter"><code>const <span class="type">char</span> *token</code></em>);</pre>
1007 <p>
1008 Parses <em class="parameter"><code>header</code></em> to see if it contains the token <em class="parameter"><code>token</code></em> (matched
1009 case-insensitively). Note that this can't be used with lists
1010 that have qvalues.
1011 </p>
1012 <div class="variablelist"><table border="0">
1013 <col align="left" valign="top">
1014 <tbody>
1015 <tr>
1016 <td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
1017 <td>An HTTP header suitable for parsing with
1018 <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-parse-list" title="soup_header_parse_list ()"><code class="function">soup_header_parse_list()</code></a>
1019 </td>
1020 </tr>
1021 <tr>
1022 <td><p><span class="term"><em class="parameter"><code>token</code></em> :</span></p></td>
1023 <td>a token</td>
1024 </tr>
1025 <tr>
1026 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1027 <td>whether or not <em class="parameter"><code>header</code></em> contains <em class="parameter"><code>token</code></em>
1028 </td>
1029 </tr>
1030 </tbody>
1031 </table></div>
1032 </div>
1033 <hr>
1034 <div class="refsect2">
1035 <a name="soup-header-parse-param-list"></a><h3>soup_header_parse_param_list ()</h3>
1036 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> *        soup_header_parse_param_list        (<em class="parameter"><code>const <span class="type">char</span> *header</code></em>);</pre>
1037 <p>
1038 Parses a header which is a comma-delimited list of something like:
1039 <code class="literal">token [ "=" ( token | quoted-string ) ]</code>.
1040 </p>
1041 <p>
1042 Tokens that don't have an associated value will still be added to
1043 the resulting hash table, but with a <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> value.
1044 </p>
1045 <p>
1046 This also handles RFC5987 encoding (which in HTTP is mostly used
1047 for giving UTF8-encoded filenames in the Content-Disposition
1048 header).
1049 </p>
1050 <div class="variablelist"><table border="0">
1051 <col align="left" valign="top">
1052 <tbody>
1053 <tr>
1054 <td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
1055 <td>a header value</td>
1056 </tr>
1057 <tr>
1058 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1059 <td>a
1060 <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> of list elements, which can be freed with
1061 <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-free-param-list" title="soup_header_free_param_list ()"><code class="function">soup_header_free_param_list()</code></a>. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 utf8][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
1062 </td>
1063 </tr>
1064 </tbody>
1065 </table></div>
1066 </div>
1067 <hr>
1068 <div class="refsect2">
1069 <a name="soup-header-parse-semi-param-list"></a><h3>soup_header_parse_semi_param_list ()</h3>
1070 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="returnvalue">GHashTable</span></a> *        soup_header_parse_semi_param_list   (<em class="parameter"><code>const <span class="type">char</span> *header</code></em>);</pre>
1071 <p>
1072 Parses a header which is a semicolon-delimited list of something
1073 like: <code class="literal">token [ "=" ( token | quoted-string ) ]</code>.
1074 </p>
1075 <p>
1076 Tokens that don't have an associated value will still be added to
1077 the resulting hash table, but with a <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> value.
1078 </p>
1079 <p>
1080 This also handles RFC5987 encoding (which in HTTP is mostly used
1081 for giving UTF8-encoded filenames in the Content-Disposition
1082 header).
1083 </p>
1084 <div class="variablelist"><table border="0">
1085 <col align="left" valign="top">
1086 <tbody>
1087 <tr>
1088 <td><p><span class="term"><em class="parameter"><code>header</code></em> :</span></p></td>
1089 <td>a header value</td>
1090 </tr>
1091 <tr>
1092 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1093 <td>a
1094 <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> of list elements, which can be freed with
1095 <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-free-param-list" title="soup_header_free_param_list ()"><code class="function">soup_header_free_param_list()</code></a>. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 utf8][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
1096 </td>
1097 </tr>
1098 </tbody>
1099 </table></div>
1100 <p class="since">Since 2.24</p>
1101 </div>
1102 <hr>
1103 <div class="refsect2">
1104 <a name="soup-header-free-param-list"></a><h3>soup_header_free_param_list ()</h3>
1105 <pre class="programlisting"><span class="returnvalue">void</span>                soup_header_free_param_list         (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *param_list</code></em>);</pre>
1106 <p>
1107 Frees <em class="parameter"><code>param_list</code></em>.
1108 </p>
1109 <div class="variablelist"><table border="0">
1110 <col align="left" valign="top">
1111 <tbody><tr>
1112 <td><p><span class="term"><em class="parameter"><code>param_list</code></em> :</span></p></td>
1113 <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> returned from <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-parse-param-list" title="soup_header_parse_param_list ()"><code class="function">soup_header_parse_param_list()</code></a>
1114 or <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-parse-semi-param-list" title="soup_header_parse_semi_param_list ()"><code class="function">soup_header_parse_semi_param_list()</code></a>. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8 utf8]</span>
1115 </td>
1116 </tr></tbody>
1117 </table></div>
1118 </div>
1119 <hr>
1120 <div class="refsect2">
1121 <a name="soup-header-g-string-append-param"></a><h3>soup_header_g_string_append_param ()</h3>
1122 <pre class="programlisting"><span class="returnvalue">void</span>                soup_header_g_string_append_param   (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Strings.html#GString"><span class="type">GString</span></a> *string</code></em>,
1123                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
1124                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre>
1125 <p>
1126 Appends something like <code class="literal"><em class="parameter"><code>name</code></em>=<em class="parameter"><code>value</code></em></code> to <em class="parameter"><code>string</code></em>,
1127 taking care to quote <em class="parameter"><code>value</code></em> if needed, and if so, to escape any
1128 quotes or backslashes in <em class="parameter"><code>value</code></em>.
1129 </p>
1130 <p>
1131 Alternatively, if <em class="parameter"><code>value</code></em> is a non-ASCII UTF-8 string, it will be
1132 appended using RFC5987 syntax. Although in theory this is supposed
1133 to work anywhere in HTTP that uses this style of parameter, in
1134 reality, it can only be used portably with the Content-Disposition
1135 "filename" parameter.
1136 </p>
1137 <p>
1138 If <em class="parameter"><code>value</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, this will just append <em class="parameter"><code>name</code></em> to <em class="parameter"><code>string</code></em>.
1139 </p>
1140 <div class="variablelist"><table border="0">
1141 <col align="left" valign="top">
1142 <tbody>
1143 <tr>
1144 <td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
1145 <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Strings.html#GString"><span class="type">GString</span></a> being used to construct an HTTP header value</td>
1146 </tr>
1147 <tr>
1148 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
1149 <td>a parameter name</td>
1150 </tr>
1151 <tr>
1152 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
1153 <td>a parameter value, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
1154 </td>
1155 </tr>
1156 </tbody>
1157 </table></div>
1158 <p class="since">Since 2.26</p>
1159 </div>
1160 <hr>
1161 <div class="refsect2">
1162 <a name="soup-header-g-string-append-param-quoted"></a><h3>soup_header_g_string_append_param_quoted ()</h3>
1163 <pre class="programlisting"><span class="returnvalue">void</span>                soup_header_g_string_append_param_quoted
1164                                                         (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Strings.html#GString"><span class="type">GString</span></a> *string</code></em>,
1165                                                          <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
1166                                                          <em class="parameter"><code>const <span class="type">char</span> *value</code></em>);</pre>
1167 <p>
1168 Appends something like <code class="literal"><em class="parameter"><code>name</code></em>="<em class="parameter"><code>value</code></em>"</code> to
1169 <em class="parameter"><code>string</code></em>, taking care to escape any quotes or backslashes in <em class="parameter"><code>value</code></em>.
1170 </p>
1171 <p>
1172 If <em class="parameter"><code>value</code></em> is (non-ASCII) UTF-8, this will instead use RFC 5987
1173 encoding, just like <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-header-g-string-append-param" title="soup_header_g_string_append_param ()"><code class="function">soup_header_g_string_append_param()</code></a>.
1174 </p>
1175 <div class="variablelist"><table border="0">
1176 <col align="left" valign="top">
1177 <tbody>
1178 <tr>
1179 <td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
1180 <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Strings.html#GString"><span class="type">GString</span></a> being used to construct an HTTP header value</td>
1181 </tr>
1182 <tr>
1183 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
1184 <td>a parameter name</td>
1185 </tr>
1186 <tr>
1187 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
1188 <td>a parameter value</td>
1189 </tr>
1190 </tbody>
1191 </table></div>
1192 <p class="since">Since 2.30</p>
1193 </div>
1194 <hr>
1195 <div class="refsect2">
1196 <a name="soup-str-case-equal"></a><h3>soup_str_case_equal ()</h3>
1197 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            soup_str_case_equal                 (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> v1</code></em>,
1198                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> v2</code></em>);</pre>
1199 <p>
1200 Compares <em class="parameter"><code>v1</code></em> and <em class="parameter"><code>v2</code></em> in a case-insensitive manner
1201 </p>
1202 <div class="variablelist"><table border="0">
1203 <col align="left" valign="top">
1204 <tbody>
1205 <tr>
1206 <td><p><span class="term"><em class="parameter"><code>v1</code></em> :</span></p></td>
1207 <td>an ASCII string</td>
1208 </tr>
1209 <tr>
1210 <td><p><span class="term"><em class="parameter"><code>v2</code></em> :</span></p></td>
1211 <td>another ASCII string</td>
1212 </tr>
1213 <tr>
1214 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1215 <td>
1216 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if they are equal (modulo case)</td>
1217 </tr>
1218 </tbody>
1219 </table></div>
1220 </div>
1221 <hr>
1222 <div class="refsect2">
1223 <a name="soup-str-case-hash"></a><h3>soup_str_case_hash ()</h3>
1224 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               soup_str_case_hash                  (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> key</code></em>);</pre>
1225 <p>
1226 Hashes <em class="parameter"><code>key</code></em> in a case-insensitive manner.
1227 </p>
1228 <div class="variablelist"><table border="0">
1229 <col align="left" valign="top">
1230 <tbody>
1231 <tr>
1232 <td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
1233 <td>ASCII string to hash</td>
1234 </tr>
1235 <tr>
1236 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1237 <td>the hash code.</td>
1238 </tr>
1239 </tbody>
1240 </table></div>
1241 </div>
1242 <hr>
1243 <div class="refsect2">
1244 <a name="soup-add-completion"></a><h3>soup_add_completion ()</h3>
1245 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSource"><span class="returnvalue">GSource</span></a> *           soup_add_completion                 (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> *async_context</code></em>,
1246                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSourceFunc"><span class="type">GSourceFunc</span></a> function</code></em>,
1247                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
1248 <p>
1249 Adds <em class="parameter"><code>function</code></em> to be executed from inside <em class="parameter"><code>async_context</code></em> with the
1250 default priority. Use this when you want to complete an action in
1251 <em class="parameter"><code>async_context</code></em>'s main loop, as soon as possible.
1252 </p>
1253 <div class="variablelist"><table border="0">
1254 <col align="left" valign="top">
1255 <tbody>
1256 <tr>
1257 <td><p><span class="term"><em class="parameter"><code>async_context</code></em> :</span></p></td>
1258 <td>the <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> to dispatch the I/O
1259 watch in, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for the default context. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
1260 </td>
1261 </tr>
1262 <tr>
1263 <td><p><span class="term"><em class="parameter"><code>function</code></em> :</span></p></td>
1264 <td>the callback to invoke</td>
1265 </tr>
1266 <tr>
1267 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
1268 <td>user data to pass to <em class="parameter"><code>function</code></em>
1269 </td>
1270 </tr>
1271 <tr>
1272 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1273 <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSource"><span class="type">GSource</span></a>, which can be removed from <em class="parameter"><code>async_context</code></em>
1274 with <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#g-source-destroy"><code class="function">g_source_destroy()</code></a>.</td>
1275 </tr>
1276 </tbody>
1277 </table></div>
1278 <p class="since">Since 2.24</p>
1279 </div>
1280 <hr>
1281 <div class="refsect2">
1282 <a name="soup-add-idle"></a><h3>soup_add_idle ()</h3>
1283 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSource"><span class="returnvalue">GSource</span></a> *           soup_add_idle                       (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> *async_context</code></em>,
1284                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSourceFunc"><span class="type">GSourceFunc</span></a> function</code></em>,
1285                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
1286 <p>
1287 Adds an idle event as with <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#g-idle-add"><code class="function">g_idle_add()</code></a>, but using the given
1288 <em class="parameter"><code>async_context</code></em>.
1289 </p>
1290 <p>
1291 If you want <em class="parameter"><code>function</code></em> to run "right away", use
1292 <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-add-completion" title="soup_add_completion ()"><code class="function">soup_add_completion()</code></a>, since that sets a higher priority on the
1293 <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSource"><span class="type">GSource</span></a> than <a class="link" href="libsoup-2.4-Soup-Miscellaneous-Utilities.html#soup-add-idle" title="soup_add_idle ()"><code class="function">soup_add_idle()</code></a> does.
1294 </p>
1295 <div class="variablelist"><table border="0">
1296 <col align="left" valign="top">
1297 <tbody>
1298 <tr>
1299 <td><p><span class="term"><em class="parameter"><code>async_context</code></em> :</span></p></td>
1300 <td>the <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> to dispatch the I/O
1301 watch in, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for the default context. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
1302 </td>
1303 </tr>
1304 <tr>
1305 <td><p><span class="term"><em class="parameter"><code>function</code></em> :</span></p></td>
1306 <td>the callback to invoke at idle time</td>
1307 </tr>
1308 <tr>
1309 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
1310 <td>user data to pass to <em class="parameter"><code>function</code></em>
1311 </td>
1312 </tr>
1313 <tr>
1314 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1315 <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSource"><span class="type">GSource</span></a>, which can be removed from <em class="parameter"><code>async_context</code></em>
1316 with <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#g-source-destroy"><code class="function">g_source_destroy()</code></a>.</td>
1317 </tr>
1318 </tbody>
1319 </table></div>
1320 </div>
1321 <hr>
1322 <div class="refsect2">
1323 <a name="soup-add-io-watch"></a><h3>soup_add_io_watch ()</h3>
1324 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSource"><span class="returnvalue">GSource</span></a> *           soup_add_io_watch                   (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> *async_context</code></em>,
1325                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#GIOChannel"><span class="type">GIOChannel</span></a> *chan</code></em>,
1326                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#GIOCondition"><span class="type">GIOCondition</span></a> condition</code></em>,
1327                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#GIOFunc"><span class="type">GIOFunc</span></a> function</code></em>,
1328                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
1329 <p>
1330 Adds an I/O watch as with <a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#g-io-add-watch"><code class="function">g_io_add_watch()</code></a>, but using the given
1331 <em class="parameter"><code>async_context</code></em>.
1332 </p>
1333 <div class="variablelist"><table border="0">
1334 <col align="left" valign="top">
1335 <tbody>
1336 <tr>
1337 <td><p><span class="term"><em class="parameter"><code>async_context</code></em> :</span></p></td>
1338 <td>the <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> to dispatch the I/O
1339 watch in, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for the default context. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
1340 </td>
1341 </tr>
1342 <tr>
1343 <td><p><span class="term"><em class="parameter"><code>chan</code></em> :</span></p></td>
1344 <td>the <a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#GIOChannel"><span class="type">GIOChannel</span></a> to watch</td>
1345 </tr>
1346 <tr>
1347 <td><p><span class="term"><em class="parameter"><code>condition</code></em> :</span></p></td>
1348 <td>the condition to watch for</td>
1349 </tr>
1350 <tr>
1351 <td><p><span class="term"><em class="parameter"><code>function</code></em> :</span></p></td>
1352 <td>the callback to invoke when <em class="parameter"><code>condition</code></em> occurs</td>
1353 </tr>
1354 <tr>
1355 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
1356 <td>user data to pass to <em class="parameter"><code>function</code></em>
1357 </td>
1358 </tr>
1359 <tr>
1360 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1361 <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSource"><span class="type">GSource</span></a>, which can be removed from <em class="parameter"><code>async_context</code></em>
1362 with <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#g-source-destroy"><code class="function">g_source_destroy()</code></a>.</td>
1363 </tr>
1364 </tbody>
1365 </table></div>
1366 </div>
1367 <hr>
1368 <div class="refsect2">
1369 <a name="soup-add-timeout"></a><h3>soup_add_timeout ()</h3>
1370 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSource"><span class="returnvalue">GSource</span></a> *           soup_add_timeout                    (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> *async_context</code></em>,
1371                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> interval</code></em>,
1372                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSourceFunc"><span class="type">GSourceFunc</span></a> function</code></em>,
1373                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
1374 <p>
1375 Adds a timeout as with <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#g-timeout-add"><code class="function">g_timeout_add()</code></a>, but using the given
1376 <em class="parameter"><code>async_context</code></em>.
1377 </p>
1378 <div class="variablelist"><table border="0">
1379 <col align="left" valign="top">
1380 <tbody>
1381 <tr>
1382 <td><p><span class="term"><em class="parameter"><code>async_context</code></em> :</span></p></td>
1383 <td>the <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GMainContext"><span class="type">GMainContext</span></a> to dispatch the I/O
1384 watch in, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> for the default context. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
1385 </td>
1386 </tr>
1387 <tr>
1388 <td><p><span class="term"><em class="parameter"><code>interval</code></em> :</span></p></td>
1389 <td>the timeout interval, in milliseconds</td>
1390 </tr>
1391 <tr>
1392 <td><p><span class="term"><em class="parameter"><code>function</code></em> :</span></p></td>
1393 <td>the callback to invoke at timeout time</td>
1394 </tr>
1395 <tr>
1396 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
1397 <td>user data to pass to <em class="parameter"><code>function</code></em>
1398 </td>
1399 </tr>
1400 <tr>
1401 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1402 <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#GSource"><span class="type">GSource</span></a>, which can be removed from <em class="parameter"><code>async_context</code></em>
1403 with <a href="http://library.gnome.org/devel/glib/unstable/glib-The-Main-Event-Loop.html#g-source-destroy"><code class="function">g_source_destroy()</code></a>.</td>
1404 </tr>
1405 </tbody>
1406 </table></div>
1407 </div>
1408 <hr>
1409 <div class="refsect2">
1410 <a name="soup-ssl-supported"></a><h3>soup_ssl_supported</h3>
1411 <pre class="programlisting">extern const gboolean soup_ssl_supported;
1412 </pre>
1413 <p>
1414 </p>
1415 </div>
1416 </div>
1417 </div>
1418 <div class="footer">
1419 <hr>
1420           Generated by GTK-Doc V1.18</div>
1421 </body>
1422 </html>