← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/libsoup2.4/jaunty-proposed

« back to all changes in this revision

Viewing changes to docs/reference/html/SoupAddress.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2008-12-17 14:51:11 UTC
  • mfrom: (1.1.12 upstream)
  • Revision ID: james.westby@ubuntu.com-20081217145111-sqbz10l57fmrh4vz
Tags: 2.25.4-0ubuntu1
* New upstream version
* debian/control.in:
  - build-depends on libgconf2-dev, libproxy-dev
* Updated to list the new libsoup-gnome binaries
* debian/rules:
  - updated shlibs version and list the new library

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/html/SoupAddress.html
5
5
<title>SoupAddress</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
7
7
<link rel="home" href="index.html" title="libsoup Reference Manual">
8
 
<link rel="up" href="ch02.html" title="API Reference">
9
 
<link rel="prev" href="ch02.html" title="API Reference">
10
 
<link rel="next" href="SoupAuth.html" title="SoupAuth">
11
 
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
 
8
<link rel="up" href="ch05.html" title="Low-level Networking API">
 
9
<link rel="prev" href="ch05.html" title="Low-level Networking API">
 
10
<link rel="next" href="SoupSocket.html" title="SoupSocket">
 
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="chapter" href="ch01.html" title="Tutorial">
14
 
<link rel="chapter" href="ch02.html" title="API Reference">
 
14
<link rel="chapter" href="ch02.html" title="Core API">
 
15
<link rel="chapter" href="ch03.html" title="Web Services APIs">
 
16
<link rel="chapter" href="ch04.html" title="GNOME integration">
 
17
<link rel="chapter" href="ch05.html" title="Low-level Networking API">
15
18
<link rel="index" href="ix01.html" title="Index">
16
19
</head>
17
20
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
18
21
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
19
22
<tr valign="middle">
20
 
<td><a accesskey="p" href="ch02.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
21
 
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
23
<td><a accesskey="p" href="ch05.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
24
<td><a accesskey="u" href="ch05.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
22
25
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
23
26
<th width="100%" align="center">libsoup Reference Manual</th>
24
 
<td><a accesskey="n" href="SoupAuth.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
27
<td><a accesskey="n" href="SoupSocket.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
25
28
</tr>
26
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#SoupAddress.synopsis" class="shortcut">Top</a>
27
 
                   | 
28
 
                  <a href="#SoupAddress.description" class="shortcut">Description</a>
29
 
                   | 
30
 
                  <a href="#SoupAddress.object-hierarchy" class="shortcut">Object Hierarchy</a>
31
 
                   | 
32
 
                  <a href="#SoupAddress.properties" class="shortcut">Properties</a></nobr></td></tr>
 
29
<tr><td colspan="5" class="shortcuts">
 
30
<a href="#SoupAddress.synopsis" class="shortcut">Top</a>
 
31
                 | 
 
32
                <a href="#SoupAddress.description" class="shortcut">Description</a>
 
33
                 | 
 
34
                <a href="#SoupAddress.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
35
                 | 
 
36
                <a href="#SoupAddress.properties" class="shortcut">Properties</a>
 
37
</td></tr>
33
38
</table>
34
39
<div class="refentry" lang="en">
35
40
<a name="SoupAddress"></a><div class="titlepage"></div>
45
50
<pre class="synopsis">
46
51
struct              <a class="link" href="SoupAddress.html#SoupAddress-struct" title="struct SoupAddress">SoupAddress</a>;
47
52
enum                <a class="link" href="SoupAddress.html#SoupAddressFamily" title="enum SoupAddressFamily">SoupAddressFamily</a>;
48
 
#define             <a class="link" href="SoupAddress.html#SOUP-ADDRESS-ANY-PORT:CAPS" title="SOUP_ADDRESS_ANY_PORT">SOUP_ADDRESS_ANY_PORT</a>
49
 
<a class="link" href="SoupAddress.html" title="SoupAddress">SoupAddress</a>*        <a class="link" href="SoupAddress.html#soup-address-new" title="soup_address_new ()">soup_address_new</a>                    (const char *name,
 
53
#define             <a class="link" href="SoupAddress.html#SOUP-ADDRESS-ANY-PORT--CAPS" title="SOUP_ADDRESS_ANY_PORT">SOUP_ADDRESS_ANY_PORT</a>
 
54
<a class="link" href="SoupAddress.html" title="SoupAddress">SoupAddress</a> *       <a class="link" href="SoupAddress.html#soup-address-new" title="soup_address_new ()">soup_address_new</a>                    (const char *name,
50
55
                                                         <a
51
56
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
52
57
>guint</a> port);
53
 
<a class="link" href="SoupAddress.html" title="SoupAddress">SoupAddress</a>*        <a class="link" href="SoupAddress.html#soup-address-new-from-sockaddr" title="soup_address_new_from_sockaddr ()">soup_address_new_from_sockaddr</a>      (struct sockaddr *sa,
 
58
<a class="link" href="SoupAddress.html" title="SoupAddress">SoupAddress</a> *       <a class="link" href="SoupAddress.html#soup-address-new-from-sockaddr" title="soup_address_new_from_sockaddr ()">soup_address_new_from_sockaddr</a>      (struct sockaddr *sa,
54
59
                                                         int len);
55
 
<a class="link" href="SoupAddress.html" title="SoupAddress">SoupAddress</a>*        <a class="link" href="SoupAddress.html#soup-address-new-any" title="soup_address_new_any ()">soup_address_new_any</a>                (<a class="link" href="SoupAddress.html#SoupAddressFamily" title="enum SoupAddressFamily">SoupAddressFamily</a> family,
 
60
<a class="link" href="SoupAddress.html" title="SoupAddress">SoupAddress</a> *       <a class="link" href="SoupAddress.html#soup-address-new-any" title="soup_address_new_any ()">soup_address_new_any</a>                (<a class="link" href="SoupAddress.html#SoupAddressFamily" title="enum SoupAddressFamily">SoupAddressFamily</a> family,
56
61
                                                         <a
57
62
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
58
63
>guint</a> port);
81
86
                                                         <a
82
87
href="/usr/share/gtk-doc/html/gio/GCancellable.html"
83
88
>GCancellable</a> *cancellable);
 
89
<a
 
90
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
91
>gboolean</a>            <a class="link" href="SoupAddress.html#soup-address-is-resolved" title="soup_address_is_resolved ()">soup_address_is_resolved</a>            (<a class="link" href="SoupAddress.html" title="SoupAddress">SoupAddress</a> *addr);
84
92
 
85
 
const char*         <a class="link" href="SoupAddress.html#soup-address-get-name" title="soup_address_get_name ()">soup_address_get_name</a>               (<a class="link" href="SoupAddress.html" title="SoupAddress">SoupAddress</a> *addr);
86
 
struct sockaddr*    <a class="link" href="SoupAddress.html#soup-address-get-sockaddr" title="soup_address_get_sockaddr ()">soup_address_get_sockaddr</a>           (<a class="link" href="SoupAddress.html" title="SoupAddress">SoupAddress</a> *addr,
 
93
const char *        <a class="link" href="SoupAddress.html#soup-address-get-name" title="soup_address_get_name ()">soup_address_get_name</a>               (<a class="link" href="SoupAddress.html" title="SoupAddress">SoupAddress</a> *addr);
 
94
struct sockaddr *   <a class="link" href="SoupAddress.html#soup-address-get-sockaddr" title="soup_address_get_sockaddr ()">soup_address_get_sockaddr</a>           (<a class="link" href="SoupAddress.html" title="SoupAddress">SoupAddress</a> *addr,
87
95
                                                         int *len);
88
 
const char*         <a class="link" href="SoupAddress.html#soup-address-get-physical" title="soup_address_get_physical ()">soup_address_get_physical</a>           (<a class="link" href="SoupAddress.html" title="SoupAddress">SoupAddress</a> *addr);
 
96
const char *        <a class="link" href="SoupAddress.html#soup-address-get-physical" title="soup_address_get_physical ()">soup_address_get_physical</a>           (<a class="link" href="SoupAddress.html" title="SoupAddress">SoupAddress</a> *addr);
89
97
<a
90
98
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
91
99
>guint</a>               <a class="link" href="SoupAddress.html#soup-address-get-port" title="soup_address_get_port ()">soup_address_get_port</a>               (<a class="link" href="SoupAddress.html" title="SoupAddress">SoupAddress</a> *addr);
92
100
 
93
 
#define             <a class="link" href="SoupAddress.html#SOUP-ADDRESS-FAMILY:CAPS" title="SOUP_ADDRESS_FAMILY">SOUP_ADDRESS_FAMILY</a>
94
 
#define             <a class="link" href="SoupAddress.html#SOUP-ADDRESS-NAME:CAPS" title="SOUP_ADDRESS_NAME">SOUP_ADDRESS_NAME</a>
95
 
#define             <a class="link" href="SoupAddress.html#SOUP-ADDRESS-PHYSICAL:CAPS" title="SOUP_ADDRESS_PHYSICAL">SOUP_ADDRESS_PHYSICAL</a>
96
 
#define             <a class="link" href="SoupAddress.html#SOUP-ADDRESS-PORT:CAPS" title="SOUP_ADDRESS_PORT">SOUP_ADDRESS_PORT</a>
97
 
#define             <a class="link" href="SoupAddress.html#SOUP-ADDRESS-SOCKADDR:CAPS" title="SOUP_ADDRESS_SOCKADDR">SOUP_ADDRESS_SOCKADDR</a>
 
101
<a
 
102
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
103
>gboolean</a>            <a class="link" href="SoupAddress.html#soup-address-equal-by-name" title="soup_address_equal_by_name ()">soup_address_equal_by_name</a>          (<a
 
104
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gconstpointer"
 
105
>gconstpointer</a> addr1,
 
106
                                                         <a
 
107
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gconstpointer"
 
108
>gconstpointer</a> addr2);
 
109
<a
 
110
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
 
111
>guint</a>               <a class="link" href="SoupAddress.html#soup-address-hash-by-name" title="soup_address_hash_by_name ()">soup_address_hash_by_name</a>           (<a
 
112
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gconstpointer"
 
113
>gconstpointer</a> addr);
 
114
<a
 
115
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
116
>gboolean</a>            <a class="link" href="SoupAddress.html#soup-address-equal-by-ip" title="soup_address_equal_by_ip ()">soup_address_equal_by_ip</a>            (<a
 
117
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gconstpointer"
 
118
>gconstpointer</a> addr1,
 
119
                                                         <a
 
120
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gconstpointer"
 
121
>gconstpointer</a> addr2);
 
122
<a
 
123
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
 
124
>guint</a>               <a class="link" href="SoupAddress.html#soup-address-hash-by-ip" title="soup_address_hash_by_ip ()">soup_address_hash_by_ip</a>             (<a
 
125
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gconstpointer"
 
126
>gconstpointer</a> addr);
 
127
 
 
128
#define             <a class="link" href="SoupAddress.html#SOUP-ADDRESS-FAMILY--CAPS" title="SOUP_ADDRESS_FAMILY">SOUP_ADDRESS_FAMILY</a>
 
129
#define             <a class="link" href="SoupAddress.html#SOUP-ADDRESS-NAME--CAPS" title="SOUP_ADDRESS_NAME">SOUP_ADDRESS_NAME</a>
 
130
#define             <a class="link" href="SoupAddress.html#SOUP-ADDRESS-PHYSICAL--CAPS" title="SOUP_ADDRESS_PHYSICAL">SOUP_ADDRESS_PHYSICAL</a>
 
131
#define             <a class="link" href="SoupAddress.html#SOUP-ADDRESS-PORT--CAPS" title="SOUP_ADDRESS_PORT">SOUP_ADDRESS_PORT</a>
 
132
#define             <a class="link" href="SoupAddress.html#SOUP-ADDRESS-SOCKADDR--CAPS" title="SOUP_ADDRESS_SOCKADDR">SOUP_ADDRESS_SOCKADDR</a>
98
133
</pre>
99
134
</div>
100
135
<div class="refsect1" lang="en">
135
170
If libsoup was built with IPv6 support, <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> will allow
136
171
both IPv4 and IPv6 addresses.</p>
137
172
<p>
138
 
 
139
173
</p>
140
174
</div>
141
175
<div class="refsect1" lang="en">
144
178
<a name="SoupAddress-struct"></a><h3>struct SoupAddress</h3>
145
179
<pre class="programlisting">struct SoupAddress;</pre>
146
180
<p>
147
 
 
148
181
</p>
149
182
</div>
150
183
<hr>
159
192
</pre>
160
193
<p>
161
194
The supported address families. Note that the
162
 
<a class="link" href="SoupAddress.html#SOUP-ADDRESS-FAMILY-IPV6:CAPS"><code class="literal">SOUP_ADDRESS_FAMILY_IPV6</code></a> constant is available even if libsoup was
 
195
<a class="link" href="SoupAddress.html#SOUP-ADDRESS-FAMILY-IPV6--CAPS"><code class="literal">SOUP_ADDRESS_FAMILY_IPV6</code></a> constant is available even if libsoup was
163
196
built without IPv6 support, but attempting to create an IPv6
164
197
address will fail in that case.</p>
165
198
<p>
166
 
 
167
199
</p>
168
200
<div class="variablelist"><table border="0">
169
201
<col align="left" valign="top">
170
202
<tbody>
171
203
<tr>
172
 
<td><p><a name="SOUP-ADDRESS-FAMILY-INVALID:CAPS"></a><span class="term"><code class="literal">SOUP_ADDRESS_FAMILY_INVALID</code></span></p></td>
 
204
<td><p><a name="SOUP-ADDRESS-FAMILY-INVALID--CAPS"></a><span class="term"><code class="literal">SOUP_ADDRESS_FAMILY_INVALID</code></span></p></td>
173
205
<td> an invalid <a class="link" href="SoupAddress.html" title="SoupAddress"><code class="literal">SoupAddress</code></a>
174
206
</td>
175
207
</tr>
176
208
<tr>
177
 
<td><p><a name="SOUP-ADDRESS-FAMILY-IPV4:CAPS"></a><span class="term"><code class="literal">SOUP_ADDRESS_FAMILY_IPV4</code></span></p></td>
 
209
<td><p><a name="SOUP-ADDRESS-FAMILY-IPV4--CAPS"></a><span class="term"><code class="literal">SOUP_ADDRESS_FAMILY_IPV4</code></span></p></td>
178
210
<td> an IPv4 address
179
211
</td>
180
212
</tr>
181
213
<tr>
182
 
<td><p><a name="SOUP-ADDRESS-FAMILY-IPV6:CAPS"></a><span class="term"><code class="literal">SOUP_ADDRESS_FAMILY_IPV6</code></span></p></td>
 
214
<td><p><a name="SOUP-ADDRESS-FAMILY-IPV6--CAPS"></a><span class="term"><code class="literal">SOUP_ADDRESS_FAMILY_IPV6</code></span></p></td>
183
215
<td> an IPv6 address
184
216
</td>
185
217
</tr>
188
220
</div>
189
221
<hr>
190
222
<div class="refsect2" lang="en">
191
 
<a name="SOUP-ADDRESS-ANY-PORT:CAPS"></a><h3>SOUP_ADDRESS_ANY_PORT</h3>
 
223
<a name="SOUP-ADDRESS-ANY-PORT--CAPS"></a><h3>SOUP_ADDRESS_ANY_PORT</h3>
192
224
<pre class="programlisting">#define SOUP_ADDRESS_ANY_PORT 0
193
225
</pre>
194
226
<p>
195
227
This can be passed to any <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> method that expects a port,
196
228
to indicate that you don't care what port is used.</p>
197
229
<p>
198
 
 
199
230
</p>
200
231
</div>
201
232
<hr>
202
233
<div class="refsect2" lang="en">
203
234
<a name="soup-address-new"></a><h3>soup_address_new ()</h3>
204
 
<pre class="programlisting"><a class="link" href="SoupAddress.html" title="SoupAddress">SoupAddress</a>*        soup_address_new                    (const char *name,
 
235
<pre class="programlisting"><a class="link" href="SoupAddress.html" title="SoupAddress">SoupAddress</a> *       soup_address_new                    (const char *name,
205
236
                                                         <a
206
237
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
207
238
>guint</a> port);</pre>
211
242
<a class="link" href="SoupAddress.html#soup-address-resolve-async" title="soup_address_resolve_async ()"><code class="function">soup_address_resolve_async()</code></a> or <a class="link" href="SoupAddress.html#soup-address-resolve-sync" title="soup_address_resolve_sync ()"><code class="function">soup_address_resolve_sync()</code></a> to
212
243
force a DNS resolution.</p>
213
244
<p>
214
 
 
215
245
</p>
216
246
<div class="variablelist"><table border="0">
217
247
<col align="left" valign="top">
237
267
<hr>
238
268
<div class="refsect2" lang="en">
239
269
<a name="soup-address-new-from-sockaddr"></a><h3>soup_address_new_from_sockaddr ()</h3>
240
 
<pre class="programlisting"><a class="link" href="SoupAddress.html" title="SoupAddress">SoupAddress</a>*        soup_address_new_from_sockaddr      (struct sockaddr *sa,
 
270
<pre class="programlisting"><a class="link" href="SoupAddress.html" title="SoupAddress">SoupAddress</a> *       soup_address_new_from_sockaddr      (struct sockaddr *sa,
241
271
                                                         int len);</pre>
242
272
<p>
243
273
Returns a <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> equivalent to <em class="parameter"><code>sa</code></em> (or <a
244
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
274
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
245
275
><code class="literal">NULL</code></a> if <em class="parameter"><code>sa</code></em>'s
246
276
address family isn't supported)</p>
247
277
<p>
248
 
 
249
278
</p>
250
279
<div class="variablelist"><table border="0">
251
280
<col align="left" valign="top">
271
300
<hr>
272
301
<div class="refsect2" lang="en">
273
302
<a name="soup-address-new-any"></a><h3>soup_address_new_any ()</h3>
274
 
<pre class="programlisting"><a class="link" href="SoupAddress.html" title="SoupAddress">SoupAddress</a>*        soup_address_new_any                (<a class="link" href="SoupAddress.html#SoupAddressFamily" title="enum SoupAddressFamily">SoupAddressFamily</a> family,
 
303
<pre class="programlisting"><a class="link" href="SoupAddress.html" title="SoupAddress">SoupAddress</a> *       soup_address_new_any                (<a class="link" href="SoupAddress.html#SoupAddressFamily" title="enum SoupAddressFamily">SoupAddressFamily</a> family,
275
304
                                                         <a
276
305
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
277
306
>guint</a> port);</pre>
278
307
<p>
279
308
Returns a <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> corresponding to the "any" address
280
309
for <em class="parameter"><code>family</code></em> (or <a
281
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
310
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
282
311
><code class="literal">NULL</code></a> if <em class="parameter"><code>family</code></em> isn't supported), suitable for
283
312
passing to <code class="function">soup_socket_server_new()</code>.</p>
284
313
<p>
285
 
 
286
314
</p>
287
315
<div class="variablelist"><table border="0">
288
316
<col align="left" valign="top">
294
322
</tr>
295
323
<tr>
296
324
<td><p><span class="term"><em class="parameter"><code>port</code></em> :</span></p></td>
297
 
<td> the port number (usually <a class="link" href="SoupAddress.html#SOUP-ADDRESS-ANY-PORT:CAPS" title="SOUP_ADDRESS_ANY_PORT"><code class="literal">SOUP_ADDRESS_ANY_PORT</code></a>)
 
325
<td> the port number (usually <a class="link" href="SoupAddress.html#SOUP-ADDRESS-ANY-PORT--CAPS" title="SOUP_ADDRESS_ANY_PORT"><code class="literal">SOUP_ADDRESS_ANY_PORT</code></a>)
298
326
</td>
299
327
</tr>
300
328
<tr>
318
346
<p>
319
347
The callback function passed to <a class="link" href="SoupAddress.html#soup-address-resolve-async" title="soup_address_resolve_async ()"><code class="function">soup_address_resolve_async()</code></a>.</p>
320
348
<p>
321
 
 
322
349
</p>
323
350
<div class="variablelist"><table border="0">
324
351
<col align="left" valign="top">
330
357
</tr>
331
358
<tr>
332
359
<td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
333
 
<td> <a class="link" href="libsoup-24-soup-status.html#SOUP-STATUS-OK:CAPS"><code class="literal">SOUP_STATUS_OK</code></a>, <a class="link" href="libsoup-24-soup-status.html#SOUP-STATUS-CANT-RESOLVE:CAPS"><code class="literal">SOUP_STATUS_CANT_RESOLVE</code></a>, or
334
 
<a class="link" href="libsoup-24-soup-status.html#SOUP-STATUS-CANCELLED:CAPS"><code class="literal">SOUP_STATUS_CANCELLED</code></a>
 
360
<td> <a class="link" href="libsoup-24-soup-status.html#SOUP-STATUS-OK--CAPS"><code class="literal">SOUP_STATUS_OK</code></a>, <a class="link" href="libsoup-24-soup-status.html#SOUP-STATUS-CANT-RESOLVE--CAPS"><code class="literal">SOUP_STATUS_CANT_RESOLVE</code></a>, or
 
361
<a class="link" href="libsoup-24-soup-status.html#SOUP-STATUS-CANCELLED--CAPS"><code class="literal">SOUP_STATUS_CANCELLED</code></a>
335
362
</td>
336
363
</tr>
337
364
<tr>
365
392
</p>
366
393
<p>
367
394
If <em class="parameter"><code>cancellable</code></em> is non-<a
368
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
395
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
369
396
><code class="literal">NULL</code></a>, it can be used to cancel the
370
397
resolution. <em class="parameter"><code>callback</code></em> will still be invoked in this case, with a
371
 
status of <a class="link" href="libsoup-24-soup-status.html#SOUP-STATUS-CANCELLED:CAPS"><code class="literal">SOUP_STATUS_CANCELLED</code></a>.</p>
 
398
status of <a class="link" href="libsoup-24-soup-status.html#SOUP-STATUS-CANCELLED--CAPS"><code class="literal">SOUP_STATUS_CANCELLED</code></a>.</p>
372
399
<p>
373
 
 
374
400
</p>
375
401
<div class="variablelist"><table border="0">
376
402
<col align="left" valign="top">
392
418
<td> a <a
393
419
href="/usr/share/gtk-doc/html/gio/GCancellable.html"
394
420
><span class="type">GCancellable</span></a> object, or <a
395
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
421
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
396
422
><code class="literal">NULL</code></a>
397
423
</td>
398
424
</tr>
424
450
</p>
425
451
<p>
426
452
If <em class="parameter"><code>cancellable</code></em> is non-<a
427
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
453
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
428
454
><code class="literal">NULL</code></a>, it can be used to cancel the
429
455
resolution. <a class="link" href="SoupAddress.html#soup-address-resolve-sync" title="soup_address_resolve_sync ()"><code class="function">soup_address_resolve_sync()</code></a> will then return a status
430
 
of <a class="link" href="libsoup-24-soup-status.html#SOUP-STATUS-CANCELLED:CAPS"><code class="literal">SOUP_STATUS_CANCELLED</code></a>.</p>
 
456
of <a class="link" href="libsoup-24-soup-status.html#SOUP-STATUS-CANCELLED--CAPS"><code class="literal">SOUP_STATUS_CANCELLED</code></a>.</p>
431
457
<p>
432
 
 
433
458
</p>
434
459
<div class="variablelist"><table border="0">
435
460
<col align="left" valign="top">
444
469
<td> a <a
445
470
href="/usr/share/gtk-doc/html/gio/GCancellable.html"
446
471
><span class="type">GCancellable</span></a> object, or <a
447
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
472
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
448
473
><code class="literal">NULL</code></a>
449
474
</td>
450
475
</tr>
451
476
<tr>
452
477
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
453
 
<td> <a class="link" href="libsoup-24-soup-status.html#SOUP-STATUS-OK:CAPS"><code class="literal">SOUP_STATUS_OK</code></a>, <a class="link" href="libsoup-24-soup-status.html#SOUP-STATUS-CANT-RESOLVE:CAPS"><code class="literal">SOUP_STATUS_CANT_RESOLVE</code></a>, or
454
 
<a class="link" href="libsoup-24-soup-status.html#SOUP-STATUS-CANCELLED:CAPS"><code class="literal">SOUP_STATUS_CANCELLED</code></a>.
 
478
<td> <a class="link" href="libsoup-24-soup-status.html#SOUP-STATUS-OK--CAPS"><code class="literal">SOUP_STATUS_OK</code></a>, <a class="link" href="libsoup-24-soup-status.html#SOUP-STATUS-CANT-RESOLVE--CAPS"><code class="literal">SOUP_STATUS_CANT_RESOLVE</code></a>, or
 
479
<a class="link" href="libsoup-24-soup-status.html#SOUP-STATUS-CANCELLED--CAPS"><code class="literal">SOUP_STATUS_CANCELLED</code></a>.
 
480
</td>
 
481
</tr>
 
482
</tbody>
 
483
</table></div>
 
484
</div>
 
485
<hr>
 
486
<div class="refsect2" lang="en">
 
487
<a name="soup-address-is-resolved"></a><h3>soup_address_is_resolved ()</h3>
 
488
<pre class="programlisting"><a
 
489
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
490
>gboolean</a>            soup_address_is_resolved            (<a class="link" href="SoupAddress.html" title="SoupAddress">SoupAddress</a> *addr);</pre>
 
491
<p>
 
492
Tests if <em class="parameter"><code>addr</code></em> has already been resolved.</p>
 
493
<p>
 
494
</p>
 
495
<div class="variablelist"><table border="0">
 
496
<col align="left" valign="top">
 
497
<tbody>
 
498
<tr>
 
499
<td><p><span class="term"><em class="parameter"><code>addr</code></em> :</span></p></td>
 
500
<td> a <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a>
 
501
</td>
 
502
</tr>
 
503
<tr>
 
504
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
505
<td> <a
 
506
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE--CAPS"
 
507
><code class="literal">TRUE</code></a> if <em class="parameter"><code>addr</code></em> has been resolved.
455
508
</td>
456
509
</tr>
457
510
</tbody>
460
513
<hr>
461
514
<div class="refsect2" lang="en">
462
515
<a name="soup-address-get-name"></a><h3>soup_address_get_name ()</h3>
463
 
<pre class="programlisting">const char*         soup_address_get_name               (<a class="link" href="SoupAddress.html" title="SoupAddress">SoupAddress</a> *addr);</pre>
 
516
<pre class="programlisting">const char *        soup_address_get_name               (<a class="link" href="SoupAddress.html" title="SoupAddress">SoupAddress</a> *addr);</pre>
464
517
<p>
465
518
Returns the hostname associated with <em class="parameter"><code>addr</code></em>.</p>
466
519
<p>
467
 
 
468
520
</p>
469
521
<div class="variablelist"><table border="0">
470
522
<col align="left" valign="top">
477
529
<tr>
478
530
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
479
531
<td> the hostname, or <a
480
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
532
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
481
533
><code class="literal">NULL</code></a> if it is not known.
482
534
</td>
483
535
</tr>
487
539
<hr>
488
540
<div class="refsect2" lang="en">
489
541
<a name="soup-address-get-sockaddr"></a><h3>soup_address_get_sockaddr ()</h3>
490
 
<pre class="programlisting">struct sockaddr*    soup_address_get_sockaddr           (<a class="link" href="SoupAddress.html" title="SoupAddress">SoupAddress</a> *addr,
 
542
<pre class="programlisting">struct sockaddr *   soup_address_get_sockaddr           (<a class="link" href="SoupAddress.html" title="SoupAddress">SoupAddress</a> *addr,
491
543
                                                         int *len);</pre>
492
544
<p>
493
545
Returns the sockaddr associated with <em class="parameter"><code>addr</code></em>, with its length in
494
546
*<em class="parameter"><code>len</code></em>. If the sockaddr is not yet known, returns <a
495
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
547
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
496
548
><code class="literal">NULL</code></a>.</p>
497
549
<p>
498
 
 
499
550
</p>
500
551
<div class="variablelist"><table border="0">
501
552
<col align="left" valign="top">
513
564
<tr>
514
565
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
515
566
<td> the sockaddr, or <a
516
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
567
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
517
568
><code class="literal">NULL</code></a>
518
569
</td>
519
570
</tr>
523
574
<hr>
524
575
<div class="refsect2" lang="en">
525
576
<a name="soup-address-get-physical"></a><h3>soup_address_get_physical ()</h3>
526
 
<pre class="programlisting">const char*         soup_address_get_physical           (<a class="link" href="SoupAddress.html" title="SoupAddress">SoupAddress</a> *addr);</pre>
 
577
<pre class="programlisting">const char *        soup_address_get_physical           (<a class="link" href="SoupAddress.html" title="SoupAddress">SoupAddress</a> *addr);</pre>
527
578
<p>
528
579
Returns the physical address associated with <em class="parameter"><code>addr</code></em> as a string.
529
580
(Eg, "127.0.0.1"). If the address is not yet known, returns <a
530
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
581
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
531
582
><code class="literal">NULL</code></a>.</p>
532
583
<p>
533
 
 
534
584
</p>
535
585
<div class="variablelist"><table border="0">
536
586
<col align="left" valign="top">
543
593
<tr>
544
594
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
545
595
<td> the physical address, or <a
546
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
596
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
547
597
><code class="literal">NULL</code></a>
548
598
</td>
549
599
</tr>
559
609
<p>
560
610
Returns the port associated with <em class="parameter"><code>addr</code></em>.</p>
561
611
<p>
562
 
 
563
612
</p>
564
613
<div class="variablelist"><table border="0">
565
614
<col align="left" valign="top">
579
628
</div>
580
629
<hr>
581
630
<div class="refsect2" lang="en">
582
 
<a name="SOUP-ADDRESS-FAMILY:CAPS"></a><h3>SOUP_ADDRESS_FAMILY</h3>
 
631
<a name="soup-address-equal-by-name"></a><h3>soup_address_equal_by_name ()</h3>
 
632
<pre class="programlisting"><a
 
633
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
634
>gboolean</a>            soup_address_equal_by_name          (<a
 
635
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gconstpointer"
 
636
>gconstpointer</a> addr1,
 
637
                                                         <a
 
638
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gconstpointer"
 
639
>gconstpointer</a> addr2);</pre>
 
640
<p>
 
641
Tests if <em class="parameter"><code>addr1</code></em> and <em class="parameter"><code>addr2</code></em> have the same "name". This method can be
 
642
used with <a class="link" href="SoupAddress.html#soup-address-hash-by-name" title="soup_address_hash_by_name ()"><code class="function">soup_address_hash_by_name()</code></a> to create a <a
 
643
href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"
 
644
><span class="type">GHashTable</span></a> that
 
645
hashes on address "names".
 
646
</p>
 
647
<p>
 
648
Comparing by name normally means comparing the addresses by their
 
649
hostnames. But if the address was originally created using an IP
 
650
address literal, then it will be compared by that instead.
 
651
</p>
 
652
<p>
 
653
In particular, if "www.example.com" has the IP address 10.0.0.1,
 
654
and <em class="parameter"><code>addr1</code></em> was created with the name "www.example.com" and <em class="parameter"><code>addr2</code></em>
 
655
was created with the name "10.0.0.1", then they will compare as
 
656
unequal for purposes of <a class="link" href="SoupAddress.html#soup-address-equal-by-name" title="soup_address_equal_by_name ()"><code class="function">soup_address_equal_by_name()</code></a>.
 
657
</p>
 
658
<p>
 
659
This would be used to distinguish hosts in situations where
 
660
different virtual hosts on the same IP address should be considered
 
661
different. Eg, for purposes of HTTP authentication or cookies, two
 
662
hosts with the same IP address but different names are considered
 
663
to be different hosts.
 
664
</p>
 
665
<p>
 
666
See also <a class="link" href="SoupAddress.html#soup-address-equal-by-ip" title="soup_address_equal_by_ip ()"><code class="function">soup_address_equal_by_ip()</code></a>, which compares by IP address
 
667
rather than by name.</p>
 
668
<p>
 
669
</p>
 
670
<div class="variablelist"><table border="0">
 
671
<col align="left" valign="top">
 
672
<tbody>
 
673
<tr>
 
674
<td><p><span class="term"><em class="parameter"><code>addr1</code></em> :</span></p></td>
 
675
<td> a <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> with a resolved name
 
676
</td>
 
677
</tr>
 
678
<tr>
 
679
<td><p><span class="term"><em class="parameter"><code>addr2</code></em> :</span></p></td>
 
680
<td> another <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> with a resolved name
 
681
</td>
 
682
</tr>
 
683
<tr>
 
684
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
685
<td> whether or not <em class="parameter"><code>addr1</code></em> and <em class="parameter"><code>addr2</code></em> have the same name
 
686
</td>
 
687
</tr>
 
688
</tbody>
 
689
</table></div>
 
690
</div>
 
691
<hr>
 
692
<div class="refsect2" lang="en">
 
693
<a name="soup-address-hash-by-name"></a><h3>soup_address_hash_by_name ()</h3>
 
694
<pre class="programlisting"><a
 
695
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
 
696
>guint</a>               soup_address_hash_by_name           (<a
 
697
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gconstpointer"
 
698
>gconstpointer</a> addr);</pre>
 
699
<p>
 
700
A hash function (for <a
 
701
href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"
 
702
><span class="type">GHashTable</span></a>) that corresponds to
 
703
<a class="link" href="SoupAddress.html#soup-address-equal-by-name" title="soup_address_equal_by_name ()"><code class="function">soup_address_equal_by_name()</code></a>, qv</p>
 
704
<p>
 
705
</p>
 
706
<div class="variablelist"><table border="0">
 
707
<col align="left" valign="top">
 
708
<tbody>
 
709
<tr>
 
710
<td><p><span class="term"><em class="parameter"><code>addr</code></em> :</span></p></td>
 
711
<td> a <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a>
 
712
</td>
 
713
</tr>
 
714
<tr>
 
715
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
716
<td> the named-based hash value for <em class="parameter"><code>addr</code></em>.
 
717
</td>
 
718
</tr>
 
719
</tbody>
 
720
</table></div>
 
721
</div>
 
722
<hr>
 
723
<div class="refsect2" lang="en">
 
724
<a name="soup-address-equal-by-ip"></a><h3>soup_address_equal_by_ip ()</h3>
 
725
<pre class="programlisting"><a
 
726
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
727
>gboolean</a>            soup_address_equal_by_ip            (<a
 
728
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gconstpointer"
 
729
>gconstpointer</a> addr1,
 
730
                                                         <a
 
731
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gconstpointer"
 
732
>gconstpointer</a> addr2);</pre>
 
733
<p>
 
734
Tests if <em class="parameter"><code>addr1</code></em> and <em class="parameter"><code>addr2</code></em> have the same IP address. This method
 
735
can be used with <a class="link" href="SoupAddress.html#soup-address-hash-by-ip" title="soup_address_hash_by_ip ()"><code class="function">soup_address_hash_by_ip()</code></a> to create a
 
736
<a
 
737
href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"
 
738
><span class="type">GHashTable</span></a> that hashes on IP address.
 
739
</p>
 
740
<p>
 
741
This would be used to distinguish hosts in situations where
 
742
different virtual hosts on the same IP address should be considered
 
743
the same. Eg, if "www.example.com" and "www.example.net" have the
 
744
same IP address, then a single <span class="type">SoupConnection</span> can be used to talk
 
745
to either of them.
 
746
</p>
 
747
<p>
 
748
See also <a class="link" href="SoupAddress.html#soup-address-equal-by-name" title="soup_address_equal_by_name ()"><code class="function">soup_address_equal_by_name()</code></a>, which compares by name
 
749
rather than by IP address.</p>
 
750
<p>
 
751
</p>
 
752
<div class="variablelist"><table border="0">
 
753
<col align="left" valign="top">
 
754
<tbody>
 
755
<tr>
 
756
<td><p><span class="term"><em class="parameter"><code>addr1</code></em> :</span></p></td>
 
757
<td> a <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> with a resolved IP address
 
758
</td>
 
759
</tr>
 
760
<tr>
 
761
<td><p><span class="term"><em class="parameter"><code>addr2</code></em> :</span></p></td>
 
762
<td> another <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a> with a resolved IP address
 
763
</td>
 
764
</tr>
 
765
<tr>
 
766
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
767
<td> whether or not <em class="parameter"><code>addr1</code></em> and <em class="parameter"><code>addr2</code></em> have the same IP
 
768
address.
 
769
</td>
 
770
</tr>
 
771
</tbody>
 
772
</table></div>
 
773
</div>
 
774
<hr>
 
775
<div class="refsect2" lang="en">
 
776
<a name="soup-address-hash-by-ip"></a><h3>soup_address_hash_by_ip ()</h3>
 
777
<pre class="programlisting"><a
 
778
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"
 
779
>guint</a>               soup_address_hash_by_ip             (<a
 
780
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gconstpointer"
 
781
>gconstpointer</a> addr);</pre>
 
782
<p>
 
783
A hash function (for <a
 
784
href="/usr/share/gtk-doc/html/glib/glib-Hash-Tables.html#GHashTable"
 
785
><span class="type">GHashTable</span></a>) that corresponds to
 
786
<a class="link" href="SoupAddress.html#soup-address-equal-by-ip" title="soup_address_equal_by_ip ()"><code class="function">soup_address_equal_by_ip()</code></a>, qv</p>
 
787
<p>
 
788
</p>
 
789
<div class="variablelist"><table border="0">
 
790
<col align="left" valign="top">
 
791
<tbody>
 
792
<tr>
 
793
<td><p><span class="term"><em class="parameter"><code>addr</code></em> :</span></p></td>
 
794
<td> a <a class="link" href="SoupAddress.html" title="SoupAddress"><span class="type">SoupAddress</span></a>
 
795
</td>
 
796
</tr>
 
797
<tr>
 
798
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
799
<td> the IP-based hash value for <em class="parameter"><code>addr</code></em>.
 
800
</td>
 
801
</tr>
 
802
</tbody>
 
803
</table></div>
 
804
</div>
 
805
<hr>
 
806
<div class="refsect2" lang="en">
 
807
<a name="SOUP-ADDRESS-FAMILY--CAPS"></a><h3>SOUP_ADDRESS_FAMILY</h3>
583
808
<pre class="programlisting">#define SOUP_ADDRESS_FAMILY   "family"
584
809
</pre>
585
810
<p>
586
 
 
587
811
</p>
588
812
</div>
589
813
<hr>
590
814
<div class="refsect2" lang="en">
591
 
<a name="SOUP-ADDRESS-NAME:CAPS"></a><h3>SOUP_ADDRESS_NAME</h3>
 
815
<a name="SOUP-ADDRESS-NAME--CAPS"></a><h3>SOUP_ADDRESS_NAME</h3>
592
816
<pre class="programlisting">#define SOUP_ADDRESS_NAME     "name"
593
817
</pre>
594
818
<p>
595
 
 
596
819
</p>
597
820
</div>
598
821
<hr>
599
822
<div class="refsect2" lang="en">
600
 
<a name="SOUP-ADDRESS-PHYSICAL:CAPS"></a><h3>SOUP_ADDRESS_PHYSICAL</h3>
 
823
<a name="SOUP-ADDRESS-PHYSICAL--CAPS"></a><h3>SOUP_ADDRESS_PHYSICAL</h3>
601
824
<pre class="programlisting">#define SOUP_ADDRESS_PHYSICAL "physical"
602
825
</pre>
603
826
<p>
604
 
 
605
827
</p>
606
828
</div>
607
829
<hr>
608
830
<div class="refsect2" lang="en">
609
 
<a name="SOUP-ADDRESS-PORT:CAPS"></a><h3>SOUP_ADDRESS_PORT</h3>
 
831
<a name="SOUP-ADDRESS-PORT--CAPS"></a><h3>SOUP_ADDRESS_PORT</h3>
610
832
<pre class="programlisting">#define SOUP_ADDRESS_PORT     "port"
611
833
</pre>
612
834
<p>
613
 
 
614
835
</p>
615
836
</div>
616
837
<hr>
617
838
<div class="refsect2" lang="en">
618
 
<a name="SOUP-ADDRESS-SOCKADDR:CAPS"></a><h3>SOUP_ADDRESS_SOCKADDR</h3>
 
839
<a name="SOUP-ADDRESS-SOCKADDR--CAPS"></a><h3>SOUP_ADDRESS_SOCKADDR</h3>
619
840
<pre class="programlisting">#define SOUP_ADDRESS_SOCKADDR "sockaddr"
620
841
</pre>
621
842
<p>
622
 
 
623
843
</p>
624
844
</div>
625
845
</div>
671
891
</div>
672
892
<div class="footer">
673
893
<hr>
674
 
          Generated by GTK-Doc V1.10</div>
 
894
          Generated by GTK-Doc V1.11</div>
675
895
</body>
676
896
</html>