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
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
|
<?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="SoupConnection">
<refmeta>
<refentrytitle role="top_of_page">SoupConnection</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBSOUP Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>SoupConnection</refname>
<refpurpose>a single possibly-persistent HTTP connection</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
struct <link linkend="SoupConnection-struct">SoupConnection</link>;
<link linkend="SoupConnection">SoupConnection</link>* <link linkend="soup-connection-new">soup_connection_new</link> (const <link linkend="char">char</link> *propname1,
...);
<link linkend="void">void</link> (<link linkend="SoupConnectionCallback">*SoupConnectionCallback</link>) (<link linkend="SoupConnection">SoupConnection</link> *conn,
<link linkend="guint">guint</link> status,
<link linkend="gpointer">gpointer</link> data);
<link linkend="void">void</link> <link linkend="soup-connection-connect-async">soup_connection_connect_async</link> (<link linkend="SoupConnection">SoupConnection</link> *conn,
<link linkend="SoupConnectionCallback">SoupConnectionCallback</link> callback,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="guint">guint</link> <link linkend="soup-connection-connect-sync">soup_connection_connect_sync</link> (<link linkend="SoupConnection">SoupConnection</link> *conn);
<link linkend="void">void</link> <link linkend="soup-connection-disconnect">soup_connection_disconnect</link> (<link linkend="SoupConnection">SoupConnection</link> *conn);
<link linkend="gboolean">gboolean</link> <link linkend="soup-connection-is-in-use">soup_connection_is_in_use</link> (<link linkend="SoupConnection">SoupConnection</link> *conn);
<link linkend="time-t">time_t</link> <link linkend="soup-connection-last-used">soup_connection_last_used</link> (<link linkend="SoupConnection">SoupConnection</link> *conn);
<link linkend="void">void</link> <link linkend="soup-connection-send-request">soup_connection_send_request</link> (<link linkend="SoupConnection">SoupConnection</link> *conn,
<link linkend="SoupMessage">SoupMessage</link> *req);
<link linkend="void">void</link> <link linkend="soup-connection-authenticate">soup_connection_authenticate</link> (<link linkend="SoupConnection">SoupConnection</link> *conn,
<link linkend="SoupMessage">SoupMessage</link> *msg,
const <link linkend="char">char</link> *auth_type,
const <link linkend="char">char</link> *auth_realm,
<link linkend="char">char</link> **username,
<link linkend="char">char</link> **password);
<link linkend="void">void</link> <link linkend="soup-connection-reauthenticate">soup_connection_reauthenticate</link> (<link linkend="SoupConnection">SoupConnection</link> *conn,
<link linkend="SoupMessage">SoupMessage</link> *msg,
const <link linkend="char">char</link> *auth_type,
const <link linkend="char">char</link> *auth_realm,
<link linkend="char">char</link> **username,
<link linkend="char">char</link> **password);
<link linkend="void">void</link> <link linkend="soup-connection-release">soup_connection_release</link> (<link linkend="SoupConnection">SoupConnection</link> *conn);
<link linkend="void">void</link> <link linkend="soup-connection-reserve">soup_connection_reserve</link> (<link linkend="SoupConnection">SoupConnection</link> *conn);
#define <link linkend="SOUP-CONNECTION-ORIGIN-URI:CAPS">SOUP_CONNECTION_ORIGIN_URI</link>
#define <link linkend="SOUP-CONNECTION-PROXY-URI:CAPS">SOUP_CONNECTION_PROXY_URI</link>
#define <link linkend="SOUP-CONNECTION-SSL-CREDENTIALS:CAPS">SOUP_CONNECTION_SSL_CREDENTIALS</link>
#define <link linkend="SOUP-CONNECTION-MESSAGE-FILTER:CAPS">SOUP_CONNECTION_MESSAGE_FILTER</link>
#define <link linkend="SOUP-CONNECTION-ASYNC-CONTEXT:CAPS">SOUP_CONNECTION_ASYNC_CONTEXT</link>
#define <link linkend="SOUP-CONNECTION-TIMEOUT:CAPS">SOUP_CONNECTION_TIMEOUT</link>
</synopsis>
</refsynopsisdiv>
<refsect1 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----SoupConnection
+----<link linkend="SoupConnectionNTLM">SoupConnectionNTLM</link>
</synopsis>
</refsect1>
<refsect1 role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="SoupConnection--async-context">async-context</link>" <link linkend="gpointer">gpointer</link> : Read / Write / Construct Only
"<link linkend="SoupConnection--message-filter">message-filter</link>" <link linkend="gpointer">gpointer</link> : Read / Write
"<link linkend="SoupConnection--origin-uri">origin-uri</link>" <link linkend="gpointer">gpointer</link> : Read / Write / Construct Only
"<link linkend="SoupConnection--proxy-uri">proxy-uri</link>" <link linkend="gpointer">gpointer</link> : Read / Write / Construct Only
"<link linkend="SoupConnection--ssl-creds">ssl-creds</link>" <link linkend="gpointer">gpointer</link> : Read / Write / Construct Only
"<link linkend="SoupConnection--timeout">timeout</link>" <link linkend="guint">guint</link> : Read / Write
</synopsis>
</refsect1>
<refsect1 role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="SoupConnection-authenticate">authenticate</link>"
<link linkend="void">void</link> user_function (<link linkend="SoupConnection">SoupConnection</link> *conn,
<link linkend="SoupMessage">SoupMessage</link> *msg,
<link linkend="gchar">gchar</link> *auth_type,
<link linkend="gchar">gchar</link> *auth_realm,
<link linkend="gpointer">gpointer</link> username,
<link linkend="gpointer">gpointer</link> password,
<link linkend="gpointer">gpointer</link> user_data) : Run first
"<link linkend="SoupConnection-connect-result">connect-result</link>"
<link linkend="void">void</link> user_function (<link linkend="SoupConnection">SoupConnection</link> *conn,
<link linkend="gint">gint</link> status,
<link linkend="gpointer">gpointer</link> user_data) : Run first
"<link linkend="SoupConnection-disconnected">disconnected</link>"
<link linkend="void">void</link> user_function (<link linkend="SoupConnection">SoupConnection</link> *conn,
<link linkend="gpointer">gpointer</link> user_data) : Run first
"<link linkend="SoupConnection-reauthenticate">reauthenticate</link>"
<link linkend="void">void</link> user_function (<link linkend="SoupConnection">SoupConnection</link> *conn,
<link linkend="SoupMessage">SoupMessage</link> *msg,
<link linkend="gchar">gchar</link> *auth_type,
<link linkend="gchar">gchar</link> *auth_realm,
<link linkend="gpointer">gpointer</link> username,
<link linkend="gpointer">gpointer</link> password,
<link linkend="gpointer">gpointer</link> user_data) : Run first
</synopsis>
</refsect1>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
<link linkend="SoupConnection"><type>SoupConnection</type></link> represents a single connection to an HTTP server
(possibly via a proxy). Connection objects are created and destroyed
automatically by <link linkend="SoupSession"><type>SoupSession</type></link>.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="SoupConnection-struct" role="struct"/>struct SoupConnection</title>
<indexterm><primary>SoupConnection</primary></indexterm><programlisting>struct SoupConnection;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="soup-connection-new" role="function"/>soup_connection_new ()</title>
<indexterm><primary>soup_connection_new</primary></indexterm><programlisting><link linkend="SoupConnection">SoupConnection</link>* soup_connection_new (const <link linkend="char">char</link> *propname1,
...);</programlisting>
<para>
Creates an HTTP connection. You must set at least one of
<link linkend="SOUP-CONNECTION-ORIGIN-URI:CAPS"><literal>SOUP_CONNECTION_ORIGIN_URI</literal></link> or <link linkend="SOUP-CONNECTION-PROXY-URI:CAPS"><literal>SOUP_CONNECTION_PROXY_URI</literal></link>. If you
set an origin server URI but no proxy URI, this will be a direct
connection. If you set a proxy URI and an https origin server URI,
this will be a tunnel. Otherwise it will be an http proxy
connection.
</para>
<para>
You must call <link linkend="soup-connection-connect-async"><function>soup_connection_connect_async()</function></link> or
<link linkend="soup-connection-connect-sync"><function>soup_connection_connect_sync()</function></link> to connect it after creating it.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>propname1</parameter> :</term>
<listitem><simpara> name of first property to set
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>...</parameter> :</term>
<listitem><simpara> value of <parameter>propname1</parameter>, followed by additional property/value pairs
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new connection (not yet ready for use).
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="SoupConnectionCallback" role="function"/>SoupConnectionCallback ()</title>
<indexterm><primary>SoupConnectionCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*SoupConnectionCallback) (<link linkend="SoupConnection">SoupConnection</link> *conn,
<link linkend="guint">guint</link> status,
<link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
The callback function passed to <link linkend="soup-connection-connect-async"><function>soup_connection_connect_async()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>conn</parameter> :</term>
<listitem><simpara> the <link linkend="SoupConnection"><type>SoupConnection</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>status</parameter> :</term>
<listitem><simpara> an HTTP status code indicating success or failure
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara> the data passed to <link linkend="soup-connection-connect-async"><function>soup_connection_connect_async()</function></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-connection-connect-async" role="function"/>soup_connection_connect_async ()</title>
<indexterm><primary>soup_connection_connect_async</primary></indexterm><programlisting><link linkend="void">void</link> soup_connection_connect_async (<link linkend="SoupConnection">SoupConnection</link> *conn,
<link linkend="SoupConnectionCallback">SoupConnectionCallback</link> callback,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
Asynchronously connects <parameter>conn</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>conn</parameter> :</term>
<listitem><simpara> the connection
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>callback</parameter> :</term>
<listitem><simpara> callback to call when the connection succeeds or fails
</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-connection-connect-sync" role="function"/>soup_connection_connect_sync ()</title>
<indexterm><primary>soup_connection_connect_sync</primary></indexterm><programlisting><link linkend="guint">guint</link> soup_connection_connect_sync (<link linkend="SoupConnection">SoupConnection</link> *conn);</programlisting>
<para>
Synchronously connects <parameter>conn</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>conn</parameter> :</term>
<listitem><simpara> the connection
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the soup status
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-connection-disconnect" role="function"/>soup_connection_disconnect ()</title>
<indexterm><primary>soup_connection_disconnect</primary></indexterm><programlisting><link linkend="void">void</link> soup_connection_disconnect (<link linkend="SoupConnection">SoupConnection</link> *conn);</programlisting>
<para>
Disconnects <parameter>conn</parameter>'s socket and emits a <link linkend="disconnected"><literal>disconnected</literal></link> signal.
After calling this, <parameter>conn</parameter> will be essentially useless.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>conn</parameter> :</term>
<listitem><simpara> a connection
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-connection-is-in-use" role="function"/>soup_connection_is_in_use ()</title>
<indexterm><primary>soup_connection_is_in_use</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> soup_connection_is_in_use (<link linkend="SoupConnection">SoupConnection</link> *conn);</programlisting>
<para>
Tests whether or not <parameter>conn</parameter> is in use.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>conn</parameter> :</term>
<listitem><simpara> a connection
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if there is currently a request being processed
on <parameter>conn</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-connection-last-used" role="function"/>soup_connection_last_used ()</title>
<indexterm><primary>soup_connection_last_used</primary></indexterm><programlisting><link linkend="time-t">time_t</link> soup_connection_last_used (<link linkend="SoupConnection">SoupConnection</link> *conn);</programlisting>
<para>
Returns the last time a response was received on <parameter>conn</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>conn</parameter> :</term>
<listitem><simpara> a <link linkend="SoupConnection"><type>SoupConnection</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the last time a response was received on <parameter>conn</parameter>, or 0
if <parameter>conn</parameter> has not been used yet.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-connection-send-request" role="function"/>soup_connection_send_request ()</title>
<indexterm><primary>soup_connection_send_request</primary></indexterm><programlisting><link linkend="void">void</link> soup_connection_send_request (<link linkend="SoupConnection">SoupConnection</link> *conn,
<link linkend="SoupMessage">SoupMessage</link> *req);</programlisting>
<para>
Sends <parameter>req</parameter> on <parameter>conn</parameter>. This is a low-level function, intended for use
by <link linkend="SoupSession"><type>SoupSession</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>conn</parameter> :</term>
<listitem><simpara> a <link linkend="SoupConnection"><type>SoupConnection</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>req</parameter> :</term>
<listitem><simpara> a <link linkend="SoupMessage"><type>SoupMessage</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-connection-authenticate" role="function"/>soup_connection_authenticate ()</title>
<indexterm><primary>soup_connection_authenticate</primary></indexterm><programlisting><link linkend="void">void</link> soup_connection_authenticate (<link linkend="SoupConnection">SoupConnection</link> *conn,
<link linkend="SoupMessage">SoupMessage</link> *msg,
const <link linkend="char">char</link> *auth_type,
const <link linkend="char">char</link> *auth_realm,
<link linkend="char">char</link> **username,
<link linkend="char">char</link> **password);</programlisting>
<para>
Emits the <link linkend="authenticate"><literal>authenticate</literal></link> signal on <parameter>conn</parameter>. For use by <link linkend="SoupConnection"><type>SoupConnection</type></link>
subclasses.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>conn</parameter> :</term>
<listitem><simpara> a <link linkend="SoupConnection"><type>SoupConnection</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>msg</parameter> :</term>
<listitem><simpara> the message to authenticate
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>auth_type</parameter> :</term>
<listitem><simpara> type of authentication to use
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>auth_realm</parameter> :</term>
<listitem><simpara> authentication realm
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>username</parameter> :</term>
<listitem><simpara> on successful return, will contain the username to
authenticate with
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>password</parameter> :</term>
<listitem><simpara> on successful return, will contain the password to
authenticate with
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-connection-reauthenticate" role="function"/>soup_connection_reauthenticate ()</title>
<indexterm><primary>soup_connection_reauthenticate</primary></indexterm><programlisting><link linkend="void">void</link> soup_connection_reauthenticate (<link linkend="SoupConnection">SoupConnection</link> *conn,
<link linkend="SoupMessage">SoupMessage</link> *msg,
const <link linkend="char">char</link> *auth_type,
const <link linkend="char">char</link> *auth_realm,
<link linkend="char">char</link> **username,
<link linkend="char">char</link> **password);</programlisting>
<para>
Emits the <link linkend="reauthenticate"><literal>reauthenticate</literal></link> signal on <parameter>conn</parameter>. For use by
<link linkend="SoupConnection"><type>SoupConnection</type></link> subclasses.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>conn</parameter> :</term>
<listitem><simpara> a <link linkend="SoupConnection"><type>SoupConnection</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>msg</parameter> :</term>
<listitem><simpara> the message to authenticate
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>auth_type</parameter> :</term>
<listitem><simpara> type of authentication to use
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>auth_realm</parameter> :</term>
<listitem><simpara> authentication realm
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>username</parameter> :</term>
<listitem><simpara> on successful return, will contain the username to
authenticate with
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>password</parameter> :</term>
<listitem><simpara> on successful return, will contain the password to
authenticate with
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-connection-release" role="function"/>soup_connection_release ()</title>
<indexterm><primary>soup_connection_release</primary></indexterm><programlisting><link linkend="void">void</link> soup_connection_release (<link linkend="SoupConnection">SoupConnection</link> *conn);</programlisting>
<para>
Marks <parameter>conn</parameter> as not "in use". This can be used to cancel the effect
of a <link linkend="soup-connection-reserve"><function>soup_connection_reserve()</function></link>. It is not necessary to call this
after <link linkend="soup-connection-send-request"><function>soup_connection_send_request()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>conn</parameter> :</term>
<listitem><simpara> a <link linkend="SoupConnection"><type>SoupConnection</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="soup-connection-reserve" role="function"/>soup_connection_reserve ()</title>
<indexterm><primary>soup_connection_reserve</primary></indexterm><programlisting><link linkend="void">void</link> soup_connection_reserve (<link linkend="SoupConnection">SoupConnection</link> *conn);</programlisting>
<para>
Marks <parameter>conn</parameter> as "in use" despite not actually having a message on
it. This is used by <link linkend="SoupSession"><type>SoupSession</type></link> to keep it from accidentally
trying to queue two messages on the same connection from different
threads at the same time.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>conn</parameter> :</term>
<listitem><simpara> a <link linkend="SoupConnection"><type>SoupConnection</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="SOUP-CONNECTION-ORIGIN-URI:CAPS" role="macro"/>SOUP_CONNECTION_ORIGIN_URI</title>
<indexterm><primary>SOUP_CONNECTION_ORIGIN_URI</primary></indexterm><programlisting>#define SOUP_CONNECTION_ORIGIN_URI "origin-uri"
</programlisting>
<para>
An alias for the "origin-uri" property.
</para></refsect2>
<refsect2>
<title><anchor id="SOUP-CONNECTION-PROXY-URI:CAPS" role="macro"/>SOUP_CONNECTION_PROXY_URI</title>
<indexterm><primary>SOUP_CONNECTION_PROXY_URI</primary></indexterm><programlisting>#define SOUP_CONNECTION_PROXY_URI "proxy-uri"
</programlisting>
<para>
An alias for the "proxy-uri" property.
</para></refsect2>
<refsect2>
<title><anchor id="SOUP-CONNECTION-SSL-CREDENTIALS:CAPS" role="macro"/>SOUP_CONNECTION_SSL_CREDENTIALS</title>
<indexterm><primary>SOUP_CONNECTION_SSL_CREDENTIALS</primary></indexterm><programlisting>#define SOUP_CONNECTION_SSL_CREDENTIALS "ssl-creds"
</programlisting>
<para>
An alias for the "ssl-creds" property.
</para></refsect2>
<refsect2>
<title><anchor id="SOUP-CONNECTION-MESSAGE-FILTER:CAPS" role="macro"/>SOUP_CONNECTION_MESSAGE_FILTER</title>
<indexterm><primary>SOUP_CONNECTION_MESSAGE_FILTER</primary></indexterm><programlisting>#define SOUP_CONNECTION_MESSAGE_FILTER "message-filter"
</programlisting>
<para>
An alias for the "message-filter" property.
</para></refsect2>
<refsect2>
<title><anchor id="SOUP-CONNECTION-ASYNC-CONTEXT:CAPS" role="macro"/>SOUP_CONNECTION_ASYNC_CONTEXT</title>
<indexterm><primary>SOUP_CONNECTION_ASYNC_CONTEXT</primary></indexterm><programlisting>#define SOUP_CONNECTION_ASYNC_CONTEXT "async-context"
</programlisting>
<para>
An alias for the "async-context" property.
</para></refsect2>
<refsect2>
<title><anchor id="SOUP-CONNECTION-TIMEOUT:CAPS" role="macro"/>SOUP_CONNECTION_TIMEOUT</title>
<indexterm><primary>SOUP_CONNECTION_TIMEOUT</primary></indexterm><programlisting>#define SOUP_CONNECTION_TIMEOUT "timeout"
</programlisting>
<para>
An alias for the "timeout" property.
</para></refsect2>
</refsect1>
<refsect1 role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="SoupConnection--async-context"/>The "<literal>async-context</literal>" property</title>
<indexterm><primary>SoupConnection:async-context</primary></indexterm><programlisting> "async-context" <link linkend="gpointer">gpointer</link> : Read / Write / Construct Only</programlisting>
<para>GMainContext to dispatch this connection's async I/O in.</para></refsect2>
<refsect2><title><anchor id="SoupConnection--message-filter"/>The "<literal>message-filter</literal>" property</title>
<indexterm><primary>SoupConnection:message-filter</primary></indexterm><programlisting> "message-filter" <link linkend="gpointer">gpointer</link> : Read / Write</programlisting>
<para>Message filter object for this connection.</para></refsect2>
<refsect2><title><anchor id="SoupConnection--origin-uri"/>The "<literal>origin-uri</literal>" property</title>
<indexterm><primary>SoupConnection:origin-uri</primary></indexterm><programlisting> "origin-uri" <link linkend="gpointer">gpointer</link> : Read / Write / Construct Only</programlisting>
<para>The HTTP origin server to use for this connection.</para></refsect2>
<refsect2><title><anchor id="SoupConnection--proxy-uri"/>The "<literal>proxy-uri</literal>" property</title>
<indexterm><primary>SoupConnection:proxy-uri</primary></indexterm><programlisting> "proxy-uri" <link linkend="gpointer">gpointer</link> : Read / Write / Construct Only</programlisting>
<para>The HTTP Proxy to use for this connection.</para></refsect2>
<refsect2><title><anchor id="SoupConnection--ssl-creds"/>The "<literal>ssl-creds</literal>" property</title>
<indexterm><primary>SoupConnection:ssl-creds</primary></indexterm><programlisting> "ssl-creds" <link linkend="gpointer">gpointer</link> : Read / Write / Construct Only</programlisting>
<para>Opaque SSL credentials for this connection.</para></refsect2>
<refsect2><title><anchor id="SoupConnection--timeout"/>The "<literal>timeout</literal>" property</title>
<indexterm><primary>SoupConnection:timeout</primary></indexterm><programlisting> "timeout" <link linkend="guint">guint</link> : Read / Write</programlisting>
<para>Value in seconds to timeout a blocking I/O.</para><para>Default value: 0</para>
</refsect2>
</refsect1>
<refsect1 role="signals">
<title role="signals.title">Signal Details</title>
<refsect2><title><anchor id="SoupConnection-authenticate"/>The "authenticate" signal</title>
<indexterm><primary>SoupConnection::authenticate</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="SoupConnection">SoupConnection</link> *conn,
<link linkend="SoupMessage">SoupMessage</link> *msg,
<link linkend="gchar">gchar</link> *auth_type,
<link linkend="gchar">gchar</link> *auth_realm,
<link linkend="gpointer">gpointer</link> username,
<link linkend="gpointer">gpointer</link> password,
<link linkend="gpointer">gpointer</link> user_data) : Run first</programlisting>
<para>
Emitted when the connection requires authentication.
(<link linkend="SoupConnectionNTLM"><type>SoupConnectionNTLM</type></link> makes use of this.)</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>conn</parameter> :</term>
<listitem><simpara> the connection
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>msg</parameter> :</term>
<listitem><simpara> the <link linkend="SoupMessage"><type>SoupMessage</type></link> being sent
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>auth_type</parameter> :</term>
<listitem><simpara> the authentication type
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>auth_realm</parameter> :</term>
<listitem><simpara> the realm being authenticated to
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>username</parameter> :</term>
<listitem><simpara> the signal handler should set this to point to
the provided username
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>password</parameter> :</term>
<listitem><simpara> the signal handler should set this to point to
the provided password
</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><refsect2><title><anchor id="SoupConnection-connect-result"/>The "connect-result" signal</title>
<indexterm><primary>SoupConnection::connect-result</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="SoupConnection">SoupConnection</link> *conn,
<link linkend="gint">gint</link> status,
<link linkend="gpointer">gpointer</link> user_data) : Run first</programlisting>
<para>
Emitted when a connection attempt succeeds or fails. This
is used internally by <link linkend="soup-connection-connect-async"><function>soup_connection_connect_async()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>conn</parameter> :</term>
<listitem><simpara> the connection
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>status</parameter> :</term>
<listitem><simpara> the status
</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><refsect2><title><anchor id="SoupConnection-disconnected"/>The "disconnected" signal</title>
<indexterm><primary>SoupConnection::disconnected</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="SoupConnection">SoupConnection</link> *conn,
<link linkend="gpointer">gpointer</link> user_data) : Run first</programlisting>
<para>
Emitted when the connection's socket is disconnected, for
whatever reason.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>conn</parameter> :</term>
<listitem><simpara> the connection
</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><refsect2><title><anchor id="SoupConnection-reauthenticate"/>The "reauthenticate" signal</title>
<indexterm><primary>SoupConnection::reauthenticate</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="SoupConnection">SoupConnection</link> *conn,
<link linkend="SoupMessage">SoupMessage</link> *msg,
<link linkend="gchar">gchar</link> *auth_type,
<link linkend="gchar">gchar</link> *auth_realm,
<link linkend="gpointer">gpointer</link> username,
<link linkend="gpointer">gpointer</link> password,
<link linkend="gpointer">gpointer</link> user_data) : Run first</programlisting>
<para>
Emitted when the authentication data acquired by a previous
<link linkend="authenticate"><literal>authenticate</literal></link> or <link linkend="reauthenticate"><literal>reauthenticate</literal></link> signal fails.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>conn</parameter> :</term>
<listitem><simpara> the connection
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>msg</parameter> :</term>
<listitem><simpara> the <link linkend="SoupMessage"><type>SoupMessage</type></link> being sent
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>auth_type</parameter> :</term>
<listitem><simpara> the authentication type
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>auth_realm</parameter> :</term>
<listitem><simpara> the realm being authenticated to
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>username</parameter> :</term>
<listitem><simpara> the signal handler should set this to point to
the provided username
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>password</parameter> :</term>
<listitem><simpara> the signal handler should set this to point to
the provided password
</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>
|
