1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="SoupAddress">
<refmeta>
<refentrytitle role="top_of_page">SoupAddress</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBSOUP Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>SoupAddress</refname>
<refpurpose>Higher-level IP address object</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
struct <link linkend="SoupAddress-struct">SoupAddress</link>;
enum <link linkend="SoupAddressFamily">SoupAddressFamily</link>;
#define <link linkend="SOUP-ADDRESS-ANY-PORT:CAPS">SOUP_ADDRESS_ANY_PORT</link>
<link linkend="SoupAddress">SoupAddress</link>* <link linkend="soup-address-new">soup_address_new</link> (const <link linkend="char">char</link> *name,
<link linkend="guint">guint</link> port);
<link linkend="SoupAddress">SoupAddress</link>* <link linkend="soup-address-new-from-sockaddr">soup_address_new_from_sockaddr</link> (<link linkend="struct-sockaddr">struct sockaddr</link> *sa,
<link linkend="int">int</link> len);
<link linkend="SoupAddress">SoupAddress</link>* <link linkend="soup-address-new-any">soup_address_new_any</link> (<link linkend="SoupAddressFamily">SoupAddressFamily</link> family,
<link linkend="guint">guint</link> port);
<link linkend="void">void</link> (<link linkend="SoupAddressCallback">*SoupAddressCallback</link>) (<link linkend="SoupAddress">SoupAddress</link> *addr,
<link linkend="guint">guint</link> status,
<link linkend="gpointer">gpointer</link> data);
<link linkend="void">void</link> <link linkend="soup-address-resolve-async">soup_address_resolve_async</link> (<link linkend="SoupAddress">SoupAddress</link> *addr,
<link linkend="SoupAddressCallback">SoupAddressCallback</link> callback,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="void">void</link> <link linkend="soup-address-resolve-async-full">soup_address_resolve_async_full</link> (<link linkend="SoupAddress">SoupAddress</link> *addr,
<link linkend="GMainContext">GMainContext</link> *async_context,
<link linkend="SoupAddressCallback">SoupAddressCallback</link> callback,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="guint">guint</link> <link linkend="soup-address-resolve-sync">soup_address_resolve_sync</link> (<link linkend="SoupAddress">SoupAddress</link> *addr);
const <link linkend="char">char</link>* <link linkend="soup-address-get-name">soup_address_get_name</link> (<link linkend="SoupAddress">SoupAddress</link> *addr);
struct <link linkend="sockaddr">sockaddr</link>* <link linkend="soup-address-get-sockaddr">soup_address_get_sockaddr</link> (<link linkend="SoupAddress">SoupAddress</link> *addr,
<link linkend="int">int</link> *len);
const <link linkend="char">char</link>* <link linkend="soup-address-get-physical">soup_address_get_physical</link> (<link linkend="SoupAddress">SoupAddress</link> *addr);
<link linkend="guint">guint</link> <link linkend="soup-address-get-port">soup_address_get_port</link> (<link linkend="SoupAddress">SoupAddress</link> *addr);
</synopsis>
</refsynopsisdiv>
<refsect1 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----SoupAddress
</synopsis>
</refsect1>
<refsect1 role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="SoupAddress-dns-result">dns-result</link>"
<link linkend="void">void</link> user_function (<link linkend="SoupAddress">SoupAddress</link> *addr,
<link linkend="gint">gint</link> status,
<link linkend="gpointer">gpointer</link> user_data) : Run first
</synopsis>
</refsect1>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
<link linkend="SoupAddress"><type>SoupAddress</type></link> represents the address of a TCP connection endpoint; both
the IP address and the port. (It is somewhat like an object-oriented
version of struct <link linkend="sockaddr"><type>sockaddr</type></link>.)
</para>
<para>
If libsoup was built with IPv6 support, <link linkend="SoupAddress"><type>SoupAddress</type></link> will allow both
IPv4 and IPv6 addresses.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="SoupAddress-struct" role="struct"/>struct SoupAddress</title>
<indexterm><primary>SoupAddress</primary></indexterm><programlisting>struct SoupAddress;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="SoupAddressFamily" role="enum"/>enum SoupAddressFamily</title>
<indexterm><primary>SoupAddressFamily</primary></indexterm><programlisting>typedef enum {
SOUP_ADDRESS_FAMILY_IPV4 = AF_INET,
SOUP_ADDRESS_FAMILY_IPV6 = AF_INET6
} SoupAddressFamily;
</programlisting>
<para>
The supported address families. Note that the
<link linkend="SOUP-ADDRESS-FAMILY-IPV6:CAPS"><literal>SOUP_ADDRESS_FAMILY_IPV6</literal></link> constant is available even if libsoup was
built without IPv6 support, but attempting to create an IPv6
address will fail in that case.</para>
<para>
</para><variablelist role="enum">
<varlistentry>
<term><anchor id="SOUP-ADDRESS-FAMILY-IPV4:CAPS" role="constant"/><literal>SOUP_ADDRESS_FAMILY_IPV4</literal></term>
<listitem><simpara> an IPv4 address
</simpara></listitem>
</varlistentry>
<varlistentry>
<term><anchor id="SOUP-ADDRESS-FAMILY-IPV6:CAPS" role="constant"/><literal>SOUP_ADDRESS_FAMILY_IPV6</literal></term>
<listitem><simpara> an IPv6 address
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="SOUP-ADDRESS-ANY-PORT:CAPS" role="macro"/>SOUP_ADDRESS_ANY_PORT</title>
<indexterm><primary>SOUP_ADDRESS_ANY_PORT</primary></indexterm><programlisting>#define SOUP_ADDRESS_ANY_PORT 0
</programlisting>
<para>
This can be passed to any <link linkend="SoupAddress"><type>SoupAddress</type></link> method that expects a port,
to indicate that you don't care what port is used.</para>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="soup-address-new" role="function"/>soup_address_new ()</title>
<indexterm><primary>soup_address_new</primary></indexterm><programlisting><link linkend="SoupAddress">SoupAddress</link>* soup_address_new (const <link linkend="char">char</link> *name,
<link linkend="guint">guint</link> port);</programlisting>
<para>
Creates a <link linkend="SoupAddress"><type>SoupAddress</type></link> from <parameter>name</parameter> and <parameter>port</parameter>. The <link linkend="SoupAddress"><type>SoupAddress</type></link>'s IP
address may not be available right away; the caller can call
<link linkend="soup-address-resolve-async"><function>soup_address_resolve_async()</function></link> or <link linkend="soup-address-resolve-sync"><function>soup_address_resolve_sync()</function></link> to
force a DNS resolution.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> a hostname or physical address
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>port</parameter> :</term>
<listitem><simpara> a port number
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="SoupAddress"><type>SoupAddress</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-address-new-from-sockaddr" role="function"/>soup_address_new_from_sockaddr ()</title>
<indexterm><primary>soup_address_new_from_sockaddr</primary></indexterm><programlisting><link linkend="SoupAddress">SoupAddress</link>* soup_address_new_from_sockaddr (<link linkend="struct-sockaddr">struct sockaddr</link> *sa,
<link linkend="int">int</link> len);</programlisting>
<para>
Returns a <link linkend="SoupAddress"><type>SoupAddress</type></link> equivalent to <parameter>sa</parameter> (or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>sa</parameter>'s
address family isn't supported)</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>sa</parameter> :</term>
<listitem><simpara> a pointer to a sockaddr
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>len</parameter> :</term>
<listitem><simpara> size of <parameter>sa</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new <link linkend="SoupAddress"><type>SoupAddress</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-address-new-any" role="function"/>soup_address_new_any ()</title>
<indexterm><primary>soup_address_new_any</primary></indexterm><programlisting><link linkend="SoupAddress">SoupAddress</link>* soup_address_new_any (<link linkend="SoupAddressFamily">SoupAddressFamily</link> family,
<link linkend="guint">guint</link> port);</programlisting>
<para>
Returns a <link linkend="SoupAddress"><type>SoupAddress</type></link> corresponding to the "any" address
for <parameter>family</parameter> (or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>family</parameter> isn't supported), suitable for
passing to <link linkend="soup-socket-server-new"><function>soup_socket_server_new()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>family</parameter> :</term>
<listitem><simpara> the address family
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>port</parameter> :</term>
<listitem><simpara> the port number (usually <link linkend="SOUP-ADDRESS-ANY-PORT:CAPS"><literal>SOUP_ADDRESS_ANY_PORT</literal></link>)
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new <link linkend="SoupAddress"><type>SoupAddress</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="SoupAddressCallback" role="function"/>SoupAddressCallback ()</title>
<indexterm><primary>SoupAddressCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*SoupAddressCallback) (<link linkend="SoupAddress">SoupAddress</link> *addr,
<link linkend="guint">guint</link> status,
<link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
The callback function passed to <link linkend="soup-address-resolve-async"><function>soup_address_resolve_async()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>addr</parameter> :</term>
<listitem><simpara> the <link linkend="SoupAddress"><type>SoupAddress</type></link> that was resolved
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>status</parameter> :</term>
<listitem><simpara> <link linkend="SOUP-STATUS-OK:CAPS"><literal>SOUP_STATUS_OK</literal></link> or <link linkend="SOUP-STATUS-CANT-RESOLVE:CAPS"><literal>SOUP_STATUS_CANT_RESOLVE</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara> the user data that was passed to
<link linkend="soup-address-resolve-async"><function>soup_address_resolve_async()</function></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-address-resolve-async" role="function"/>soup_address_resolve_async ()</title>
<indexterm><primary>soup_address_resolve_async</primary></indexterm><programlisting><link linkend="void">void</link> soup_address_resolve_async (<link linkend="SoupAddress">SoupAddress</link> *addr,
<link linkend="SoupAddressCallback">SoupAddressCallback</link> callback,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
Asynchronously resolves the missing half of <parameter>addr</parameter>. (Its IP address
if it was created with <link linkend="soup-address-new"><function>soup_address_new()</function></link>, or its hostname if it
was created with <link linkend="soup-address-new-from-sockaddr"><function>soup_address_new_from_sockaddr()</function></link> or
<link linkend="soup-address-new-any"><function>soup_address_new_any()</function></link>.) <parameter>callback</parameter> will be called when the
resolution finishes (successfully or not).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>addr</parameter> :</term>
<listitem><simpara> a <link linkend="SoupAddress"><type>SoupAddress</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>callback</parameter> :</term>
<listitem><simpara> callback to call with the result
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara> data for <parameter>callback</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-address-resolve-async-full" role="function"/>soup_address_resolve_async_full ()</title>
<indexterm><primary>soup_address_resolve_async_full</primary></indexterm><programlisting><link linkend="void">void</link> soup_address_resolve_async_full (<link linkend="SoupAddress">SoupAddress</link> *addr,
<link linkend="GMainContext">GMainContext</link> *async_context,
<link linkend="SoupAddressCallback">SoupAddressCallback</link> callback,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
Like <link linkend="soup-address-resolve-async"><function>soup_address_resolve_async()</function></link>, but calls <parameter>callback</parameter> from
the given <parameter>async_context</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>addr</parameter> :</term>
<listitem><simpara> a <link linkend="SoupAddress"><type>SoupAddress</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>async_context</parameter> :</term>
<listitem><simpara> the <link linkend="GMainContext"><type>GMainContext</type></link> to call <parameter>callback</parameter> from
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>callback</parameter> :</term>
<listitem><simpara> callback to call with the result
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara> data for <parameter>callback</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-address-resolve-sync" role="function"/>soup_address_resolve_sync ()</title>
<indexterm><primary>soup_address_resolve_sync</primary></indexterm><programlisting><link linkend="guint">guint</link> soup_address_resolve_sync (<link linkend="SoupAddress">SoupAddress</link> *addr);</programlisting>
<para>
Synchronously resolves the missing half of <parameter>addr</parameter>, as with
<link linkend="soup-address-resolve-async"><function>soup_address_resolve_async()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>addr</parameter> :</term>
<listitem><simpara> a <link linkend="SoupAddress"><type>SoupAddress</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="SOUP-STATUS-OK:CAPS"><literal>SOUP_STATUS_OK</literal></link> or <link linkend="SOUP-STATUS-CANT-RESOLVE:CAPS"><literal>SOUP_STATUS_CANT_RESOLVE</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-address-get-name" role="function"/>soup_address_get_name ()</title>
<indexterm><primary>soup_address_get_name</primary></indexterm><programlisting>const <link linkend="char">char</link>* soup_address_get_name (<link linkend="SoupAddress">SoupAddress</link> *addr);</programlisting>
<para>
Returns the hostname associated with <parameter>addr</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>addr</parameter> :</term>
<listitem><simpara> a <link linkend="SoupAddress"><type>SoupAddress</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the hostname, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if it is not known.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-address-get-sockaddr" role="function"/>soup_address_get_sockaddr ()</title>
<indexterm><primary>soup_address_get_sockaddr</primary></indexterm><programlisting>struct <link linkend="sockaddr">sockaddr</link>* soup_address_get_sockaddr (<link linkend="SoupAddress">SoupAddress</link> *addr,
<link linkend="int">int</link> *len);</programlisting>
<para>
Returns the sockaddr associated with <parameter>addr</parameter>, with its length in
*<parameter>len</parameter>. If the sockaddr is not yet known, returns <link linkend="NULL:CAPS"><literal>NULL</literal></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>addr</parameter> :</term>
<listitem><simpara> a <link linkend="SoupAddress"><type>SoupAddress</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>len</parameter> :</term>
<listitem><simpara> return location for sockaddr length
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the sockaddr, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-address-get-physical" role="function"/>soup_address_get_physical ()</title>
<indexterm><primary>soup_address_get_physical</primary></indexterm><programlisting>const <link linkend="char">char</link>* soup_address_get_physical (<link linkend="SoupAddress">SoupAddress</link> *addr);</programlisting>
<para>
Returns the physical address associated with <parameter>addr</parameter> as a string.
(Eg, "127.0.0.1"). If the address is not yet known, returns <link linkend="NULL:CAPS"><literal>NULL</literal></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>addr</parameter> :</term>
<listitem><simpara> a <link linkend="SoupAddress"><type>SoupAddress</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the physical address, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-address-get-port" role="function"/>soup_address_get_port ()</title>
<indexterm><primary>soup_address_get_port</primary></indexterm><programlisting><link linkend="guint">guint</link> soup_address_get_port (<link linkend="SoupAddress">SoupAddress</link> *addr);</programlisting>
<para>
Returns the port associated with <parameter>addr</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>addr</parameter> :</term>
<listitem><simpara> a <link linkend="SoupAddress"><type>SoupAddress</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the port
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 role="signals">
<title role="signals.title">Signal Details</title>
<refsect2><title><anchor id="SoupAddress-dns-result"/>The "dns-result" signal</title>
<indexterm><primary>SoupAddress::dns-result</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="SoupAddress">SoupAddress</link> *addr,
<link linkend="gint">gint</link> status,
<link linkend="gpointer">gpointer</link> user_data) : Run first</programlisting>
<para>
Emitted when an address resolution completes. (This is used
internally by <link linkend="soup-address-resolve-async"><function>soup_address_resolve_async()</function></link> itself.)</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>addr</parameter> :</term>
<listitem><simpara> the <link linkend="SoupAddress"><type>SoupAddress</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>status</parameter> :</term>
<listitem><simpara> the DNS status code
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
