-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathSoup-2.4.gir
20364 lines (20002 loc) · 888 KB
/
Soup-2.4.gir
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
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<!-- This file was automatically generated from C sources - DO NOT EDIT!
To affect the contents of this file, edit the original C definitions,
and/or use gtk-doc annotations. -->
<repository version="1.2"
xmlns="http://www.gtk.org/introspection/core/1.0"
xmlns:c="http://www.gtk.org/introspection/c/1.0"
xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
<include name="Gio" version="2.0"/>
<package name="libsoup-2.4"/>
<c:include name="libsoup/soup.h"/>
<namespace name="Soup"
version="2.4"
shared-library="libsoup-2.4.so.1"
c:identifier-prefixes="Soup"
c:symbol-prefixes="soup">
<constant name="ADDRESS_ANY_PORT" value="0" c:type="SOUP_ADDRESS_ANY_PORT">
<doc xml:space="preserve">This can be passed to any #SoupAddress method that expects a port,
to indicate that you don't care what port is used.</doc>
<type name="gint" c:type="gint"/>
</constant>
<constant name="ADDRESS_FAMILY"
value="family"
c:type="SOUP_ADDRESS_FAMILY">
<doc xml:space="preserve">Alias for the #SoupAddress:family property. (The
#SoupAddressFamily for this address.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ADDRESS_NAME" value="name" c:type="SOUP_ADDRESS_NAME">
<doc xml:space="preserve">Alias for the #SoupAddress:name property. (The hostname for
this address.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ADDRESS_PHYSICAL"
value="physical"
c:type="SOUP_ADDRESS_PHYSICAL">
<doc xml:space="preserve">An alias for the #SoupAddress:physical property. (The
stringified IP address for this address.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ADDRESS_PORT" value="port" c:type="SOUP_ADDRESS_PORT">
<doc xml:space="preserve">An alias for the #SoupAddress:port property. (The port for
this address.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ADDRESS_PROTOCOL"
value="protocol"
c:type="SOUP_ADDRESS_PROTOCOL">
<doc xml:space="preserve">Alias for the #SoupAddress:protocol property. (The URI scheme
used with this address.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="ADDRESS_SOCKADDR"
value="sockaddr"
c:type="SOUP_ADDRESS_SOCKADDR">
<doc xml:space="preserve">An alias for the #SoupAddress:sockaddr property. (A pointer
to the struct sockaddr for this address.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="AUTH_DOMAIN_ADD_PATH"
value="add-path"
c:type="SOUP_AUTH_DOMAIN_ADD_PATH">
<doc xml:space="preserve">Alias for the #SoupAuthDomain:add-path property. (Shortcut
for calling soup_auth_domain_add_path().)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="AUTH_DOMAIN_BASIC_AUTH_CALLBACK"
value="auth-callback"
c:type="SOUP_AUTH_DOMAIN_BASIC_AUTH_CALLBACK">
<doc xml:space="preserve">Alias for the #SoupAuthDomainBasic:auth-callback property.
(The #SoupAuthDomainBasicAuthCallback.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="AUTH_DOMAIN_BASIC_AUTH_DATA"
value="auth-data"
c:type="SOUP_AUTH_DOMAIN_BASIC_AUTH_DATA">
<doc xml:space="preserve">Alias for the #SoupAuthDomainBasic:auth-data property.
(The data to pass to the #SoupAuthDomainBasicAuthCallback.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="AUTH_DOMAIN_BASIC_H"
value="1"
c:type="SOUP_AUTH_DOMAIN_BASIC_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="AUTH_DOMAIN_DIGEST_AUTH_CALLBACK"
value="auth-callback"
c:type="SOUP_AUTH_DOMAIN_DIGEST_AUTH_CALLBACK">
<doc xml:space="preserve">Alias for the #SoupAuthDomainDigest:auth-callback property.
(The #SoupAuthDomainDigestAuthCallback.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="AUTH_DOMAIN_DIGEST_AUTH_DATA"
value="auth-data"
c:type="SOUP_AUTH_DOMAIN_DIGEST_AUTH_DATA">
<doc xml:space="preserve">Alias for the #SoupAuthDomainDigest:auth-callback property.
(The #SoupAuthDomainDigestAuthCallback.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="AUTH_DOMAIN_DIGEST_H"
value="1"
c:type="SOUP_AUTH_DOMAIN_DIGEST_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="AUTH_DOMAIN_FILTER"
value="filter"
c:type="SOUP_AUTH_DOMAIN_FILTER">
<doc xml:space="preserve">Alias for the #SoupAuthDomain:filter property. (The
#SoupAuthDomainFilter for the domain.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="AUTH_DOMAIN_FILTER_DATA"
value="filter-data"
c:type="SOUP_AUTH_DOMAIN_FILTER_DATA">
<doc xml:space="preserve">Alias for the #SoupAuthDomain:filter-data property. (Data
to pass to the #SoupAuthDomainFilter.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="AUTH_DOMAIN_GENERIC_AUTH_CALLBACK"
value="generic-auth-callback"
c:type="SOUP_AUTH_DOMAIN_GENERIC_AUTH_CALLBACK">
<doc xml:space="preserve">Alias for the #SoupAuthDomain:generic-auth-callback property.
(The #SoupAuthDomainGenericAuthCallback.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="AUTH_DOMAIN_GENERIC_AUTH_DATA"
value="generic-auth-data"
c:type="SOUP_AUTH_DOMAIN_GENERIC_AUTH_DATA">
<doc xml:space="preserve">Alias for the #SoupAuthDomain:generic-auth-data property.
(The data to pass to the #SoupAuthDomainGenericAuthCallback.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="AUTH_DOMAIN_H" value="1" c:type="SOUP_AUTH_DOMAIN_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="AUTH_DOMAIN_PROXY"
value="proxy"
c:type="SOUP_AUTH_DOMAIN_PROXY">
<doc xml:space="preserve">Alias for the #SoupAuthDomain:proxy property. (Whether or
not this is a proxy auth domain.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="AUTH_DOMAIN_REALM"
value="realm"
c:type="SOUP_AUTH_DOMAIN_REALM">
<doc xml:space="preserve">Alias for the #SoupAuthDomain:realm property. (The realm of
this auth domain.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="AUTH_DOMAIN_REMOVE_PATH"
value="remove-path"
c:type="SOUP_AUTH_DOMAIN_REMOVE_PATH">
<doc xml:space="preserve">Alias for the #SoupAuthDomain:remove-path property.
(Shortcut for calling soup_auth_domain_remove_path().)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="AUTH_H" value="1" c:type="SOUP_AUTH_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="AUTH_HOST" value="host" c:type="SOUP_AUTH_HOST">
<doc xml:space="preserve">An alias for the #SoupAuth:host property. (The
host being authenticated to.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="AUTH_IS_AUTHENTICATED"
value="is-authenticated"
c:type="SOUP_AUTH_IS_AUTHENTICATED">
<doc xml:space="preserve">An alias for the #SoupAuth:is-authenticated property.
(Whether or not the auth has been authenticated.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="AUTH_IS_FOR_PROXY"
value="is-for-proxy"
c:type="SOUP_AUTH_IS_FOR_PROXY">
<doc xml:space="preserve">An alias for the #SoupAuth:is-for-proxy property. (Whether
or not the auth is for a proxy server.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="AUTH_MANAGER_H" value="1" c:type="SOUP_AUTH_MANAGER_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="AUTH_REALM" value="realm" c:type="SOUP_AUTH_REALM">
<doc xml:space="preserve">An alias for the #SoupAuth:realm property. (The
authentication realm.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="AUTH_SCHEME_NAME"
value="scheme-name"
c:type="SOUP_AUTH_SCHEME_NAME">
<doc xml:space="preserve">An alias for the #SoupAuth:scheme-name property. (The
authentication scheme name.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<class name="Address"
c:symbol-prefix="address"
c:type="SoupAddress"
parent="GObject.Object"
glib:type-name="SoupAddress"
glib:get-type="soup_address_get_type"
glib:type-struct="AddressClass">
<implements name="Gio.SocketConnectable"/>
<constructor name="new" c:identifier="soup_address_new">
<doc xml:space="preserve">Creates a #SoupAddress from @name and @port. The #SoupAddress's IP
address may not be available right away; the caller can call
soup_address_resolve_async() or soup_address_resolve_sync() to
force a DNS resolution.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #SoupAddress</doc>
<type name="Address" c:type="SoupAddress*"/>
</return-value>
<parameters>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">a hostname or physical address</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="port" transfer-ownership="none">
<doc xml:space="preserve">a port number</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_any" c:identifier="soup_address_new_any">
<doc xml:space="preserve">Returns a #SoupAddress corresponding to the "any" address
for @family (or %NULL if @family isn't supported), suitable for
using as a listening #SoupSocket.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">the new #SoupAddress</doc>
<type name="Address" c:type="SoupAddress*"/>
</return-value>
<parameters>
<parameter name="family" transfer-ownership="none">
<doc xml:space="preserve">the address family</doc>
<type name="AddressFamily" c:type="SoupAddressFamily"/>
</parameter>
<parameter name="port" transfer-ownership="none">
<doc xml:space="preserve">the port number (usually %SOUP_ADDRESS_ANY_PORT)</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_from_sockaddr"
c:identifier="soup_address_new_from_sockaddr">
<doc xml:space="preserve">Returns a #SoupAddress equivalent to @sa (or %NULL if @sa's
address family isn't supported)</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">the new #SoupAddress</doc>
<type name="Address" c:type="SoupAddress*"/>
</return-value>
<parameters>
<parameter name="sa"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a pointer to a sockaddr</doc>
<type name="gpointer" c:type="sockaddr*"/>
</parameter>
<parameter name="len" transfer-ownership="none">
<doc xml:space="preserve">size of @sa</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</constructor>
<method name="equal_by_ip"
c:identifier="soup_address_equal_by_ip"
version="2.26">
<doc xml:space="preserve">Tests if @addr1 and @addr2 have the same IP address. This method
can be used with soup_address_hash_by_ip() to create a
#GHashTable that hashes on IP address.
This would be used to distinguish hosts in situations where
different virtual hosts on the same IP address should be considered
the same. Eg, if "www.example.com" and "www.example.net" have the
same IP address, then a single connection can be used to talk
to either of them.
See also soup_address_equal_by_name(), which compares by name
rather than by IP address.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">whether or not @addr1 and @addr2 have the same IP
address.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="addr1" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAddress with a resolved IP
address</doc>
<type name="Address" c:type="gconstpointer"/>
</instance-parameter>
<parameter name="addr2" transfer-ownership="none">
<doc xml:space="preserve">another #SoupAddress with a resolved
IP address</doc>
<type name="Address" c:type="gconstpointer"/>
</parameter>
</parameters>
</method>
<method name="equal_by_name"
c:identifier="soup_address_equal_by_name"
version="2.26">
<doc xml:space="preserve">Tests if @addr1 and @addr2 have the same "name". This method can be
used with soup_address_hash_by_name() to create a #GHashTable that
hashes on address "names".
Comparing by name normally means comparing the addresses by their
hostnames. But if the address was originally created using an IP
address literal, then it will be compared by that instead.
In particular, if "www.example.com" has the IP address 10.0.0.1,
and @addr1 was created with the name "www.example.com" and @addr2
was created with the name "10.0.0.1", then they will compare as
unequal for purposes of soup_address_equal_by_name().
This would be used to distinguish hosts in situations where
different virtual hosts on the same IP address should be considered
different. Eg, for purposes of HTTP authentication or cookies, two
hosts with the same IP address but different names are considered
to be different hosts.
See also soup_address_equal_by_ip(), which compares by IP address
rather than by name.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">whether or not @addr1 and @addr2 have the same name</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="addr1" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAddress with a resolved name</doc>
<type name="Address" c:type="gconstpointer"/>
</instance-parameter>
<parameter name="addr2" transfer-ownership="none">
<doc xml:space="preserve">another #SoupAddress with a resolved
name</doc>
<type name="Address" c:type="gconstpointer"/>
</parameter>
</parameters>
</method>
<method name="get_gsockaddr"
c:identifier="soup_address_get_gsockaddr"
version="2.32">
<doc xml:space="preserve">Creates a new #GSocketAddress corresponding to @addr (which is assumed
to only have one socket address associated with it).</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #GSocketAddress</doc>
<type name="Gio.SocketAddress" c:type="GSocketAddress*"/>
</return-value>
<parameters>
<instance-parameter name="addr" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAddress</doc>
<type name="Address" c:type="SoupAddress*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_name" c:identifier="soup_address_get_name">
<doc xml:space="preserve">Returns the hostname associated with @addr.
This method is not thread-safe; if you call it while @addr is being
resolved in another thread, it may return garbage. You can use
soup_address_is_resolved() to safely test whether or not an address
is resolved before fetching its name or address.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">the hostname, or %NULL if it is not known.</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<instance-parameter name="addr" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAddress</doc>
<type name="Address" c:type="SoupAddress*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_physical" c:identifier="soup_address_get_physical">
<doc xml:space="preserve">Returns the physical address associated with @addr as a string.
(Eg, "127.0.0.1"). If the address is not yet known, returns %NULL.
This method is not thread-safe; if you call it while @addr is being
resolved in another thread, it may return garbage. You can use
soup_address_is_resolved() to safely test whether or not an address
is resolved before fetching its name or address.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">the physical address, or %NULL</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<instance-parameter name="addr" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAddress</doc>
<type name="Address" c:type="SoupAddress*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_port" c:identifier="soup_address_get_port">
<doc xml:space="preserve">Returns the port associated with @addr.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the port</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="addr" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAddress</doc>
<type name="Address" c:type="SoupAddress*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_sockaddr" c:identifier="soup_address_get_sockaddr">
<doc xml:space="preserve">Returns the sockaddr associated with @addr, with its length in
*@len. If the sockaddr is not yet known, returns %NULL.
This method is not thread-safe; if you call it while @addr is being
resolved in another thread, it may return garbage. You can use
soup_address_is_resolved() to safely test whether or not an address
is resolved before fetching its name or address.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">the sockaddr, or %NULL</doc>
<type name="gpointer" c:type="sockaddr*"/>
</return-value>
<parameters>
<instance-parameter name="addr" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAddress</doc>
<type name="Address" c:type="SoupAddress*"/>
</instance-parameter>
<parameter name="len" transfer-ownership="none">
<doc xml:space="preserve">return location for sockaddr length</doc>
<type name="gint" c:type="int*"/>
</parameter>
</parameters>
</method>
<method name="hash_by_ip"
c:identifier="soup_address_hash_by_ip"
version="2.26">
<doc xml:space="preserve">A hash function (for #GHashTable) that corresponds to
soup_address_equal_by_ip(), qv</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the IP-based hash value for @addr.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="addr" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAddress</doc>
<type name="Address" c:type="gconstpointer"/>
</instance-parameter>
</parameters>
</method>
<method name="hash_by_name"
c:identifier="soup_address_hash_by_name"
version="2.26">
<doc xml:space="preserve">A hash function (for #GHashTable) that corresponds to
soup_address_equal_by_name(), qv</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the named-based hash value for @addr.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="addr" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAddress</doc>
<type name="Address" c:type="gconstpointer"/>
</instance-parameter>
</parameters>
</method>
<method name="is_resolved" c:identifier="soup_address_is_resolved">
<doc xml:space="preserve">Tests if @addr has already been resolved. Unlike the other
#SoupAddress "get" methods, this is safe to call when @addr might
be being resolved in another thread.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @addr has been resolved.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="addr" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAddress</doc>
<type name="Address" c:type="SoupAddress*"/>
</instance-parameter>
</parameters>
</method>
<method name="resolve_async" c:identifier="soup_address_resolve_async">
<doc xml:space="preserve">Asynchronously resolves the missing half of @addr (its IP address
if it was created with soup_address_new(), or its hostname if it
was created with soup_address_new_from_sockaddr() or
soup_address_new_any().)
If @cancellable is non-%NULL, it can be used to cancel the
resolution. @callback will still be invoked in this case, with a
status of %SOUP_STATUS_CANCELLED.
It is safe to call this more than once on a given address, from the
same thread, with the same @async_context (and doing so will not
result in redundant DNS queries being made). But it is not safe to
call from multiple threads, or with different @async_contexts, or
mixed with calls to soup_address_resolve_sync().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="addr" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAddress</doc>
<type name="Address" c:type="SoupAddress*"/>
</instance-parameter>
<parameter name="async_context"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the #GMainContext to call @callback from</doc>
<type name="GLib.MainContext" c:type="GMainContext*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GCancellable object, or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
scope="async"
closure="3">
<doc xml:space="preserve">callback to call with the result</doc>
<type name="AddressCallback" c:type="SoupAddressCallback"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">data for @callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</method>
<method name="resolve_sync" c:identifier="soup_address_resolve_sync">
<doc xml:space="preserve">Synchronously resolves the missing half of @addr, as with
soup_address_resolve_async().
If @cancellable is non-%NULL, it can be used to cancel the
resolution. soup_address_resolve_sync() will then return a status
of %SOUP_STATUS_CANCELLED.
It is safe to call this more than once, even from different
threads, but it is not safe to mix calls to
soup_address_resolve_sync() with calls to
soup_address_resolve_async() on the same address.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%SOUP_STATUS_OK, %SOUP_STATUS_CANT_RESOLVE, or
%SOUP_STATUS_CANCELLED.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="addr" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAddress</doc>
<type name="Address" c:type="SoupAddress*"/>
</instance-parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GCancellable object, or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
</parameters>
</method>
<property name="family"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="AddressFamily"/>
</property>
<property name="name"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="physical" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="port"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gint" c:type="gint"/>
</property>
<property name="protocol"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="sockaddr"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</property>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<callback name="AddressCallback" c:type="SoupAddressCallback">
<doc xml:space="preserve">The callback function passed to soup_address_resolve_async().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="addr" transfer-ownership="none">
<doc xml:space="preserve">the #SoupAddress that was resolved</doc>
<type name="Address" c:type="SoupAddress*"/>
</parameter>
<parameter name="status" transfer-ownership="none">
<doc xml:space="preserve">%SOUP_STATUS_OK, %SOUP_STATUS_CANT_RESOLVE, or
%SOUP_STATUS_CANCELLED</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1"
closure="2">
<doc xml:space="preserve">the user data that was passed to
soup_address_resolve_async()</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<record name="AddressClass"
c:type="SoupAddressClass"
glib:is-gtype-struct-for="Address">
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="_libsoup_reserved1" introspectable="0">
<callback name="_libsoup_reserved1">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_libsoup_reserved2" introspectable="0">
<callback name="_libsoup_reserved2">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_libsoup_reserved3" introspectable="0">
<callback name="_libsoup_reserved3">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
<field name="_libsoup_reserved4" introspectable="0">
<callback name="_libsoup_reserved4">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<enumeration name="AddressFamily"
glib:type-name="SoupAddressFamily"
glib:get-type="soup_address_family_get_type"
c:type="SoupAddressFamily">
<doc xml:space="preserve">The supported address families.</doc>
<member name="invalid"
value="-1"
c:identifier="SOUP_ADDRESS_FAMILY_INVALID"
glib:nick="invalid">
<doc xml:space="preserve">an invalid %SoupAddress</doc>
</member>
<member name="ipv4"
value="2"
c:identifier="SOUP_ADDRESS_FAMILY_IPV4"
glib:nick="ipv4">
<doc xml:space="preserve">an IPv4 address</doc>
</member>
<member name="ipv6"
value="10"
c:identifier="SOUP_ADDRESS_FAMILY_IPV6"
glib:nick="ipv6">
<doc xml:space="preserve">an IPv6 address</doc>
</member>
</enumeration>
<class name="Auth"
c:symbol-prefix="auth"
c:type="SoupAuth"
parent="GObject.Object"
abstract="1"
glib:type-name="SoupAuth"
glib:get-type="soup_auth_get_type"
glib:type-struct="AuthClass">
<doc xml:space="preserve">The abstract base class for handling authentication. Specific HTTP
Authentication mechanisms are implemented by its subclasses, but
applications never need to be aware of the specific subclasses
being used.</doc>
<constructor name="new" c:identifier="soup_auth_new">
<doc xml:space="preserve">Creates a new #SoupAuth of type @type with the information from
@msg and @auth_header.
This is called by #SoupSession; you will normally not create auths
yourself.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">the new #SoupAuth, or %NULL if it could
not be created</doc>
<type name="Auth" c:type="SoupAuth*"/>
</return-value>
<parameters>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">the type of auth to create (a subtype of #SoupAuth)</doc>
<type name="GType" c:type="GType"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the #SoupMessage the auth is being created for</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="auth_header" transfer-ownership="none">
<doc xml:space="preserve">the WWW-Authenticate/Proxy-Authenticate header</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</constructor>
<virtual-method name="authenticate" invoker="authenticate">
<doc xml:space="preserve">Call this on an auth to authenticate it; normally this will cause
the auth's message to be requeued with the new authentication info.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuth</doc>
<type name="Auth" c:type="SoupAuth*"/>
</instance-parameter>
<parameter name="username" transfer-ownership="none">
<doc xml:space="preserve">the username provided by the user or client</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="password" transfer-ownership="none">
<doc xml:space="preserve">the password provided by the user or client</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="can_authenticate"
invoker="can_authenticate"
version="2.54">
<doc xml:space="preserve">Tests if @auth is able to authenticate by providing credentials to the
soup_auth_authenticate().</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @auth is able to accept credentials.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuth</doc>
<type name="Auth" c:type="SoupAuth*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="get_authorization" invoker="get_authorization">
<doc xml:space="preserve">Generates an appropriate "Authorization" header for @msg. (The
session will only call this if soup_auth_is_authenticated()
returned %TRUE.)</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the "Authorization" header, which must be freed.</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuth</doc>
<type name="Auth" c:type="SoupAuth*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the #SoupMessage to be authorized</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="get_protection_space"
invoker="get_protection_space">
<doc xml:space="preserve">Returns a list of paths on the server which @auth extends over.
(All subdirectories of these paths are also assumed to be part
of @auth's protection space, unless otherwise discovered not to
be.)</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the list of
paths, which can be freed with soup_auth_free_protection_space().</doc>
<type name="GLib.SList" c:type="GSList*">
<type name="utf8"/>
</type>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuth</doc>
<type name="Auth" c:type="SoupAuth*"/>
</instance-parameter>
<parameter name="source_uri" transfer-ownership="none">
<doc xml:space="preserve">the URI of the request that @auth was generated in
response to.</doc>
<type name="URI" c:type="SoupURI*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="is_authenticated" invoker="is_authenticated">
<doc xml:space="preserve">Tests if @auth has been given a username and password</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @auth has been given a username and password</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuth</doc>
<type name="Auth" c:type="SoupAuth*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="is_ready" invoker="is_ready" version="2.42">
<doc xml:space="preserve">Tests if @auth is ready to make a request for @msg with. For most
auths, this is equivalent to soup_auth_is_authenticated(), but for
some auth types (eg, NTLM), the auth may be sendable (eg, as an
authentication request) even before it is authenticated.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @auth is ready to make a request with.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuth</doc>
<type name="Auth" c:type="SoupAuth*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="update" invoker="update">
<doc xml:space="preserve">Updates @auth with the information from @msg and @auth_header,
possibly un-authenticating it. As with soup_auth_new(), this is
normally only used by #SoupSession.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @auth is still a valid (but potentially
unauthenticated) #SoupAuth. %FALSE if something about @auth_params
could not be parsed or incorporated into @auth at all.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuth</doc>
<type name="Auth" c:type="SoupAuth*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the #SoupMessage @auth is being updated for</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="auth_header" transfer-ownership="none">
<doc xml:space="preserve">the WWW-Authenticate/Proxy-Authenticate header</doc>
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="gpointer" c:type="gpointer"/>
<type name="gpointer" c:type="gpointer"/>
</type>
</parameter>
</parameters>
</virtual-method>
<method name="authenticate" c:identifier="soup_auth_authenticate">
<doc xml:space="preserve">Call this on an auth to authenticate it; normally this will cause
the auth's message to be requeued with the new authentication info.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuth</doc>
<type name="Auth" c:type="SoupAuth*"/>
</instance-parameter>
<parameter name="username" transfer-ownership="none">
<doc xml:space="preserve">the username provided by the user or client</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="password" transfer-ownership="none">
<doc xml:space="preserve">the password provided by the user or client</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="can_authenticate"
c:identifier="soup_auth_can_authenticate"
version="2.54">
<doc xml:space="preserve">Tests if @auth is able to authenticate by providing credentials to the
soup_auth_authenticate().</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @auth is able to accept credentials.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuth</doc>
<type name="Auth" c:type="SoupAuth*"/>
</instance-parameter>
</parameters>
</method>
<method name="free_protection_space"
c:identifier="soup_auth_free_protection_space"
introspectable="0">
<doc xml:space="preserve">Frees @space.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuth</doc>
<type name="Auth" c:type="SoupAuth*"/>
</instance-parameter>
<parameter name="space" transfer-ownership="none">
<doc xml:space="preserve">the return value from soup_auth_get_protection_space()</doc>
<type name="GLib.SList" c:type="GSList*">
<type name="gpointer" c:type="gpointer"/>
</type>
</parameter>
</parameters>
</method>
<method name="get_authorization"
c:identifier="soup_auth_get_authorization">
<doc xml:space="preserve">Generates an appropriate "Authorization" header for @msg. (The
session will only call this if soup_auth_is_authenticated()
returned %TRUE.)</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the "Authorization" header, which must be freed.</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuth</doc>
<type name="Auth" c:type="SoupAuth*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the #SoupMessage to be authorized</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</method>
<method name="get_host" c:identifier="soup_auth_get_host">
<doc xml:space="preserve">Returns the host that @auth is associated with.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the hostname</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuth</doc>
<type name="Auth" c:type="SoupAuth*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_info" c:identifier="soup_auth_get_info">
<doc xml:space="preserve">Gets an opaque identifier for @auth, for use as a hash key or the
like. #SoupAuth objects from the same server with the same
identifier refer to the same authentication domain (eg, the URLs
associated with them take the same usernames and passwords).</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the identifier</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuth</doc>
<type name="Auth" c:type="SoupAuth*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_protection_space"
c:identifier="soup_auth_get_protection_space">
<doc xml:space="preserve">Returns a list of paths on the server which @auth extends over.
(All subdirectories of these paths are also assumed to be part
of @auth's protection space, unless otherwise discovered not to
be.)</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the list of
paths, which can be freed with soup_auth_free_protection_space().</doc>
<type name="GLib.SList" c:type="GSList*">
<type name="utf8"/>
</type>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuth</doc>
<type name="Auth" c:type="SoupAuth*"/>
</instance-parameter>
<parameter name="source_uri" transfer-ownership="none">
<doc xml:space="preserve">the URI of the request that @auth was generated in
response to.</doc>
<type name="URI" c:type="SoupURI*"/>
</parameter>
</parameters>
</method>
<method name="get_realm" c:identifier="soup_auth_get_realm">
<doc xml:space="preserve">Returns @auth's realm. This is an identifier that distinguishes
separate authentication spaces on a given server, and may be some
string that is meaningful to the user. (Although it is probably not
localized.)</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the realm name</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuth</doc>