/usr/share/gir-1.0/Soup-2.4.gir is in libsoup2.4-dev 2.52.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644 8645 8646 8647 8648 8649 8650 8651 8652 8653 8654 8655 8656 8657 8658 8659 8660 8661 8662 8663 8664 8665 8666 8667 8668 8669 8670 8671 8672 8673 8674 8675 8676 8677 8678 8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741 8742 8743 8744 8745 8746 8747 8748 8749 8750 8751 8752 8753 8754 8755 8756 8757 8758 8759 8760 8761 8762 8763 8764 8765 8766 8767 8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779 8780 8781 8782 8783 8784 8785 8786 8787 8788 8789 8790 8791 8792 8793 8794 8795 8796 8797 8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 8812 8813 8814 8815 8816 8817 8818 8819 8820 8821 8822 8823 8824 8825 8826 8827 8828 8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840 8841 8842 8843 8844 8845 8846 8847 8848 8849 8850 8851 8852 8853 8854 8855 8856 8857 8858 8859 8860 8861 8862 8863 8864 8865 8866 8867 8868 8869 8870 8871 8872 8873 8874 8875 8876 8877 8878 8879 8880 8881 8882 8883 8884 8885 8886 8887 8888 8889 8890 8891 8892 8893 8894 8895 8896 8897 8898 8899 8900 8901 8902 8903 8904 8905 8906 8907 8908 8909 8910 8911 8912 8913 8914 8915 8916 8917 8918 8919 8920 8921 8922 8923 8924 8925 8926 8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 8940 8941 8942 8943 8944 8945 8946 8947 8948 8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962 8963 8964 8965 8966 8967 8968 8969 8970 8971 8972 8973 8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986 8987 8988 8989 8990 8991 8992 8993 8994 8995 8996 8997 8998 8999 9000 9001 9002 9003 9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 9021 9022 9023 9024 9025 9026 9027 9028 9029 9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041 9042 9043 9044 9045 9046 9047 9048 9049 9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074 9075 9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 9088 9089 9090 9091 9092 9093 9094 9095 9096 9097 9098 9099 9100 9101 9102 9103 9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121 9122 9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232 9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 9270 9271 9272 9273 9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325 9326 9327 9328 9329 9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 9352 9353 9354 9355 9356 9357 9358 9359 9360 9361 9362 9363 9364 9365 9366 9367 9368 9369 9370 9371 9372 9373 9374 9375 9376 9377 9378 9379 9380 9381 9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 9438 9439 9440 9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 9464 9465 9466 9467 9468 9469 9470 9471 9472 9473 9474 9475 9476 9477 9478 9479 9480 9481 9482 9483 9484 9485 9486 9487 9488 9489 9490 9491 9492 9493 9494 9495 9496 9497 9498 9499 9500 9501 9502 9503 9504 9505 9506 9507 9508 9509 9510 9511 9512 9513 9514 9515 9516 9517 9518 9519 9520 9521 9522 9523 9524 9525 9526 9527 9528 9529 9530 9531 9532 9533 9534 9535 9536 9537 9538 9539 9540 9541 9542 9543 9544 9545 9546 9547 9548 9549 9550 9551 9552 9553 9554 9555 9556 9557 9558 9559 9560 9561 9562 9563 9564 9565 9566 9567 9568 9569 9570 9571 9572 9573 9574 9575 9576 9577 9578 9579 9580 9581 9582 9583 9584 9585 9586 9587 9588 9589 9590 9591 9592 9593 9594 9595 9596 9597 9598 9599 9600 9601 9602 9603 9604 9605 9606 9607 9608 9609 9610 9611 9612 9613 9614 9615 9616 9617 9618 9619 9620 9621 9622 9623 9624 9625 9626 9627 9628 9629 9630 9631 9632 9633 9634 9635 9636 9637 9638 9639 9640 9641 9642 9643 9644 9645 9646 9647 9648 9649 9650 9651 9652 9653 9654 9655 9656 9657 9658 9659 9660 9661 9662 9663 9664 9665 9666 9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678 9679 9680 9681 9682 9683 9684 9685 9686 9687 9688 9689 9690 9691 9692 9693 9694 9695 9696 9697 9698 9699 9700 9701 9702 9703 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714 9715 9716 9717 9718 9719 9720 9721 9722 9723 9724 9725 9726 9727 9728 9729 9730 9731 9732 9733 9734 9735 9736 9737 9738 9739 9740 9741 9742 9743 9744 9745 9746 9747 9748 9749 9750 9751 9752 9753 9754 9755 9756 9757 9758 9759 9760 9761 9762 9763 9764 9765 9766 9767 9768 9769 9770 9771 9772 9773 9774 9775 9776 9777 9778 9779 9780 9781 9782 9783 9784 9785 9786 9787 9788 9789 9790 9791 9792 9793 9794 9795 9796 9797 9798 9799 9800 9801 9802 9803 9804 9805 9806 9807 9808 9809 9810 9811 9812 9813 9814 9815 9816 9817 9818 9819 9820 9821 9822 9823 9824 9825 9826 9827 9828 9829 9830 9831 9832 9833 9834 9835 9836 9837 9838 9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 9879 9880 9881 9882 9883 9884 9885 9886 9887 9888 9889 9890 9891 9892 9893 9894 9895 9896 9897 9898 9899 9900 9901 9902 9903 9904 9905 9906 9907 9908 9909 9910 9911 9912 9913 9914 9915 9916 9917 9918 9919 9920 9921 9922 9923 9924 9925 9926 9927 9928 9929 9930 9931 9932 9933 9934 9935 9936 9937 9938 9939 9940 9941 9942 9943 9944 9945 9946 9947 9948 9949 9950 9951 9952 9953 9954 9955 9956 9957 9958 9959 9960 9961 9962 9963 9964 9965 9966 9967 9968 9969 9970 9971 9972 9973 9974 9975 9976 9977 9978 9979 9980 9981 9982 9983 9984 9985 9986 9987 9988 9989 9990 9991 9992 9993 9994 9995 9996 9997 9998 9999 10000 10001 10002 10003 10004 10005 10006 10007 10008 10009 10010 10011 10012 10013 10014 10015 10016 10017 10018 10019 10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030 10031 10032 10033 10034 10035 10036 10037 10038 10039 10040 10041 10042 10043 10044 10045 10046 10047 10048 10049 10050 10051 10052 10053 10054 10055 10056 10057 10058 10059 10060 10061 10062 10063 10064 10065 10066 10067 10068 10069 10070 10071 10072 10073 10074 10075 10076 10077 10078 10079 10080 10081 10082 10083 10084 10085 10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096 10097 10098 10099 10100 10101 10102 10103 10104 10105 10106 10107 10108 10109 10110 10111 10112 10113 10114 10115 10116 10117 10118 10119 10120 10121 10122 10123 10124 10125 10126 10127 10128 10129 10130 10131 10132 10133 10134 10135 10136 10137 10138 10139 10140 10141 10142 10143 10144 10145 10146 10147 10148 10149 10150 10151 10152 10153 10154 10155 10156 10157 10158 10159 10160 10161 10162 10163 10164 10165 10166 10167 10168 10169 10170 10171 10172 10173 10174 10175 10176 10177 10178 10179 10180 10181 10182 10183 10184 10185 10186 10187 10188 10189 10190 10191 10192 10193 10194 10195 10196 10197 10198 10199 10200 10201 10202 10203 10204 10205 10206 10207 10208 10209 10210 10211 10212 10213 10214 10215 10216 10217 10218 10219 10220 10221 10222 10223 10224 10225 10226 10227 10228 10229 10230 10231 10232 10233 10234 10235 10236 10237 10238 10239 10240 10241 10242 10243 10244 10245 10246 10247 10248 10249 10250 10251 10252 10253 10254 10255 10256 10257 10258 10259 10260 10261 10262 10263 10264 10265 10266 10267 10268 10269 10270 10271 10272 10273 10274 10275 10276 10277 10278 10279 10280 10281 10282 10283 10284 10285 10286 10287 10288 10289 10290 10291 10292 10293 10294 10295 10296 10297 10298 10299 10300 10301 10302 10303 10304 10305 10306 10307 10308 10309 10310 10311 10312 10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 10336 10337 10338 10339 10340 10341 10342 10343 10344 10345 10346 10347 10348 10349 10350 10351 10352 10353 10354 10355 10356 10357 10358 10359 10360 10361 10362 10363 10364 10365 10366 10367 10368 10369 10370 10371 10372 10373 10374 10375 10376 10377 10378 10379 10380 10381 10382 10383 10384 10385 10386 10387 10388 10389 10390 10391 10392 10393 10394 10395 10396 10397 10398 10399 10400 10401 10402 10403 10404 10405 10406 10407 10408 10409 10410 10411 10412 10413 10414 10415 10416 10417 10418 10419 10420 10421 10422 10423 10424 10425 10426 10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447 10448 10449 10450 10451 10452 10453 10454 10455 10456 10457 10458 10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 10473 10474 10475 10476 10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 10490 10491 10492 10493 10494 10495 10496 10497 10498 10499 10500 10501 10502 10503 10504 10505 10506 10507 10508 10509 10510 10511 10512 10513 10514 10515 10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535 10536 10537 10538 10539 10540 10541 10542 10543 10544 10545 10546 10547 10548 10549 10550 10551 10552 10553 10554 10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 10570 10571 10572 10573 10574 10575 10576 10577 10578 10579 10580 10581 10582 10583 10584 10585 10586 10587 10588 10589 10590 10591 10592 10593 10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 10611 10612 10613 10614 10615 10616 10617 10618 10619 10620 10621 10622 10623 10624 10625 10626 10627 10628 10629 10630 10631 10632 10633 10634 10635 10636 10637 10638 10639 10640 10641 10642 10643 10644 10645 10646 10647 10648 10649 10650 10651 10652 10653 10654 10655 10656 10657 10658 10659 10660 10661 10662 10663 10664 10665 10666 10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 10702 10703 10704 10705 10706 10707 10708 10709 10710 10711 10712 10713 10714 10715 10716 10717 10718 10719 10720 10721 10722 10723 10724 10725 10726 10727 10728 10729 10730 10731 10732 10733 10734 10735 10736 10737 10738 10739 10740 10741 10742 10743 10744 10745 10746 10747 10748 10749 10750 10751 10752 10753 10754 10755 10756 10757 10758 10759 10760 10761 10762 10763 10764 10765 10766 10767 10768 10769 10770 10771 10772 10773 10774 10775 10776 10777 10778 10779 10780 10781 10782 10783 10784 10785 10786 10787 10788 10789 10790 10791 10792 10793 10794 10795 10796 10797 10798 10799 10800 10801 10802 10803 10804 10805 10806 10807 10808 10809 10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836 10837 10838 10839 10840 10841 10842 10843 10844 10845 10846 10847 10848 10849 10850 10851 10852 10853 10854 10855 10856 10857 10858 10859 10860 10861 10862 10863 10864 10865 10866 10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 10884 10885 10886 10887 10888 10889 10890 10891 10892 10893 10894 10895 10896 10897 10898 10899 10900 10901 10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914 10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 10926 10927 10928 10929 10930 10931 10932 10933 10934 10935 10936 10937 10938 10939 10940 10941 10942 10943 10944 10945 10946 10947 10948 10949 10950 10951 10952 10953 10954 10955 10956 10957 10958 10959 10960 10961 10962 10963 10964 10965 10966 10967 10968 10969 10970 10971 10972 10973 10974 10975 10976 10977 10978 10979 10980 10981 10982 10983 10984 10985 10986 10987 10988 10989 10990 10991 10992 10993 10994 10995 10996 10997 10998 10999 11000 11001 11002 11003 11004 11005 11006 11007 11008 11009 11010 11011 11012 11013 11014 11015 11016 11017 11018 11019 11020 11021 11022 11023 11024 11025 11026 11027 11028 11029 11030 11031 11032 11033 11034 11035 11036 11037 11038 11039 11040 11041 11042 11043 11044 11045 11046 11047 11048 11049 11050 11051 11052 11053 11054 11055 11056 11057 11058 11059 11060 11061 11062 11063 11064 11065 11066 11067 11068 11069 11070 11071 11072 11073 11074 11075 11076 11077 11078 11079 11080 11081 11082 11083 11084 11085 11086 11087 11088 11089 11090 11091 11092 11093 11094 11095 11096 11097 11098 11099 11100 11101 11102 11103 11104 11105 11106 11107 11108 11109 11110 11111 11112 11113 11114 11115 11116 11117 11118 11119 11120 11121 11122 11123 11124 11125 11126 11127 11128 11129 11130 11131 11132 11133 11134 11135 11136 11137 11138 11139 11140 11141 11142 11143 11144 11145 11146 11147 11148 11149 11150 11151 11152 11153 11154 11155 11156 11157 11158 11159 11160 11161 11162 11163 11164 11165 11166 11167 11168 11169 11170 11171 11172 11173 11174 11175 11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 11191 11192 11193 11194 11195 11196 11197 11198 11199 11200 11201 11202 11203 11204 11205 11206 11207 11208 11209 11210 11211 11212 11213 11214 11215 11216 11217 11218 11219 11220 11221 11222 11223 11224 11225 11226 11227 11228 11229 11230 11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 11247 11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 11262 11263 11264 11265 11266 11267 11268 11269 11270 11271 11272 11273 11274 11275 11276 11277 11278 11279 11280 11281 11282 11283 11284 11285 11286 11287 11288 11289 11290 11291 11292 11293 11294 11295 11296 11297 11298 11299 11300 11301 11302 11303 11304 11305 11306 11307 11308 11309 11310 11311 11312 11313 11314 11315 11316 11317 11318 11319 11320 11321 11322 11323 11324 11325 11326 11327 11328 11329 11330 11331 11332 11333 11334 11335 11336 11337 11338 11339 11340 11341 11342 11343 11344 11345 11346 11347 11348 11349 11350 11351 11352 11353 11354 11355 11356 11357 11358 11359 11360 11361 11362 11363 11364 11365 11366 11367 11368 11369 11370 11371 11372 11373 11374 11375 11376 11377 11378 11379 11380 11381 11382 11383 11384 11385 11386 11387 11388 11389 11390 11391 11392 11393 11394 11395 11396 11397 11398 11399 11400 11401 11402 11403 11404 11405 11406 11407 11408 11409 11410 11411 11412 11413 11414 11415 11416 11417 11418 11419 11420 11421 11422 11423 11424 11425 11426 11427 11428 11429 11430 11431 11432 11433 11434 11435 11436 11437 11438 11439 11440 11441 11442 11443 11444 11445 11446 11447 11448 11449 11450 11451 11452 11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 11469 11470 11471 11472 11473 11474 11475 11476 11477 11478 11479 11480 11481 11482 11483 11484 11485 11486 11487 11488 11489 11490 11491 11492 11493 11494 11495 11496 11497 11498 11499 11500 11501 11502 11503 11504 11505 11506 11507 11508 11509 11510 11511 11512 11513 11514 11515 11516 11517 11518 11519 11520 11521 11522 11523 11524 11525 11526 11527 11528 11529 11530 11531 11532 11533 11534 11535 11536 11537 11538 11539 11540 11541 11542 11543 11544 11545 11546 11547 11548 11549 11550 11551 11552 11553 11554 11555 11556 11557 11558 11559 11560 11561 11562 11563 11564 11565 11566 11567 11568 11569 11570 11571 11572 11573 11574 11575 11576 11577 11578 11579 11580 11581 11582 11583 11584 11585 11586 11587 11588 11589 11590 11591 11592 11593 11594 11595 11596 11597 11598 11599 11600 11601 11602 11603 11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 11629 11630 11631 11632 11633 11634 11635 11636 11637 11638 11639 11640 11641 11642 11643 11644 11645 11646 11647 11648 11649 11650 11651 11652 11653 11654 11655 11656 11657 11658 11659 11660 11661 11662 11663 11664 11665 11666 11667 11668 11669 11670 11671 11672 11673 11674 11675 11676 11677 11678 11679 11680 11681 11682 11683 11684 11685 11686 11687 11688 11689 11690 11691 11692 11693 11694 11695 11696 11697 11698 11699 11700 11701 11702 11703 11704 11705 11706 11707 11708 11709 11710 11711 11712 11713 11714 11715 11716 11717 11718 11719 11720 11721 11722 11723 11724 11725 11726 11727 11728 11729 11730 11731 11732 11733 11734 11735 11736 11737 11738 11739 11740 11741 11742 11743 11744 11745 11746 11747 11748 11749 11750 11751 11752 11753 11754 11755 11756 11757 11758 11759 11760 11761 11762 11763 11764 11765 11766 11767 11768 11769 11770 11771 11772 11773 11774 11775 11776 11777 11778 11779 11780 11781 11782 11783 11784 11785 11786 11787 11788 11789 11790 11791 11792 11793 11794 11795 11796 11797 11798 11799 11800 11801 11802 11803 11804 11805 11806 11807 11808 11809 11810 11811 11812 11813 11814 11815 11816 11817 11818 11819 11820 11821 11822 11823 11824 11825 11826 11827 11828 11829 11830 11831 11832 11833 11834 11835 11836 11837 11838 11839 11840 11841 11842 11843 11844 11845 11846 11847 11848 11849 11850 11851 11852 11853 11854 11855 11856 11857 11858 11859 11860 11861 11862 11863 11864 11865 11866 11867 11868 11869 11870 11871 11872 11873 11874 11875 11876 11877 11878 11879 11880 11881 11882 11883 11884 11885 11886 11887 11888 11889 11890 11891 11892 11893 11894 11895 11896 11897 11898 11899 11900 11901 11902 11903 11904 11905 11906 11907 11908 11909 11910 11911 11912 11913 11914 11915 11916 11917 11918 11919 11920 11921 11922 11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 11942 11943 11944 11945 11946 11947 11948 11949 11950 11951 11952 11953 11954 11955 11956 11957 11958 11959 11960 11961 11962 11963 11964 11965 11966 11967 11968 11969 11970 11971 11972 11973 11974 11975 11976 11977 11978 11979 11980 11981 11982 11983 11984 11985 11986 11987 11988 11989 11990 11991 11992 11993 11994 11995 11996 11997 11998 11999 12000 12001 12002 12003 12004 12005 12006 12007 12008 12009 12010 12011 12012 12013 12014 12015 12016 12017 12018 12019 12020 12021 12022 12023 12024 12025 12026 12027 12028 12029 12030 12031 12032 12033 12034 12035 12036 12037 12038 12039 12040 12041 12042 12043 12044 12045 12046 12047 12048 12049 12050 12051 12052 12053 12054 12055 12056 12057 12058 12059 12060 12061 12062 12063 12064 12065 12066 12067 12068 12069 12070 12071 12072 12073 12074 12075 12076 12077 12078 12079 12080 12081 12082 12083 12084 12085 12086 12087 12088 12089 12090 12091 12092 12093 12094 12095 12096 12097 12098 12099 12100 12101 12102 12103 12104 12105 12106 12107 12108 12109 12110 12111 12112 12113 12114 12115 12116 12117 12118 12119 12120 12121 12122 12123 12124 12125 12126 12127 12128 12129 12130 12131 12132 12133 12134 12135 12136 12137 12138 12139 12140 12141 12142 12143 12144 12145 12146 12147 12148 12149 12150 12151 12152 12153 12154 12155 12156 12157 12158 12159 12160 12161 12162 12163 12164 12165 12166 12167 12168 12169 12170 12171 12172 12173 12174 12175 12176 12177 12178 12179 12180 12181 12182 12183 12184 12185 12186 12187 12188 12189 12190 12191 12192 12193 12194 12195 12196 12197 12198 12199 12200 12201 12202 12203 12204 12205 12206 12207 12208 12209 12210 12211 12212 12213 12214 12215 12216 12217 12218 12219 12220 12221 12222 12223 12224 12225 12226 12227 12228 12229 12230 12231 12232 12233 12234 12235 12236 12237 12238 12239 12240 12241 12242 12243 12244 12245 12246 12247 12248 12249 12250 12251 12252 12253 12254 12255 12256 12257 12258 12259 12260 12261 12262 12263 12264 12265 12266 12267 12268 12269 12270 12271 12272 12273 12274 12275 12276 12277 12278 12279 12280 12281 12282 12283 12284 12285 12286 12287 12288 12289 12290 12291 12292 12293 12294 12295 12296 12297 12298 12299 12300 12301 12302 12303 12304 12305 12306 12307 12308 12309 12310 12311 12312 12313 12314 12315 12316 12317 12318 12319 12320 12321 12322 12323 12324 12325 12326 12327 12328 12329 12330 12331 12332 12333 12334 12335 12336 12337 12338 12339 12340 12341 12342 12343 12344 12345 12346 12347 12348 12349 12350 12351 12352 12353 12354 12355 12356 12357 12358 12359 12360 12361 12362 12363 12364 12365 12366 12367 12368 12369 12370 12371 12372 12373 12374 12375 12376 12377 12378 12379 12380 12381 12382 12383 12384 12385 12386 12387 12388 12389 12390 12391 12392 12393 12394 12395 12396 12397 12398 12399 12400 12401 12402 12403 12404 12405 12406 12407 12408 12409 12410 12411 12412 12413 12414 12415 12416 12417 12418 12419 12420 12421 12422 12423 12424 12425 12426 12427 12428 12429 12430 12431 12432 12433 12434 12435 12436 12437 12438 12439 12440 12441 12442 12443 12444 12445 12446 12447 12448 12449 12450 12451 12452 12453 12454 12455 12456 12457 12458 12459 12460 12461 12462 12463 12464 12465 12466 12467 12468 12469 12470 12471 12472 12473 12474 12475 12476 12477 12478 12479 12480 12481 12482 12483 12484 12485 12486 12487 12488 12489 12490 12491 12492 12493 12494 12495 12496 12497 12498 12499 12500 12501 12502 12503 12504 12505 12506 12507 12508 12509 12510 12511 12512 12513 12514 12515 12516 12517 12518 12519 12520 12521 12522 12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535 12536 12537 12538 12539 12540 12541 12542 12543 12544 12545 12546 12547 12548 12549 12550 12551 12552 12553 12554 12555 12556 12557 12558 12559 12560 12561 12562 12563 12564 12565 12566 12567 12568 12569 12570 12571 12572 12573 12574 12575 12576 12577 12578 12579 12580 12581 12582 12583 12584 12585 12586 12587 12588 12589 12590 12591 12592 12593 12594 12595 12596 12597 12598 12599 12600 12601 12602 12603 12604 12605 12606 12607 12608 12609 12610 12611 12612 12613 12614 12615 12616 12617 12618 12619 12620 12621 12622 12623 12624 12625 12626 12627 12628 12629 12630 12631 12632 12633 12634 12635 12636 12637 12638 12639 12640 12641 12642 12643 12644 12645 12646 12647 12648 12649 12650 12651 12652 12653 12654 12655 12656 12657 12658 12659 12660 12661 12662 12663 12664 12665 12666 12667 12668 12669 12670 12671 12672 12673 12674 12675 12676 12677 12678 12679 12680 12681 12682 12683 12684 12685 12686 12687 12688 12689 12690 12691 12692 12693 12694 12695 12696 12697 12698 12699 12700 12701 12702 12703 12704 12705 12706 12707 12708 12709 12710 12711 12712 12713 12714 12715 12716 12717 12718 12719 12720 12721 12722 12723 12724 12725 12726 12727 12728 12729 12730 12731 12732 12733 12734 12735 12736 12737 12738 12739 12740 12741 12742 12743 12744 12745 12746 12747 12748 12749 12750 12751 12752 12753 12754 12755 12756 12757 12758 12759 12760 12761 12762 12763 12764 12765 12766 12767 12768 12769 12770 12771 12772 12773 12774 12775 12776 12777 12778 12779 12780 12781 12782 12783 12784 12785 12786 12787 12788 12789 12790 12791 12792 12793 12794 12795 12796 12797 12798 12799 12800 12801 12802 12803 12804 12805 12806 12807 12808 12809 12810 12811 12812 12813 12814 12815 12816 12817 12818 12819 12820 12821 12822 12823 12824 12825 12826 12827 12828 12829 12830 12831 12832 12833 12834 12835 12836 12837 12838 12839 12840 12841 12842 12843 12844 12845 12846 12847 12848 12849 12850 12851 12852 12853 12854 12855 12856 12857 12858 12859 12860 12861 12862 12863 12864 12865 12866 12867 12868 12869 12870 12871 12872 12873 12874 12875 12876 12877 12878 12879 12880 12881 12882 12883 12884 12885 12886 12887 12888 12889 12890 12891 12892 12893 12894 12895 12896 12897 12898 12899 12900 12901 12902 12903 12904 12905 12906 12907 12908 12909 12910 12911 12912 12913 12914 12915 12916 12917 12918 12919 12920 12921 12922 12923 12924 12925 12926 12927 12928 12929 12930 12931 12932 12933 12934 12935 12936 12937 12938 12939 12940 12941 12942 12943 12944 12945 12946 12947 12948 12949 12950 12951 12952 12953 12954 12955 12956 12957 12958 12959 12960 12961 12962 12963 12964 12965 12966 12967 12968 12969 12970 12971 12972 12973 12974 12975 12976 12977 12978 12979 12980 12981 12982 12983 12984 12985 12986 12987 12988 12989 12990 12991 12992 12993 12994 12995 12996 12997 12998 12999 13000 13001 13002 13003 13004 13005 13006 13007 13008 13009 13010 13011 13012 13013 13014 13015 13016 13017 13018 13019 13020 13021 13022 13023 13024 13025 13026 13027 13028 13029 13030 13031 13032 13033 13034 13035 13036 13037 13038 13039 13040 13041 13042 13043 13044 13045 13046 13047 13048 13049 13050 13051 13052 13053 13054 13055 13056 13057 13058 13059 13060 13061 13062 13063 13064 13065 13066 13067 13068 13069 13070 13071 13072 13073 13074 13075 13076 13077 13078 13079 13080 13081 13082 13083 13084 13085 13086 13087 13088 13089 13090 13091 13092 13093 13094 13095 13096 13097 13098 13099 13100 13101 13102 13103 13104 13105 13106 13107 13108 13109 13110 13111 13112 13113 13114 13115 13116 13117 13118 13119 13120 13121 13122 13123 13124 13125 13126 13127 13128 13129 13130 13131 13132 13133 13134 13135 13136 13137 13138 13139 13140 13141 13142 13143 13144 13145 13146 13147 13148 13149 13150 13151 13152 13153 13154 13155 13156 13157 13158 13159 13160 13161 13162 13163 13164 13165 13166 13167 13168 13169 13170 13171 13172 13173 13174 13175 13176 13177 13178 13179 13180 13181 13182 13183 13184 13185 13186 13187 13188 13189 13190 13191 13192 13193 13194 13195 13196 13197 13198 13199 13200 13201 13202 13203 13204 13205 13206 13207 13208 13209 13210 13211 13212 13213 13214 13215 13216 13217 13218 13219 13220 13221 13222 13223 13224 13225 13226 13227 13228 13229 13230 13231 13232 13233 13234 13235 13236 13237 13238 13239 13240 13241 13242 13243 13244 13245 13246 13247 13248 13249 13250 13251 13252 13253 13254 13255 13256 13257 13258 13259 13260 13261 13262 13263 13264 13265 13266 13267 13268 13269 13270 13271 13272 13273 13274 13275 13276 13277 13278 13279 13280 13281 13282 13283 13284 13285 13286 13287 13288 13289 13290 13291 13292 13293 13294 13295 13296 13297 13298 13299 13300 13301 13302 13303 13304 13305 13306 13307 13308 13309 13310 13311 13312 13313 13314 13315 13316 13317 13318 13319 13320 13321 13322 13323 13324 13325 13326 13327 13328 13329 13330 13331 13332 13333 13334 13335 13336 13337 13338 13339 13340 13341 13342 13343 13344 13345 13346 13347 13348 13349 13350 13351 13352 13353 13354 13355 13356 13357 13358 13359 13360 13361 13362 13363 13364 13365 13366 13367 13368 13369 13370 13371 13372 13373 13374 13375 13376 13377 13378 13379 13380 13381 13382 13383 13384 13385 13386 13387 13388 13389 13390 13391 13392 13393 13394 13395 13396 13397 13398 13399 13400 13401 13402 13403 13404 13405 13406 13407 13408 13409 13410 13411 13412 13413 13414 13415 13416 13417 13418 13419 13420 13421 13422 13423 13424 13425 13426 13427 13428 13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449 13450 13451 13452 13453 13454 13455 13456 13457 13458 13459 13460 13461 13462 13463 13464 13465 13466 13467 13468 13469 13470 13471 13472 13473 13474 13475 13476 13477 13478 13479 13480 13481 13482 13483 13484 13485 13486 13487 13488 13489 13490 13491 13492 13493 13494 13495 13496 13497 13498 13499 13500 13501 13502 13503 13504 13505 13506 13507 13508 13509 13510 13511 13512 13513 13514 13515 13516 13517 13518 13519 13520 13521 13522 13523 13524 13525 13526 13527 13528 13529 13530 13531 13532 13533 13534 13535 13536 13537 13538 13539 13540 13541 13542 13543 13544 13545 13546 13547 13548 13549 13550 13551 13552 13553 13554 13555 13556 13557 13558 13559 13560 13561 13562 13563 13564 13565 13566 13567 13568 13569 13570 13571 13572 13573 13574 13575 13576 13577 13578 13579 13580 13581 13582 13583 13584 13585 13586 13587 13588 13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 13610 13611 13612 13613 13614 13615 13616 13617 13618 13619 13620 13621 13622 13623 13624 13625 13626 13627 13628 13629 13630 13631 13632 13633 13634 13635 13636 13637 13638 13639 13640 13641 13642 13643 13644 13645 13646 13647 13648 13649 13650 13651 13652 13653 13654 13655 13656 13657 13658 13659 13660 13661 13662 13663 13664 13665 13666 13667 13668 13669 13670 13671 13672 13673 13674 13675 13676 13677 13678 13679 13680 13681 13682 13683 13684 13685 13686 13687 13688 13689 13690 13691 13692 13693 13694 13695 13696 13697 13698 13699 13700 13701 13702 13703 13704 13705 13706 13707 13708 13709 13710 13711 13712 13713 13714 13715 13716 13717 13718 13719 13720 13721 13722 13723 13724 13725 13726 13727 13728 13729 13730 13731 13732 13733 13734 13735 13736 13737 13738 13739 13740 13741 13742 13743 13744 13745 13746 13747 13748 13749 13750 13751 13752 13753 13754 13755 13756 13757 13758 13759 13760 13761 13762 13763 13764 13765 13766 13767 13768 13769 13770 13771 13772 13773 13774 13775 13776 13777 13778 13779 13780 13781 13782 13783 13784 13785 13786 13787 13788 13789 13790 13791 13792 13793 13794 13795 13796 13797 13798 13799 13800 13801 13802 13803 13804 13805 13806 13807 13808 13809 13810 13811 13812 13813 13814 13815 13816 13817 13818 13819 13820 13821 13822 13823 13824 13825 13826 13827 13828 13829 13830 13831 13832 13833 13834 13835 13836 13837 13838 13839 13840 13841 13842 13843 13844 13845 13846 13847 13848 13849 13850 13851 13852 13853 13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864 13865 13866 13867 13868 13869 13870 13871 13872 13873 13874 13875 13876 13877 13878 13879 13880 13881 13882 13883 13884 13885 13886 13887 13888 13889 13890 13891 13892 13893 13894 13895 13896 13897 13898 13899 13900 13901 13902 13903 13904 13905 13906 13907 13908 13909 13910 13911 13912 13913 13914 13915 13916 13917 13918 13919 13920 13921 13922 13923 13924 13925 13926 13927 13928 13929 13930 13931 13932 13933 13934 13935 13936 13937 13938 13939 13940 13941 13942 13943 13944 13945 13946 13947 13948 13949 13950 13951 13952 13953 13954 13955 13956 13957 13958 13959 13960 13961 13962 13963 13964 13965 13966 13967 13968 13969 13970 13971 13972 13973 13974 13975 13976 13977 13978 13979 13980 13981 13982 13983 13984 13985 13986 13987 13988 13989 13990 13991 13992 13993 13994 13995 13996 13997 13998 13999 14000 14001 14002 14003 14004 14005 14006 14007 14008 14009 14010 14011 14012 14013 14014 14015 14016 14017 14018 14019 14020 14021 14022 14023 14024 14025 14026 14027 14028 14029 14030 14031 14032 14033 14034 14035 14036 14037 14038 14039 14040 14041 14042 14043 14044 14045 14046 14047 14048 14049 14050 14051 14052 14053 14054 14055 14056 14057 14058 14059 14060 14061 14062 14063 14064 14065 14066 14067 14068 14069 14070 14071 14072 14073 14074 14075 14076 14077 14078 14079 14080 14081 14082 14083 14084 14085 14086 14087 14088 14089 14090 14091 14092 14093 14094 14095 14096 14097 14098 14099 14100 14101 14102 14103 14104 14105 14106 14107 14108 14109 14110 14111 14112 14113 14114 14115 14116 14117 14118 14119 14120 14121 14122 14123 14124 14125 14126 14127 14128 14129 14130 14131 14132 14133 14134 14135 14136 14137 14138 14139 14140 14141 14142 14143 14144 14145 14146 14147 14148 14149 14150 14151 14152 14153 14154 14155 14156 14157 14158 14159 14160 14161 14162 14163 14164 14165 14166 14167 14168 14169 14170 14171 14172 14173 14174 14175 14176 14177 14178 14179 14180 14181 14182 14183 14184 14185 14186 14187 14188 14189 14190 14191 14192 14193 14194 14195 14196 14197 14198 14199 14200 14201 14202 14203 14204 14205 14206 14207 14208 14209 14210 14211 14212 14213 14214 14215 14216 14217 14218 14219 14220 14221 14222 14223 14224 14225 14226 14227 14228 14229 14230 14231 14232 14233 14234 14235 14236 14237 14238 14239 14240 14241 14242 14243 14244 14245 14246 14247 14248 14249 14250 14251 14252 14253 14254 14255 14256 14257 14258 14259 14260 14261 14262 14263 14264 14265 14266 14267 14268 14269 14270 14271 14272 14273 14274 14275 14276 14277 14278 14279 14280 14281 14282 14283 14284 14285 14286 14287 14288 14289 14290 14291 14292 14293 14294 14295 14296 14297 14298 14299 14300 14301 14302 14303 14304 14305 14306 14307 14308 14309 14310 14311 14312 14313 14314 14315 14316 14317 14318 14319 14320 14321 14322 14323 14324 14325 14326 14327 14328 14329 14330 14331 14332 14333 14334 14335 14336 14337 14338 14339 14340 14341 14342 14343 14344 14345 14346 14347 14348 14349 14350 14351 14352 14353 14354 14355 14356 14357 14358 14359 14360 14361 14362 14363 14364 14365 14366 14367 14368 14369 14370 14371 14372 14373 14374 14375 14376 14377 14378 14379 14380 14381 14382 14383 14384 14385 14386 14387 14388 14389 14390 14391 14392 14393 14394 14395 14396 14397 14398 14399 14400 14401 14402 14403 14404 14405 14406 14407 14408 14409 14410 14411 14412 14413 14414 14415 14416 14417 14418 14419 14420 14421 14422 14423 14424 14425 14426 14427 14428 14429 14430 14431 14432 14433 14434 14435 14436 14437 14438 14439 14440 14441 14442 14443 14444 14445 14446 14447 14448 14449 14450 14451 14452 14453 14454 14455 14456 14457 14458 14459 14460 14461 14462 14463 14464 14465 14466 14467 14468 14469 14470 14471 14472 14473 14474 14475 14476 14477 14478 14479 14480 14481 14482 14483 14484 14485 14486 14487 14488 14489 14490 14491 14492 14493 14494 14495 14496 14497 14498 14499 14500 14501 14502 14503 14504 14505 14506 14507 14508 14509 14510 14511 14512 14513 14514 14515 14516 14517 14518 14519 14520 14521 14522 14523 14524 14525 14526 14527 14528 14529 14530 14531 14532 14533 14534 14535 14536 14537 14538 14539 14540 14541 14542 14543 14544 14545 14546 14547 14548 14549 14550 14551 14552 14553 14554 14555 14556 14557 14558 14559 14560 14561 14562 14563 14564 14565 14566 14567 14568 14569 14570 14571 14572 14573 14574 14575 14576 14577 14578 14579 14580 14581 14582 14583 14584 14585 14586 14587 14588 14589 14590 14591 14592 14593 14594 14595 14596 14597 14598 14599 14600 14601 14602 14603 14604 14605 14606 14607 14608 14609 14610 14611 14612 14613 14614 14615 14616 14617 14618 14619 14620 14621 14622 14623 14624 14625 14626 14627 14628 14629 14630 14631 14632 14633 14634 14635 14636 14637 14638 14639 14640 14641 14642 14643 14644 14645 14646 14647 14648 14649 14650 14651 14652 14653 14654 14655 14656 14657 14658 14659 14660 14661 14662 14663 14664 14665 14666 14667 14668 14669 14670 14671 14672 14673 14674 14675 14676 14677 14678 14679 14680 14681 14682 14683 14684 14685 14686 14687 14688 14689 14690 14691 14692 14693 14694 14695 14696 14697 14698 14699 14700 14701 14702 14703 14704 14705 14706 14707 14708 14709 14710 14711 14712 14713 14714 14715 14716 14717 14718 14719 14720 14721 14722 14723 14724 14725 14726 14727 14728 14729 14730 14731 14732 14733 14734 14735 14736 14737 14738 14739 14740 14741 14742 14743 14744 14745 14746 14747 14748 14749 14750 14751 14752 14753 14754 14755 14756 14757 14758 14759 14760 14761 14762 14763 14764 14765 14766 14767 14768 14769 14770 14771 14772 14773 14774 14775 14776 14777 14778 14779 14780 14781 14782 14783 14784 14785 14786 14787 14788 14789 14790 14791 14792 14793 14794 14795 14796 14797 14798 14799 14800 14801 14802 14803 14804 14805 14806 14807 14808 14809 14810 14811 14812 14813 14814 14815 14816 14817 14818 14819 14820 14821 14822 14823 14824 14825 14826 14827 14828 14829 14830 14831 14832 14833 14834 14835 14836 14837 14838 14839 14840 14841 14842 14843 14844 14845 14846 14847 14848 14849 14850 14851 14852 14853 14854 14855 14856 14857 14858 14859 14860 14861 14862 14863 14864 14865 14866 14867 14868 14869 14870 14871 14872 14873 14874 14875 14876 14877 14878 14879 14880 14881 14882 14883 14884 14885 14886 14887 14888 14889 14890 14891 14892 14893 14894 14895 14896 14897 14898 14899 14900 14901 14902 14903 14904 14905 14906 14907 14908 14909 14910 14911 14912 14913 14914 14915 14916 14917 14918 14919 14920 14921 14922 14923 14924 14925 14926 14927 14928 14929 14930 14931 14932 14933 14934 14935 14936 14937 14938 14939 14940 14941 14942 14943 14944 14945 14946 14947 14948 14949 14950 14951 14952 14953 14954 14955 14956 14957 14958 14959 14960 14961 14962 14963 14964 14965 14966 14967 14968 14969 14970 14971 14972 14973 14974 14975 14976 14977 14978 14979 14980 14981 14982 14983 14984 14985 14986 14987 14988 14989 14990 14991 14992 14993 14994 14995 14996 14997 14998 14999 15000 15001 15002 15003 15004 15005 15006 15007 15008 15009 15010 15011 15012 15013 15014 15015 15016 15017 15018 15019 15020 15021 15022 15023 15024 15025 15026 15027 15028 15029 15030 15031 15032 15033 15034 15035 15036 15037 15038 15039 15040 15041 15042 15043 15044 15045 15046 15047 15048 15049 15050 15051 15052 15053 15054 15055 15056 15057 15058 15059 15060 15061 15062 15063 15064 15065 15066 15067 15068 15069 15070 15071 15072 15073 15074 15075 15076 15077 15078 15079 15080 15081 15082 15083 15084 15085 15086 15087 15088 15089 15090 15091 15092 15093 15094 15095 15096 15097 15098 15099 15100 15101 15102 15103 15104 15105 15106 15107 15108 15109 15110 15111 15112 15113 15114 15115 15116 15117 15118 15119 15120 15121 15122 15123 15124 15125 15126 15127 15128 15129 15130 15131 15132 15133 15134 15135 15136 15137 15138 15139 15140 15141 15142 15143 15144 15145 15146 15147 15148 15149 15150 15151 15152 15153 15154 15155 15156 15157 15158 15159 15160 15161 15162 15163 15164 15165 15166 15167 15168 15169 15170 15171 15172 15173 15174 15175 15176 15177 15178 15179 15180 15181 15182 15183 15184 15185 15186 15187 15188 15189 15190 15191 15192 15193 15194 15195 15196 15197 15198 15199 15200 15201 15202 15203 15204 15205 15206 15207 15208 15209 15210 15211 15212 15213 15214 15215 15216 15217 15218 15219 15220 15221 15222 15223 15224 15225 15226 15227 15228 15229 15230 15231 15232 15233 15234 15235 15236 15237 15238 15239 15240 15241 15242 15243 15244 15245 15246 15247 15248 15249 15250 15251 15252 15253 15254 15255 15256 15257 15258 15259 15260 15261 15262 15263 15264 15265 15266 15267 15268 15269 15270 15271 15272 15273 15274 15275 15276 15277 15278 15279 15280 15281 15282 15283 15284 15285 15286 15287 15288 15289 15290 15291 15292 15293 15294 15295 15296 15297 15298 15299 15300 15301 15302 15303 15304 15305 15306 15307 15308 15309 15310 15311 15312 15313 15314 15315 15316 15317 15318 15319 15320 15321 15322 15323 15324 15325 15326 15327 15328 15329 15330 15331 15332 15333 15334 15335 15336 15337 15338 15339 15340 15341 15342 15343 15344 15345 15346 15347 15348 15349 15350 15351 15352 15353 15354 15355 15356 15357 15358 15359 15360 15361 15362 15363 15364 15365 15366 15367 15368 15369 15370 15371 15372 15373 15374 15375 15376 15377 15378 15379 15380 15381 15382 15383 15384 15385 15386 15387 15388 15389 15390 15391 15392 15393 15394 15395 15396 15397 15398 15399 15400 15401 15402 15403 15404 15405 15406 15407 15408 15409 15410 15411 15412 15413 15414 15415 15416 15417 15418 15419 15420 15421 15422 15423 15424 15425 15426 15427 15428 15429 15430 15431 15432 15433 15434 15435 15436 15437 15438 15439 15440 15441 15442 15443 15444 15445 15446 15447 15448 15449 15450 15451 15452 15453 15454 15455 15456 15457 15458 15459 15460 15461 15462 15463 15464 15465 15466 15467 15468 15469 15470 15471 15472 15473 15474 15475 15476 15477 15478 15479 15480 15481 15482 15483 15484 15485 15486 15487 15488 15489 15490 15491 15492 15493 15494 15495 15496 15497 15498 15499 15500 15501 15502 15503 15504 15505 15506 15507 15508 15509 15510 15511 15512 15513 15514 15515 15516 15517 15518 15519 15520 15521 15522 15523 15524 15525 15526 15527 15528 15529 15530 15531 15532 15533 15534 15535 15536 15537 15538 15539 15540 15541 15542 15543 15544 15545 15546 15547 15548 15549 15550 15551 15552 15553 15554 15555 15556 15557 15558 15559 15560 15561 15562 15563 15564 15565 15566 15567 15568 15569 15570 15571 15572 15573 15574 15575 15576 15577 15578 15579 15580 15581 15582 15583 15584 15585 15586 15587 15588 15589 15590 15591 15592 15593 15594 15595 15596 15597 15598 15599 15600 15601 15602 15603 15604 15605 15606 15607 15608 15609 15610 15611 15612 15613 15614 15615 15616 15617 15618 15619 15620 15621 15622 15623 15624 15625 15626 15627 15628 15629 15630 15631 15632 15633 15634 15635 15636 15637 15638 15639 15640 15641 15642 15643 15644 15645 15646 15647 15648 15649 15650 15651 15652 15653 15654 15655 15656 15657 15658 15659 15660 15661 15662 15663 15664 15665 15666 15667 15668 15669 15670 15671 15672 15673 15674 15675 15676 15677 15678 15679 15680 15681 15682 15683 15684 15685 15686 15687 15688 15689 15690 15691 15692 15693 15694 15695 15696 15697 15698 15699 15700 15701 15702 15703 15704 15705 15706 15707 15708 15709 15710 15711 15712 15713 15714 15715 15716 15717 15718 15719 15720 15721 15722 15723 15724 15725 15726 15727 15728 15729 15730 15731 15732 15733 15734 15735 15736 15737 15738 15739 15740 15741 15742 15743 15744 15745 15746 15747 15748 15749 15750 15751 15752 15753 15754 15755 15756 15757 15758 15759 15760 15761 15762 15763 15764 15765 15766 15767 15768 15769 15770 15771 15772 15773 15774 15775 15776 15777 15778 15779 15780 15781 15782 15783 15784 15785 15786 15787 15788 15789 15790 15791 15792 15793 15794 15795 15796 15797 15798 15799 15800 15801 15802 15803 15804 15805 15806 15807 15808 15809 15810 15811 15812 15813 15814 15815 15816 15817 15818 15819 15820 15821 15822 15823 15824 15825 15826 15827 15828 15829 15830 15831 15832 15833 15834 15835 15836 15837 15838 15839 15840 15841 15842 15843 15844 15845 15846 15847 15848 15849 15850 15851 15852 15853 15854 15855 15856 15857 15858 15859 15860 15861 15862 15863 15864 15865 15866 15867 15868 15869 15870 15871 15872 15873 15874 15875 15876 15877 15878 15879 15880 15881 15882 15883 15884 15885 15886 15887 15888 15889 15890 15891 15892 15893 15894 15895 15896 15897 15898 15899 15900 15901 15902 15903 15904 15905 15906 15907 15908 15909 15910 15911 15912 15913 15914 15915 15916 15917 15918 15919 15920 15921 15922 15923 15924 15925 15926 15927 15928 15929 15930 15931 15932 15933 15934 15935 15936 15937 15938 15939 15940 15941 15942 15943 15944 15945 15946 15947 15948 15949 15950 15951 15952 15953 15954 15955 15956 15957 15958 15959 15960 15961 15962 15963 15964 15965 15966 15967 15968 15969 15970 15971 15972 15973 15974 15975 15976 15977 15978 15979 15980 15981 15982 15983 15984 15985 15986 15987 15988 15989 15990 15991 15992 15993 15994 15995 15996 15997 15998 15999 16000 16001 16002 16003 16004 16005 16006 16007 16008 16009 16010 16011 16012 16013 16014 16015 16016 16017 16018 16019 16020 16021 16022 16023 16024 16025 16026 16027 16028 16029 16030 16031 16032 16033 16034 16035 16036 16037 16038 16039 16040 16041 16042 16043 16044 16045 16046 16047 16048 16049 16050 16051 16052 16053 16054 16055 16056 16057 16058 16059 16060 16061 16062 16063 16064 16065 16066 16067 16068 16069 16070 16071 16072 16073 16074 16075 16076 16077 16078 16079 16080 16081 16082 16083 16084 16085 16086 16087 16088 16089 16090 16091 16092 16093 16094 16095 16096 16097 16098 16099 16100 16101 16102 16103 16104 16105 16106 16107 16108 16109 16110 16111 16112 16113 16114 16115 16116 16117 16118 16119 16120 16121 16122 16123 16124 16125 16126 16127 16128 16129 16130 16131 16132 16133 16134 16135 16136 16137 16138 16139 16140 16141 16142 16143 16144 16145 16146 16147 16148 16149 16150 16151 16152 16153 16154 16155 16156 16157 16158 16159 16160 16161 16162 16163 16164 16165 16166 16167 16168 16169 16170 16171 16172 16173 16174 16175 16176 16177 16178 16179 16180 16181 16182 16183 16184 16185 16186 16187 16188 16189 16190 16191 16192 16193 16194 16195 16196 16197 16198 16199 16200 16201 16202 16203 16204 16205 16206 16207 16208 16209 16210 16211 16212 16213 16214 16215 16216 16217 16218 16219 16220 16221 16222 16223 16224 16225 16226 16227 16228 16229 16230 16231 16232 16233 16234 16235 16236 16237 16238 16239 16240 16241 16242 16243 16244 16245 16246 16247 16248 16249 16250 16251 16252 16253 16254 16255 16256 16257 16258 16259 16260 16261 16262 16263 16264 16265 16266 16267 16268 16269 16270 16271 16272 16273 16274 16275 16276 16277 16278 16279 16280 16281 16282 16283 16284 16285 16286 16287 16288 16289 16290 16291 16292 16293 16294 16295 16296 16297 16298 16299 16300 16301 16302 16303 16304 16305 16306 16307 16308 16309 16310 16311 16312 16313 16314 16315 16316 16317 16318 16319 16320 16321 16322 16323 16324 16325 16326 16327 16328 16329 16330 16331 16332 16333 16334 16335 16336 16337 16338 16339 16340 16341 16342 16343 16344 16345 16346 16347 16348 16349 16350 16351 16352 16353 16354 16355 16356 16357 16358 16359 16360 16361 16362 16363 16364 16365 16366 16367 16368 16369 16370 16371 16372 16373 16374 16375 16376 16377 16378 16379 16380 16381 16382 16383 16384 16385 16386 16387 16388 16389 16390 16391 16392 16393 16394 16395 16396 16397 16398 16399 16400 16401 16402 16403 16404 16405 16406 16407 16408 16409 16410 16411 16412 16413 16414 16415 16416 16417 16418 16419 16420 16421 16422 16423 16424 16425 16426 16427 16428 16429 16430 16431 16432 16433 16434 16435 16436 16437 16438 16439 16440 16441 16442 16443 16444 16445 16446 16447 16448 16449 16450 16451 16452 16453 16454 16455 16456 16457 16458 16459 16460 16461 16462 16463 16464 16465 16466 16467 16468 16469 16470 16471 16472 16473 16474 16475 16476 16477 16478 16479 16480 16481 16482 16483 16484 16485 16486 16487 16488 16489 16490 16491 16492 16493 16494 16495 16496 16497 16498 16499 16500 16501 16502 16503 16504 16505 16506 16507 16508 16509 16510 16511 16512 16513 16514 16515 16516 16517 16518 16519 16520 16521 16522 16523 16524 16525 16526 16527 16528 16529 16530 16531 16532 16533 16534 16535 16536 16537 16538 16539 16540 16541 16542 16543 16544 16545 16546 16547 16548 16549 16550 16551 16552 16553 16554 16555 16556 16557 16558 16559 16560 16561 16562 16563 16564 16565 16566 16567 16568 16569 16570 16571 16572 16573 16574 16575 16576 16577 16578 16579 16580 16581 16582 16583 16584 16585 16586 16587 16588 16589 16590 16591 16592 16593 16594 16595 16596 16597 16598 16599 16600 16601 16602 16603 16604 16605 16606 16607 16608 16609 16610 16611 16612 16613 16614 16615 16616 16617 16618 16619 16620 16621 16622 16623 16624 16625 16626 16627 16628 16629 16630 16631 16632 16633 16634 16635 16636 16637 16638 16639 16640 16641 16642 16643 16644 16645 16646 16647 16648 16649 16650 16651 16652 16653 16654 16655 16656 16657 16658 16659 16660 16661 16662 16663 16664 16665 16666 16667 16668 16669 16670 16671 16672 16673 16674 16675 16676 16677 16678 16679 16680 16681 16682 16683 16684 16685 16686 16687 16688 16689 16690 16691 16692 16693 16694 16695 16696 16697 16698 16699 16700 16701 16702 16703 16704 16705 16706 16707 16708 16709 16710 16711 16712 16713 16714 16715 16716 16717 16718 16719 16720 16721 16722 16723 16724 16725 16726 16727 16728 16729 16730 16731 16732 16733 16734 16735 16736 16737 16738 16739 16740 16741 16742 16743 16744 16745 16746 16747 16748 16749 16750 16751 16752 16753 16754 16755 16756 16757 16758 16759 16760 16761 16762 16763 16764 16765 16766 16767 16768 16769 16770 16771 16772 16773 16774 16775 16776 16777 16778 16779 16780 16781 16782 16783 16784 16785 16786 16787 16788 16789 16790 16791 16792 16793 16794 16795 16796 16797 16798 16799 16800 16801 16802 16803 16804 16805 16806 16807 16808 16809 16810 16811 16812 16813 16814 16815 16816 16817 16818 16819 16820 16821 16822 16823 16824 16825 16826 16827 16828 16829 16830 16831 16832 16833 16834 16835 16836 16837 16838 16839 16840 16841 16842 16843 16844 16845 16846 16847 16848 16849 16850 16851 16852 16853 16854 16855 16856 16857 16858 16859 16860 16861 16862 16863 16864 16865 16866 16867 16868 16869 16870 16871 16872 16873 16874 16875 16876 16877 16878 16879 16880 16881 16882 16883 16884 16885 16886 16887 16888 16889 16890 16891 16892 16893 16894 16895 16896 16897 16898 16899 16900 16901 16902 16903 16904 16905 16906 16907 16908 16909 16910 16911 16912 16913 16914 16915 16916 16917 16918 16919 16920 16921 16922 16923 16924 16925 16926 16927 16928 16929 16930 16931 16932 16933 16934 16935 16936 16937 16938 16939 16940 16941 16942 16943 16944 16945 16946 16947 16948 16949 16950 16951 16952 16953 16954 16955 16956 16957 16958 16959 16960 16961 16962 16963 16964 16965 16966 16967 16968 16969 16970 16971 16972 16973 16974 16975 16976 16977 16978 16979 16980 16981 16982 16983 16984 16985 16986 16987 16988 16989 16990 16991 16992 16993 16994 16995 16996 16997 16998 16999 17000 17001 17002 17003 17004 17005 17006 17007 17008 17009 17010 17011 17012 17013 17014 17015 17016 17017 17018 17019 17020 17021 17022 17023 17024 17025 17026 17027 17028 17029 17030 17031 17032 17033 17034 17035 17036 17037 17038 17039 17040 17041 17042 17043 17044 17045 17046 17047 17048 17049 17050 17051 17052 17053 17054 17055 17056 17057 17058 17059 17060 17061 17062 17063 17064 17065 17066 17067 17068 17069 17070 17071 17072 17073 17074 17075 17076 17077 17078 17079 17080 17081 17082 17083 17084 17085 17086 17087 17088 17089 17090 17091 17092 17093 17094 17095 17096 17097 17098 17099 17100 17101 17102 17103 17104 17105 17106 17107 17108 17109 17110 17111 17112 17113 17114 17115 17116 17117 17118 17119 17120 17121 17122 17123 17124 17125 17126 17127 17128 17129 17130 17131 17132 17133 17134 17135 17136 17137 17138 17139 17140 17141 17142 17143 17144 17145 17146 17147 17148 17149 17150 17151 17152 17153 17154 17155 17156 17157 17158 17159 17160 17161 17162 17163 17164 17165 17166 17167 17168 17169 17170 17171 17172 17173 17174 17175 17176 17177 17178 17179 17180 17181 17182 17183 17184 17185 17186 17187 17188 17189 17190 17191 17192 17193 17194 17195 17196 17197 17198 17199 17200 17201 17202 17203 17204 17205 17206 17207 17208 17209 17210 17211 17212 17213 17214 17215 17216 17217 17218 17219 17220 17221 17222 17223 17224 17225 17226 17227 17228 17229 17230 17231 17232 17233 17234 17235 17236 17237 17238 17239 17240 17241 17242 17243 17244 17245 17246 17247 17248 17249 17250 17251 17252 17253 17254 17255 17256 17257 17258 17259 17260 17261 17262 17263 17264 17265 17266 17267 17268 17269 17270 17271 17272 17273 17274 17275 17276 17277 17278 17279 17280 17281 17282 17283 17284 17285 17286 17287 17288 17289 17290 17291 17292 17293 17294 17295 17296 17297 17298 17299 17300 17301 17302 17303 17304 17305 17306 17307 17308 17309 17310 17311 17312 17313 17314 17315 17316 17317 17318 17319 17320 17321 17322 17323 17324 17325 17326 17327 17328 17329 17330 17331 17332 17333 17334 17335 17336 17337 17338 17339 17340 17341 17342 17343 17344 17345 17346 17347 17348 17349 17350 17351 17352 17353 17354 17355 17356 17357 17358 17359 17360 17361 17362 17363 17364 17365 17366 17367 17368 17369 17370 17371 17372 17373 17374 17375 17376 17377 17378 17379 17380 17381 17382 17383 17384 17385 17386 17387 17388 17389 17390 17391 17392 17393 17394 17395 17396 17397 17398 17399 17400 17401 17402 17403 17404 17405 17406 17407 17408 17409 17410 17411 17412 17413 17414 17415 17416 17417 17418 17419 17420 17421 17422 17423 17424 17425 17426 17427 17428 17429 17430 17431 17432 17433 17434 17435 17436 17437 17438 17439 17440 17441 17442 17443 17444 17445 17446 17447 17448 17449 17450 17451 17452 17453 17454 17455 17456 17457 17458 17459 17460 17461 17462 17463 17464 17465 17466 17467 17468 17469 17470 17471 17472 17473 17474 17475 17476 17477 17478 17479 17480 17481 17482 17483 17484 17485 17486 17487 17488 17489 17490 17491 17492 17493 17494 17495 17496 17497 17498 17499 17500 17501 17502 17503 17504 17505 17506 17507 17508 17509 17510 17511 17512 17513 17514 17515 17516 17517 17518 17519 17520 17521 17522 17523 17524 17525 17526 17527 17528 17529 17530 17531 17532 17533 17534 17535 17536 17537 17538 17539 17540 17541 17542 17543 17544 17545 17546 17547 17548 17549 17550 17551 17552 17553 17554 17555 17556 17557 17558 17559 17560 17561 17562 17563 17564 17565 17566 17567 17568 17569 17570 17571 17572 17573 17574 17575 17576 17577 17578 17579 17580 17581 17582 17583 17584 17585 17586 17587 17588 17589 17590 17591 17592 17593 17594 17595 17596 17597 17598 17599 17600 17601 17602 17603 17604 17605 17606 17607 17608 17609 17610 17611 17612 17613 17614 17615 17616 17617 17618 17619 17620 17621 17622 17623 17624 17625 17626 17627 17628 17629 17630 17631 17632 17633 17634 17635 17636 17637 17638 17639 17640 17641 17642 17643 17644 17645 17646 17647 17648 17649 17650 17651 17652 17653 17654 17655 17656 17657 17658 17659 17660 17661 17662 17663 17664 17665 17666 17667 17668 17669 17670 17671 17672 17673 17674 17675 17676 17677 17678 17679 17680 17681 17682 17683 17684 17685 17686 17687 17688 17689 17690 17691 17692 17693 17694 17695 17696 17697 17698 17699 17700 17701 17702 17703 17704 17705 17706 17707 17708 17709 17710 17711 17712 17713 17714 17715 17716 17717 17718 17719 17720 17721 17722 17723 17724 17725 17726 17727 17728 17729 17730 17731 17732 17733 17734 17735 17736 17737 17738 17739 17740 17741 17742 17743 17744 17745 17746 17747 17748 17749 17750 17751 17752 17753 17754 17755 17756 17757 17758 17759 17760 17761 17762 17763 17764 17765 17766 17767 17768 17769 17770 17771 17772 17773 17774 17775 17776 17777 17778 17779 17780 17781 17782 17783 17784 17785 17786 17787 17788 17789 17790 17791 17792 17793 17794 17795 17796 17797 17798 17799 17800 17801 17802 17803 17804 17805 17806 17807 17808 17809 17810 17811 17812 17813 17814 17815 17816 17817 17818 17819 17820 17821 17822 17823 17824 17825 17826 17827 17828 17829 17830 17831 17832 17833 17834 17835 17836 17837 17838 17839 17840 17841 17842 17843 17844 17845 17846 17847 17848 17849 17850 17851 17852 17853 17854 17855 17856 17857 17858 17859 17860 17861 17862 17863 17864 17865 17866 17867 17868 17869 17870 17871 17872 17873 17874 17875 17876 17877 17878 17879 17880 17881 17882 17883 17884 17885 17886 17887 17888 17889 17890 17891 17892 17893 17894 17895 17896 17897 17898 17899 17900 17901 17902 17903 17904 17905 17906 17907 17908 17909 17910 17911 17912 17913 17914 17915 17916 17917 17918 17919 17920 17921 17922 17923 17924 17925 17926 17927 17928 17929 17930 17931 17932 17933 17934 17935 17936 17937 17938 17939 17940 17941 17942 17943 17944 17945 17946 17947 17948 17949 17950 17951 17952 17953 17954 17955 17956 17957 17958 17959 17960 17961 17962 17963 17964 17965 17966 17967 17968 17969 17970 17971 17972 17973 17974 17975 17976 17977 17978 17979 17980 17981 17982 17983 17984 17985 17986 17987 17988 17989 17990 17991 17992 17993 17994 17995 17996 17997 17998 17999 18000 18001 18002 18003 18004 18005 18006 18007 18008 18009 18010 18011 18012 18013 18014 18015 18016 18017 18018 18019 18020 18021 18022 18023 18024 18025 18026 18027 18028 18029 18030 18031 18032 18033 18034 18035 18036 18037 18038 18039 18040 18041 18042 18043 18044 18045 18046 18047 18048 18049 18050 18051 18052 18053 18054 18055 18056 18057 18058 18059 18060 18061 18062 18063 18064 18065 18066 18067 18068 18069 18070 18071 18072 18073 18074 18075 18076 18077 18078 18079 18080 18081 18082 18083 18084 18085 18086 18087 18088 18089 18090 18091 18092 18093 18094 18095 18096 18097 18098 18099 18100 18101 18102 18103 18104 18105 18106 18107 18108 18109 18110 18111 18112 18113 18114 18115 18116 18117 18118 18119 18120 18121 18122 18123 18124 18125 18126 18127 18128 18129 18130 18131 18132 18133 18134 18135 18136 18137 18138 18139 18140 18141 18142 18143 18144 18145 18146 18147 18148 18149 18150 18151 18152 18153 18154 18155 18156 18157 18158 18159 18160 18161 18162 18163 18164 18165 18166 18167 18168 18169 18170 18171 18172 18173 18174 18175 18176 18177 18178 18179 18180 18181 18182 18183 18184 18185 18186 18187 18188 18189 18190 18191 18192 18193 18194 18195 18196 18197 18198 18199 18200 18201 18202 18203 18204 18205 18206 18207 18208 18209 18210 18211 18212 18213 18214 18215 18216 18217 18218 18219 18220 18221 18222 18223 18224 18225 18226 18227 18228 18229 18230 18231 18232 18233 18234 18235 18236 18237 18238 18239 18240 18241 18242 18243 18244 18245 18246 18247 18248 18249 18250 18251 18252 18253 18254 18255 18256 18257 18258 18259 18260 18261 18262 18263 18264 18265 18266 18267 18268 18269 18270 18271 18272 18273 18274 18275 18276 18277 18278 18279 18280 18281 18282 18283 18284 18285 18286 18287 18288 18289 18290 18291 18292 18293 18294 18295 18296 18297 18298 18299 18300 18301 18302 18303 18304 18305 18306 18307 18308 18309 18310 18311 18312 18313 18314 18315 18316 18317 18318 18319 18320 18321 18322 18323 18324 18325 18326 18327 18328 18329 18330 18331 18332 18333 18334 18335 18336 18337 18338 18339 18340 18341 18342 18343 18344 18345 18346 18347 18348 18349 18350 18351 18352 18353 18354 18355 18356 18357 18358 18359 18360 18361 18362 18363 18364 18365 18366 18367 18368 18369 18370 18371 18372 18373 18374 18375 18376 18377 18378 18379 18380 18381 18382 18383 18384 18385 18386 18387 18388 18389 18390 18391 18392 18393 18394 18395 18396 18397 18398 18399 18400 18401 18402 18403 18404 18405 18406 18407 18408 18409 18410 18411 18412 18413 18414 18415 18416 18417 18418 18419 18420 18421 18422 18423 18424 18425 18426 18427 18428 18429 18430 18431 18432 18433 18434 18435 18436 18437 18438 18439 18440 18441 18442 18443 18444 18445 18446 18447 18448 18449 18450 18451 18452 18453 18454 18455 18456 18457 18458 18459 18460 18461 18462 18463 18464 18465 18466 18467 18468 18469 18470 18471 18472 18473 18474 18475 18476 18477 18478 18479 18480 18481 18482 18483 18484 18485 18486 18487 18488 18489 18490 18491 18492 18493 18494 18495 18496 18497 18498 18499 18500 18501 18502 18503 18504 18505 18506 18507 18508 18509 18510 18511 18512 18513 18514 18515 18516 18517 18518 18519 18520 18521 18522 18523 18524 18525 18526 18527 18528 18529 18530 18531 18532 18533 18534 18535 18536 18537 18538 18539 18540 18541 18542 18543 18544 18545 18546 18547 18548 18549 18550 18551 18552 18553 18554 18555 18556 18557 18558 18559 18560 18561 18562 18563 18564 18565 18566 18567 18568 18569 18570 18571 18572 18573 18574 18575 18576 18577 18578 18579 18580 18581 18582 18583 18584 18585 18586 18587 18588 18589 18590 18591 18592 18593 18594 18595 18596 18597 18598 18599 18600 18601 18602 18603 18604 18605 18606 18607 18608 18609 18610 18611 18612 18613 18614 18615 18616 18617 18618 18619 18620 18621 18622 18623 18624 18625 18626 18627 18628 18629 18630 18631 18632 18633 18634 18635 18636 18637 18638 18639 18640 18641 18642 18643 18644 18645 18646 18647 18648 18649 18650 18651 18652 18653 18654 18655 18656 18657 18658 18659 18660 18661 18662 18663 18664 18665 18666 18667 18668 18669 18670 18671 18672 18673 18674 18675 18676 18677 18678 18679 18680 18681 18682 18683 18684 18685 18686 18687 18688 18689 18690 18691 18692 18693 18694 18695 18696 18697 18698 18699 18700 18701 18702 18703 18704 18705 18706 18707 18708 18709 18710 18711 18712 18713 18714 18715 18716 18717 18718 18719 18720 18721 18722 18723 18724 18725 18726 18727 18728 18729 18730 18731 18732 18733 18734 18735 18736 18737 18738 18739 18740 18741 18742 18743 18744 18745 18746 18747 18748 18749 18750 18751 18752 18753 18754 18755 18756 18757 18758 18759 18760 18761 18762 18763 18764 18765 18766 18767 18768 18769 18770 18771 18772 18773 18774 18775 18776 18777 18778 18779 18780 18781 18782 18783 18784 18785 18786 18787 18788 18789 18790 18791 18792 18793 18794 18795 18796 18797 18798 18799 18800 18801 18802 18803 18804 18805 18806 18807 18808 18809 18810 18811 18812 18813 18814 18815 18816 18817 18818 18819 18820 18821 18822 18823 18824 18825 18826 18827 18828 18829 18830 18831 18832 18833 18834 18835 18836 18837 18838 18839 18840 18841 18842 18843 18844 18845 18846 18847 18848 18849 18850 18851 18852 18853 18854 18855 18856 18857 18858 18859 18860 18861 18862 18863 18864 18865 18866 18867 18868 18869 18870 18871 18872 18873 18874 18875 18876 18877 18878 18879 18880 18881 18882 18883 18884 18885 18886 18887 18888 18889 18890 18891 18892 18893 18894 18895 18896 18897 18898 18899 18900 18901 18902 18903 18904 18905 18906 18907 18908 18909 18910 18911 18912 18913 18914 18915 18916 18917 18918 18919 18920 18921 18922 18923 18924 18925 18926 18927 18928 18929 18930 18931 18932 18933 18934 18935 18936 18937 18938 18939 18940 18941 18942 18943 18944 18945 18946 18947 18948 18949 18950 18951 18952 18953 18954 18955 18956 18957 18958 18959 18960 18961 18962 18963 18964 18965 18966 18967 18968 18969 18970 18971 18972 18973 18974 18975 18976 18977 18978 18979 18980 18981 18982 18983 18984 18985 18986 18987 18988 18989 18990 18991 18992 18993 18994 18995 18996 18997 18998 18999 19000 19001 19002 19003 19004 19005 19006 19007 19008 19009 19010 19011 19012 19013 19014 19015 19016 19017 19018 19019 19020 19021 19022 19023 19024 19025 19026 19027 19028 19029 19030 19031 19032 19033 19034 19035 19036 19037 19038 19039 19040 19041 19042 19043 19044 19045 19046 19047 19048 19049 19050 19051 19052 19053 19054 19055 19056 19057 19058 19059 19060 19061 19062 19063 19064 19065 19066 19067 19068 19069 19070 19071 19072 19073 19074 19075 19076 19077 19078 19079 19080 19081 19082 19083 19084 19085 19086 19087 19088 19089 19090 19091 19092 19093 19094 19095 19096 19097 19098 19099 19100 19101 19102 19103 19104 19105 19106 19107 19108 19109 19110 19111 19112 19113 19114 19115 19116 19117 19118 19119 19120 19121 19122 19123 19124 19125 19126 19127 19128 19129 19130 19131 19132 19133 19134 19135 19136 19137 19138 19139 19140 19141 19142 19143 19144 19145 19146 19147 19148 19149 19150 19151 19152 19153 19154 19155 19156 19157 19158 19159 19160 19161 19162 19163 19164 19165 19166 19167 19168 19169 19170 19171 19172 19173 19174 19175 19176 19177 19178 19179 19180 19181 19182 19183 19184 19185 19186 19187 19188 19189 19190 19191 19192 19193 19194 19195 19196 19197 19198 19199 19200 19201 19202 19203 19204 19205 19206 19207 19208 19209 19210 19211 19212 19213 19214 19215 19216 19217 19218 19219 19220 19221 19222 19223 19224 19225 19226 19227 19228 19229 19230 19231 19232 19233 19234 19235 19236 19237 19238 19239 19240 19241 19242 19243 19244 19245 19246 19247 19248 19249 19250 19251 19252 19253 19254 19255 19256 19257 19258 19259 19260 19261 19262 19263 19264 19265 19266 19267 19268 19269 19270 19271 19272 19273 19274 19275 19276 19277 19278 19279 19280 19281 19282 19283 19284 19285 19286 19287 19288 19289 19290 19291 19292 19293 19294 19295 19296 19297 19298 19299 19300 19301 19302 19303 19304 19305 19306 19307 19308 19309 19310 19311 19312 19313 19314 19315 19316 19317 19318 19319 19320 19321 19322 19323 19324 19325 19326 19327 19328 19329 19330 19331 19332 19333 19334 19335 19336 19337 19338 19339 19340 19341 19342 19343 19344 19345 19346 19347 19348 19349 19350 19351 19352 19353 19354 19355 19356 19357 19358 19359 19360 19361 19362 19363 19364 19365 19366 19367 19368 19369 19370 19371 19372 19373 19374 19375 19376 19377 19378 19379 19380 19381 19382 19383 19384 19385 19386 19387 19388 19389 19390 19391 19392 19393 19394 19395 19396 19397 19398 19399 19400 19401 19402 19403 19404 19405 19406 19407 19408 19409 19410 19411 19412 19413 19414 19415 19416 19417 19418 19419 19420 19421 19422 19423 19424 19425 19426 19427 19428 19429 19430 19431 19432 19433 19434 19435 19436 19437 19438 19439 19440 19441 19442 19443 19444 19445 19446 19447 19448 19449 19450 19451 19452 19453 19454 19455 19456 19457 19458 19459 19460 19461 19462 19463 19464 19465 19466 19467 19468 19469 19470 19471 19472 19473 19474 19475 19476 19477 19478 19479 19480 19481 19482 19483 19484 19485 19486 19487 19488 19489 19490 19491 19492 19493 19494 19495 19496 19497 19498 19499 19500 19501 19502 19503 19504 19505 19506 19507 19508 19509 19510 19511 19512 19513 19514 19515 19516 19517 19518 19519 19520 19521 19522 19523 19524 19525 19526 19527 19528 19529 19530 19531 19532 19533 19534 19535 19536 19537 19538 19539 19540 19541 19542 19543 19544 19545 19546 19547 19548 19549 19550 19551 19552 19553 19554 19555 19556 19557 19558 19559 19560 19561 19562 19563 19564 19565 19566 19567 19568 19569 19570 19571 19572 19573 19574 19575 19576 19577 19578 19579 19580 19581 19582 19583 19584 19585 19586 19587 19588 19589 19590 19591 19592 19593 19594 19595 19596 19597 19598 19599 19600 19601 19602 19603 19604 19605 19606 19607 19608 19609 19610 19611 19612 19613 19614 19615 19616 19617 19618 19619 19620 19621 19622 19623 19624 19625 19626 19627 19628 19629 19630 19631 19632 19633 19634 19635 19636 19637 19638 19639 19640 19641 19642 19643 19644 19645 19646 19647 19648 19649 19650 19651 19652 19653 19654 19655 19656 19657 19658 19659 19660 19661 19662 19663 19664 19665 19666 19667 19668 19669 19670 19671 19672 19673 19674 19675 19676 19677 19678 19679 19680 19681 19682 19683 19684 19685 19686 19687 19688 19689 19690 19691 19692 | <?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">
<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">
<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" 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="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="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>
<type name="Auth" c:type="SoupAuth*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_saved_password"
c:identifier="soup_auth_get_saved_password">
<return-value transfer-ownership="none">
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<type name="Auth" c:type="SoupAuth*"/>
</instance-parameter>
<parameter name="user" transfer-ownership="none">
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="get_saved_users" c:identifier="soup_auth_get_saved_users">
<return-value transfer-ownership="full">
<type name="GLib.SList" c:type="GSList*">
<type name="utf8"/>
</type>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<type name="Auth" c:type="SoupAuth*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_scheme_name" c:identifier="soup_auth_get_scheme_name">
<doc xml:space="preserve">Returns @auth's scheme name. (Eg, "Basic", "Digest", or "NTLM")</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the scheme 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>
<type name="Auth" c:type="SoupAuth*"/>
</instance-parameter>
</parameters>
</method>
<method name="has_saved_password"
c:identifier="soup_auth_has_saved_password">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<type name="Auth" c:type="SoupAuth*"/>
</instance-parameter>
<parameter name="username" transfer-ownership="none">
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="password" transfer-ownership="none">
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="is_authenticated"
c:identifier="soup_auth_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>
</method>
<method name="is_for_proxy" c:identifier="soup_auth_is_for_proxy">
<doc xml:space="preserve">Tests whether or not @auth is associated with a proxy server rather
than an "origin" server.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE or %FALSE</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="is_ready" c:identifier="soup_auth_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>
</method>
<method name="save_password" c:identifier="soup_auth_save_password">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="auth" transfer-ownership="none">
<type name="Auth" c:type="SoupAuth*"/>
</instance-parameter>
<parameter name="username" transfer-ownership="none">
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="password" transfer-ownership="none">
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="update" c:identifier="soup_auth_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="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<property name="host" writable="1" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="is-authenticated" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="is-for-proxy" writable="1" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="realm" writable="1" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="scheme-name" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
<field name="realm">
<type name="utf8" c:type="char*"/>
</field>
</class>
<class name="AuthBasic"
c:symbol-prefix="auth_basic"
parent="Auth"
glib:type-name="SoupAuthBasic"
glib:get-type="soup_auth_basic_get_type">
</class>
<record name="AuthClass"
c:type="SoupAuthClass"
glib:is-gtype-struct-for="Auth">
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="scheme_name">
<type name="utf8" c:type="const char*"/>
</field>
<field name="strength">
<type name="guint" c:type="guint"/>
</field>
<field name="update">
<callback name="update">
<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>
<parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuth</doc>
<type name="Auth" c:type="SoupAuth*"/>
</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>
</callback>
</field>
<field name="get_protection_space">
<callback name="get_protection_space">
<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>
<parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuth</doc>
<type name="Auth" c:type="SoupAuth*"/>
</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>
</callback>
</field>
<field name="authenticate">
<callback name="authenticate">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuth</doc>
<type name="Auth" c:type="SoupAuth*"/>
</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>
</callback>
</field>
<field name="is_authenticated">
<callback name="is_authenticated">
<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>
<parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuth</doc>
<type name="Auth" c:type="SoupAuth*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="get_authorization">
<callback name="get_authorization">
<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>
<parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuth</doc>
<type name="Auth" c:type="SoupAuth*"/>
</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>
</callback>
</field>
<field name="is_ready">
<callback name="is_ready">
<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>
<parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuth</doc>
<type name="Auth" c:type="SoupAuth*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</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>
<class name="AuthDigest"
c:symbol-prefix="auth_digest"
parent="Auth"
glib:type-name="SoupAuthDigest"
glib:get-type="soup_auth_digest_get_type">
</class>
<class name="AuthDomain"
c:symbol-prefix="auth_domain"
c:type="SoupAuthDomain"
parent="GObject.Object"
abstract="1"
glib:type-name="SoupAuthDomain"
glib:get-type="soup_auth_domain_get_type"
glib:type-struct="AuthDomainClass">
<virtual-method name="accepts">
<return-value transfer-ownership="full">
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<instance-parameter name="domain" transfer-ownership="none">
<type name="AuthDomain" c:type="SoupAuthDomain*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="header" transfer-ownership="none">
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="challenge">
<return-value transfer-ownership="full">
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<instance-parameter name="domain" transfer-ownership="none">
<type name="AuthDomain" c:type="SoupAuthDomain*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="check_password" invoker="check_password">
<doc xml:space="preserve">Checks if @msg authenticates to @domain via @username and
@password. This would normally be called from a
#SoupAuthDomainGenericAuthCallback.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">whether or not the message is authenticated</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="domain" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuthDomain</doc>
<type name="AuthDomain" c:type="SoupAuthDomain*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="username" transfer-ownership="none">
<doc xml:space="preserve">a username</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="password" transfer-ownership="none">
<doc xml:space="preserve">a password</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</virtual-method>
<method name="accepts" c:identifier="soup_auth_domain_accepts">
<doc xml:space="preserve">Checks if @msg contains appropriate authorization for @domain to
accept it. Mirroring soup_auth_domain_covers(), this does not check
whether or not @domain <emphasis>cares</emphasis> if @msg is
authorized.
This is used by #SoupServer internally and is probably of no use to
anyone else.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">the username that @msg has authenticated
as, if in fact it has authenticated. %NULL otherwise.</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<instance-parameter name="domain" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuthDomain</doc>
<type name="AuthDomain" c:type="SoupAuthDomain*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</method>
<method name="add_path" c:identifier="soup_auth_domain_add_path">
<doc xml:space="preserve">Adds @path to @domain, such that requests under @path on @domain's
server will require authentication (unless overridden by
soup_auth_domain_remove_path() or soup_auth_domain_set_filter()).
You can also add paths by setting the %SOUP_AUTH_DOMAIN_ADD_PATH
property, which can also be used to add one or more paths at
construct time.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="domain" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuthDomain</doc>
<type name="AuthDomain" c:type="SoupAuthDomain*"/>
</instance-parameter>
<parameter name="path" transfer-ownership="none">
<doc xml:space="preserve">the path to add to @domain</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="basic_set_auth_callback"
c:identifier="soup_auth_domain_basic_set_auth_callback">
<doc xml:space="preserve">Sets the callback that @domain will use to authenticate incoming
requests. For each request containing authorization, @domain will
invoke the callback, and then either accept or reject the request
based on @callback's return value.
You can also set the auth callback by setting the
%SOUP_AUTH_DOMAIN_BASIC_AUTH_CALLBACK and
%SOUP_AUTH_DOMAIN_BASIC_AUTH_DATA properties, which can also be
used to set the callback at construct time.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="domain" transfer-ownership="none">
<doc xml:space="preserve">the domain</doc>
<type name="AuthDomain" c:type="SoupAuthDomain*"/>
</instance-parameter>
<parameter name="callback"
transfer-ownership="none"
scope="notified"
closure="1"
destroy="2">
<doc xml:space="preserve">the callback</doc>
<type name="AuthDomainBasicAuthCallback"
c:type="SoupAuthDomainBasicAuthCallback"/>
</parameter>
<parameter name="user_data" transfer-ownership="none">
<doc xml:space="preserve">data to pass to @auth_callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="dnotify" transfer-ownership="none" scope="async">
<doc xml:space="preserve">destroy notifier to free @user_data when @domain
is destroyed</doc>
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
</parameter>
</parameters>
</method>
<method name="challenge" c:identifier="soup_auth_domain_challenge">
<doc xml:space="preserve">Adds a "WWW-Authenticate" or "Proxy-Authenticate" header to @msg,
requesting that the client authenticate, and sets @msg's status
accordingly.
This is used by #SoupServer internally and is probably of no use to
anyone else.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="domain" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuthDomain</doc>
<type name="AuthDomain" c:type="SoupAuthDomain*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</method>
<method name="check_password"
c:identifier="soup_auth_domain_check_password">
<doc xml:space="preserve">Checks if @msg authenticates to @domain via @username and
@password. This would normally be called from a
#SoupAuthDomainGenericAuthCallback.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">whether or not the message is authenticated</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="domain" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuthDomain</doc>
<type name="AuthDomain" c:type="SoupAuthDomain*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="username" transfer-ownership="none">
<doc xml:space="preserve">a username</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="password" transfer-ownership="none">
<doc xml:space="preserve">a password</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="covers" c:identifier="soup_auth_domain_covers">
<doc xml:space="preserve">Checks if @domain requires @msg to be authenticated (according to
its paths and filter function). This does not actually look at
whether @msg <emphasis>is</emphasis> authenticated, merely whether
or not it needs to be.
This is used by #SoupServer internally and is probably of no use to
anyone else.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @domain requires @msg to be authenticated</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="domain" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuthDomain</doc>
<type name="AuthDomain" c:type="SoupAuthDomain*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</method>
<method name="digest_set_auth_callback"
c:identifier="soup_auth_domain_digest_set_auth_callback">
<doc xml:space="preserve">Sets the callback that @domain will use to authenticate incoming
requests. For each request containing authorization, @domain will
invoke the callback, and then either accept or reject the request
based on @callback's return value.
You can also set the auth callback by setting the
%SOUP_AUTH_DOMAIN_DIGEST_AUTH_CALLBACK and
%SOUP_AUTH_DOMAIN_DIGEST_AUTH_DATA properties, which can also be
used to set the callback at construct time.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="domain" transfer-ownership="none">
<doc xml:space="preserve">the domain</doc>
<type name="AuthDomain" c:type="SoupAuthDomain*"/>
</instance-parameter>
<parameter name="callback"
transfer-ownership="none"
scope="notified"
closure="1"
destroy="2">
<doc xml:space="preserve">the callback</doc>
<type name="AuthDomainDigestAuthCallback"
c:type="SoupAuthDomainDigestAuthCallback"/>
</parameter>
<parameter name="user_data" transfer-ownership="none">
<doc xml:space="preserve">data to pass to @auth_callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="dnotify" transfer-ownership="none" scope="async">
<doc xml:space="preserve">destroy notifier to free @user_data when @domain
is destroyed</doc>
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
</parameter>
</parameters>
</method>
<method name="get_realm" c:identifier="soup_auth_domain_get_realm">
<doc xml:space="preserve">Gets the realm name associated with @domain</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">@domain's realm</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<instance-parameter name="domain" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuthDomain</doc>
<type name="AuthDomain" c:type="SoupAuthDomain*"/>
</instance-parameter>
</parameters>
</method>
<method name="remove_path" c:identifier="soup_auth_domain_remove_path">
<doc xml:space="preserve">Removes @path from @domain, such that requests under @path on
@domain's server will NOT require authentication.
This is not simply an undo-er for soup_auth_domain_add_path(); it
can be used to "carve out" a subtree that does not require
authentication inside a hierarchy that does. Note also that unlike
with soup_auth_domain_add_path(), this cannot be overridden by
adding a filter, as filters can only bypass authentication that
would otherwise be required, not require it where it would
otherwise be unnecessary.
You can also remove paths by setting the
%SOUP_AUTH_DOMAIN_REMOVE_PATH property, which can also be used to
remove one or more paths at construct time.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="domain" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuthDomain</doc>
<type name="AuthDomain" c:type="SoupAuthDomain*"/>
</instance-parameter>
<parameter name="path" transfer-ownership="none">
<doc xml:space="preserve">the path to remove from @domain</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="set_filter" c:identifier="soup_auth_domain_set_filter">
<doc xml:space="preserve">Adds @filter as an authentication filter to @domain. The filter
gets a chance to bypass authentication for certain requests that
would otherwise require it. Eg, it might check the message's path
in some way that is too complicated to do via the other methods, or
it might check the message's method, and allow GETs but not PUTs.
The filter function returns %TRUE if the request should still
require authentication, or %FALSE if authentication is unnecessary
for this request.
To help prevent security holes, your filter should return %TRUE by
default, and only return %FALSE under specifically-tested
circumstances, rather than the other way around. Eg, in the example
above, where you want to authenticate PUTs but not GETs, you should
check if the method is GET and return %FALSE in that case, and then
return %TRUE for all other methods (rather than returning %TRUE for
PUT and %FALSE for all other methods). This way if it turned out
(now or later) that some paths supported additional methods besides
GET and PUT, those methods would default to being NOT allowed for
unauthenticated users.
You can also set the filter by setting the %SOUP_AUTH_DOMAIN_FILTER
and %SOUP_AUTH_DOMAIN_FILTER_DATA properties, which can also be
used to set the filter at construct time.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="domain" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuthDomain</doc>
<type name="AuthDomain" c:type="SoupAuthDomain*"/>
</instance-parameter>
<parameter name="filter"
transfer-ownership="none"
scope="notified"
closure="1"
destroy="2">
<doc xml:space="preserve">the auth filter for @domain</doc>
<type name="AuthDomainFilter" c:type="SoupAuthDomainFilter"/>
</parameter>
<parameter name="filter_data" transfer-ownership="none">
<doc xml:space="preserve">data to pass to @filter</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="dnotify" transfer-ownership="none" scope="async">
<doc xml:space="preserve">destroy notifier to free @filter_data when @domain
is destroyed</doc>
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
</parameter>
</parameters>
</method>
<method name="set_generic_auth_callback"
c:identifier="soup_auth_domain_set_generic_auth_callback">
<doc xml:space="preserve">Sets @auth_callback as an authentication-handling callback for
@domain. Whenever a request comes in to @domain which cannot be
authenticated via a domain-specific auth callback (eg,
#SoupAuthDomainDigestAuthCallback), the generic auth callback
will be invoked. See #SoupAuthDomainGenericAuthCallback for information
on what the callback should do.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="domain" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuthDomain</doc>
<type name="AuthDomain" c:type="SoupAuthDomain*"/>
</instance-parameter>
<parameter name="auth_callback"
transfer-ownership="none"
scope="notified"
closure="1"
destroy="2">
<doc xml:space="preserve">the auth callback</doc>
<type name="AuthDomainGenericAuthCallback"
c:type="SoupAuthDomainGenericAuthCallback"/>
</parameter>
<parameter name="auth_data" transfer-ownership="none">
<doc xml:space="preserve">data to pass to @auth_callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="dnotify" transfer-ownership="none" scope="async">
<doc xml:space="preserve">destroy notifier to free @auth_data when @domain
is destroyed</doc>
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
</parameter>
</parameters>
</method>
<method name="try_generic_auth_callback"
c:identifier="soup_auth_domain_try_generic_auth_callback">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="domain" transfer-ownership="none">
<type name="AuthDomain" c:type="SoupAuthDomain*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="username" transfer-ownership="none">
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<property name="add-path"
readable="0"
writable="1"
transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="filter" writable="1" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</property>
<property name="filter-data" writable="1" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</property>
<property name="generic-auth-callback"
writable="1"
transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</property>
<property name="generic-auth-data"
writable="1"
transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</property>
<property name="proxy"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="realm"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="remove-path"
readable="0"
writable="1"
transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<class name="AuthDomainBasic"
c:symbol-prefix="auth_domain_basic"
c:type="SoupAuthDomainBasic"
parent="AuthDomain"
glib:type-name="SoupAuthDomainBasic"
glib:get-type="soup_auth_domain_basic_get_type"
glib:type-struct="AuthDomainBasicClass">
<constructor name="new"
c:identifier="soup_auth_domain_basic_new"
introspectable="0">
<doc xml:space="preserve">Creates a #SoupAuthDomainBasic. You must set the
%SOUP_AUTH_DOMAIN_REALM parameter, to indicate the realm name to be
returned with the authentication challenge to the client. Other
parameters are optional.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the new #SoupAuthDomain</doc>
<type name="AuthDomain" c:type="SoupAuthDomain*"/>
</return-value>
<parameters>
<parameter name="optname1" transfer-ownership="none">
<doc xml:space="preserve">name of first option, or %NULL</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">option name/value pairs</doc>
<varargs/>
</parameter>
</parameters>
</constructor>
<property name="auth-callback" writable="1" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</property>
<property name="auth-data" writable="1" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</property>
<field name="parent">
<type name="AuthDomain" c:type="SoupAuthDomain"/>
</field>
</class>
<callback name="AuthDomainBasicAuthCallback"
c:type="SoupAuthDomainBasicAuthCallback">
<doc xml:space="preserve">Callback used by #SoupAuthDomainBasic for authentication purposes.
The application should verify that @username and @password and valid
and return %TRUE or %FALSE.
If you are maintaining your own password database (rather than
using the password to authenticate against some other system like
PAM or a remote server), you should make sure you know what you are
doing. In particular, don't store cleartext passwords, or
easily-computed hashes of cleartext passwords, even if you don't
care that much about the security of your server, because users
will frequently use the same password for multiple sites, and so
compromising any site with a cleartext (or easily-cracked) password
database may give attackers access to other more-interesting sites
as well.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @username and @password are valid</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="domain" transfer-ownership="none">
<doc xml:space="preserve">the domain</doc>
<type name="AuthDomain" c:type="SoupAuthDomain*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the message being authenticated</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="username" transfer-ownership="none">
<doc xml:space="preserve">the username provided by the 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 client</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" closure="4">
<doc xml:space="preserve">the data passed to soup_auth_domain_basic_set_auth_callback()</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<record name="AuthDomainBasicClass"
c:type="SoupAuthDomainBasicClass"
glib:is-gtype-struct-for="AuthDomainBasic">
<field name="parent_class">
<type name="AuthDomainClass" c:type="SoupAuthDomainClass"/>
</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>
<record name="AuthDomainClass"
c:type="SoupAuthDomainClass"
glib:is-gtype-struct-for="AuthDomain">
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="accepts">
<callback name="accepts">
<return-value transfer-ownership="full">
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<parameter name="domain" transfer-ownership="none">
<type name="AuthDomain" c:type="SoupAuthDomain*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="header" transfer-ownership="none">
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="challenge">
<callback name="challenge">
<return-value transfer-ownership="full">
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<parameter name="domain" transfer-ownership="none">
<type name="AuthDomain" c:type="SoupAuthDomain*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="check_password">
<callback name="check_password">
<return-value transfer-ownership="none">
<doc xml:space="preserve">whether or not the message is authenticated</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="domain" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuthDomain</doc>
<type name="AuthDomain" c:type="SoupAuthDomain*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="username" transfer-ownership="none">
<doc xml:space="preserve">a username</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="password" transfer-ownership="none">
<doc xml:space="preserve">a password</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</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>
<class name="AuthDomainDigest"
c:symbol-prefix="auth_domain_digest"
c:type="SoupAuthDomainDigest"
parent="AuthDomain"
glib:type-name="SoupAuthDomainDigest"
glib:get-type="soup_auth_domain_digest_get_type"
glib:type-struct="AuthDomainDigestClass">
<constructor name="new"
c:identifier="soup_auth_domain_digest_new"
introspectable="0">
<doc xml:space="preserve">Creates a #SoupAuthDomainDigest. You must set the
%SOUP_AUTH_DOMAIN_REALM parameter, to indicate the realm name to be
returned with the authentication challenge to the client. Other
parameters are optional.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the new #SoupAuthDomain</doc>
<type name="AuthDomain" c:type="SoupAuthDomain*"/>
</return-value>
<parameters>
<parameter name="optname1" transfer-ownership="none">
<doc xml:space="preserve">name of first option, or %NULL</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">option name/value pairs</doc>
<varargs/>
</parameter>
</parameters>
</constructor>
<function name="encode_password"
c:identifier="soup_auth_domain_digest_encode_password">
<doc xml:space="preserve">Encodes the username/realm/password triplet for Digest
authentication. (That is, it returns a stringified MD5 hash of
@username, @realm, and @password concatenated together). This is
the form that is needed as the return value of
#SoupAuthDomainDigest's auth handler.
For security reasons, you should store the encoded hash, rather
than storing the cleartext password itself and calling this method
only when you need to verify it. This way, if your server is
compromised, the attackers will not gain access to cleartext
passwords which might also be usable at other sites. (Note also
that the encoded password returned by this method is identical to
the encoded password stored in an Apache .htdigest file.)</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the encoded password</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<parameter name="username" transfer-ownership="none">
<doc xml:space="preserve">a username</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="realm" transfer-ownership="none">
<doc xml:space="preserve">an auth realm name</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="password" transfer-ownership="none">
<doc xml:space="preserve">the password for @username in @realm</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</function>
<property name="auth-callback" writable="1" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</property>
<property name="auth-data" writable="1" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</property>
<field name="parent">
<type name="AuthDomain" c:type="SoupAuthDomain"/>
</field>
</class>
<callback name="AuthDomainDigestAuthCallback"
c:type="SoupAuthDomainDigestAuthCallback">
<doc xml:space="preserve">Callback used by #SoupAuthDomainDigest for authentication purposes.
The application should look up @username in its password database,
and return the corresponding encoded password (see
soup_auth_domain_digest_encode_password()).</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">the encoded password, or %NULL if
@username is not a valid user. @domain will free the password when
it is done with it.</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<parameter name="domain" transfer-ownership="none">
<doc xml:space="preserve">the domain</doc>
<type name="AuthDomain" c:type="SoupAuthDomain*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the message being authenticated</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="username" transfer-ownership="none">
<doc xml:space="preserve">the username provided by the client</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" closure="3">
<doc xml:space="preserve">the data passed to soup_auth_domain_digest_set_auth_callback()</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<record name="AuthDomainDigestClass"
c:type="SoupAuthDomainDigestClass"
glib:is-gtype-struct-for="AuthDomainDigest">
<field name="parent_class">
<type name="AuthDomainClass" c:type="SoupAuthDomainClass"/>
</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>
<callback name="AuthDomainFilter" c:type="SoupAuthDomainFilter">
<doc xml:space="preserve">The prototype for a #SoupAuthDomain filter; see
soup_auth_domain_set_filter() for details.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @msg requires authentication, %FALSE if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="domain" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuthDomain</doc>
<type name="AuthDomain" c:type="SoupAuthDomain*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" closure="2">
<doc xml:space="preserve">the data passed to soup_auth_domain_set_filter()</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<callback name="AuthDomainGenericAuthCallback"
c:type="SoupAuthDomainGenericAuthCallback">
<doc xml:space="preserve">The prototype for a #SoupAuthDomain generic authentication callback.
The callback should look up the user's password, call
soup_auth_domain_check_password(), and use the return value from
that method as its own return value.
In general, for security reasons, it is preferable to use the
auth-domain-specific auth callbacks (eg,
#SoupAuthDomainBasicAuthCallback and
#SoupAuthDomainDigestAuthCallback), because they don't require
keeping a cleartext password database. Most users will use the same
password for many different sites, meaning if any site with a
cleartext password database is compromised, accounts on other
servers might be compromised as well. For many of the cases where
#SoupServer is used, this is not really relevant, but it may still
be worth considering.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @msg is authenticated, %FALSE if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="domain" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuthDomain</doc>
<type name="AuthDomain" c:type="SoupAuthDomain*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the #SoupMessage being authenticated</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="username" transfer-ownership="none">
<doc xml:space="preserve">the username from @msg</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" closure="3">
<doc xml:space="preserve">the data passed to
soup_auth_domain_set_generic_auth_callback()</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<class name="AuthManager"
c:symbol-prefix="auth_manager"
c:type="SoupAuthManager"
parent="GObject.Object"
glib:type-name="SoupAuthManager"
glib:get-type="soup_auth_manager_get_type"
glib:type-struct="AuthManagerClass">
<implements name="SessionFeature"/>
<virtual-method name="authenticate">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="manager" transfer-ownership="none">
<type name="AuthManager" c:type="SoupAuthManager*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="auth" transfer-ownership="none">
<type name="Auth" c:type="SoupAuth*"/>
</parameter>
<parameter name="retrying" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</virtual-method>
<method name="use_auth"
c:identifier="soup_auth_manager_use_auth"
version="2.42">
<doc xml:space="preserve">Records that @auth is to be used under @uri, as though a
WWW-Authenticate header had been received at that URI. This can be
used to "preload" @manager's auth cache, to avoid an extra HTTP
round trip in the case where you know ahead of time that a 401
response will be returned.
This is only useful for authentication types where the initial
Authorization header does not depend on any additional information
from the server. (Eg, Basic or NTLM, but not Digest.)</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="manager" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuthManager</doc>
<type name="AuthManager" c:type="SoupAuthManager*"/>
</instance-parameter>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">the #SoupURI under which @auth is to be used</doc>
<type name="URI" c:type="SoupURI*"/>
</parameter>
<parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">the #SoupAuth to use</doc>
<type name="Auth" c:type="SoupAuth*"/>
</parameter>
</parameters>
</method>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
<field name="priv">
<type name="AuthManagerPrivate" c:type="SoupAuthManagerPrivate*"/>
</field>
<glib:signal name="authenticate" when="first">
<doc xml:space="preserve">Emitted when the manager requires the application to
provide authentication credentials.
#SoupSession connects to this signal and emits its own
#SoupSession::authenticate signal when it is emitted, so
you shouldn't need to use this signal directly.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the #SoupMessage being sent</doc>
<type name="Message"/>
</parameter>
<parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">the #SoupAuth to authenticate</doc>
<type name="Auth"/>
</parameter>
<parameter name="retrying" transfer-ownership="none">
<doc xml:space="preserve">%TRUE if this is the second (or later) attempt</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</glib:signal>
</class>
<record name="AuthManagerClass"
c:type="SoupAuthManagerClass"
glib:is-gtype-struct-for="AuthManager">
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="authenticate">
<callback name="authenticate">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="manager" transfer-ownership="none">
<type name="AuthManager" c:type="SoupAuthManager*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="auth" transfer-ownership="none">
<type name="Auth" c:type="SoupAuth*"/>
</parameter>
<parameter name="retrying" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</callback>
</field>
</record>
<record name="AuthManagerPrivate"
c:type="SoupAuthManagerPrivate"
disguised="1">
</record>
<class name="AuthNTLM"
c:symbol-prefix="auth_ntlm"
parent="Auth"
glib:type-name="SoupAuthNTLM"
glib:get-type="soup_auth_ntlm_get_type">
</class>
<record name="Buffer"
c:type="SoupBuffer"
glib:type-name="SoupBuffer"
glib:get-type="soup_buffer_get_type"
c:symbol-prefix="buffer">
<doc xml:space="preserve">A data buffer, generally used to represent a chunk of a
#SoupMessageBody.
@data is a #char because that's generally convenient; in some
situations you may need to cast it to #guchar or another type.</doc>
<field name="data" writable="1">
<doc xml:space="preserve">the data</doc>
<type name="gpointer"/>
</field>
<field name="length" writable="1">
<doc xml:space="preserve">length of @data</doc>
<type name="gsize" c:type="gsize"/>
</field>
<constructor name="new"
c:identifier="soup_buffer_new"
shadowed-by="new_take">
<doc xml:space="preserve">Creates a new #SoupBuffer containing @length bytes from @data.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the new #SoupBuffer.</doc>
<type name="Buffer" c:type="SoupBuffer*"/>
</return-value>
<parameters>
<parameter name="use" transfer-ownership="none">
<doc xml:space="preserve">how @data is to be used by the buffer</doc>
<type name="MemoryUse" c:type="SoupMemoryUse"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">data</doc>
<array length="2" zero-terminated="0" c:type="gconstpointer">
<type name="guint8"/>
</array>
</parameter>
<parameter name="length" transfer-ownership="none">
<doc xml:space="preserve">length of @data</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_take"
c:identifier="soup_buffer_new_take"
shadows="new"
version="2.32">
<doc xml:space="preserve">Creates a new #SoupBuffer containing @length bytes from @data.
This function is exactly equivalent to soup_buffer_new() with
%SOUP_MEMORY_TAKE as first argument; it exists mainly for
convenience and simplifying language bindings.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the new #SoupBuffer.</doc>
<type name="Buffer" c:type="SoupBuffer*"/>
</return-value>
<parameters>
<parameter name="data" transfer-ownership="full">
<doc xml:space="preserve">data</doc>
<array length="1" zero-terminated="0" c:type="guchar*">
<type name="guint8" c:type="guchar"/>
</array>
</parameter>
<parameter name="length" transfer-ownership="none">
<doc xml:space="preserve">length of @data</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_with_owner"
c:identifier="soup_buffer_new_with_owner">
<doc xml:space="preserve">Creates a new #SoupBuffer containing @length bytes from @data. When
the #SoupBuffer is freed, it will call @owner_dnotify, passing
@owner to it. You must ensure that @data will remain valid until
@owner_dnotify is called.
For example, you could use this to create a buffer containing data
returned from libxml without needing to do an extra copy:
<informalexample><programlisting>
xmlDocDumpMemory (doc, &xmlbody, &len);
return soup_buffer_new_with_owner (xmlbody, len, xmlbody,
(GDestroyNotify)xmlFree);
</programlisting></informalexample>
In this example, @data and @owner are the same, but in other cases
they would be different (eg, @owner would be a object, and @data
would be a pointer to one of the object's fields).</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the new #SoupBuffer.</doc>
<type name="Buffer" c:type="SoupBuffer*"/>
</return-value>
<parameters>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">data</doc>
<array length="1" zero-terminated="0" c:type="gconstpointer">
<type name="guint8"/>
</array>
</parameter>
<parameter name="length" transfer-ownership="none">
<doc xml:space="preserve">length of @data</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
<parameter name="owner" transfer-ownership="none">
<doc xml:space="preserve">pointer to an object that owns @data</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="owner_dnotify"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async">
<doc xml:space="preserve">a function to free/unref @owner when
the buffer is freed</doc>
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
</parameter>
</parameters>
</constructor>
<method name="copy" c:identifier="soup_buffer_copy">
<doc xml:space="preserve">Makes a copy of @buffer. In reality, #SoupBuffer is a refcounted
type, and calling soup_buffer_copy() will normally just increment
the refcount on @buffer and return it. However, if @buffer was
created with #SOUP_MEMORY_TEMPORARY memory, then soup_buffer_copy()
will actually return a copy of it, so that the data in the copy
will remain valid after the temporary buffer is freed.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the new (or newly-reffed) buffer</doc>
<type name="Buffer" c:type="SoupBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">a #SoupBuffer</doc>
<type name="Buffer" c:type="SoupBuffer*"/>
</instance-parameter>
</parameters>
</method>
<method name="free" c:identifier="soup_buffer_free">
<doc xml:space="preserve">Frees @buffer. (In reality, as described in the documentation for
soup_buffer_copy(), this is actually an "unref" operation, and may
or may not actually free @buffer.)</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">a #SoupBuffer</doc>
<type name="Buffer" c:type="SoupBuffer*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_as_bytes"
c:identifier="soup_buffer_get_as_bytes"
version="2.40">
<doc xml:space="preserve">Creates a #GBytes pointing to the same memory as @buffer. The
#GBytes will hold a reference on @buffer to ensure that it is not
freed while the #GBytes is still valid.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #GBytes which has the same content
as the #SoupBuffer.</doc>
<type name="GLib.Bytes" c:type="GBytes*"/>
</return-value>
<parameters>
<instance-parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">a #SoupBuffer</doc>
<type name="Buffer" c:type="SoupBuffer*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_data"
c:identifier="soup_buffer_get_data"
version="2.32">
<doc xml:space="preserve">This function exists for use by language bindings, because it's not
currently possible to get the right effect by annotating the fields
of #SoupBuffer.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">a #SoupBuffer</doc>
<type name="Buffer" c:type="SoupBuffer*"/>
</instance-parameter>
<parameter name="data"
direction="out"
caller-allocates="0"
transfer-ownership="none">
<doc xml:space="preserve">the pointer
to the buffer data is stored here</doc>
<array length="1" zero-terminated="0" c:type="guint8**">
<type name="guint8" c:type="guint8*"/>
</array>
</parameter>
<parameter name="length"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">the length of the buffer data is stored here</doc>
<type name="gsize" c:type="gsize*"/>
</parameter>
</parameters>
</method>
<method name="get_owner" c:identifier="soup_buffer_get_owner">
<doc xml:space="preserve">Gets the "owner" object for a buffer created with
soup_buffer_new_with_owner().</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the owner pointer</doc>
<type name="gpointer" c:type="gpointer"/>
</return-value>
<parameters>
<instance-parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">a #SoupBuffer created with soup_buffer_new_with_owner()</doc>
<type name="Buffer" c:type="SoupBuffer*"/>
</instance-parameter>
</parameters>
</method>
<method name="new_subbuffer" c:identifier="soup_buffer_new_subbuffer">
<doc xml:space="preserve">Creates a new #SoupBuffer containing @length bytes "copied" from
@parent starting at @offset. (Normally this will not actually copy
any data, but will instead simply reference the same data as
@parent does.)</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the new #SoupBuffer.</doc>
<type name="Buffer" c:type="SoupBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="parent" transfer-ownership="none">
<doc xml:space="preserve">the parent #SoupBuffer</doc>
<type name="Buffer" c:type="SoupBuffer*"/>
</instance-parameter>
<parameter name="offset" transfer-ownership="none">
<doc xml:space="preserve">offset within @parent to start at</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
<parameter name="length" transfer-ownership="none">
<doc xml:space="preserve">number of bytes to copy from @parent</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
</parameters>
</method>
</record>
<glib:boxed glib:name="ByteArray"
c:symbol-prefix="byte_array"
glib:type-name="SoupByteArray"
glib:get-type="soup_byte_array_get_type">
</glib:boxed>
<constant name="CACHE_H" value="1" c:type="SOUP_CACHE_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="CHAR_HTTP_CTL" value="16" c:type="SOUP_CHAR_HTTP_CTL">
<type name="gint" c:type="gint"/>
</constant>
<constant name="CHAR_HTTP_SEPARATOR"
value="8"
c:type="SOUP_CHAR_HTTP_SEPARATOR">
<type name="gint" c:type="gint"/>
</constant>
<constant name="CHAR_URI_GEN_DELIMS"
value="2"
c:type="SOUP_CHAR_URI_GEN_DELIMS">
<type name="gint" c:type="gint"/>
</constant>
<constant name="CHAR_URI_PERCENT_ENCODED"
value="1"
c:type="SOUP_CHAR_URI_PERCENT_ENCODED">
<type name="gint" c:type="gint"/>
</constant>
<constant name="CHAR_URI_SUB_DELIMS"
value="4"
c:type="SOUP_CHAR_URI_SUB_DELIMS">
<type name="gint" c:type="gint"/>
</constant>
<constant name="CONTENT_DECODER_H"
value="1"
c:type="SOUP_CONTENT_DECODER_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="CONTENT_SNIFFER_H"
value="1"
c:type="SOUP_CONTENT_SNIFFER_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="COOKIE_H" value="1" c:type="SOUP_COOKIE_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="COOKIE_JAR_ACCEPT_POLICY"
value="accept-policy"
c:type="SOUP_COOKIE_JAR_ACCEPT_POLICY"
version="2.30">
<doc xml:space="preserve">Alias for the #SoupCookieJar:accept-policy property.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="COOKIE_JAR_DB_FILENAME"
value="filename"
c:type="SOUP_COOKIE_JAR_DB_FILENAME">
<doc xml:space="preserve">Alias for the #SoupCookieJarDB:filename property. (The
cookie-storage filename.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="COOKIE_JAR_DB_H" value="1" c:type="SOUP_COOKIE_JAR_DB_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="COOKIE_JAR_H" value="1" c:type="SOUP_COOKIE_JAR_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="COOKIE_JAR_READ_ONLY"
value="read-only"
c:type="SOUP_COOKIE_JAR_READ_ONLY">
<doc xml:space="preserve">Alias for the #SoupCookieJar:read-only property. (Whether
or not the cookie jar is read-only.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="COOKIE_JAR_TEXT_FILENAME"
value="filename"
c:type="SOUP_COOKIE_JAR_TEXT_FILENAME">
<doc xml:space="preserve">Alias for the #SoupCookieJarText:filename property. (The
cookie-storage filename.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="COOKIE_JAR_TEXT_H"
value="1"
c:type="SOUP_COOKIE_JAR_TEXT_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="COOKIE_MAX_AGE_ONE_DAY"
value="0"
c:type="SOUP_COOKIE_MAX_AGE_ONE_DAY"
version="2.24">
<doc xml:space="preserve">A constant corresponding to 1 day, for use with soup_cookie_new()
and soup_cookie_set_max_age().</doc>
<type name="gint" c:type="gint"/>
</constant>
<constant name="COOKIE_MAX_AGE_ONE_HOUR"
value="3600"
c:type="SOUP_COOKIE_MAX_AGE_ONE_HOUR"
version="2.24">
<doc xml:space="preserve">A constant corresponding to 1 hour, for use with soup_cookie_new()
and soup_cookie_set_max_age().</doc>
<type name="gint" c:type="gint"/>
</constant>
<constant name="COOKIE_MAX_AGE_ONE_WEEK"
value="0"
c:type="SOUP_COOKIE_MAX_AGE_ONE_WEEK"
version="2.24">
<doc xml:space="preserve">A constant corresponding to 1 week, for use with soup_cookie_new()
and soup_cookie_set_max_age().</doc>
<type name="gint" c:type="gint"/>
</constant>
<constant name="COOKIE_MAX_AGE_ONE_YEAR"
value="0"
c:type="SOUP_COOKIE_MAX_AGE_ONE_YEAR"
version="2.24">
<doc xml:space="preserve">A constant corresponding to 1 year, for use with soup_cookie_new()
and soup_cookie_set_max_age().</doc>
<type name="gint" c:type="gint"/>
</constant>
<class name="Cache"
c:symbol-prefix="cache"
c:type="SoupCache"
parent="GObject.Object"
glib:type-name="SoupCache"
glib:get-type="soup_cache_get_type"
glib:type-struct="CacheClass">
<implements name="SessionFeature"/>
<constructor name="new" c:identifier="soup_cache_new" version="2.34">
<doc xml:space="preserve">Creates a new #SoupCache.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #SoupCache</doc>
<type name="Cache" c:type="SoupCache*"/>
</return-value>
<parameters>
<parameter name="cache_dir" transfer-ownership="none">
<doc xml:space="preserve">the directory to store the cached data, or %NULL to use the default one</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="cache_type" transfer-ownership="none">
<doc xml:space="preserve">the #SoupCacheType of the cache</doc>
<type name="CacheType" c:type="SoupCacheType"/>
</parameter>
</parameters>
</constructor>
<virtual-method name="get_cacheability">
<return-value transfer-ownership="none">
<type name="Cacheability" c:type="SoupCacheability"/>
</return-value>
<parameters>
<instance-parameter name="cache" transfer-ownership="none">
<type name="Cache" c:type="SoupCache*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</virtual-method>
<method name="clear" c:identifier="soup_cache_clear" version="2.34">
<doc xml:space="preserve">Will remove all entries in the @cache plus all the cache files.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cache" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCache</doc>
<type name="Cache" c:type="SoupCache*"/>
</instance-parameter>
</parameters>
</method>
<method name="dump" c:identifier="soup_cache_dump" version="2.34.">
<doc xml:space="preserve">Synchronously writes the cache index out to disk. Contrast with
soup_cache_flush(), which writes pending cache
<emphasis>entries</emphasis> to disk.
You must call this before exiting if you want your cache data to
persist between sessions.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cache" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCache</doc>
<type name="Cache" c:type="SoupCache*"/>
</instance-parameter>
</parameters>
</method>
<method name="flush" c:identifier="soup_cache_flush" version="2.34">
<doc xml:space="preserve">This function will force all pending writes in the @cache to be
committed to disk. For doing so it will iterate the #GMainContext
associated with @cache's session as long as needed.
Contrast with soup_cache_dump(), which writes out the cache index
file.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cache" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCache</doc>
<type name="Cache" c:type="SoupCache*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_max_size"
c:identifier="soup_cache_get_max_size"
version="2.34">
<doc xml:space="preserve">Gets the maximum size of the cache.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the maximum size of the cache, in bytes.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="cache" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCache</doc>
<type name="Cache" c:type="SoupCache*"/>
</instance-parameter>
</parameters>
</method>
<method name="load" c:identifier="soup_cache_load" version="2.34">
<doc xml:space="preserve">Loads the contents of @cache's index into memory.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cache" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCache</doc>
<type name="Cache" c:type="SoupCache*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_max_size"
c:identifier="soup_cache_set_max_size"
version="2.34">
<doc xml:space="preserve">Sets the maximum size of the cache.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cache" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCache</doc>
<type name="Cache" c:type="SoupCache*"/>
</instance-parameter>
<parameter name="max_size" transfer-ownership="none">
<doc xml:space="preserve">the maximum size of the cache, in bytes</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<property name="cache-dir"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="cache-type"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="CacheType"/>
</property>
<field name="parent_instance">
<type name="GObject.Object" c:type="GObject"/>
</field>
<field name="priv">
<type name="CachePrivate" c:type="SoupCachePrivate*"/>
</field>
</class>
<record name="CacheClass"
c:type="SoupCacheClass"
glib:is-gtype-struct-for="Cache">
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="get_cacheability">
<callback name="get_cacheability">
<return-value transfer-ownership="none">
<type name="Cacheability" c:type="SoupCacheability"/>
</return-value>
<parameters>
<parameter name="cache" transfer-ownership="none">
<type name="Cache" c:type="SoupCache*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</callback>
</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>
</record>
<record name="CachePrivate" c:type="SoupCachePrivate" disguised="1">
</record>
<enumeration name="CacheResponse"
glib:type-name="SoupCacheResponse"
glib:get-type="soup_cache_response_get_type"
c:type="SoupCacheResponse">
<member name="fresh"
value="0"
c:identifier="SOUP_CACHE_RESPONSE_FRESH"
glib:nick="fresh">
</member>
<member name="needs_validation"
value="1"
c:identifier="SOUP_CACHE_RESPONSE_NEEDS_VALIDATION"
glib:nick="needs-validation">
</member>
<member name="stale"
value="2"
c:identifier="SOUP_CACHE_RESPONSE_STALE"
glib:nick="stale">
</member>
</enumeration>
<enumeration name="CacheType"
version="2.34"
glib:type-name="SoupCacheType"
glib:get-type="soup_cache_type_get_type"
c:type="SoupCacheType">
<doc xml:space="preserve">The type of cache; this affects what kinds of responses will be
saved.</doc>
<member name="single_user"
value="0"
c:identifier="SOUP_CACHE_SINGLE_USER"
glib:nick="single-user">
<doc xml:space="preserve">a single-user cache</doc>
</member>
<member name="shared"
value="1"
c:identifier="SOUP_CACHE_SHARED"
glib:nick="shared">
<doc xml:space="preserve">a shared cache</doc>
</member>
</enumeration>
<bitfield name="Cacheability"
glib:type-name="SoupCacheability"
glib:get-type="soup_cacheability_get_type"
c:type="SoupCacheability">
<member name="cacheable"
value="1"
c:identifier="SOUP_CACHE_CACHEABLE"
glib:nick="cacheable">
</member>
<member name="uncacheable"
value="2"
c:identifier="SOUP_CACHE_UNCACHEABLE"
glib:nick="uncacheable">
</member>
<member name="invalidates"
value="4"
c:identifier="SOUP_CACHE_INVALIDATES"
glib:nick="invalidates">
</member>
<member name="validates"
value="8"
c:identifier="SOUP_CACHE_VALIDATES"
glib:nick="validates">
</member>
</bitfield>
<callback name="ChunkAllocator" c:type="SoupChunkAllocator" deprecated="1">
<doc xml:space="preserve">The prototype for a chunk allocation callback. This should allocate
a new #SoupBuffer and return it for the I/O layer to read message
body data off the network into.
If @max_len is non-0, it indicates the maximum number of bytes that
could be read, based on what is known about the message size. Note
that this might be a very large number, and you should not simply
try to allocate that many bytes blindly. If @max_len is 0, that
means that libsoup does not know how many bytes remain to be read,
and the allocator should return a buffer of a size that it finds
convenient.
If the allocator returns %NULL, the message will be paused. It is
up to the application to make sure that it gets unpaused when it
becomes possible to allocate a new buffer.</doc>
<doc-deprecated xml:space="preserve">Use #SoupRequest if you want to read into your
own buffers.</doc-deprecated>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">the new buffer (or %NULL)</doc>
<type name="Buffer" c:type="SoupBuffer*"/>
</return-value>
<parameters>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the #SoupMessage the chunk is being allocated for</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="max_len" transfer-ownership="none">
<doc xml:space="preserve">the maximum length that will be read, or 0.</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" closure="2">
<doc xml:space="preserve">the data passed to soup_message_set_chunk_allocator()</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<record name="ClientContext"
c:type="SoupClientContext"
glib:type-name="SoupClientContext"
glib:get-type="soup_client_context_get_type"
c:symbol-prefix="client_context">
<doc xml:space="preserve">A #SoupClientContext provides additional information about the
client making a particular request. In particular, you can use
soup_client_context_get_auth_domain() and
soup_client_context_get_auth_user() to determine if HTTP
authentication was used successfully.
soup_client_context_get_remote_address() and/or
soup_client_context_get_host() can be used to get information for
logging or debugging purposes. soup_client_context_get_gsocket() may
also be of use in some situations (eg, tracking when multiple
requests are made on the same connection).</doc>
<method name="get_address"
c:identifier="soup_client_context_get_address"
deprecated="1">
<doc xml:space="preserve">Retrieves the #SoupAddress associated with the remote end
of a connection.</doc>
<doc-deprecated xml:space="preserve">Use soup_client_context_get_remote_address(), which returns
a #GSocketAddress.</doc-deprecated>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">the #SoupAddress
associated with the remote end of a connection, it may be
%NULL if you used soup_server_accept_iostream().</doc>
<type name="Address" c:type="SoupAddress*"/>
</return-value>
<parameters>
<instance-parameter name="client" transfer-ownership="none">
<doc xml:space="preserve">a #SoupClientContext</doc>
<type name="ClientContext" c:type="SoupClientContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_auth_domain"
c:identifier="soup_client_context_get_auth_domain">
<doc xml:space="preserve">Checks whether the request associated with @client has been
authenticated, and if so returns the #SoupAuthDomain that
authenticated it.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">a #SoupAuthDomain, or
%NULL if the request was not authenticated.</doc>
<type name="AuthDomain" c:type="SoupAuthDomain*"/>
</return-value>
<parameters>
<instance-parameter name="client" transfer-ownership="none">
<doc xml:space="preserve">a #SoupClientContext</doc>
<type name="ClientContext" c:type="SoupClientContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_auth_user"
c:identifier="soup_client_context_get_auth_user">
<doc xml:space="preserve">Checks whether the request associated with @client has been
authenticated, and if so returns the username that the client
authenticated as.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">the authenticated-as user, or %NULL if
the request was not authenticated.</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<instance-parameter name="client" transfer-ownership="none">
<doc xml:space="preserve">a #SoupClientContext</doc>
<type name="ClientContext" c:type="SoupClientContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_gsocket"
c:identifier="soup_client_context_get_gsocket"
version="2.48">
<doc xml:space="preserve">Retrieves the #GSocket that @client is associated with.
If you are using this method to observe when multiple requests are
made on the same persistent HTTP connection (eg, as the ntlm-test
test program does), you will need to pay attention to socket
destruction as well (eg, by using weak references), so that you do
not get fooled when the allocator reuses the memory address of a
previously-destroyed socket to represent a new socket.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">the #GSocket that @client is
associated with, %NULL if you used soup_server_accept_iostream().</doc>
<type name="Gio.Socket" c:type="GSocket*"/>
</return-value>
<parameters>
<instance-parameter name="client" transfer-ownership="none">
<doc xml:space="preserve">a #SoupClientContext</doc>
<type name="ClientContext" c:type="SoupClientContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_host" c:identifier="soup_client_context_get_host">
<doc xml:space="preserve">Retrieves the IP address associated with the remote end of a
connection.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">the IP address associated with the remote
end of a connection, it may be %NULL if you used
soup_server_accept_iostream().</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<instance-parameter name="client" transfer-ownership="none">
<doc xml:space="preserve">a #SoupClientContext</doc>
<type name="ClientContext" c:type="SoupClientContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_local_address"
c:identifier="soup_client_context_get_local_address"
version="2.48">
<doc xml:space="preserve">Retrieves the #GSocketAddress associated with the local end
of a connection.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">the #GSocketAddress
associated with the local end of a connection, it may be
%NULL if you used soup_server_accept_iostream().</doc>
<type name="Gio.SocketAddress" c:type="GSocketAddress*"/>
</return-value>
<parameters>
<instance-parameter name="client" transfer-ownership="none">
<doc xml:space="preserve">a #SoupClientContext</doc>
<type name="ClientContext" c:type="SoupClientContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_remote_address"
c:identifier="soup_client_context_get_remote_address"
version="2.48">
<doc xml:space="preserve">Retrieves the #GSocketAddress associated with the remote end
of a connection.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">the #GSocketAddress
associated with the remote end of a connection, it may be
%NULL if you used soup_server_accept_iostream().</doc>
<type name="Gio.SocketAddress" c:type="GSocketAddress*"/>
</return-value>
<parameters>
<instance-parameter name="client" transfer-ownership="none">
<doc xml:space="preserve">a #SoupClientContext</doc>
<type name="ClientContext" c:type="SoupClientContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_socket"
c:identifier="soup_client_context_get_socket"
deprecated="1">
<doc xml:space="preserve">Retrieves the #SoupSocket that @client is associated with.
If you are using this method to observe when multiple requests are
made on the same persistent HTTP connection (eg, as the ntlm-test
test program does), you will need to pay attention to socket
destruction as well (either by using weak references, or by
connecting to the #SoupSocket::disconnected signal), so that you do
not get fooled when the allocator reuses the memory address of a
previously-destroyed socket to represent a new socket.</doc>
<doc-deprecated xml:space="preserve">use soup_client_context_get_gsocket(), which returns
a #GSocket.</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the #SoupSocket that @client is
associated with.</doc>
<type name="Socket" c:type="SoupSocket*"/>
</return-value>
<parameters>
<instance-parameter name="client" transfer-ownership="none">
<doc xml:space="preserve">a #SoupClientContext</doc>
<type name="ClientContext" c:type="SoupClientContext*"/>
</instance-parameter>
</parameters>
</method>
<method name="steal_connection"
c:identifier="soup_client_context_steal_connection"
version="2.50">
<doc xml:space="preserve">"Steals" the HTTP connection associated with @client from its
#SoupServer. This happens immediately, regardless of the current
state of the connection; if the response to the current
#SoupMessage has not yet finished being sent, then it will be
discarded; you can steal the connection from a
#SoupMessage:wrote-informational or #SoupMessage:wrote-body signal
handler if you need to wait for part or all of the response to be
sent.
Note that when calling this function from C, @client will most
likely be freed as a side effect.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the #GIOStream formerly associated
with @client (or %NULL if @client was no longer associated with a
connection). No guarantees are made about what kind of #GIOStream
is returned.</doc>
<type name="Gio.IOStream" c:type="GIOStream*"/>
</return-value>
<parameters>
<instance-parameter name="client" transfer-ownership="none">
<doc xml:space="preserve">a #SoupClientContext</doc>
<type name="ClientContext" c:type="SoupClientContext*"/>
</instance-parameter>
</parameters>
</method>
</record>
<record name="Connection" c:type="SoupConnection" disguised="1">
</record>
<enumeration name="ConnectionState"
glib:type-name="SoupConnectionState"
glib:get-type="soup_connection_state_get_type"
c:type="SoupConnectionState">
<member name="new"
value="0"
c:identifier="SOUP_CONNECTION_NEW"
glib:nick="new">
</member>
<member name="connecting"
value="1"
c:identifier="SOUP_CONNECTION_CONNECTING"
glib:nick="connecting">
</member>
<member name="idle"
value="2"
c:identifier="SOUP_CONNECTION_IDLE"
glib:nick="idle">
</member>
<member name="in_use"
value="3"
c:identifier="SOUP_CONNECTION_IN_USE"
glib:nick="in-use">
</member>
<member name="remote_disconnected"
value="4"
c:identifier="SOUP_CONNECTION_REMOTE_DISCONNECTED"
glib:nick="remote-disconnected">
</member>
<member name="disconnected"
value="5"
c:identifier="SOUP_CONNECTION_DISCONNECTED"
glib:nick="disconnected">
</member>
</enumeration>
<class name="ContentDecoder"
c:symbol-prefix="content_decoder"
c:type="SoupContentDecoder"
parent="GObject.Object"
glib:type-name="SoupContentDecoder"
glib:get-type="soup_content_decoder_get_type"
glib:type-struct="ContentDecoderClass">
<implements name="SessionFeature"/>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
<field name="priv">
<type name="ContentDecoderPrivate"
c:type="SoupContentDecoderPrivate*"/>
</field>
</class>
<record name="ContentDecoderClass"
c:type="SoupContentDecoderClass"
glib:is-gtype-struct-for="ContentDecoder">
<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>
<field name="_libsoup_reserved5" introspectable="0">
<callback name="_libsoup_reserved5">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<record name="ContentDecoderPrivate"
c:type="SoupContentDecoderPrivate"
disguised="1">
</record>
<class name="ContentSniffer"
c:symbol-prefix="content_sniffer"
c:type="SoupContentSniffer"
parent="GObject.Object"
glib:type-name="SoupContentSniffer"
glib:get-type="soup_content_sniffer_get_type"
glib:type-struct="ContentSnifferClass">
<implements name="SessionFeature"/>
<constructor name="new"
c:identifier="soup_content_sniffer_new"
version="2.28">
<doc xml:space="preserve">Creates a new #SoupContentSniffer.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #SoupContentSniffer</doc>
<type name="ContentSniffer" c:type="SoupContentSniffer*"/>
</return-value>
</constructor>
<virtual-method name="get_buffer_size"
invoker="get_buffer_size"
version="2.28">
<doc xml:space="preserve">Gets the number of bytes @sniffer needs in order to properly sniff
a buffer.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the number of bytes to sniff</doc>
<type name="gsize" c:type="gsize"/>
</return-value>
<parameters>
<instance-parameter name="sniffer" transfer-ownership="none">
<doc xml:space="preserve">a #SoupContentSniffer</doc>
<type name="ContentSniffer" c:type="SoupContentSniffer*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="sniff" invoker="sniff" version="2.28">
<doc xml:space="preserve">Sniffs @buffer to determine its Content-Type. The result may also
be influenced by the Content-Type declared in @msg's response
headers.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the sniffed Content-Type of @buffer; this will never be %NULL,
but may be "application/octet-stream".</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<instance-parameter name="sniffer" transfer-ownership="none">
<doc xml:space="preserve">a #SoupContentSniffer</doc>
<type name="ContentSniffer" c:type="SoupContentSniffer*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the message to sniff</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">a buffer containing the start of @msg's response body</doc>
<type name="Buffer" c:type="SoupBuffer*"/>
</parameter>
<parameter name="params"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">return
location for Content-Type parameters (eg, "charset"), or %NULL</doc>
<type name="GLib.HashTable" c:type="GHashTable**">
<type name="utf8"/>
<type name="utf8"/>
</type>
</parameter>
</parameters>
</virtual-method>
<method name="get_buffer_size"
c:identifier="soup_content_sniffer_get_buffer_size"
version="2.28">
<doc xml:space="preserve">Gets the number of bytes @sniffer needs in order to properly sniff
a buffer.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the number of bytes to sniff</doc>
<type name="gsize" c:type="gsize"/>
</return-value>
<parameters>
<instance-parameter name="sniffer" transfer-ownership="none">
<doc xml:space="preserve">a #SoupContentSniffer</doc>
<type name="ContentSniffer" c:type="SoupContentSniffer*"/>
</instance-parameter>
</parameters>
</method>
<method name="sniff"
c:identifier="soup_content_sniffer_sniff"
version="2.28">
<doc xml:space="preserve">Sniffs @buffer to determine its Content-Type. The result may also
be influenced by the Content-Type declared in @msg's response
headers.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the sniffed Content-Type of @buffer; this will never be %NULL,
but may be "application/octet-stream".</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<instance-parameter name="sniffer" transfer-ownership="none">
<doc xml:space="preserve">a #SoupContentSniffer</doc>
<type name="ContentSniffer" c:type="SoupContentSniffer*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the message to sniff</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">a buffer containing the start of @msg's response body</doc>
<type name="Buffer" c:type="SoupBuffer*"/>
</parameter>
<parameter name="params"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">return
location for Content-Type parameters (eg, "charset"), or %NULL</doc>
<type name="GLib.HashTable" c:type="GHashTable**">
<type name="utf8"/>
<type name="utf8"/>
</type>
</parameter>
</parameters>
</method>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
<field name="priv">
<type name="ContentSnifferPrivate"
c:type="SoupContentSnifferPrivate*"/>
</field>
</class>
<record name="ContentSnifferClass"
c:type="SoupContentSnifferClass"
glib:is-gtype-struct-for="ContentSniffer">
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="sniff">
<callback name="sniff">
<return-value transfer-ownership="full">
<doc xml:space="preserve">the sniffed Content-Type of @buffer; this will never be %NULL,
but may be "application/octet-stream".</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<parameter name="sniffer" transfer-ownership="none">
<doc xml:space="preserve">a #SoupContentSniffer</doc>
<type name="ContentSniffer" c:type="SoupContentSniffer*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the message to sniff</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">a buffer containing the start of @msg's response body</doc>
<type name="Buffer" c:type="SoupBuffer*"/>
</parameter>
<parameter name="params"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">return
location for Content-Type parameters (eg, "charset"), or %NULL</doc>
<type name="GLib.HashTable" c:type="GHashTable**">
<type name="utf8"/>
<type name="utf8"/>
</type>
</parameter>
</parameters>
</callback>
</field>
<field name="get_buffer_size">
<callback name="get_buffer_size">
<return-value transfer-ownership="none">
<doc xml:space="preserve">the number of bytes to sniff</doc>
<type name="gsize" c:type="gsize"/>
</return-value>
<parameters>
<parameter name="sniffer" transfer-ownership="none">
<doc xml:space="preserve">a #SoupContentSniffer</doc>
<type name="ContentSniffer" c:type="SoupContentSniffer*"/>
</parameter>
</parameters>
</callback>
</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>
<field name="_libsoup_reserved5" introspectable="0">
<callback name="_libsoup_reserved5">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</callback>
</field>
</record>
<record name="ContentSnifferPrivate"
c:type="SoupContentSnifferPrivate"
disguised="1">
</record>
<record name="Cookie"
c:type="SoupCookie"
version="2.24"
glib:type-name="SoupCookie"
glib:get-type="soup_cookie_get_type"
c:symbol-prefix="cookie">
<doc xml:space="preserve">An HTTP cookie.
@name and @value will be set for all cookies. If the cookie is
generated from a string that appears to have no name, then @name
will be the empty string.
@domain and @path give the host or domain, and path within that
host/domain, to restrict this cookie to. If @domain starts with
".", that indicates a domain (which matches the string after the
".", or any hostname that has @domain as a suffix). Otherwise, it
is a hostname and must match exactly.
@expires will be non-%NULL if the cookie uses either the original
"expires" attribute, or the newer "max-age" attribute. If @expires
is %NULL, it indicates that neither "expires" nor "max-age" was
specified, and the cookie expires at the end of the session.
If @http_only is set, the cookie should not be exposed to untrusted
code (eg, javascript), so as to minimize the danger posed by
cross-site scripting attacks.</doc>
<field name="name" writable="1">
<doc xml:space="preserve">the cookie name</doc>
<type name="utf8" c:type="char*"/>
</field>
<field name="value" writable="1">
<doc xml:space="preserve">the cookie value</doc>
<type name="utf8" c:type="char*"/>
</field>
<field name="domain" writable="1">
<doc xml:space="preserve">the "domain" attribute, or else the hostname that the
cookie came from.</doc>
<type name="utf8" c:type="char*"/>
</field>
<field name="path" writable="1">
<doc xml:space="preserve">the "path" attribute, or %NULL</doc>
<type name="utf8" c:type="char*"/>
</field>
<field name="expires" writable="1">
<doc xml:space="preserve">the cookie expiration time, or %NULL for a session cookie</doc>
<type name="Date" c:type="SoupDate*"/>
</field>
<field name="secure" writable="1">
<doc xml:space="preserve">%TRUE if the cookie should only be tranferred over SSL</doc>
<type name="gboolean" c:type="gboolean"/>
</field>
<field name="http_only" writable="1">
<doc xml:space="preserve">%TRUE if the cookie should not be exposed to scripts</doc>
<type name="gboolean" c:type="gboolean"/>
</field>
<constructor name="new" c:identifier="soup_cookie_new" version="2.24">
<doc xml:space="preserve">Creates a new #SoupCookie with the given attributes. (Use
soup_cookie_set_secure() and soup_cookie_set_http_only() if you
need to set those attributes on the returned cookie.)
If @domain starts with ".", that indicates a domain (which matches
the string after the ".", or any hostname that has @domain as a
suffix). Otherwise, it is a hostname and must match exactly.
@max_age is used to set the "expires" attribute on the cookie; pass
-1 to not include the attribute (indicating that the cookie expires
with the current session), 0 for an already-expired cookie, or a
lifetime in seconds. You can use the constants
%SOUP_COOKIE_MAX_AGE_ONE_HOUR, %SOUP_COOKIE_MAX_AGE_ONE_DAY,
%SOUP_COOKIE_MAX_AGE_ONE_WEEK and %SOUP_COOKIE_MAX_AGE_ONE_YEAR (or
multiples thereof) to calculate this value. (If you really care
about setting the exact time that the cookie will expire, use
soup_cookie_set_expires().)</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #SoupCookie.</doc>
<type name="Cookie" c:type="SoupCookie*"/>
</return-value>
<parameters>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">cookie name</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">cookie value</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="domain" transfer-ownership="none">
<doc xml:space="preserve">cookie domain or hostname</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="path" transfer-ownership="none">
<doc xml:space="preserve">cookie path, or %NULL</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="max_age" transfer-ownership="none">
<doc xml:space="preserve">max age of the cookie, or -1 for a session cookie</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</constructor>
<method name="applies_to_uri"
c:identifier="soup_cookie_applies_to_uri"
version="2.24">
<doc xml:space="preserve">Tests if @cookie should be sent to @uri.
(At the moment, this does not check that @cookie's domain matches
@uri, because it assumes that the caller has already done that.
But don't rely on that; it may change in the future.)</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @cookie should be sent to @uri, %FALSE if
not</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="cookie" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookie</doc>
<type name="Cookie" c:type="SoupCookie*"/>
</instance-parameter>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI</doc>
<type name="URI" c:type="SoupURI*"/>
</parameter>
</parameters>
</method>
<method name="copy" c:identifier="soup_cookie_copy" version="2.24">
<doc xml:space="preserve">Copies @cookie.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a copy of @cookie</doc>
<type name="Cookie" c:type="SoupCookie*"/>
</return-value>
<parameters>
<instance-parameter name="cookie" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookie</doc>
<type name="Cookie" c:type="SoupCookie*"/>
</instance-parameter>
</parameters>
</method>
<method name="domain_matches"
c:identifier="soup_cookie_domain_matches"
version="2.30">
<doc xml:space="preserve">Checks if the @cookie's domain and @host match in the sense that
@cookie should be sent when making a request to @host, or that
@cookie should be accepted when receiving a response from @host.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the domains match, %FALSE otherwise</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="cookie" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookie</doc>
<type name="Cookie" c:type="SoupCookie*"/>
</instance-parameter>
<parameter name="host" transfer-ownership="none">
<doc xml:space="preserve">a URI</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="equal" c:identifier="soup_cookie_equal" version="2.24">
<doc xml:space="preserve">Tests if @cookie1 and @cookie2 are equal.
Note that currently, this does not check that the cookie domains
match. This may change in the future.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">whether the cookies are equal.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="cookie1" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookie</doc>
<type name="Cookie" c:type="SoupCookie*"/>
</instance-parameter>
<parameter name="cookie2" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookie</doc>
<type name="Cookie" c:type="SoupCookie*"/>
</parameter>
</parameters>
</method>
<method name="free" c:identifier="soup_cookie_free" version="2.24">
<doc xml:space="preserve">Frees @cookie</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cookie" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookie</doc>
<type name="Cookie" c:type="SoupCookie*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_domain"
c:identifier="soup_cookie_get_domain"
version="2.32">
<doc xml:space="preserve">Gets @cookie's domain</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">@cookie's domain</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<instance-parameter name="cookie" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookie</doc>
<type name="Cookie" c:type="SoupCookie*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_expires"
c:identifier="soup_cookie_get_expires"
version="2.32">
<doc xml:space="preserve">Gets @cookie's expiration time</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">@cookie's expiration time, which is
owned by @cookie and should not be modified or freed.</doc>
<type name="Date" c:type="SoupDate*"/>
</return-value>
<parameters>
<instance-parameter name="cookie" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookie</doc>
<type name="Cookie" c:type="SoupCookie*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_http_only"
c:identifier="soup_cookie_get_http_only"
version="2.32">
<doc xml:space="preserve">Gets @cookie's HttpOnly attribute</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">@cookie's HttpOnly attribute</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="cookie" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookie</doc>
<type name="Cookie" c:type="SoupCookie*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_name"
c:identifier="soup_cookie_get_name"
version="2.32">
<doc xml:space="preserve">Gets @cookie's name</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">@cookie's name</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<instance-parameter name="cookie" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookie</doc>
<type name="Cookie" c:type="SoupCookie*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_path"
c:identifier="soup_cookie_get_path"
version="2.32">
<doc xml:space="preserve">Gets @cookie's path</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">@cookie's path</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<instance-parameter name="cookie" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookie</doc>
<type name="Cookie" c:type="SoupCookie*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_secure"
c:identifier="soup_cookie_get_secure"
version="2.32">
<doc xml:space="preserve">Gets @cookie's secure attribute</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">@cookie's secure attribute</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="cookie" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookie</doc>
<type name="Cookie" c:type="SoupCookie*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_value"
c:identifier="soup_cookie_get_value"
version="2.32">
<doc xml:space="preserve">Gets @cookie's value</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">@cookie's value</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<instance-parameter name="cookie" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookie</doc>
<type name="Cookie" c:type="SoupCookie*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_domain"
c:identifier="soup_cookie_set_domain"
version="2.24">
<doc xml:space="preserve">Sets @cookie's domain to @domain</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cookie" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookie</doc>
<type name="Cookie" c:type="SoupCookie*"/>
</instance-parameter>
<parameter name="domain" transfer-ownership="none">
<doc xml:space="preserve">the new domain</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="set_expires"
c:identifier="soup_cookie_set_expires"
version="2.24">
<doc xml:space="preserve">Sets @cookie's expiration time to @expires. If @expires is %NULL,
@cookie will be a session cookie and will expire at the end of the
client's session.
(This sets the same property as soup_cookie_set_max_age().)</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cookie" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookie</doc>
<type name="Cookie" c:type="SoupCookie*"/>
</instance-parameter>
<parameter name="expires" transfer-ownership="none">
<doc xml:space="preserve">the new expiration time, or %NULL</doc>
<type name="Date" c:type="SoupDate*"/>
</parameter>
</parameters>
</method>
<method name="set_http_only"
c:identifier="soup_cookie_set_http_only"
version="2.24">
<doc xml:space="preserve">Sets @cookie's HttpOnly attribute to @http_only. If %TRUE, @cookie
will be marked as "http only", meaning it should not be exposed to
web page scripts or other untrusted code.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cookie" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookie</doc>
<type name="Cookie" c:type="SoupCookie*"/>
</instance-parameter>
<parameter name="http_only" transfer-ownership="none">
<doc xml:space="preserve">the new value for the HttpOnly attribute</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_max_age"
c:identifier="soup_cookie_set_max_age"
version="2.24">
<doc xml:space="preserve">Sets @cookie's max age to @max_age. If @max_age is -1, the cookie
is a session cookie, and will expire at the end of the client's
session. Otherwise, it is the number of seconds until the cookie
expires. You can use the constants %SOUP_COOKIE_MAX_AGE_ONE_HOUR,
%SOUP_COOKIE_MAX_AGE_ONE_DAY, %SOUP_COOKIE_MAX_AGE_ONE_WEEK and
%SOUP_COOKIE_MAX_AGE_ONE_YEAR (or multiples thereof) to calculate
this value. (A value of 0 indicates that the cookie should be
considered already-expired.)
(This sets the same property as soup_cookie_set_expires().)</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cookie" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookie</doc>
<type name="Cookie" c:type="SoupCookie*"/>
</instance-parameter>
<parameter name="max_age" transfer-ownership="none">
<doc xml:space="preserve">the new max age</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</method>
<method name="set_name"
c:identifier="soup_cookie_set_name"
version="2.24">
<doc xml:space="preserve">Sets @cookie's name to @name</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cookie" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookie</doc>
<type name="Cookie" c:type="SoupCookie*"/>
</instance-parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">the new name</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="set_path"
c:identifier="soup_cookie_set_path"
version="2.24">
<doc xml:space="preserve">Sets @cookie's path to @path</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cookie" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookie</doc>
<type name="Cookie" c:type="SoupCookie*"/>
</instance-parameter>
<parameter name="path" transfer-ownership="none">
<doc xml:space="preserve">the new path</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="set_secure"
c:identifier="soup_cookie_set_secure"
version="2.24">
<doc xml:space="preserve">Sets @cookie's secure attribute to @secure. If %TRUE, @cookie will
only be transmitted from the client to the server over secure
(https) connections.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cookie" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookie</doc>
<type name="Cookie" c:type="SoupCookie*"/>
</instance-parameter>
<parameter name="secure" transfer-ownership="none">
<doc xml:space="preserve">the new value for the secure attribute</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="set_value"
c:identifier="soup_cookie_set_value"
version="2.24">
<doc xml:space="preserve">Sets @cookie's value to @value</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cookie" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookie</doc>
<type name="Cookie" c:type="SoupCookie*"/>
</instance-parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">the new value</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="to_cookie_header"
c:identifier="soup_cookie_to_cookie_header"
version="2.24">
<doc xml:space="preserve">Serializes @cookie in the format used by the Cookie header (ie, for
returning a cookie from a #SoupSession to a server).</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the header</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<instance-parameter name="cookie" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookie</doc>
<type name="Cookie" c:type="SoupCookie*"/>
</instance-parameter>
</parameters>
</method>
<method name="to_set_cookie_header"
c:identifier="soup_cookie_to_set_cookie_header"
version="2.24">
<doc xml:space="preserve">Serializes @cookie in the format used by the Set-Cookie header
(ie, for sending a cookie from a #SoupServer to a client).</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the header</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<instance-parameter name="cookie" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookie</doc>
<type name="Cookie" c:type="SoupCookie*"/>
</instance-parameter>
</parameters>
</method>
<function name="parse" c:identifier="soup_cookie_parse" version="2.24">
<doc xml:space="preserve">Parses @header and returns a #SoupCookie. (If @header contains
multiple cookies, only the first one will be parsed.)
If @header does not have "path" or "domain" attributes, they will
be defaulted from @origin. If @origin is %NULL, path will default
to "/", but domain will be left as %NULL. Note that this is not a
valid state for a #SoupCookie, and you will need to fill in some
appropriate string for the domain if you want to actually make use
of the cookie.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">a new #SoupCookie, or %NULL if it could
not be parsed, or contained an illegal "domain" attribute for a
cookie originating from @origin.</doc>
<type name="Cookie" c:type="SoupCookie*"/>
</return-value>
<parameters>
<parameter name="header" transfer-ownership="none">
<doc xml:space="preserve">a cookie string (eg, the value of a Set-Cookie header)</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="origin" transfer-ownership="none">
<doc xml:space="preserve">origin of the cookie, or %NULL</doc>
<type name="URI" c:type="SoupURI*"/>
</parameter>
</parameters>
</function>
</record>
<class name="CookieJar"
c:symbol-prefix="cookie_jar"
c:type="SoupCookieJar"
parent="GObject.Object"
glib:type-name="SoupCookieJar"
glib:get-type="soup_cookie_jar_get_type"
glib:type-struct="CookieJarClass">
<implements name="SessionFeature"/>
<constructor name="new"
c:identifier="soup_cookie_jar_new"
version="2.24">
<doc xml:space="preserve">Creates a new #SoupCookieJar. The base #SoupCookieJar class does
not support persistent storage of cookies; use a subclass for that.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #SoupCookieJar</doc>
<type name="CookieJar" c:type="SoupCookieJar*"/>
</return-value>
</constructor>
<virtual-method name="changed">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="jar" transfer-ownership="none">
<type name="CookieJar" c:type="SoupCookieJar*"/>
</instance-parameter>
<parameter name="old_cookie" transfer-ownership="none">
<type name="Cookie" c:type="SoupCookie*"/>
</parameter>
<parameter name="new_cookie" transfer-ownership="none">
<type name="Cookie" c:type="SoupCookie*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="is_persistent"
invoker="is_persistent"
version="2.40">
<doc xml:space="preserve">Gets whether @jar stores cookies persistenly.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @jar storage is persistent or %FALSE otherwise.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="jar" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookieJar</doc>
<type name="CookieJar" c:type="SoupCookieJar*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="save" invoker="save" version="2.24" deprecated="1">
<doc xml:space="preserve">This function exists for backward compatibility, but does not do
anything any more; cookie jars are saved automatically when they
are changed.</doc>
<doc-deprecated xml:space="preserve">This is a no-op.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="jar" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookieJar</doc>
<type name="CookieJar" c:type="SoupCookieJar*"/>
</instance-parameter>
</parameters>
</virtual-method>
<method name="add_cookie"
c:identifier="soup_cookie_jar_add_cookie"
version="2.26">
<doc xml:space="preserve">Adds @cookie to @jar, emitting the 'changed' signal if we are modifying
an existing cookie or adding a valid new cookie ('valid' means
that the cookie's expire date is not in the past).
@cookie will be 'stolen' by the jar, so don't free it afterwards.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="jar" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookieJar</doc>
<type name="CookieJar" c:type="SoupCookieJar*"/>
</instance-parameter>
<parameter name="cookie" transfer-ownership="full">
<doc xml:space="preserve">a #SoupCookie</doc>
<type name="Cookie" c:type="SoupCookie*"/>
</parameter>
</parameters>
</method>
<method name="add_cookie_with_first_party"
c:identifier="soup_cookie_jar_add_cookie_with_first_party"
version="2.40">
<doc xml:space="preserve">Adds @cookie to @jar, emitting the 'changed' signal if we are modifying
an existing cookie or adding a valid new cookie ('valid' means
that the cookie's expire date is not in the past).
@first_party will be used to reject cookies coming from third party
resources in case such a security policy is set in the @jar.
@cookie will be 'stolen' by the jar, so don't free it afterwards.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="jar" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookieJar</doc>
<type name="CookieJar" c:type="SoupCookieJar*"/>
</instance-parameter>
<parameter name="first_party" transfer-ownership="none">
<doc xml:space="preserve">the URI for the main document</doc>
<type name="URI" c:type="SoupURI*"/>
</parameter>
<parameter name="cookie" transfer-ownership="full">
<doc xml:space="preserve">a #SoupCookie</doc>
<type name="Cookie" c:type="SoupCookie*"/>
</parameter>
</parameters>
</method>
<method name="all_cookies"
c:identifier="soup_cookie_jar_all_cookies"
version="2.26">
<doc xml:space="preserve">Constructs a #GSList with every cookie inside the @jar.
The cookies in the list are a copy of the original, so
you have to free them when you are done with them.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GSList
with all the cookies in the @jar.</doc>
<type name="GLib.SList" c:type="GSList*">
<type name="Cookie"/>
</type>
</return-value>
<parameters>
<instance-parameter name="jar" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookieJar</doc>
<type name="CookieJar" c:type="SoupCookieJar*"/>
</instance-parameter>
</parameters>
</method>
<method name="delete_cookie"
c:identifier="soup_cookie_jar_delete_cookie"
version="2.26">
<doc xml:space="preserve">Deletes @cookie from @jar, emitting the 'changed' signal.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="jar" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookieJar</doc>
<type name="CookieJar" c:type="SoupCookieJar*"/>
</instance-parameter>
<parameter name="cookie" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookie</doc>
<type name="Cookie" c:type="SoupCookie*"/>
</parameter>
</parameters>
</method>
<method name="get_accept_policy"
c:identifier="soup_cookie_jar_get_accept_policy"
version="2.30">
<doc xml:space="preserve">Gets @jar's #SoupCookieJarAcceptPolicy</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the #SoupCookieJarAcceptPolicy set in the @jar</doc>
<type name="CookieJarAcceptPolicy"
c:type="SoupCookieJarAcceptPolicy"/>
</return-value>
<parameters>
<instance-parameter name="jar" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookieJar</doc>
<type name="CookieJar" c:type="SoupCookieJar*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_cookie_list"
c:identifier="soup_cookie_jar_get_cookie_list"
version="2.40">
<doc xml:space="preserve">Retrieves the list of cookies that would be sent with a request to @uri
as a #GSList of #SoupCookie objects.
If @for_http is %TRUE, the return value will include cookies marked
"HttpOnly" (that is, cookies that the server wishes to keep hidden
from client-side scripting operations such as the JavaScript
document.cookies property). Since #SoupCookieJar sets the Cookie
header itself when making the actual HTTP request, you should
almost certainly be setting @for_http to %FALSE if you are calling
this.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GSList
with the cookies in the @jar that would be sent with a request to @uri.</doc>
<type name="GLib.SList" c:type="GSList*">
<type name="Cookie"/>
</type>
</return-value>
<parameters>
<instance-parameter name="jar" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookieJar</doc>
<type name="CookieJar" c:type="SoupCookieJar*"/>
</instance-parameter>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI</doc>
<type name="URI" c:type="SoupURI*"/>
</parameter>
<parameter name="for_http" transfer-ownership="none">
<doc xml:space="preserve">whether or not the return value is being passed directly
to an HTTP operation</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="get_cookies"
c:identifier="soup_cookie_jar_get_cookies"
version="2.24">
<doc xml:space="preserve">Retrieves (in Cookie-header form) the list of cookies that would
be sent with a request to @uri.
If @for_http is %TRUE, the return value will include cookies marked
"HttpOnly" (that is, cookies that the server wishes to keep hidden
from client-side scripting operations such as the JavaScript
document.cookies property). Since #SoupCookieJar sets the Cookie
header itself when making the actual HTTP request, you should
almost certainly be setting @for_http to %FALSE if you are calling
this.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">the cookies, in string form, or %NULL if
there are no cookies for @uri.</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<instance-parameter name="jar" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookieJar</doc>
<type name="CookieJar" c:type="SoupCookieJar*"/>
</instance-parameter>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI</doc>
<type name="URI" c:type="SoupURI*"/>
</parameter>
<parameter name="for_http" transfer-ownership="none">
<doc xml:space="preserve">whether or not the return value is being passed directly
to an HTTP operation</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="is_persistent"
c:identifier="soup_cookie_jar_is_persistent"
version="2.40">
<doc xml:space="preserve">Gets whether @jar stores cookies persistenly.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @jar storage is persistent or %FALSE otherwise.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="jar" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookieJar</doc>
<type name="CookieJar" c:type="SoupCookieJar*"/>
</instance-parameter>
</parameters>
</method>
<method name="save"
c:identifier="soup_cookie_jar_save"
version="2.24"
deprecated="1">
<doc xml:space="preserve">This function exists for backward compatibility, but does not do
anything any more; cookie jars are saved automatically when they
are changed.</doc>
<doc-deprecated xml:space="preserve">This is a no-op.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="jar" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookieJar</doc>
<type name="CookieJar" c:type="SoupCookieJar*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_accept_policy"
c:identifier="soup_cookie_jar_set_accept_policy"
version="2.30">
<doc xml:space="preserve">Sets @policy as the cookie acceptance policy for @jar.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="jar" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookieJar</doc>
<type name="CookieJar" c:type="SoupCookieJar*"/>
</instance-parameter>
<parameter name="policy" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookieJarAcceptPolicy</doc>
<type name="CookieJarAcceptPolicy"
c:type="SoupCookieJarAcceptPolicy"/>
</parameter>
</parameters>
</method>
<method name="set_cookie"
c:identifier="soup_cookie_jar_set_cookie"
version="2.24">
<doc xml:space="preserve">Adds @cookie to @jar, exactly as though it had appeared in a
Set-Cookie header returned from a request to @uri.
Keep in mind that if the #SoupCookieJarAcceptPolicy
%SOUP_COOKIE_JAR_ACCEPT_NO_THIRD_PARTY is set you'll need to use
soup_cookie_jar_set_cookie_with_first_party(), otherwise the jar
will have no way of knowing if the cookie is being set by a third
party or not.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="jar" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookieJar</doc>
<type name="CookieJar" c:type="SoupCookieJar*"/>
</instance-parameter>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">the URI setting the cookie</doc>
<type name="URI" c:type="SoupURI*"/>
</parameter>
<parameter name="cookie" transfer-ownership="none">
<doc xml:space="preserve">the stringified cookie to set</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="set_cookie_with_first_party"
c:identifier="soup_cookie_jar_set_cookie_with_first_party"
version="2.30">
<doc xml:space="preserve">Adds @cookie to @jar, exactly as though it had appeared in a
Set-Cookie header returned from a request to @uri. @first_party
will be used to reject cookies coming from third party resources in
case such a security policy is set in the @jar.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="jar" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookieJar</doc>
<type name="CookieJar" c:type="SoupCookieJar*"/>
</instance-parameter>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">the URI setting the cookie</doc>
<type name="URI" c:type="SoupURI*"/>
</parameter>
<parameter name="first_party" transfer-ownership="none">
<doc xml:space="preserve">the URI for the main document</doc>
<type name="URI" c:type="SoupURI*"/>
</parameter>
<parameter name="cookie" transfer-ownership="none">
<doc xml:space="preserve">the stringified cookie to set</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<property name="accept-policy"
version="2.30"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve">The policy the jar should follow to accept or reject cookies</doc>
<type name="CookieJarAcceptPolicy"/>
</property>
<property name="read-only"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
<glib:signal name="changed" when="first">
<doc xml:space="preserve">Emitted when @jar changes. If a cookie has been added,
@new_cookie will contain the newly-added cookie and
@old_cookie will be %NULL. If a cookie has been deleted,
@old_cookie will contain the to-be-deleted cookie and
@new_cookie will be %NULL. If a cookie has been changed,
@old_cookie will contain its old value, and @new_cookie its
new value.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="old_cookie" transfer-ownership="none">
<doc xml:space="preserve">the old #SoupCookie value</doc>
<type name="Cookie"/>
</parameter>
<parameter name="new_cookie" transfer-ownership="none">
<doc xml:space="preserve">the new #SoupCookie value</doc>
<type name="Cookie"/>
</parameter>
</parameters>
</glib:signal>
</class>
<enumeration name="CookieJarAcceptPolicy"
version="2.30"
glib:type-name="SoupCookieJarAcceptPolicy"
glib:get-type="soup_cookie_jar_accept_policy_get_type"
c:type="SoupCookieJarAcceptPolicy">
<doc xml:space="preserve">The policy for accepting or rejecting cookies returned in
responses.</doc>
<member name="always"
value="0"
c:identifier="SOUP_COOKIE_JAR_ACCEPT_ALWAYS"
glib:nick="always">
<doc xml:space="preserve">accept all cookies unconditionally.</doc>
</member>
<member name="never"
value="1"
c:identifier="SOUP_COOKIE_JAR_ACCEPT_NEVER"
glib:nick="never">
<doc xml:space="preserve">reject all cookies unconditionally.</doc>
</member>
<member name="no_third_party"
value="2"
c:identifier="SOUP_COOKIE_JAR_ACCEPT_NO_THIRD_PARTY"
glib:nick="no-third-party">
<doc xml:space="preserve">accept all cookies set by
the main document loaded in the application using libsoup. An
example of the most common case, web browsers, would be: If
http://www.example.com is the page loaded, accept all cookies set
by example.com, but if a resource from http://www.third-party.com
is loaded from that page reject any cookie that it could try to
set. For libsoup to be able to tell apart first party cookies from
the rest, the application must call soup_message_set_first_party()
on each outgoing #SoupMessage, setting the #SoupURI of the main
document. If no first party is set in a message when this policy is
in effect, cookies will be assumed to be third party by default.</doc>
</member>
</enumeration>
<record name="CookieJarClass"
c:type="SoupCookieJarClass"
glib:is-gtype-struct-for="CookieJar">
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="save">
<callback name="save">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="jar" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookieJar</doc>
<type name="CookieJar" c:type="SoupCookieJar*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="is_persistent">
<callback name="is_persistent">
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @jar storage is persistent or %FALSE otherwise.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="jar" transfer-ownership="none">
<doc xml:space="preserve">a #SoupCookieJar</doc>
<type name="CookieJar" c:type="SoupCookieJar*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="changed">
<callback name="changed">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="jar" transfer-ownership="none">
<type name="CookieJar" c:type="SoupCookieJar*"/>
</parameter>
<parameter name="old_cookie" transfer-ownership="none">
<type name="Cookie" c:type="SoupCookie*"/>
</parameter>
<parameter name="new_cookie" transfer-ownership="none">
<type name="Cookie" c:type="SoupCookie*"/>
</parameter>
</parameters>
</callback>
</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>
</record>
<class name="CookieJarDB"
c:symbol-prefix="cookie_jar_db"
c:type="SoupCookieJarDB"
parent="CookieJar"
glib:type-name="SoupCookieJarDB"
glib:get-type="soup_cookie_jar_db_get_type"
glib:type-struct="CookieJarDBClass">
<implements name="SessionFeature"/>
<constructor name="new"
c:identifier="soup_cookie_jar_db_new"
version="2.42">
<doc xml:space="preserve">Creates a #SoupCookieJarDB.
@filename will be read in at startup to create an initial set of
cookies. If @read_only is %FALSE, then the non-session cookies will
be written to @filename when the 'changed' signal is emitted from
the jar. (If @read_only is %TRUE, then the cookie jar will only be
used for this session, and changes made to it will be lost when the
jar is destroyed.)</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the new #SoupCookieJar</doc>
<type name="CookieJar" c:type="SoupCookieJar*"/>
</return-value>
<parameters>
<parameter name="filename" transfer-ownership="none">
<doc xml:space="preserve">the filename to read to/write from, or %NULL</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="read_only" transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @filename is read-only</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</constructor>
<property name="filename"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<field name="parent">
<type name="CookieJar" c:type="SoupCookieJar"/>
</field>
</class>
<record name="CookieJarDBClass"
c:type="SoupCookieJarDBClass"
glib:is-gtype-struct-for="CookieJarDB">
<field name="parent_class">
<type name="CookieJarClass" c:type="SoupCookieJarClass"/>
</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>
<class name="CookieJarText"
c:symbol-prefix="cookie_jar_text"
c:type="SoupCookieJarText"
parent="CookieJar"
glib:type-name="SoupCookieJarText"
glib:get-type="soup_cookie_jar_text_get_type"
glib:type-struct="CookieJarTextClass">
<implements name="SessionFeature"/>
<constructor name="new"
c:identifier="soup_cookie_jar_text_new"
version="2.26">
<doc xml:space="preserve">Creates a #SoupCookieJarText.
@filename will be read in at startup to create an initial set of
cookies. If @read_only is %FALSE, then the non-session cookies will
be written to @filename when the 'changed' signal is emitted from
the jar. (If @read_only is %TRUE, then the cookie jar will only be
used for this session, and changes made to it will be lost when the
jar is destroyed.)</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the new #SoupCookieJar</doc>
<type name="CookieJar" c:type="SoupCookieJar*"/>
</return-value>
<parameters>
<parameter name="filename" transfer-ownership="none">
<doc xml:space="preserve">the filename to read to/write from</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="read_only" transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @filename is read-only</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</constructor>
<property name="filename"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<field name="parent">
<type name="CookieJar" c:type="SoupCookieJar"/>
</field>
</class>
<record name="CookieJarTextClass"
c:type="SoupCookieJarTextClass"
glib:is-gtype-struct-for="CookieJarText">
<field name="parent_class">
<type name="CookieJarClass" c:type="SoupCookieJarClass"/>
</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>
<constant name="DATE_H" value="1" c:type="SOUP_DATE_H">
<type name="gint" c:type="gint"/>
</constant>
<record name="Date"
c:type="SoupDate"
glib:type-name="SoupDate"
glib:get-type="soup_date_get_type"
c:symbol-prefix="date">
<doc xml:space="preserve">A date and time. The date is assumed to be in the (proleptic)
Gregorian calendar. The time is in UTC if @utc is %TRUE. Otherwise,
the time is a local time, and @offset gives the offset from UTC in
minutes (such that adding @offset to the time would give the
correct UTC time). If @utc is %FALSE and @offset is 0, then the
%SoupDate represents a "floating" time with no associated timezone
information.</doc>
<field name="year" writable="1">
<doc xml:space="preserve">the year, 1 to 9999</doc>
<type name="gint" c:type="int"/>
</field>
<field name="month" writable="1">
<doc xml:space="preserve">the month, 1 to 12</doc>
<type name="gint" c:type="int"/>
</field>
<field name="day" writable="1">
<doc xml:space="preserve">day of the month, 1 to 31</doc>
<type name="gint" c:type="int"/>
</field>
<field name="hour" writable="1">
<doc xml:space="preserve">hour of the day, 0 to 23</doc>
<type name="gint" c:type="int"/>
</field>
<field name="minute" writable="1">
<doc xml:space="preserve">minute, 0 to 59</doc>
<type name="gint" c:type="int"/>
</field>
<field name="second" writable="1">
<doc xml:space="preserve">second, 0 to 59 (or up to 61 in the case of leap seconds)</doc>
<type name="gint" c:type="int"/>
</field>
<field name="utc" writable="1">
<doc xml:space="preserve">%TRUE if the date is in UTC</doc>
<type name="gboolean" c:type="gboolean"/>
</field>
<field name="offset" writable="1">
<doc xml:space="preserve">offset from UTC</doc>
<type name="gint" c:type="int"/>
</field>
<constructor name="new" c:identifier="soup_date_new">
<doc xml:space="preserve">Creates a #SoupDate representing the indicated time, UTC.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #SoupDate</doc>
<type name="Date" c:type="SoupDate*"/>
</return-value>
<parameters>
<parameter name="year" transfer-ownership="none">
<doc xml:space="preserve">the year (1-9999)</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="month" transfer-ownership="none">
<doc xml:space="preserve">the month (1-12)</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="day" transfer-ownership="none">
<doc xml:space="preserve">the day of the month (1-31, as appropriate for @month)</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="hour" transfer-ownership="none">
<doc xml:space="preserve">the hour (0-23)</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="minute" transfer-ownership="none">
<doc xml:space="preserve">the minute (0-59)</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="second" transfer-ownership="none">
<doc xml:space="preserve">the second (0-59, or up to 61 for leap seconds)</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_from_now" c:identifier="soup_date_new_from_now">
<doc xml:space="preserve">Creates a #SoupDate representing a time @offset_seconds after the
current time (or before it, if @offset_seconds is negative). If
offset_seconds is 0, returns the current time.
If @offset_seconds would indicate a time not expressible as a
<type>time_t</type>, the return value will be clamped into range.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #SoupDate</doc>
<type name="Date" c:type="SoupDate*"/>
</return-value>
<parameters>
<parameter name="offset_seconds" transfer-ownership="none">
<doc xml:space="preserve">offset from current time</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_from_string"
c:identifier="soup_date_new_from_string">
<doc xml:space="preserve">Parses @date_string and tries to extract a date from it. This
recognizes all of the "HTTP-date" formats from RFC 2616, all ISO
8601 formats containing both a time and a date, RFC 2822 dates,
and reasonable approximations thereof. (Eg, it is lenient about
whitespace, leading "0"s, etc.)</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">a new #SoupDate, or %NULL if @date_string
could not be parsed.</doc>
<type name="Date" c:type="SoupDate*"/>
</return-value>
<parameters>
<parameter name="date_string" transfer-ownership="none">
<doc xml:space="preserve">the date in some plausible format</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_from_time_t"
c:identifier="soup_date_new_from_time_t">
<doc xml:space="preserve">Creates a #SoupDate corresponding to @when</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #SoupDate</doc>
<type name="Date" c:type="SoupDate*"/>
</return-value>
<parameters>
<parameter name="when" transfer-ownership="none">
<doc xml:space="preserve">a <type>time_t</type></doc>
<type name="glong" c:type="time_t"/>
</parameter>
</parameters>
</constructor>
<method name="copy" c:identifier="soup_date_copy" version="2.24">
<doc xml:space="preserve">Copies @date.</doc>
<return-value transfer-ownership="full">
<type name="Date" c:type="SoupDate*"/>
</return-value>
<parameters>
<instance-parameter name="date" transfer-ownership="none">
<doc xml:space="preserve">a #SoupDate</doc>
<type name="Date" c:type="SoupDate*"/>
</instance-parameter>
</parameters>
</method>
<method name="free" c:identifier="soup_date_free" version="2.24">
<doc xml:space="preserve">Frees @date.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="date" transfer-ownership="none">
<doc xml:space="preserve">a #SoupDate</doc>
<type name="Date" c:type="SoupDate*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_day" c:identifier="soup_date_get_day" version="2.32">
<doc xml:space="preserve">Gets @date's day.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">@date's day</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<instance-parameter name="date" transfer-ownership="none">
<doc xml:space="preserve">a #SoupDate</doc>
<type name="Date" c:type="SoupDate*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_hour" c:identifier="soup_date_get_hour" version="2.32">
<doc xml:space="preserve">Gets @date's hour.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">@date's hour</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<instance-parameter name="date" transfer-ownership="none">
<doc xml:space="preserve">a #SoupDate</doc>
<type name="Date" c:type="SoupDate*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_minute"
c:identifier="soup_date_get_minute"
version="2.32">
<doc xml:space="preserve">Gets @date's minute.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">@date's minute</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<instance-parameter name="date" transfer-ownership="none">
<doc xml:space="preserve">a #SoupDate</doc>
<type name="Date" c:type="SoupDate*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_month"
c:identifier="soup_date_get_month"
version="2.32">
<doc xml:space="preserve">Gets @date's month.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">@date's month</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<instance-parameter name="date" transfer-ownership="none">
<doc xml:space="preserve">a #SoupDate</doc>
<type name="Date" c:type="SoupDate*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_offset"
c:identifier="soup_date_get_offset"
version="2.32">
<doc xml:space="preserve">Gets @date's offset from UTC.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">@date's offset from UTC. If soup_date_get_utc()
returns %FALSE but soup_date_get_offset() returns 0, that means the
date is a "floating" time with no associated offset information.</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<instance-parameter name="date" transfer-ownership="none">
<doc xml:space="preserve">a #SoupDate</doc>
<type name="Date" c:type="SoupDate*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_second"
c:identifier="soup_date_get_second"
version="2.32">
<doc xml:space="preserve">Gets @date's second.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">@date's second</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<instance-parameter name="date" transfer-ownership="none">
<doc xml:space="preserve">a #SoupDate</doc>
<type name="Date" c:type="SoupDate*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_utc" c:identifier="soup_date_get_utc" version="2.32">
<doc xml:space="preserve">Gets @date's UTC flag</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @date is UTC.</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<instance-parameter name="date" transfer-ownership="none">
<doc xml:space="preserve">a #SoupDate</doc>
<type name="Date" c:type="SoupDate*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_year" c:identifier="soup_date_get_year" version="2.32">
<doc xml:space="preserve">Gets @date's year.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">@date's year</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<instance-parameter name="date" transfer-ownership="none">
<doc xml:space="preserve">a #SoupDate</doc>
<type name="Date" c:type="SoupDate*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_past" c:identifier="soup_date_is_past" version="2.24">
<doc xml:space="preserve">Determines if @date is in the past.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @date is in the past</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="date" transfer-ownership="none">
<doc xml:space="preserve">a #SoupDate</doc>
<type name="Date" c:type="SoupDate*"/>
</instance-parameter>
</parameters>
</method>
<method name="to_string" c:identifier="soup_date_to_string">
<doc xml:space="preserve">Converts @date to a string in the format described by @format.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">@date as a string</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<instance-parameter name="date" transfer-ownership="none">
<doc xml:space="preserve">a #SoupDate</doc>
<type name="Date" c:type="SoupDate*"/>
</instance-parameter>
<parameter name="format" transfer-ownership="none">
<doc xml:space="preserve">the format to generate the date in</doc>
<type name="DateFormat" c:type="SoupDateFormat"/>
</parameter>
</parameters>
</method>
<method name="to_time_t" c:identifier="soup_date_to_time_t">
<doc xml:space="preserve">Converts @date to a <type>time_t</type>.
If @date is not representable as a <type>time_t</type>, it will be
clamped into range. (In particular, some HTTP cookies have
expiration dates after "Y2.038k" (2038-01-19T03:14:07Z).)</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">@date as a <type>time_t</type></doc>
<type name="glong" c:type="time_t"/>
</return-value>
<parameters>
<instance-parameter name="date" transfer-ownership="none">
<doc xml:space="preserve">a #SoupDate</doc>
<type name="Date" c:type="SoupDate*"/>
</instance-parameter>
</parameters>
</method>
<method name="to_timeval"
c:identifier="soup_date_to_timeval"
version="2.24">
<doc xml:space="preserve">Converts @date to a #GTimeVal.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="date" transfer-ownership="none">
<doc xml:space="preserve">a #SoupDate</doc>
<type name="Date" c:type="SoupDate*"/>
</instance-parameter>
<parameter name="time"
direction="out"
caller-allocates="1"
transfer-ownership="none">
<doc xml:space="preserve">a #GTimeVal structure in which to store the converted time.</doc>
<type name="GLib.TimeVal" c:type="GTimeVal*"/>
</parameter>
</parameters>
</method>
</record>
<enumeration name="DateFormat"
glib:type-name="SoupDateFormat"
glib:get-type="soup_date_format_get_type"
c:type="SoupDateFormat">
<doc xml:space="preserve">Date formats that soup_date_to_string() can use.
@SOUP_DATE_HTTP and @SOUP_DATE_COOKIE always coerce the time to
UTC. @SOUP_DATE_ISO8601_XMLRPC uses the time as given, ignoring the
offset completely. @SOUP_DATE_RFC2822 and the other ISO 8601
variants use the local time, appending the offset information if
available.
This enum may be extended with more values in future releases.</doc>
<member name="http"
value="1"
c:identifier="SOUP_DATE_HTTP"
glib:nick="http">
<doc xml:space="preserve">RFC 1123 format, used by the HTTP "Date" header. Eg
"Sun, 06 Nov 1994 08:49:37 GMT"</doc>
</member>
<member name="cookie"
value="2"
c:identifier="SOUP_DATE_COOKIE"
glib:nick="cookie">
<doc xml:space="preserve">The format for the "Expires" timestamp in the
Netscape cookie specification. Eg, "Sun, 06-Nov-1994 08:49:37 GMT".</doc>
</member>
<member name="rfc2822"
value="3"
c:identifier="SOUP_DATE_RFC2822"
glib:nick="rfc2822">
<doc xml:space="preserve">RFC 2822 format, eg "Sun, 6 Nov 1994 09:49:37 -0100"</doc>
</member>
<member name="iso8601_compact"
value="4"
c:identifier="SOUP_DATE_ISO8601_COMPACT"
glib:nick="iso8601-compact">
<doc xml:space="preserve">ISO 8601 date/time with no optional
punctuation. Eg, "19941106T094937-0100".</doc>
</member>
<member name="iso8601_full"
value="5"
c:identifier="SOUP_DATE_ISO8601_FULL"
glib:nick="iso8601-full">
<doc xml:space="preserve">ISO 8601 date/time with all optional
punctuation. Eg, "1994-11-06T09:49:37-01:00".</doc>
</member>
<member name="iso8601"
value="5"
c:identifier="SOUP_DATE_ISO8601"
glib:nick="iso8601">
<doc xml:space="preserve">An alias for @SOUP_DATE_ISO8601_FULL.</doc>
</member>
<member name="iso8601_xmlrpc"
value="6"
c:identifier="SOUP_DATE_ISO8601_XMLRPC"
glib:nick="iso8601-xmlrpc">
<doc xml:space="preserve">ISO 8601 date/time as used by XML-RPC.
Eg, "19941106T09:49:37".</doc>
</member>
</enumeration>
<enumeration name="Encoding"
glib:type-name="SoupEncoding"
glib:get-type="soup_encoding_get_type"
c:type="SoupEncoding">
<doc xml:space="preserve">How a message body is encoded for transport</doc>
<member name="unrecognized"
value="0"
c:identifier="SOUP_ENCODING_UNRECOGNIZED"
glib:nick="unrecognized">
<doc xml:space="preserve">unknown / error</doc>
</member>
<member name="none"
value="1"
c:identifier="SOUP_ENCODING_NONE"
glib:nick="none">
<doc xml:space="preserve">no body is present (which is not the same as a
0-length body, and only occurs in certain places)</doc>
</member>
<member name="content_length"
value="2"
c:identifier="SOUP_ENCODING_CONTENT_LENGTH"
glib:nick="content-length">
<doc xml:space="preserve">Content-Length encoding</doc>
</member>
<member name="eof"
value="3"
c:identifier="SOUP_ENCODING_EOF"
glib:nick="eof">
<doc xml:space="preserve">Response body ends when the connection is closed</doc>
</member>
<member name="chunked"
value="4"
c:identifier="SOUP_ENCODING_CHUNKED"
glib:nick="chunked">
<doc xml:space="preserve">chunked encoding (currently only supported
for response)</doc>
</member>
<member name="byteranges"
value="5"
c:identifier="SOUP_ENCODING_BYTERANGES"
glib:nick="byteranges">
<doc xml:space="preserve">multipart/byteranges (Reserved for future
use: NOT CURRENTLY IMPLEMENTED)</doc>
</member>
</enumeration>
<bitfield name="Expectation"
glib:type-name="SoupExpectation"
glib:get-type="soup_expectation_get_type"
c:type="SoupExpectation">
<doc xml:space="preserve">Represents the parsed value of the "Expect" header.</doc>
<member name="unrecognized"
value="1"
c:identifier="SOUP_EXPECTATION_UNRECOGNIZED"
glib:nick="unrecognized">
<doc xml:space="preserve">any unrecognized expectation</doc>
</member>
<member name="continue"
value="2"
c:identifier="SOUP_EXPECTATION_CONTINUE"
glib:nick="continue">
<doc xml:space="preserve">"100-continue"</doc>
</member>
</bitfield>
<constant name="FORM_H" value="1" c:type="SOUP_FORM_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="FORM_MIME_TYPE_MULTIPART"
value="multipart/form-data"
c:type="SOUP_FORM_MIME_TYPE_MULTIPART"
version="2.26">
<doc xml:space="preserve">A macro containing the value
<literal>"multipart/form-data"</literal>; the MIME type used for
posting form data that contains files to be uploaded.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="FORM_MIME_TYPE_URLENCODED"
value="application/x-www-form-urlencoded"
c:type="SOUP_FORM_MIME_TYPE_URLENCODED"
version="2.26">
<doc xml:space="preserve">A macro containing the value
<literal>"application/x-www-form-urlencoded"</literal>; the default
MIME type for POSTing HTML form data.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="HEADERS_H" value="1" c:type="SOUP_HEADERS_H">
<type name="gint" c:type="gint"/>
</constant>
<enumeration name="HTTPVersion"
glib:type-name="SoupHTTPVersion"
glib:get-type="soup_http_version_get_type"
c:type="SoupHTTPVersion">
<doc xml:space="preserve">Indicates the HTTP protocol version being used.</doc>
<member name="http_1_0"
value="0"
c:identifier="SOUP_HTTP_1_0"
glib:nick="http-1-0">
<doc xml:space="preserve">HTTP 1.0 (RFC 1945)</doc>
</member>
<member name="http_1_1"
value="1"
c:identifier="SOUP_HTTP_1_1"
glib:nick="http-1-1">
<doc xml:space="preserve">HTTP 1.1 (RFC 2616)</doc>
</member>
</enumeration>
<enumeration name="KnownStatusCode"
glib:type-name="SoupKnownStatusCode"
glib:get-type="soup_known_status_code_get_type"
c:type="SoupKnownStatusCode">
<member name="none"
value="0"
c:identifier="SOUP_KNOWN_STATUS_CODE_NONE"
glib:nick="none">
</member>
<member name="cancelled"
value="1"
c:identifier="SOUP_KNOWN_STATUS_CODE_CANCELLED"
glib:nick="cancelled">
</member>
<member name="cant_resolve"
value="2"
c:identifier="SOUP_KNOWN_STATUS_CODE_CANT_RESOLVE"
glib:nick="cant-resolve">
</member>
<member name="cant_resolve_proxy"
value="3"
c:identifier="SOUP_KNOWN_STATUS_CODE_CANT_RESOLVE_PROXY"
glib:nick="cant-resolve-proxy">
</member>
<member name="cant_connect"
value="4"
c:identifier="SOUP_KNOWN_STATUS_CODE_CANT_CONNECT"
glib:nick="cant-connect">
</member>
<member name="cant_connect_proxy"
value="5"
c:identifier="SOUP_KNOWN_STATUS_CODE_CANT_CONNECT_PROXY"
glib:nick="cant-connect-proxy">
</member>
<member name="ssl_failed"
value="6"
c:identifier="SOUP_KNOWN_STATUS_CODE_SSL_FAILED"
glib:nick="ssl-failed">
</member>
<member name="io_error"
value="7"
c:identifier="SOUP_KNOWN_STATUS_CODE_IO_ERROR"
glib:nick="io-error">
</member>
<member name="malformed"
value="8"
c:identifier="SOUP_KNOWN_STATUS_CODE_MALFORMED"
glib:nick="malformed">
</member>
<member name="try_again"
value="9"
c:identifier="SOUP_KNOWN_STATUS_CODE_TRY_AGAIN"
glib:nick="try-again">
</member>
<member name="too_many_redirects"
value="10"
c:identifier="SOUP_KNOWN_STATUS_CODE_TOO_MANY_REDIRECTS"
glib:nick="too-many-redirects">
</member>
<member name="tls_failed"
value="11"
c:identifier="SOUP_KNOWN_STATUS_CODE_TLS_FAILED"
glib:nick="tls-failed">
</member>
<member name="continue"
value="100"
c:identifier="SOUP_KNOWN_STATUS_CODE_CONTINUE"
glib:nick="continue">
</member>
<member name="switching_protocols"
value="101"
c:identifier="SOUP_KNOWN_STATUS_CODE_SWITCHING_PROTOCOLS"
glib:nick="switching-protocols">
</member>
<member name="processing"
value="102"
c:identifier="SOUP_KNOWN_STATUS_CODE_PROCESSING"
glib:nick="processing">
</member>
<member name="ok"
value="200"
c:identifier="SOUP_KNOWN_STATUS_CODE_OK"
glib:nick="ok">
</member>
<member name="created"
value="201"
c:identifier="SOUP_KNOWN_STATUS_CODE_CREATED"
glib:nick="created">
</member>
<member name="accepted"
value="202"
c:identifier="SOUP_KNOWN_STATUS_CODE_ACCEPTED"
glib:nick="accepted">
</member>
<member name="non_authoritative"
value="203"
c:identifier="SOUP_KNOWN_STATUS_CODE_NON_AUTHORITATIVE"
glib:nick="non-authoritative">
</member>
<member name="no_content"
value="204"
c:identifier="SOUP_KNOWN_STATUS_CODE_NO_CONTENT"
glib:nick="no-content">
</member>
<member name="reset_content"
value="205"
c:identifier="SOUP_KNOWN_STATUS_CODE_RESET_CONTENT"
glib:nick="reset-content">
</member>
<member name="partial_content"
value="206"
c:identifier="SOUP_KNOWN_STATUS_CODE_PARTIAL_CONTENT"
glib:nick="partial-content">
</member>
<member name="multi_status"
value="207"
c:identifier="SOUP_KNOWN_STATUS_CODE_MULTI_STATUS"
glib:nick="multi-status">
</member>
<member name="multiple_choices"
value="300"
c:identifier="SOUP_KNOWN_STATUS_CODE_MULTIPLE_CHOICES"
glib:nick="multiple-choices">
</member>
<member name="moved_permanently"
value="301"
c:identifier="SOUP_KNOWN_STATUS_CODE_MOVED_PERMANENTLY"
glib:nick="moved-permanently">
</member>
<member name="found"
value="302"
c:identifier="SOUP_KNOWN_STATUS_CODE_FOUND"
glib:nick="found">
</member>
<member name="moved_temporarily"
value="302"
c:identifier="SOUP_KNOWN_STATUS_CODE_MOVED_TEMPORARILY"
glib:nick="moved-temporarily">
</member>
<member name="see_other"
value="303"
c:identifier="SOUP_KNOWN_STATUS_CODE_SEE_OTHER"
glib:nick="see-other">
</member>
<member name="not_modified"
value="304"
c:identifier="SOUP_KNOWN_STATUS_CODE_NOT_MODIFIED"
glib:nick="not-modified">
</member>
<member name="use_proxy"
value="305"
c:identifier="SOUP_KNOWN_STATUS_CODE_USE_PROXY"
glib:nick="use-proxy">
</member>
<member name="not_appearing_in_this_protocol"
value="306"
c:identifier="SOUP_KNOWN_STATUS_CODE_NOT_APPEARING_IN_THIS_PROTOCOL"
glib:nick="not-appearing-in-this-protocol">
</member>
<member name="temporary_redirect"
value="307"
c:identifier="SOUP_KNOWN_STATUS_CODE_TEMPORARY_REDIRECT"
glib:nick="temporary-redirect">
</member>
<member name="bad_request"
value="400"
c:identifier="SOUP_KNOWN_STATUS_CODE_BAD_REQUEST"
glib:nick="bad-request">
</member>
<member name="unauthorized"
value="401"
c:identifier="SOUP_KNOWN_STATUS_CODE_UNAUTHORIZED"
glib:nick="unauthorized">
</member>
<member name="payment_required"
value="402"
c:identifier="SOUP_KNOWN_STATUS_CODE_PAYMENT_REQUIRED"
glib:nick="payment-required">
</member>
<member name="forbidden"
value="403"
c:identifier="SOUP_KNOWN_STATUS_CODE_FORBIDDEN"
glib:nick="forbidden">
</member>
<member name="not_found"
value="404"
c:identifier="SOUP_KNOWN_STATUS_CODE_NOT_FOUND"
glib:nick="not-found">
</member>
<member name="method_not_allowed"
value="405"
c:identifier="SOUP_KNOWN_STATUS_CODE_METHOD_NOT_ALLOWED"
glib:nick="method-not-allowed">
</member>
<member name="not_acceptable"
value="406"
c:identifier="SOUP_KNOWN_STATUS_CODE_NOT_ACCEPTABLE"
glib:nick="not-acceptable">
</member>
<member name="proxy_authentication_required"
value="407"
c:identifier="SOUP_KNOWN_STATUS_CODE_PROXY_AUTHENTICATION_REQUIRED"
glib:nick="proxy-authentication-required">
</member>
<member name="proxy_unauthorized"
value="407"
c:identifier="SOUP_KNOWN_STATUS_CODE_PROXY_UNAUTHORIZED"
glib:nick="proxy-unauthorized">
</member>
<member name="request_timeout"
value="408"
c:identifier="SOUP_KNOWN_STATUS_CODE_REQUEST_TIMEOUT"
glib:nick="request-timeout">
</member>
<member name="conflict"
value="409"
c:identifier="SOUP_KNOWN_STATUS_CODE_CONFLICT"
glib:nick="conflict">
</member>
<member name="gone"
value="410"
c:identifier="SOUP_KNOWN_STATUS_CODE_GONE"
glib:nick="gone">
</member>
<member name="length_required"
value="411"
c:identifier="SOUP_KNOWN_STATUS_CODE_LENGTH_REQUIRED"
glib:nick="length-required">
</member>
<member name="precondition_failed"
value="412"
c:identifier="SOUP_KNOWN_STATUS_CODE_PRECONDITION_FAILED"
glib:nick="precondition-failed">
</member>
<member name="request_entity_too_large"
value="413"
c:identifier="SOUP_KNOWN_STATUS_CODE_REQUEST_ENTITY_TOO_LARGE"
glib:nick="request-entity-too-large">
</member>
<member name="request_uri_too_long"
value="414"
c:identifier="SOUP_KNOWN_STATUS_CODE_REQUEST_URI_TOO_LONG"
glib:nick="request-uri-too-long">
</member>
<member name="unsupported_media_type"
value="415"
c:identifier="SOUP_KNOWN_STATUS_CODE_UNSUPPORTED_MEDIA_TYPE"
glib:nick="unsupported-media-type">
</member>
<member name="requested_range_not_satisfiable"
value="416"
c:identifier="SOUP_KNOWN_STATUS_CODE_REQUESTED_RANGE_NOT_SATISFIABLE"
glib:nick="requested-range-not-satisfiable">
</member>
<member name="invalid_range"
value="416"
c:identifier="SOUP_KNOWN_STATUS_CODE_INVALID_RANGE"
glib:nick="invalid-range">
</member>
<member name="expectation_failed"
value="417"
c:identifier="SOUP_KNOWN_STATUS_CODE_EXPECTATION_FAILED"
glib:nick="expectation-failed">
</member>
<member name="unprocessable_entity"
value="422"
c:identifier="SOUP_KNOWN_STATUS_CODE_UNPROCESSABLE_ENTITY"
glib:nick="unprocessable-entity">
</member>
<member name="locked"
value="423"
c:identifier="SOUP_KNOWN_STATUS_CODE_LOCKED"
glib:nick="locked">
</member>
<member name="failed_dependency"
value="424"
c:identifier="SOUP_KNOWN_STATUS_CODE_FAILED_DEPENDENCY"
glib:nick="failed-dependency">
</member>
<member name="internal_server_error"
value="500"
c:identifier="SOUP_KNOWN_STATUS_CODE_INTERNAL_SERVER_ERROR"
glib:nick="internal-server-error">
</member>
<member name="not_implemented"
value="501"
c:identifier="SOUP_KNOWN_STATUS_CODE_NOT_IMPLEMENTED"
glib:nick="not-implemented">
</member>
<member name="bad_gateway"
value="502"
c:identifier="SOUP_KNOWN_STATUS_CODE_BAD_GATEWAY"
glib:nick="bad-gateway">
</member>
<member name="service_unavailable"
value="503"
c:identifier="SOUP_KNOWN_STATUS_CODE_SERVICE_UNAVAILABLE"
glib:nick="service-unavailable">
</member>
<member name="gateway_timeout"
value="504"
c:identifier="SOUP_KNOWN_STATUS_CODE_GATEWAY_TIMEOUT"
glib:nick="gateway-timeout">
</member>
<member name="http_version_not_supported"
value="505"
c:identifier="SOUP_KNOWN_STATUS_CODE_HTTP_VERSION_NOT_SUPPORTED"
glib:nick="http-version-not-supported">
</member>
<member name="insufficient_storage"
value="507"
c:identifier="SOUP_KNOWN_STATUS_CODE_INSUFFICIENT_STORAGE"
glib:nick="insufficient-storage">
</member>
<member name="not_extended"
value="510"
c:identifier="SOUP_KNOWN_STATUS_CODE_NOT_EXTENDED"
glib:nick="not-extended">
</member>
</enumeration>
<constant name="LOGGER_H" value="1" c:type="SOUP_LOGGER_H">
<type name="gint" c:type="gint"/>
</constant>
<class name="Logger"
c:symbol-prefix="logger"
c:type="SoupLogger"
parent="GObject.Object"
glib:type-name="SoupLogger"
glib:get-type="soup_logger_get_type"
glib:type-struct="LoggerClass">
<implements name="SessionFeature"/>
<constructor name="new" c:identifier="soup_logger_new">
<doc xml:space="preserve">Creates a new #SoupLogger with the given debug level. If @level is
%SOUP_LOGGER_LOG_BODY, @max_body_size gives the maximum number of
bytes of the body that will be logged. (-1 means "no limit".)
If you need finer control over what message parts are and aren't
logged, use soup_logger_set_request_filter() and
soup_logger_set_response_filter().</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #SoupLogger</doc>
<type name="Logger" c:type="SoupLogger*"/>
</return-value>
<parameters>
<parameter name="level" transfer-ownership="none">
<doc xml:space="preserve">the debug level</doc>
<type name="LoggerLogLevel" c:type="SoupLoggerLogLevel"/>
</parameter>
<parameter name="max_body_size" transfer-ownership="none">
<doc xml:space="preserve">the maximum body size to output, or -1</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</constructor>
<method name="attach" c:identifier="soup_logger_attach" deprecated="1">
<doc xml:space="preserve">Sets @logger to watch @session and print debug information for
its messages.
(The session will take a reference on @logger, which will be
removed when you call soup_logger_detach(), or when the session is
destroyed.)</doc>
<doc-deprecated xml:space="preserve">Use soup_session_add_feature() instead.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="logger" transfer-ownership="none">
<doc xml:space="preserve">a #SoupLogger</doc>
<type name="Logger" c:type="SoupLogger*"/>
</instance-parameter>
<parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</parameter>
</parameters>
</method>
<method name="detach" c:identifier="soup_logger_detach" deprecated="1">
<doc xml:space="preserve">Stops @logger from watching @session.</doc>
<doc-deprecated xml:space="preserve">Use soup_session_remove_feature() instead.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="logger" transfer-ownership="none">
<doc xml:space="preserve">a #SoupLogger</doc>
<type name="Logger" c:type="SoupLogger*"/>
</instance-parameter>
<parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</parameter>
</parameters>
</method>
<method name="set_printer" c:identifier="soup_logger_set_printer">
<doc xml:space="preserve">Sets up an alternate log printing routine, if you don't want
the log to go to <literal>stdout</literal>.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="logger" transfer-ownership="none">
<doc xml:space="preserve">a #SoupLogger</doc>
<type name="Logger" c:type="SoupLogger*"/>
</instance-parameter>
<parameter name="printer"
transfer-ownership="none"
scope="notified"
closure="1"
destroy="2">
<doc xml:space="preserve">the callback for printing logging output</doc>
<type name="LoggerPrinter" c:type="SoupLoggerPrinter"/>
</parameter>
<parameter name="printer_data" transfer-ownership="none">
<doc xml:space="preserve">data to pass to the callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="destroy" transfer-ownership="none" scope="async">
<doc xml:space="preserve">a #GDestroyNotify to free @printer_data</doc>
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
</parameter>
</parameters>
</method>
<method name="set_request_filter"
c:identifier="soup_logger_set_request_filter">
<doc xml:space="preserve">Sets up a filter to determine the log level for a given request.
For each HTTP request @logger will invoke @request_filter to
determine how much (if any) of that request to log. (If you do not
set a request filter, @logger will just always log requests at the
level passed to soup_logger_new().)</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="logger" transfer-ownership="none">
<doc xml:space="preserve">a #SoupLogger</doc>
<type name="Logger" c:type="SoupLogger*"/>
</instance-parameter>
<parameter name="request_filter"
transfer-ownership="none"
scope="notified"
closure="1"
destroy="2">
<doc xml:space="preserve">the callback for request debugging</doc>
<type name="LoggerFilter" c:type="SoupLoggerFilter"/>
</parameter>
<parameter name="filter_data" transfer-ownership="none">
<doc xml:space="preserve">data to pass to the callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="destroy" transfer-ownership="none" scope="async">
<doc xml:space="preserve">a #GDestroyNotify to free @filter_data</doc>
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
</parameter>
</parameters>
</method>
<method name="set_response_filter"
c:identifier="soup_logger_set_response_filter">
<doc xml:space="preserve">Sets up a filter to determine the log level for a given response.
For each HTTP response @logger will invoke @response_filter to
determine how much (if any) of that response to log. (If you do not
set a response filter, @logger will just always log responses at
the level passed to soup_logger_new().)</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="logger" transfer-ownership="none">
<doc xml:space="preserve">a #SoupLogger</doc>
<type name="Logger" c:type="SoupLogger*"/>
</instance-parameter>
<parameter name="response_filter"
transfer-ownership="none"
scope="notified"
closure="1"
destroy="2">
<doc xml:space="preserve">the callback for response debugging</doc>
<type name="LoggerFilter" c:type="SoupLoggerFilter"/>
</parameter>
<parameter name="filter_data" transfer-ownership="none">
<doc xml:space="preserve">data to pass to the callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="destroy" transfer-ownership="none" scope="async">
<doc xml:space="preserve">a #GDestroyNotify to free @filter_data</doc>
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
</parameter>
</parameters>
</method>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="LoggerClass"
c:type="SoupLoggerClass"
glib:is-gtype-struct-for="Logger">
<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>
<callback name="LoggerFilter" c:type="SoupLoggerFilter">
<doc xml:space="preserve">The prototype for a logging filter. The filter callback will be
invoked for each request or response, and should analyze it and
return a #SoupLoggerLogLevel value indicating how much of the
message to log. Eg, it might choose between %SOUP_LOGGER_LOG_BODY
and %SOUP_LOGGER_LOG_HEADERS depending on the Content-Type.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #SoupLoggerLogLevel value indicating how much of
the message to log</doc>
<type name="LoggerLogLevel" c:type="SoupLoggerLogLevel"/>
</return-value>
<parameters>
<parameter name="logger" transfer-ownership="none">
<doc xml:space="preserve">the #SoupLogger</doc>
<type name="Logger" c:type="SoupLogger*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the message being logged</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" closure="2">
<doc xml:space="preserve">the data passed to soup_logger_set_request_filter()
or soup_logger_set_response_filter()</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<enumeration name="LoggerLogLevel"
glib:type-name="SoupLoggerLogLevel"
glib:get-type="soup_logger_log_level_get_type"
c:type="SoupLoggerLogLevel">
<doc xml:space="preserve">Describes the level of logging output to provide.</doc>
<member name="none"
value="0"
c:identifier="SOUP_LOGGER_LOG_NONE"
glib:nick="none">
<doc xml:space="preserve">No logging</doc>
</member>
<member name="minimal"
value="1"
c:identifier="SOUP_LOGGER_LOG_MINIMAL"
glib:nick="minimal">
<doc xml:space="preserve">Log the Request-Line or Status-Line and
the Soup-Debug pseudo-headers</doc>
</member>
<member name="headers"
value="2"
c:identifier="SOUP_LOGGER_LOG_HEADERS"
glib:nick="headers">
<doc xml:space="preserve">Log the full request/response headers</doc>
</member>
<member name="body"
value="3"
c:identifier="SOUP_LOGGER_LOG_BODY"
glib:nick="body">
<doc xml:space="preserve">Log the full headers and request/response
bodies.</doc>
</member>
</enumeration>
<callback name="LoggerPrinter" c:type="SoupLoggerPrinter">
<doc xml:space="preserve">The prototype for a custom printing callback.
@level indicates what kind of information is being printed. Eg, it
will be %SOUP_LOGGER_LOG_HEADERS if @data is header data.
@direction is either '<', '>', or ' ', and @data is the single line
to print; the printer is expected to add a terminating newline.
To get the effect of the default printer, you would do:
<informalexample><programlisting>
printf ("%c %s\n", direction, data);
</programlisting></informalexample></doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="logger" transfer-ownership="none">
<doc xml:space="preserve">the #SoupLogger</doc>
<type name="Logger" c:type="SoupLogger*"/>
</parameter>
<parameter name="level" transfer-ownership="none">
<doc xml:space="preserve">the level of the information being printed.</doc>
<type name="LoggerLogLevel" c:type="SoupLoggerLogLevel"/>
</parameter>
<parameter name="direction" transfer-ownership="none">
<doc xml:space="preserve">a single-character prefix to @data</doc>
<type name="gchar" c:type="char"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">data to print</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" closure="4">
<doc xml:space="preserve">the data passed to soup_logger_set_printer()</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<constant name="MESSAGE_BODY_H" value="1" c:type="SOUP_MESSAGE_BODY_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="MESSAGE_FIRST_PARTY"
value="first-party"
c:type="SOUP_MESSAGE_FIRST_PARTY"
version="2.30">
<doc xml:space="preserve">Alias for the #SoupMessage:first-party property. (The
#SoupURI loaded in the application when the message was
queued.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="MESSAGE_FLAGS" value="flags" c:type="SOUP_MESSAGE_FLAGS">
<doc xml:space="preserve">Alias for the #SoupMessage:flags property. (The message's
#SoupMessageFlags.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="MESSAGE_H" value="1" c:type="SOUP_MESSAGE_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="MESSAGE_HEADERS_H"
value="1"
c:type="SOUP_MESSAGE_HEADERS_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="MESSAGE_HTTP_VERSION"
value="http-version"
c:type="SOUP_MESSAGE_HTTP_VERSION">
<doc xml:space="preserve">Alias for the #SoupMessage:http-version property. (The
message's #SoupHTTPVersion.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="MESSAGE_METHOD"
value="method"
c:type="SOUP_MESSAGE_METHOD">
<doc xml:space="preserve">Alias for the #SoupMessage:method property. (The message's
HTTP method.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="MESSAGE_PRIORITY"
value="priority"
c:type="SOUP_MESSAGE_PRIORITY"
version="2.44">
<doc xml:space="preserve">Sets the priority of the #SoupMessage. See
soup_message_set_priority() for further details.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="MESSAGE_REASON_PHRASE"
value="reason-phrase"
c:type="SOUP_MESSAGE_REASON_PHRASE">
<doc xml:space="preserve">Alias for the #SoupMessage:reason-phrase property. (The
message's HTTP response reason phrase.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="MESSAGE_REQUEST_BODY"
value="request-body"
c:type="SOUP_MESSAGE_REQUEST_BODY">
<doc xml:space="preserve">Alias for the #SoupMessage:request-body property. (The
message's HTTP request body.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="MESSAGE_REQUEST_BODY_DATA"
value="request-body-data"
c:type="SOUP_MESSAGE_REQUEST_BODY_DATA"
version="2.46">
<doc xml:space="preserve">Alias for the #SoupMessage:request-body-data property. (The
message's HTTP request body, as a #GBytes.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="MESSAGE_REQUEST_HEADERS"
value="request-headers"
c:type="SOUP_MESSAGE_REQUEST_HEADERS">
<doc xml:space="preserve">Alias for the #SoupMessage:request-headers property. (The
message's HTTP request headers.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="MESSAGE_RESPONSE_BODY"
value="response-body"
c:type="SOUP_MESSAGE_RESPONSE_BODY">
<doc xml:space="preserve">Alias for the #SoupMessage:response-body property. (The
message's HTTP response body.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="MESSAGE_RESPONSE_BODY_DATA"
value="response-body-data"
c:type="SOUP_MESSAGE_RESPONSE_BODY_DATA"
version="2.46">
<doc xml:space="preserve">Alias for the #SoupMessage:response-body-data property. (The
message's HTTP response body, as a #GBytes.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="MESSAGE_RESPONSE_HEADERS"
value="response-headers"
c:type="SOUP_MESSAGE_RESPONSE_HEADERS">
<doc xml:space="preserve">Alias for the #SoupMessage:response-headers property. (The
message's HTTP response headers.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="MESSAGE_SERVER_SIDE"
value="server-side"
c:type="SOUP_MESSAGE_SERVER_SIDE">
<doc xml:space="preserve">Alias for the #SoupMessage:server-side property. (%TRUE if
the message was created by #SoupServer.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="MESSAGE_STATUS_CODE"
value="status-code"
c:type="SOUP_MESSAGE_STATUS_CODE">
<doc xml:space="preserve">Alias for the #SoupMessage:status-code property. (The
message's HTTP response status code.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="MESSAGE_TLS_CERTIFICATE"
value="tls-certificate"
c:type="SOUP_MESSAGE_TLS_CERTIFICATE"
version="2.34">
<doc xml:space="preserve">Alias for the #SoupMessage:tls-certificate property. (The
TLS certificate associated with the message, if any.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="MESSAGE_TLS_ERRORS"
value="tls-errors"
c:type="SOUP_MESSAGE_TLS_ERRORS"
version="2.34">
<doc xml:space="preserve">Alias for the #SoupMessage:tls-errors property. (The
verification errors on #SoupMessage:tls-certificate.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="MESSAGE_URI" value="uri" c:type="SOUP_MESSAGE_URI">
<doc xml:space="preserve">Alias for the #SoupMessage:uri property. (The message's
#SoupURI.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="METHOD_H" value="1" c:type="SOUP_METHOD_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="MISC_H" value="1" c:type="SOUP_MISC_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="MULTIPART_H" value="1" c:type="SOUP_MULTIPART_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="MULTIPART_INPUT_STREAM_H"
value="1"
c:type="SOUP_MULTIPART_INPUT_STREAM_H">
<type name="gint" c:type="gint"/>
</constant>
<enumeration name="MemoryUse"
glib:type-name="SoupMemoryUse"
glib:get-type="soup_memory_use_get_type"
c:type="SoupMemoryUse">
<doc xml:space="preserve">Describes how #SoupBuffer should use the data passed in by the
caller.
See also soup_buffer_new_with_owner(), which allows to you create a
buffer containing data which is owned by another object.</doc>
<member name="static"
value="0"
c:identifier="SOUP_MEMORY_STATIC"
glib:nick="static">
<doc xml:space="preserve">The memory is statically allocated and
constant; libsoup can use the passed-in buffer directly and not
need to worry about it being modified or freed.</doc>
</member>
<member name="take"
value="1"
c:identifier="SOUP_MEMORY_TAKE"
glib:nick="take">
<doc xml:space="preserve">The caller has allocated the memory for the
#SoupBuffer's use; libsoup will assume ownership of it and free it
(with g_free()) when it is done with it.</doc>
</member>
<member name="copy"
value="2"
c:identifier="SOUP_MEMORY_COPY"
glib:nick="copy">
<doc xml:space="preserve">The passed-in data belongs to the caller; the
#SoupBuffer will copy it into new memory, leaving the caller free
to reuse the original memory.</doc>
</member>
<member name="temporary"
value="3"
c:identifier="SOUP_MEMORY_TEMPORARY"
glib:nick="temporary">
<doc xml:space="preserve">The passed-in data belongs to the caller,
but will remain valid for the lifetime of the #SoupBuffer. The
difference between this and @SOUP_MEMORY_STATIC is that if you copy
a @SOUP_MEMORY_TEMPORARY buffer, it will make a copy of the memory
as well, rather than reusing the original memory.</doc>
</member>
</enumeration>
<class name="Message"
c:symbol-prefix="message"
c:type="SoupMessage"
parent="GObject.Object"
glib:type-name="SoupMessage"
glib:get-type="soup_message_get_type"
glib:type-struct="MessageClass">
<doc xml:space="preserve">Represents an HTTP message being sent or received.
@status_code will normally be a #SoupStatus value, eg,
%SOUP_STATUS_OK, though of course it might actually be an unknown
status code. @reason_phrase is the actual text returned from the
server, which may or may not correspond to the "standard"
description of @status_code. At any rate, it is almost certainly
not localized, and not very descriptive even if it is in the user's
language; you should not use @reason_phrase in user-visible
messages. Rather, you should look at @status_code, and determine an
end-user-appropriate message based on that and on what you were
trying to do.
As described in the #SoupMessageBody documentation, the
@request_body and @response_body <literal>data</literal> fields
will not necessarily be filled in at all times. When the body
fields are filled in, they will be terminated with a '\0' byte
(which is not included in the <literal>length</literal>), so you
can use them as ordinary C strings (assuming that you know that the
body doesn't have any other '\0' bytes).
For a client-side #SoupMessage, @request_body's
<literal>data</literal> is usually filled in right before libsoup
writes the request to the network, but you should not count on
this; use soup_message_body_flatten() if you want to ensure that
<literal>data</literal> is filled in. If you are not using
#SoupRequest to read the response, then @response_body's
<literal>data</literal> will be filled in before
#SoupMessage::finished is emitted. (If you are using #SoupRequest,
then the message body is not accumulated by default, so
@response_body's <literal>data</literal> will always be %NULL.)
For a server-side #SoupMessage, @request_body's %data will be
filled in before #SoupMessage::got_body is emitted.
To prevent the %data field from being filled in at all (eg, if you
are handling the data from a #SoupMessage::got_chunk, and so don't
need to see it all at the end), call
soup_message_body_set_accumulate() on @response_body or
@request_body as appropriate, passing %FALSE.</doc>
<constructor name="new" c:identifier="soup_message_new">
<doc xml:space="preserve">Creates a new empty #SoupMessage, which will connect to @uri</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">the new #SoupMessage (or %NULL if @uri
could not be parsed).</doc>
<type name="Message" c:type="SoupMessage*"/>
</return-value>
<parameters>
<parameter name="method" transfer-ownership="none">
<doc xml:space="preserve">the HTTP method for the created request</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="uri_string" transfer-ownership="none">
<doc xml:space="preserve">the destination endpoint (as a string)</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_from_uri"
c:identifier="soup_message_new_from_uri">
<doc xml:space="preserve">Creates a new empty #SoupMessage, which will connect to @uri</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the new #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</return-value>
<parameters>
<parameter name="method" transfer-ownership="none">
<doc xml:space="preserve">the HTTP method for the created request</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">the destination endpoint (as a #SoupURI)</doc>
<type name="URI" c:type="SoupURI*"/>
</parameter>
</parameters>
</constructor>
<virtual-method name="finished" invoker="finished">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="got_body" invoker="got_body">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="got_chunk" invoker="got_chunk">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
<parameter name="chunk" transfer-ownership="none">
<type name="Buffer" c:type="SoupBuffer*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="got_headers" invoker="got_headers">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="got_informational" invoker="got_informational">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="restarted" invoker="restarted">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="starting" invoker="starting">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="wrote_body" invoker="wrote_body">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="wrote_chunk" invoker="wrote_chunk">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="wrote_headers" invoker="wrote_headers">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="wrote_informational" invoker="wrote_informational">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
</parameters>
</virtual-method>
<method name="add_header_handler"
c:identifier="soup_message_add_header_handler"
introspectable="0">
<doc xml:space="preserve">Adds a signal handler to @msg for @signal, as with
g_signal_connect(), but the @callback will only be run if @msg's
incoming messages headers (that is, the
<literal>request_headers</literal> for a client #SoupMessage, or
the <literal>response_headers</literal> for a server #SoupMessage)
contain a header named @header.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the handler ID from g_signal_connect()</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
<parameter name="signal" transfer-ownership="none">
<doc xml:space="preserve">signal to connect the handler to.</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="header" transfer-ownership="none">
<doc xml:space="preserve">HTTP response header to match against</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="callback" transfer-ownership="none" closure="3">
<doc xml:space="preserve">the header handler</doc>
<type name="GObject.Callback" c:type="GCallback"/>
</parameter>
<parameter name="user_data" transfer-ownership="none">
<doc xml:space="preserve">data to pass to @handler_cb</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</method>
<method name="add_status_code_handler"
c:identifier="soup_message_add_status_code_handler"
introspectable="0">
<doc xml:space="preserve">Adds a signal handler to @msg for @signal, as with
g_signal_connect(), but the @callback will only be run if @msg has
the status @status_code.
@signal must be a signal that will be emitted after @msg's status
is set. For a client #SoupMessage, this means it can't be a "wrote"
signal. For a server #SoupMessage, this means it can't be a "got"
signal.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the handler ID from g_signal_connect()</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
<parameter name="signal" transfer-ownership="none">
<doc xml:space="preserve">signal to connect the handler to.</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="status_code" transfer-ownership="none">
<doc xml:space="preserve">status code to match against</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="callback" transfer-ownership="none" closure="3">
<doc xml:space="preserve">the header handler</doc>
<type name="GObject.Callback" c:type="GCallback"/>
</parameter>
<parameter name="user_data" transfer-ownership="none">
<doc xml:space="preserve">data to pass to @handler_cb</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</method>
<method name="content_sniffed"
c:identifier="soup_message_content_sniffed">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
<parameter name="content_type" transfer-ownership="none">
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="params" transfer-ownership="none">
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="gpointer" c:type="gpointer"/>
<type name="gpointer" c:type="gpointer"/>
</type>
</parameter>
</parameters>
</method>
<method name="disable_feature"
c:identifier="soup_message_disable_feature"
version="2.28">
<doc xml:space="preserve">This disables the actions of #SoupSessionFeature<!-- -->s with the
given @feature_type (or a subclass of that type) on @msg, so that
@msg is processed as though the feature(s) hadn't been added to the
session. Eg, passing #SOUP_TYPE_CONTENT_SNIFFER for @feature_type
will disable Content-Type sniffing on the message.
You must call this before queueing @msg on a session; calling it on
a message that has already been queued is undefined. In particular,
you cannot call this on a message that is being requeued after a
redirect or authentication.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
<parameter name="feature_type" transfer-ownership="none">
<doc xml:space="preserve">the #GType of a #SoupSessionFeature</doc>
<type name="GType" c:type="GType"/>
</parameter>
</parameters>
</method>
<method name="finished" c:identifier="soup_message_finished">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_address"
c:identifier="soup_message_get_address"
version="2.26">
<doc xml:space="preserve">Gets the address @msg's URI points to. After first setting the
URI on a message, this will be unresolved, although the message's
session will resolve it before sending the message.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the address @msg's URI points to</doc>
<type name="Address" c:type="SoupAddress*"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_first_party"
c:identifier="soup_message_get_first_party"
version="2.30">
<doc xml:space="preserve">Gets @msg's first-party #SoupURI</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the @msg's first party #SoupURI</doc>
<type name="URI" c:type="SoupURI*"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_flags" c:identifier="soup_message_get_flags">
<doc xml:space="preserve">Gets the flags on @msg</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the flags</doc>
<type name="MessageFlags" c:type="SoupMessageFlags"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_http_version"
c:identifier="soup_message_get_http_version">
<doc xml:space="preserve">Gets the HTTP version of @msg. This is the minimum of the
version from the request and the version from the response.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the HTTP version</doc>
<type name="HTTPVersion" c:type="SoupHTTPVersion"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_https_status"
c:identifier="soup_message_get_https_status"
version="2.34">
<doc xml:space="preserve">If @msg is using https (or attempted to use https but got
%SOUP_STATUS_SSL_FAILED), this retrieves the #GTlsCertificate
associated with its connection, and the #GTlsCertificateFlags
showing what problems, if any, have been found with that
certificate.
<note><para>This is only meaningful with messages processed by a #SoupSession and is
not useful for messages received by a #SoupServer</para></note></doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @msg used/attempted https, %FALSE if not</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
<parameter name="certificate"
direction="out"
caller-allocates="0"
transfer-ownership="none">
<doc xml:space="preserve">@msg's TLS certificate</doc>
<type name="Gio.TlsCertificate" c:type="GTlsCertificate**"/>
</parameter>
<parameter name="errors"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">the verification status of @certificate</doc>
<type name="Gio.TlsCertificateFlags"
c:type="GTlsCertificateFlags*"/>
</parameter>
</parameters>
</method>
<method name="get_priority"
c:identifier="soup_message_get_priority"
version="2.44">
<doc xml:space="preserve">Retrieves the #SoupMessagePriority. If not set this value defaults
to #SOUP_MESSAGE_PRIORITY_NORMAL.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the priority of the message.</doc>
<type name="MessagePriority" c:type="SoupMessagePriority"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_soup_request"
c:identifier="soup_message_get_soup_request"
version="2.42">
<doc xml:space="preserve">If @msg is associated with a #SoupRequest, this returns that
request. Otherwise it returns %NULL.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">@msg's associated #SoupRequest</doc>
<type name="Request" c:type="SoupRequest*"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_uri" c:identifier="soup_message_get_uri">
<doc xml:space="preserve">Gets @msg's URI</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the URI @msg is targeted for.</doc>
<type name="URI" c:type="SoupURI*"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
</parameters>
</method>
<method name="got_body" c:identifier="soup_message_got_body">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
</parameters>
</method>
<method name="got_chunk" c:identifier="soup_message_got_chunk">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
<parameter name="chunk" transfer-ownership="none">
<type name="Buffer" c:type="SoupBuffer*"/>
</parameter>
</parameters>
</method>
<method name="got_headers" c:identifier="soup_message_got_headers">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
</parameters>
</method>
<method name="got_informational"
c:identifier="soup_message_got_informational">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_keepalive" c:identifier="soup_message_is_keepalive">
<doc xml:space="preserve">Determines whether or not @msg's connection can be kept alive for
further requests after processing @msg, based on the HTTP version,
Connection header, etc.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE or %FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
</parameters>
</method>
<method name="restarted" c:identifier="soup_message_restarted">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_chunk_allocator"
c:identifier="soup_message_set_chunk_allocator"
deprecated="1">
<doc xml:space="preserve">Sets an alternate chunk-allocation function to use when reading
@msg's body when using the traditional (ie,
non-#SoupRequest<!-- -->-based) API. Every time data is available
to read, libsoup will call @allocator, which should return a
#SoupBuffer. (See #SoupChunkAllocator for additional details.)
Libsoup will then read data from the network into that buffer, and
update the buffer's <literal>length</literal> to indicate how much
data it read.
Generally, a custom chunk allocator would be used in conjunction
with soup_message_body_set_accumulate() %FALSE and
#SoupMessage::got_chunk, as part of a strategy to avoid unnecessary
copying of data. However, you cannot assume that every call to the
allocator will be followed by a call to your
#SoupMessage::got_chunk handler; if an I/O error occurs, then the
buffer will be unreffed without ever having been used. If your
buffer-allocation strategy requires special cleanup, use
soup_buffer_new_with_owner() rather than doing the cleanup from the
#SoupMessage::got_chunk handler.
The other thing to remember when using non-accumulating message
bodies is that the buffer passed to the #SoupMessage::got_chunk
handler will be unreffed after the handler returns, just as it
would be in the non-custom-allocated case. If you want to hand the
chunk data off to some other part of your program to use later,
you'll need to ref the #SoupBuffer (or its owner, in the
soup_buffer_new_with_owner() case) to ensure that the data remains
valid.</doc>
<doc-deprecated xml:space="preserve">#SoupRequest provides a much simpler API that lets you
read the response directly into your own buffers without needing to
mess with callbacks, pausing/unpausing, etc.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
<parameter name="allocator"
transfer-ownership="none"
scope="notified"
closure="1"
destroy="2">
<doc xml:space="preserve">the chunk allocator callback</doc>
<type name="ChunkAllocator" c:type="SoupChunkAllocator"/>
</parameter>
<parameter name="user_data" transfer-ownership="none">
<doc xml:space="preserve">data to pass to @allocator</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="destroy_notify"
transfer-ownership="none"
scope="async">
<doc xml:space="preserve">destroy notifier to free @user_data when @msg is
destroyed</doc>
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
</parameter>
</parameters>
</method>
<method name="set_first_party"
c:identifier="soup_message_set_first_party"
version="2.30">
<doc xml:space="preserve">Sets @first_party as the main document #SoupURI for @msg. For
details of when and how this is used refer to the documentation for
#SoupCookieJarAcceptPolicy.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
<parameter name="first_party" transfer-ownership="none">
<doc xml:space="preserve">the #SoupURI for the @msg's first party</doc>
<type name="URI" c:type="SoupURI*"/>
</parameter>
</parameters>
</method>
<method name="set_flags" c:identifier="soup_message_set_flags">
<doc xml:space="preserve">Sets the specified flags on @msg.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:space="preserve">a set of #SoupMessageFlags values</doc>
<type name="MessageFlags" c:type="SoupMessageFlags"/>
</parameter>
</parameters>
</method>
<method name="set_http_version"
c:identifier="soup_message_set_http_version">
<doc xml:space="preserve">Sets the HTTP version on @msg. The default version is
%SOUP_HTTP_1_1. Setting it to %SOUP_HTTP_1_0 will prevent certain
functionality from being used.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
<parameter name="version" transfer-ownership="none">
<doc xml:space="preserve">the HTTP version</doc>
<type name="HTTPVersion" c:type="SoupHTTPVersion"/>
</parameter>
</parameters>
</method>
<method name="set_priority"
c:identifier="soup_message_set_priority"
version="2.44">
<doc xml:space="preserve">Sets the priority of a message. Note that this won't have any
effect unless used before the message is added to the session's
message processing queue.
The message will be placed just before any other previously added
message with lower priority (messages with the same priority are
processed on a FIFO basis).
Setting priorities does not currently work with #SoupSessionSync
(or with synchronous messages on a plain #SoupSession) because in
the synchronous/blocking case, priority ends up being determined
semi-randomly by thread scheduling.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
<parameter name="priority" transfer-ownership="none">
<doc xml:space="preserve">the #SoupMessagePriority</doc>
<type name="MessagePriority" c:type="SoupMessagePriority"/>
</parameter>
</parameters>
</method>
<method name="set_redirect"
c:identifier="soup_message_set_redirect"
version="2.38">
<doc xml:space="preserve">Sets @msg's status_code to @status_code and adds a Location header
pointing to @redirect_uri. Use this from a #SoupServer when you
want to redirect the client to another URI.
@redirect_uri can be a relative URI, in which case it is
interpreted relative to @msg's current URI. In particular, if
@redirect_uri is just a path, it will replace the path
<emphasis>and query</emphasis> of @msg's URI.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
<parameter name="status_code" transfer-ownership="none">
<doc xml:space="preserve">a 3xx status code</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="redirect_uri" transfer-ownership="none">
<doc xml:space="preserve">the URI to redirect @msg to</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="set_request" c:identifier="soup_message_set_request">
<doc xml:space="preserve">Convenience function to set the request body of a #SoupMessage. If
@content_type is %NULL, the request body must be empty as well.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the message</doc>
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
<parameter name="content_type"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">MIME Content-Type of the body</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="req_use" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMemoryUse describing how to handle @req_body</doc>
<type name="MemoryUse" c:type="SoupMemoryUse"/>
</parameter>
<parameter name="req_body"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">
a data buffer containing the body of the message request.</doc>
<array length="3" zero-terminated="0" c:type="char*">
<type name="guint8"/>
</array>
</parameter>
<parameter name="req_length" transfer-ownership="none">
<doc xml:space="preserve">the byte length of @req_body.</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
</parameters>
</method>
<method name="set_response" c:identifier="soup_message_set_response">
<doc xml:space="preserve">Convenience function to set the response body of a #SoupMessage. If
@content_type is %NULL, the response body must be empty as well.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the message</doc>
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
<parameter name="content_type"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">MIME Content-Type of the body</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="resp_use" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMemoryUse describing how to handle @resp_body</doc>
<type name="MemoryUse" c:type="SoupMemoryUse"/>
</parameter>
<parameter name="resp_body"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">
a data buffer containing the body of the message response.</doc>
<array length="3" zero-terminated="0" c:type="char*">
<type name="guint8"/>
</array>
</parameter>
<parameter name="resp_length" transfer-ownership="none">
<doc xml:space="preserve">the byte length of @resp_body.</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
</parameters>
</method>
<method name="set_status" c:identifier="soup_message_set_status">
<doc xml:space="preserve">Sets @msg's status code to @status_code. If @status_code is a
known value, it will also set @msg's reason_phrase.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
<parameter name="status_code" transfer-ownership="none">
<doc xml:space="preserve">an HTTP status code</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="set_status_full"
c:identifier="soup_message_set_status_full">
<doc xml:space="preserve">Sets @msg's status code and reason phrase.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
<parameter name="status_code" transfer-ownership="none">
<doc xml:space="preserve">an HTTP status code</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="reason_phrase" transfer-ownership="none">
<doc xml:space="preserve">a description of the status</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="set_uri" c:identifier="soup_message_set_uri">
<doc xml:space="preserve">Sets @msg's URI to @uri. If @msg has already been sent and you want
to re-send it with the new URI, you need to call
soup_session_requeue_message().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">the new #SoupURI</doc>
<type name="URI" c:type="SoupURI*"/>
</parameter>
</parameters>
</method>
<method name="starting" c:identifier="soup_message_starting">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
</parameters>
</method>
<method name="wrote_body" c:identifier="soup_message_wrote_body">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
</parameters>
</method>
<method name="wrote_body_data"
c:identifier="soup_message_wrote_body_data">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
<parameter name="chunk" transfer-ownership="none">
<type name="Buffer" c:type="SoupBuffer*"/>
</parameter>
</parameters>
</method>
<method name="wrote_chunk" c:identifier="soup_message_wrote_chunk">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
</parameters>
</method>
<method name="wrote_headers" c:identifier="soup_message_wrote_headers">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
</parameters>
</method>
<method name="wrote_informational"
c:identifier="soup_message_wrote_informational">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</instance-parameter>
</parameters>
</method>
<property name="first-party"
version="2.30"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve">The #SoupURI loaded in the application when the message was
queued.</doc>
<type name="URI"/>
</property>
<property name="flags" writable="1" transfer-ownership="none">
<type name="MessageFlags"/>
</property>
<property name="http-version" writable="1" transfer-ownership="none">
<type name="HTTPVersion"/>
</property>
<property name="method" writable="1" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="priority" writable="1" transfer-ownership="none">
<type name="MessagePriority"/>
</property>
<property name="reason-phrase" writable="1" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="request-body" transfer-ownership="none">
<type name="MessageBody"/>
</property>
<property name="request-body-data"
version="2.46"
transfer-ownership="none">
<doc xml:space="preserve">The message's HTTP request body, as a #GBytes.</doc>
<type name="GLib.Bytes"/>
</property>
<property name="request-headers" transfer-ownership="none">
<type name="MessageHeaders"/>
</property>
<property name="response-body" transfer-ownership="none">
<type name="MessageBody"/>
</property>
<property name="response-body-data"
version="2.46"
transfer-ownership="none">
<doc xml:space="preserve">The message's HTTP response body, as a #GBytes.</doc>
<type name="GLib.Bytes"/>
</property>
<property name="response-headers" transfer-ownership="none">
<type name="MessageHeaders"/>
</property>
<property name="server-side"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="status-code" writable="1" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</property>
<property name="tls-certificate"
version="2.34"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve">The #GTlsCertificate associated with the message</doc>
<type name="Gio.TlsCertificate"/>
</property>
<property name="tls-errors"
version="2.34"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve">The verification errors on #SoupMessage:tls-certificate</doc>
<type name="Gio.TlsCertificateFlags"/>
</property>
<property name="uri" writable="1" transfer-ownership="none">
<type name="URI"/>
</property>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
<field name="method">
<doc xml:space="preserve">the HTTP method</doc>
<type name="utf8" c:type="const char*"/>
</field>
<field name="status_code">
<doc xml:space="preserve">the HTTP status code</doc>
<type name="guint" c:type="guint"/>
</field>
<field name="reason_phrase">
<doc xml:space="preserve">the status phrase associated with @status_code</doc>
<type name="utf8" c:type="char*"/>
</field>
<field name="request_body">
<doc xml:space="preserve">the request body</doc>
<type name="MessageBody" c:type="SoupMessageBody*"/>
</field>
<field name="request_headers">
<doc xml:space="preserve">the request headers</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</field>
<field name="response_body">
<doc xml:space="preserve">the response body</doc>
<type name="MessageBody" c:type="SoupMessageBody*"/>
</field>
<field name="response_headers">
<doc xml:space="preserve">the response headers</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</field>
<glib:signal name="content-sniffed" when="first" version="2.28">
<doc xml:space="preserve">This signal is emitted after #SoupMessage::got-headers, and
before the first #SoupMessage::got-chunk. If content
sniffing is disabled, or no content sniffing will be
performed, due to the sniffer deciding to trust the
Content-Type sent by the server, this signal is emitted
immediately after #SoupMessage::got-headers, and @type is
%NULL.
If the #SoupContentSniffer feature is enabled, and the
sniffer decided to perform sniffing, the first
#SoupMessage::got-chunk emission may be delayed, so that the
sniffer has enough data to correctly sniff the content. It
notified the library user that the content has been
sniffed, and allows it to change the header contents in the
message, if desired.
After this signal is emitted, the data that was spooled so
that sniffing could be done is delivered on the first
emission of #SoupMessage::got-chunk.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">the content type that we got from sniffing</doc>
<type name="utf8" c:type="gchar*"/>
</parameter>
<parameter name="params" transfer-ownership="none">
<doc xml:space="preserve">a #GHashTable with the parameters</doc>
<type name="GLib.HashTable">
<type name="utf8"/>
<type name="utf8"/>
</type>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="finished" when="first">
<doc xml:space="preserve">Emitted when all HTTP processing is finished for a message.
(After #SoupMessage::got_body for client-side messages, or
after #SoupMessage::wrote_body for server-side messages.)</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
<glib:signal name="got-body" when="first">
<doc xml:space="preserve">Emitted after receiving the complete message body. (For a
server-side message, this means it has received the request
body. For a client-side message, this means it has received
the response body and is nearly done with the message.)
See also soup_message_add_header_handler() and
soup_message_add_status_code_handler(), which can be used
to connect to a subset of emissions of this signal.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
<glib:signal name="got-chunk" when="first">
<doc xml:space="preserve">Emitted after receiving a chunk of a message body. Note
that "chunk" in this context means any subpiece of the
body, not necessarily the specific HTTP 1.1 chunks sent by
the other side.
If you cancel or requeue @msg while processing this signal,
then the current HTTP I/O will be stopped after this signal
emission finished, and @msg's connection will be closed.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="chunk" transfer-ownership="none">
<doc xml:space="preserve">the just-read chunk</doc>
<type name="Buffer"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="got-headers" when="first">
<doc xml:space="preserve">Emitted after receiving all message headers for a message.
(For a client-side message, this is after receiving the
Status-Line and response headers; for a server-side
message, it is after receiving the Request-Line and request
headers.)
See also soup_message_add_header_handler() and
soup_message_add_status_code_handler(), which can be used
to connect to a subset of emissions of this signal.
If you cancel or requeue @msg while processing this signal,
then the current HTTP I/O will be stopped after this signal
emission finished, and @msg's connection will be closed.
(If you need to requeue a message--eg, after handling
authentication or redirection--it is usually better to
requeue it from a #SoupMessage::got_body handler rather
than a #SoupMessage::got_headers handler, so that the
existing HTTP connection can be reused.)</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
<glib:signal name="got-informational" when="first">
<doc xml:space="preserve">Emitted after receiving a 1xx (Informational) response for
a (client-side) message. The response_headers will be
filled in with the headers associated with the
informational response; however, those header values will
be erased after this signal is done.
If you cancel or requeue @msg while processing this signal,
then the current HTTP I/O will be stopped after this signal
emission finished, and @msg's connection will be closed.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
<glib:signal name="network-event" when="first" version="2.38">
<doc xml:space="preserve">Emitted to indicate that some network-related event
related to @msg has occurred. This essentially proxies the
#GSocketClient::event signal, but only for events that
occur while @msg "owns" the connection; if @msg is sent on
an existing persistent connection, then this signal will
not be emitted. (If you want to force the message to be
sent on a new connection, set the
%SOUP_MESSAGE_NEW_CONNECTION flag on it.)
See #GSocketClient::event for more information on what
the different values of @event correspond to, and what
@connection will be in each case.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="event" transfer-ownership="none">
<doc xml:space="preserve">the network event</doc>
<type name="Gio.SocketClientEvent"/>
</parameter>
<parameter name="connection" transfer-ownership="none">
<doc xml:space="preserve">the current state of the network connection</doc>
<type name="Gio.IOStream"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="restarted" when="first">
<doc xml:space="preserve">Emitted when a request that was already sent once is now
being sent again (eg, because the first attempt received a
redirection response, or because we needed to use
authentication).</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
<glib:signal name="starting" when="first" version="2.50">
<doc xml:space="preserve">Emitted just before a message is sent.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
<glib:signal name="wrote-body" when="first">
<doc xml:space="preserve">Emitted immediately after writing the complete body for a
message. (For a client-side message, this means that
libsoup is done writing and is now waiting for the response
from the server. For a server-side message, this means that
libsoup has finished writing the response and is nearly
done with the message.)</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
<glib:signal name="wrote-body-data" when="first" version="2.24">
<doc xml:space="preserve">Emitted immediately after writing a portion of the message
body to the network.
Unlike #SoupMessage::wrote_chunk, this is emitted after
every successful write() call, not only after finishing a
complete "chunk".</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="chunk" transfer-ownership="none">
<doc xml:space="preserve">the data written</doc>
<type name="Buffer"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="wrote-chunk" when="first">
<doc xml:space="preserve">Emitted immediately after writing a body chunk for a message.
Note that this signal is not parallel to
#SoupMessage::got_chunk; it is emitted only when a complete
chunk (added with soup_message_body_append() or
soup_message_body_append_buffer()) has been written. To get
more useful continuous progress information, use
#SoupMessage::wrote_body_data.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
<glib:signal name="wrote-headers" when="first">
<doc xml:space="preserve">Emitted immediately after writing the headers for a
message. (For a client-side message, this is after writing
the request headers; for a server-side message, it is after
writing the response headers.)</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
<glib:signal name="wrote-informational" when="first">
<doc xml:space="preserve">Emitted immediately after writing a 1xx (Informational)
response for a (server-side) message.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
</class>
<record name="MessageBody"
c:type="SoupMessageBody"
glib:type-name="SoupMessageBody"
glib:get-type="soup_message_body_get_type"
c:symbol-prefix="message_body">
<doc xml:space="preserve">A #SoupMessage request or response body.
Note that while @length always reflects the full length of the
message body, @data is normally %NULL, and will only be filled in
after soup_message_body_flatten() is called. For client-side
messages, this automatically happens for the response body after it
has been fully read, unless you set the
%SOUP_MESSAGE_OVERWRITE_CHUNKS flags. Likewise, for server-side
messages, the request body is automatically filled in after being
read.
As an added bonus, when @data is filled in, it is always terminated
with a '\0' byte (which is not reflected in @length).</doc>
<field name="data" writable="1">
<doc xml:space="preserve">the data</doc>
<type name="utf8" c:type="const char*"/>
</field>
<field name="length" writable="1">
<doc xml:space="preserve">length of @data</doc>
<type name="gint64" c:type="goffset"/>
</field>
<constructor name="new" c:identifier="soup_message_body_new">
<doc xml:space="preserve">Creates a new #SoupMessageBody. #SoupMessage uses this internally; you
will not normally need to call it yourself.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #SoupMessageBody.</doc>
<type name="MessageBody" c:type="SoupMessageBody*"/>
</return-value>
</constructor>
<method name="append"
c:identifier="soup_message_body_append"
shadowed-by="append_take">
<doc xml:space="preserve">Appends @length bytes from @data to @body according to @use.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="body" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageBody</doc>
<type name="MessageBody" c:type="SoupMessageBody*"/>
</instance-parameter>
<parameter name="use" transfer-ownership="none">
<doc xml:space="preserve">how to use @data</doc>
<type name="MemoryUse" c:type="SoupMemoryUse"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">data to append</doc>
<array length="2" zero-terminated="0" c:type="gconstpointer">
<type name="guint8"/>
</array>
</parameter>
<parameter name="length" transfer-ownership="none">
<doc xml:space="preserve">length of @data</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
</parameters>
</method>
<method name="append_buffer"
c:identifier="soup_message_body_append_buffer">
<doc xml:space="preserve">Appends the data from @buffer to @body. (#SoupMessageBody uses
#SoupBuffers internally, so this is normally a constant-time
operation that doesn't actually require copying the data in
@buffer.)</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="body" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageBody</doc>
<type name="MessageBody" c:type="SoupMessageBody*"/>
</instance-parameter>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">a #SoupBuffer</doc>
<type name="Buffer" c:type="SoupBuffer*"/>
</parameter>
</parameters>
</method>
<method name="append_take"
c:identifier="soup_message_body_append_take"
shadows="append"
version="2.32">
<doc xml:space="preserve">Appends @length bytes from @data to @body.
This function is exactly equivalent to soup_message_body_append()
with %SOUP_MEMORY_TAKE as second argument; it exists mainly for
convenience and simplifying language bindings.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="body" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageBody</doc>
<type name="MessageBody" c:type="SoupMessageBody*"/>
</instance-parameter>
<parameter name="data" transfer-ownership="full">
<doc xml:space="preserve">data to append</doc>
<array length="1" zero-terminated="0" c:type="guchar*">
<type name="guint8" c:type="guchar"/>
</array>
</parameter>
<parameter name="length" transfer-ownership="none">
<doc xml:space="preserve">length of @data</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
</parameters>
</method>
<method name="complete" c:identifier="soup_message_body_complete">
<doc xml:space="preserve">Tags @body as being complete; Call this when using chunked encoding
after you have appended the last chunk.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="body" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageBody</doc>
<type name="MessageBody" c:type="SoupMessageBody*"/>
</instance-parameter>
</parameters>
</method>
<method name="flatten" c:identifier="soup_message_body_flatten">
<doc xml:space="preserve">Fills in @body's data field with a buffer containing all of the
data in @body (plus an additional '\0' byte not counted by @body's
length field).</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #SoupBuffer containing the same data as @body.
(You must free this buffer if you do not want it.)</doc>
<type name="Buffer" c:type="SoupBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="body" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageBody</doc>
<type name="MessageBody" c:type="SoupMessageBody*"/>
</instance-parameter>
</parameters>
</method>
<method name="free" c:identifier="soup_message_body_free">
<doc xml:space="preserve">Frees @body. You will not normally need to use this, as
#SoupMessage frees its associated message bodies automatically.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="body" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageBody</doc>
<type name="MessageBody" c:type="SoupMessageBody*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_accumulate"
c:identifier="soup_message_body_get_accumulate"
version="2.24">
<doc xml:space="preserve">Gets the accumulate flag on @body; see
soup_message_body_set_accumulate() for details.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the accumulate flag for @body.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="body" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageBody</doc>
<type name="MessageBody" c:type="SoupMessageBody*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_chunk" c:identifier="soup_message_body_get_chunk">
<doc xml:space="preserve">Gets a #SoupBuffer containing data from @body starting at @offset.
The size of the returned chunk is unspecified. You can iterate
through the entire body by first calling
soup_message_body_get_chunk() with an offset of 0, and then on each
successive call, increment the offset by the length of the
previously-returned chunk.
If @offset is greater than or equal to the total length of @body,
then the return value depends on whether or not
soup_message_body_complete() has been called or not; if it has,
then soup_message_body_get_chunk() will return a 0-length chunk
(indicating the end of @body). If it has not, then
soup_message_body_get_chunk() will return %NULL (indicating that
@body may still potentially have more data, but that data is not
currently available).</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">a #SoupBuffer, or %NULL.</doc>
<type name="Buffer" c:type="SoupBuffer*"/>
</return-value>
<parameters>
<instance-parameter name="body" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageBody</doc>
<type name="MessageBody" c:type="SoupMessageBody*"/>
</instance-parameter>
<parameter name="offset" transfer-ownership="none">
<doc xml:space="preserve">an offset</doc>
<type name="gint64" c:type="goffset"/>
</parameter>
</parameters>
</method>
<method name="got_chunk"
c:identifier="soup_message_body_got_chunk"
version="2.24">
<doc xml:space="preserve">Handles the #SoupMessageBody part of receiving a chunk of data from
the network. Normally this means appending @chunk to @body, exactly
as with soup_message_body_append_buffer(), but if you have set
@body's accumulate flag to %FALSE, then that will not happen.
This is a low-level method which you should not normally need to
use.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="body" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageBody</doc>
<type name="MessageBody" c:type="SoupMessageBody*"/>
</instance-parameter>
<parameter name="chunk" transfer-ownership="none">
<doc xml:space="preserve">a #SoupBuffer received from the network</doc>
<type name="Buffer" c:type="SoupBuffer*"/>
</parameter>
</parameters>
</method>
<method name="set_accumulate"
c:identifier="soup_message_body_set_accumulate"
version="2.24">
<doc xml:space="preserve">Sets or clears the accumulate flag on @body. (The default value is
%TRUE.) If set to %FALSE, @body's %data field will not be filled in
after the body is fully sent/received, and the chunks that make up
@body may be discarded when they are no longer needed.
In particular, if you set this flag to %FALSE on an "incoming"
message body (that is, the #SoupMessage:response_body of a
client-side message, or #SoupMessage:request_body of a server-side
message), this will cause each chunk of the body to be discarded
after its corresponding #SoupMessage::got_chunk signal is emitted.
(This is equivalent to setting the deprecated
%SOUP_MESSAGE_OVERWRITE_CHUNKS flag on the message.)
If you set this flag to %FALSE on the #SoupMessage:response_body of
a server-side message, it will cause each chunk of the body to be
discarded after its corresponding #SoupMessage::wrote_chunk signal
is emitted.
If you set the flag to %FALSE on the #SoupMessage:request_body of a
client-side message, it will block the accumulation of chunks into
@body's %data field, but it will not normally cause the chunks to
be discarded after being written like in the server-side
#SoupMessage:response_body case, because the request body needs to
be kept around in case the request needs to be sent a second time
due to redirection or authentication. However, if you set the
%SOUP_MESSAGE_CAN_REBUILD flag on the message, then the chunks will
be discarded, and you will be responsible for recreating the
request body after the #SoupMessage::restarted signal is emitted.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="body" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageBody</doc>
<type name="MessageBody" c:type="SoupMessageBody*"/>
</instance-parameter>
<parameter name="accumulate" transfer-ownership="none">
<doc xml:space="preserve">whether or not to accumulate body chunks in @body</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="truncate" c:identifier="soup_message_body_truncate">
<doc xml:space="preserve">Deletes all of the data in @body.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="body" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageBody</doc>
<type name="MessageBody" c:type="SoupMessageBody*"/>
</instance-parameter>
</parameters>
</method>
<method name="wrote_chunk"
c:identifier="soup_message_body_wrote_chunk"
version="2.24">
<doc xml:space="preserve">Handles the #SoupMessageBody part of writing a chunk of data to the
network. Normally this is a no-op, but if you have set @body's
accumulate flag to %FALSE, then this will cause @chunk to be
discarded to free up memory.
This is a low-level method which you should not need to use, and
there are further restrictions on its proper use which are not
documented here.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="body" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageBody</doc>
<type name="MessageBody" c:type="SoupMessageBody*"/>
</instance-parameter>
<parameter name="chunk" transfer-ownership="none">
<doc xml:space="preserve">a #SoupBuffer returned from soup_message_body_get_chunk()</doc>
<type name="Buffer" c:type="SoupBuffer*"/>
</parameter>
</parameters>
</method>
</record>
<record name="MessageClass"
c:type="SoupMessageClass"
glib:is-gtype-struct-for="Message">
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="wrote_informational">
<callback name="wrote_informational">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="wrote_headers">
<callback name="wrote_headers">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="wrote_chunk">
<callback name="wrote_chunk">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="wrote_body">
<callback name="wrote_body">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="got_informational">
<callback name="got_informational">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="got_headers">
<callback name="got_headers">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="got_chunk">
<callback name="got_chunk">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="chunk" transfer-ownership="none">
<type name="Buffer" c:type="SoupBuffer*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="got_body">
<callback name="got_body">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="restarted">
<callback name="restarted">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="finished">
<callback name="finished">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="starting">
<callback name="starting">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</callback>
</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>
</record>
<bitfield name="MessageFlags"
glib:type-name="SoupMessageFlags"
glib:get-type="soup_message_flags_get_type"
c:type="SoupMessageFlags">
<doc xml:space="preserve">Various flags that can be set on a #SoupMessage to alter its
behavior.</doc>
<member name="no_redirect"
value="2"
c:identifier="SOUP_MESSAGE_NO_REDIRECT"
glib:nick="no-redirect">
<doc xml:space="preserve">The session should not follow redirect
(3xx) responses received by this message.</doc>
</member>
<member name="can_rebuild"
value="4"
c:identifier="SOUP_MESSAGE_CAN_REBUILD"
glib:nick="can-rebuild">
<doc xml:space="preserve">The caller will rebuild the request
body if the message is restarted; see
soup_message_body_set_accumulate() for more details.</doc>
</member>
<member name="overwrite_chunks"
value="8"
c:identifier="SOUP_MESSAGE_OVERWRITE_CHUNKS"
glib:nick="overwrite-chunks">
<doc xml:space="preserve">Deprecated: equivalent to calling
soup_message_body_set_accumulate() on the incoming message body
(ie, #SoupMessage:response_body for a client-side request),
passing %FALSE.</doc>
</member>
<member name="content_decoded"
value="16"
c:identifier="SOUP_MESSAGE_CONTENT_DECODED"
glib:nick="content-decoded">
<doc xml:space="preserve">Set by #SoupContentDecoder to
indicate that it has removed the Content-Encoding on a message (and
so headers such as Content-Length may no longer accurately describe
the body).</doc>
</member>
<member name="certificate_trusted"
value="32"
c:identifier="SOUP_MESSAGE_CERTIFICATE_TRUSTED"
glib:nick="certificate-trusted">
<doc xml:space="preserve">if set after an https response
has been received, indicates that the server's SSL certificate is
trusted according to the session's CA.</doc>
</member>
<member name="new_connection"
value="64"
c:identifier="SOUP_MESSAGE_NEW_CONNECTION"
glib:nick="new-connection">
<doc xml:space="preserve">Requests that the message should be
sent on a newly-created connection, not reusing an existing
persistent connection. Note that messages with non-idempotent
#SoupMessage:method<!-- -->s behave this way by default, unless
#SOUP_MESSAGE_IDEMPOTENT is set.</doc>
</member>
<member name="idempotent"
value="128"
c:identifier="SOUP_MESSAGE_IDEMPOTENT"
glib:nick="idempotent">
<doc xml:space="preserve">The message is considered idempotent,
regardless its #SoupMessage:method, and allows reuse of existing
idle connections, instead of always requiring a new one, unless
#SOUP_MESSAGE_NEW_CONNECTION is set.</doc>
</member>
<member name="ignore_connection_limits"
value="256"
c:identifier="SOUP_MESSAGE_IGNORE_CONNECTION_LIMITS"
glib:nick="ignore-connection-limits">
<doc xml:space="preserve">Request that a new connection is
created for the message if there aren't idle connections available
and it's not possible to create new connections due to any of the
connection limits has been reached. If a dedicated connection is
eventually created for this message, it will be dropped when the
message finishes. Since 2.50</doc>
</member>
</bitfield>
<record name="MessageHeaders"
c:type="SoupMessageHeaders"
glib:type-name="SoupMessageHeaders"
glib:get-type="soup_message_headers_get_type"
c:symbol-prefix="message_headers">
<doc xml:space="preserve">The HTTP message headers associated with a request or response.</doc>
<constructor name="new" c:identifier="soup_message_headers_new">
<doc xml:space="preserve">Creates a #SoupMessageHeaders. (#SoupMessage does this
automatically for its own headers. You would only need to use this
method if you are manually parsing or generating message headers.)</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</return-value>
<parameters>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">the type of headers</doc>
<type name="MessageHeadersType" c:type="SoupMessageHeadersType"/>
</parameter>
</parameters>
</constructor>
<method name="append" c:identifier="soup_message_headers_append">
<doc xml:space="preserve">Appends a new header with name @name and value @value to @hdrs. (If
there is an existing header with name @name, then this creates a
second one, which is only allowed for list-valued headers; see also
soup_message_headers_replace().)
The caller is expected to make sure that @name and @value are
syntactically correct.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="hdrs" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</instance-parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">the header name to add</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">the new value of @name</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="clean_connection_headers"
c:identifier="soup_message_headers_clean_connection_headers"
version="2.36">
<doc xml:space="preserve">Removes all the headers listed in the Connection header.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="hdrs" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</instance-parameter>
</parameters>
</method>
<method name="clear" c:identifier="soup_message_headers_clear">
<doc xml:space="preserve">Clears @hdrs.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="hdrs" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</instance-parameter>
</parameters>
</method>
<method name="foreach" c:identifier="soup_message_headers_foreach">
<doc xml:space="preserve">Calls @func once for each header value in @hdrs.
Beware that unlike soup_message_headers_get(), this processes the
headers in exactly the way they were added, rather than
concatenating multiple same-named headers into a single value.
(This is intentional; it ensures that if you call
soup_message_headers_append() multiple times with the same name,
then the I/O code will output multiple copies of the header when
sending the message to the remote implementation, which may be
required for interoperability in some cases.)
You may not modify the headers from @func.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="hdrs" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</instance-parameter>
<parameter name="func"
transfer-ownership="none"
scope="call"
closure="1">
<doc xml:space="preserve">callback function to run for each header</doc>
<type name="MessageHeadersForeachFunc"
c:type="SoupMessageHeadersForeachFunc"/>
</parameter>
<parameter name="user_data" transfer-ownership="none">
<doc xml:space="preserve">data to pass to @func</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</method>
<method name="free" c:identifier="soup_message_headers_free">
<doc xml:space="preserve">Frees @hdrs.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="hdrs" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</instance-parameter>
</parameters>
</method>
<method name="free_ranges"
c:identifier="soup_message_headers_free_ranges"
version="2.26">
<doc xml:space="preserve">Frees the array of ranges returned from soup_message_headers_get_ranges().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="hdrs" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</instance-parameter>
<parameter name="ranges" transfer-ownership="none">
<doc xml:space="preserve">an array of #SoupRange</doc>
<type name="Range" c:type="SoupRange*"/>
</parameter>
</parameters>
</method>
<method name="get"
c:identifier="soup_message_headers_get"
deprecated="1">
<doc xml:space="preserve">Gets the value of header @name in @hdrs.
This method was supposed to work correctly for both single-valued
and list-valued headers, but because some HTTP clients/servers
mistakenly send multiple copies of headers that are supposed to be
single-valued, it sometimes returns incorrect results. To fix this,
the methods soup_message_headers_get_one() and
soup_message_headers_get_list() were introduced, so callers can
explicitly state which behavior they are expecting.</doc>
<doc-deprecated xml:space="preserve">Use soup_message_headers_get_one() or
soup_message_headers_get_list() instead.</doc-deprecated>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">as with soup_message_headers_get_list().</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<instance-parameter name="hdrs" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</instance-parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">header name</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="get_content_disposition"
c:identifier="soup_message_headers_get_content_disposition"
version="2.26">
<doc xml:space="preserve">Looks up the "Content-Disposition" header in @hdrs, parses it, and
returns its value in *@disposition and *@params. @params can be
%NULL if you are only interested in the disposition-type.
In HTTP, the most common use of this header is to set a
disposition-type of "attachment", to suggest to the browser that a
response should be saved to disk rather than displayed in the
browser. If @params contains a "filename" parameter, this is a
suggestion of a filename to use. (If the parameter value in the
header contains an absolute or relative path, libsoup will truncate
it down to just the final path component, so you do not need to
test this yourself.)
Content-Disposition is also used in "multipart/form-data", however
this is handled automatically by #SoupMultipart and the associated
form methods.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @hdrs contains a "Content-Disposition"
header, %FALSE if not (in which case *@disposition and *@params
will be unchanged).</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="hdrs" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</instance-parameter>
<parameter name="disposition"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">return location for the
disposition-type, or %NULL</doc>
<type name="utf8" c:type="char**"/>
</parameter>
<parameter name="params"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">return
location for the Content-Disposition parameters, or %NULL</doc>
<type name="GLib.HashTable" c:type="GHashTable**">
<type name="utf8"/>
<type name="utf8"/>
</type>
</parameter>
</parameters>
</method>
<method name="get_content_length"
c:identifier="soup_message_headers_get_content_length">
<doc xml:space="preserve">Gets the message body length that @hdrs declare. This will only
be non-0 if soup_message_headers_get_encoding() returns
%SOUP_ENCODING_CONTENT_LENGTH.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the message body length declared by @hdrs.</doc>
<type name="gint64" c:type="goffset"/>
</return-value>
<parameters>
<instance-parameter name="hdrs" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_content_range"
c:identifier="soup_message_headers_get_content_range"
version="2.26">
<doc xml:space="preserve">Parses @hdrs's Content-Range header and returns it in @start,
@end, and @total_length. If the total length field in the header
was specified as "*", then @total_length will be set to -1.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @hdrs contained a "Content-Range" header
containing a byte range which could be parsed, %FALSE otherwise.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="hdrs" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</instance-parameter>
<parameter name="start" transfer-ownership="none">
<doc xml:space="preserve">return value for the start of the range</doc>
<type name="gint64" c:type="goffset*"/>
</parameter>
<parameter name="end" transfer-ownership="none">
<doc xml:space="preserve">return value for the end of the range</doc>
<type name="gint64" c:type="goffset*"/>
</parameter>
<parameter name="total_length" transfer-ownership="none">
<doc xml:space="preserve">return value for the total length of the resource,
or %NULL if you don't care.</doc>
<type name="gint64" c:type="goffset*"/>
</parameter>
</parameters>
</method>
<method name="get_content_type"
c:identifier="soup_message_headers_get_content_type"
version="2.26">
<doc xml:space="preserve">Looks up the "Content-Type" header in @hdrs, parses it, and returns
its value in *@content_type and *@params. @params can be %NULL if you
are only interested in the content type itself.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">a string with the value of the
"Content-Type" header or %NULL if @hdrs does not contain that
header or it cannot be parsed (in which case *@params will be
unchanged).</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<instance-parameter name="hdrs" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</instance-parameter>
<parameter name="params"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">
return location for the Content-Type parameters (eg, "charset"), or
%NULL</doc>
<type name="GLib.HashTable" c:type="GHashTable**">
<type name="utf8"/>
<type name="utf8"/>
</type>
</parameter>
</parameters>
</method>
<method name="get_encoding"
c:identifier="soup_message_headers_get_encoding">
<doc xml:space="preserve">Gets the message body encoding that @hdrs declare. This may not
always correspond to the encoding used on the wire; eg, a HEAD
response may declare a Content-Length or Transfer-Encoding, but
it will never actually include a body.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the encoding declared by @hdrs.</doc>
<type name="Encoding" c:type="SoupEncoding"/>
</return-value>
<parameters>
<instance-parameter name="hdrs" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_expectations"
c:identifier="soup_message_headers_get_expectations">
<doc xml:space="preserve">Gets the expectations declared by @hdrs's "Expect" header.
Currently this will either be %SOUP_EXPECTATION_CONTINUE or
%SOUP_EXPECTATION_UNRECOGNIZED.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the contents of @hdrs's "Expect" header</doc>
<type name="Expectation" c:type="SoupExpectation"/>
</return-value>
<parameters>
<instance-parameter name="hdrs" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_headers_type"
c:identifier="soup_message_headers_get_headers_type"
version="2.50">
<doc xml:space="preserve">Gets the type of headers.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the header's type.</doc>
<type name="MessageHeadersType" c:type="SoupMessageHeadersType"/>
</return-value>
<parameters>
<instance-parameter name="hdrs" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_list"
c:identifier="soup_message_headers_get_list"
version="2.28">
<doc xml:space="preserve">Gets the value of header @name in @hdrs. Use this for headers whose
values are comma-delimited lists, and which are therefore allowed
to appear multiple times in the headers. For non-list-valued
headers, use soup_message_headers_get_one().
If @name appears multiple times in @hdrs,
soup_message_headers_get_list() will concatenate all of the values
together, separated by commas. This is sometimes awkward to parse
(eg, WWW-Authenticate, Set-Cookie), but you have to be able to deal
with it anyway, because the HTTP spec explicitly states that this
transformation is allowed, and so an upstream proxy could do the
same thing.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">the header's value or %NULL if not found.</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<instance-parameter name="hdrs" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</instance-parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">header name</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="get_one"
c:identifier="soup_message_headers_get_one"
version="2.28">
<doc xml:space="preserve">Gets the value of header @name in @hdrs. Use this for headers whose
values are <emphasis>not</emphasis> comma-delimited lists, and
which therefore can only appear at most once in the headers. For
list-valued headers, use soup_message_headers_get_list().
If @hdrs does erroneously contain multiple copies of the header, it
is not defined which one will be returned. (Ideally, it will return
whichever one makes libsoup most compatible with other HTTP
implementations.)</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">the header's value or %NULL if not found.</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<instance-parameter name="hdrs" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</instance-parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">header name</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="get_ranges"
c:identifier="soup_message_headers_get_ranges"
version="2.26">
<doc xml:space="preserve">Parses @hdrs's Range header and returns an array of the requested
byte ranges. The returned array must be freed with
soup_message_headers_free_ranges().
If @total_length is non-0, its value will be used to adjust the
returned ranges to have explicit start and end values, and the
returned ranges will be sorted and non-overlapping. If
@total_length is 0, then some ranges may have an end value of -1,
as described under #SoupRange, and some of the ranges may be
redundant.
Beware that even if given a @total_length, this function does not
check that the ranges are satisfiable.
<note><para>
#SoupServer has built-in handling for range requests. If your
server handler returns a %SOUP_STATUS_OK response containing the
complete response body (rather than pausing the message and
returning some of the response body later), and there is a Range
header in the request, then libsoup will automatically convert the
response to a %SOUP_STATUS_PARTIAL_CONTENT response containing only
the range(s) requested by the client.
The only time you need to process the Range header yourself is if
either you need to stream the response body rather than returning
it all at once, or you do not already have the complete response
body available, and only want to generate the parts that were
actually requested by the client.
</para></note></doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @hdrs contained a syntactically-valid
"Range" header, %FALSE otherwise (in which case @range and @length
will not be set).</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="hdrs" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</instance-parameter>
<parameter name="total_length" transfer-ownership="none">
<doc xml:space="preserve">the total_length of the response body</doc>
<type name="gint64" c:type="goffset"/>
</parameter>
<parameter name="ranges"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">return location for an array
of #SoupRange</doc>
<array length="2" zero-terminated="0" c:type="SoupRange**">
<type name="Range" c:type="SoupRange*"/>
</array>
</parameter>
<parameter name="length"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">the length of the returned array</doc>
<type name="gint" c:type="int*"/>
</parameter>
</parameters>
</method>
<method name="header_contains"
c:identifier="soup_message_headers_header_contains"
version="2.50">
<doc xml:space="preserve">Checks whether the list-valued header @name is present in @hdrs,
and contains a case-insensitive match for @token.
(If @name is present in @hdrs, then this is equivalent to calling
soup_header_contains() on its value.)</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the header is present and contains @token,
%FALSE otherwise.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="hdrs" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</instance-parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">header name</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="token" transfer-ownership="none">
<doc xml:space="preserve">token to look for</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="header_equals"
c:identifier="soup_message_headers_header_equals"
version="2.50">
<doc xml:space="preserve">Checks whether the header @name is present in @hdrs and is
(case-insensitively) equal to @value.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the header is present and its value is
@value, %FALSE otherwise.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="hdrs" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</instance-parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">header name</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">expected value</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="remove" c:identifier="soup_message_headers_remove">
<doc xml:space="preserve">Removes @name from @hdrs. If there are multiple values for @name,
they are all removed.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="hdrs" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</instance-parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">the header name to remove</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="replace" c:identifier="soup_message_headers_replace">
<doc xml:space="preserve">Replaces the value of the header @name in @hdrs with @value. (See
also soup_message_headers_append().)
The caller is expected to make sure that @name and @value are
syntactically correct.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="hdrs" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</instance-parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">the header name to replace</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">the new value of @name</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="set_content_disposition"
c:identifier="soup_message_headers_set_content_disposition"
version="2.26">
<doc xml:space="preserve">Sets the "Content-Disposition" header in @hdrs to @disposition,
optionally with additional parameters specified in @params.
See soup_message_headers_get_content_disposition() for a discussion
of how Content-Disposition is used in HTTP.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="hdrs" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</instance-parameter>
<parameter name="disposition" transfer-ownership="none">
<doc xml:space="preserve">the disposition-type</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="params"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">additional
parameters, or %NULL</doc>
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="utf8"/>
<type name="utf8"/>
</type>
</parameter>
</parameters>
</method>
<method name="set_content_length"
c:identifier="soup_message_headers_set_content_length">
<doc xml:space="preserve">Sets the message body length that @hdrs will declare, and sets
@hdrs's encoding to %SOUP_ENCODING_CONTENT_LENGTH.
You do not normally need to call this; if @hdrs is set to use
Content-Length encoding, libsoup will automatically set its
Content-Length header for you immediately before sending the
headers. One situation in which this method is useful is when
generating the response to a HEAD request; Calling
soup_message_headers_set_content_length() allows you to put the
correct content length into the response without needing to waste
memory by filling in a response body which won't actually be sent.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="hdrs" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</instance-parameter>
<parameter name="content_length" transfer-ownership="none">
<doc xml:space="preserve">the message body length</doc>
<type name="gint64" c:type="goffset"/>
</parameter>
</parameters>
</method>
<method name="set_content_range"
c:identifier="soup_message_headers_set_content_range"
version="2.26">
<doc xml:space="preserve">Sets @hdrs's Content-Range header according to the given values.
(Note that @total_length is the total length of the entire resource
that this is a range of, not simply @end - @start + 1.)
<note><para>
#SoupServer has built-in handling for range requests, and you do
not normally need to call this function youself. See
soup_message_headers_get_ranges() for more details.
</para></note></doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="hdrs" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</instance-parameter>
<parameter name="start" transfer-ownership="none">
<doc xml:space="preserve">the start of the range</doc>
<type name="gint64" c:type="goffset"/>
</parameter>
<parameter name="end" transfer-ownership="none">
<doc xml:space="preserve">the end of the range</doc>
<type name="gint64" c:type="goffset"/>
</parameter>
<parameter name="total_length" transfer-ownership="none">
<doc xml:space="preserve">the total length of the resource, or -1 if unknown</doc>
<type name="gint64" c:type="goffset"/>
</parameter>
</parameters>
</method>
<method name="set_content_type"
c:identifier="soup_message_headers_set_content_type"
version="2.26">
<doc xml:space="preserve">Sets the "Content-Type" header in @hdrs to @content_type,
optionally with additional parameters specified in @params.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="hdrs" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</instance-parameter>
<parameter name="content_type" transfer-ownership="none">
<doc xml:space="preserve">the MIME type</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="params"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">additional
parameters, or %NULL</doc>
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="utf8"/>
<type name="utf8"/>
</type>
</parameter>
</parameters>
</method>
<method name="set_encoding"
c:identifier="soup_message_headers_set_encoding">
<doc xml:space="preserve">Sets the message body encoding that @hdrs will declare. In particular,
you should use this if you are going to send a request or response in
chunked encoding.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="hdrs" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</instance-parameter>
<parameter name="encoding" transfer-ownership="none">
<doc xml:space="preserve">a #SoupEncoding</doc>
<type name="Encoding" c:type="SoupEncoding"/>
</parameter>
</parameters>
</method>
<method name="set_expectations"
c:identifier="soup_message_headers_set_expectations">
<doc xml:space="preserve">Sets @hdrs's "Expect" header according to @expectations.
Currently %SOUP_EXPECTATION_CONTINUE is the only known expectation
value. You should set this value on a request if you are sending a
large message body (eg, via POST or PUT), and want to give the
server a chance to reject the request after seeing just the headers
(eg, because it will require authentication before allowing you to
post, or because you're POSTing to a URL that doesn't exist). This
saves you from having to transmit the large request body when the
server is just going to ignore it anyway.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="hdrs" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</instance-parameter>
<parameter name="expectations" transfer-ownership="none">
<doc xml:space="preserve">the expectations to set</doc>
<type name="Expectation" c:type="SoupExpectation"/>
</parameter>
</parameters>
</method>
<method name="set_range"
c:identifier="soup_message_headers_set_range"
version="2.26">
<doc xml:space="preserve">Sets @hdrs's Range header to request the indicated range.
@start and @end are interpreted as in a #SoupRange.
If you need to request multiple ranges, use
soup_message_headers_set_ranges().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="hdrs" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</instance-parameter>
<parameter name="start" transfer-ownership="none">
<doc xml:space="preserve">the start of the range to request</doc>
<type name="gint64" c:type="goffset"/>
</parameter>
<parameter name="end" transfer-ownership="none">
<doc xml:space="preserve">the end of the range to request</doc>
<type name="gint64" c:type="goffset"/>
</parameter>
</parameters>
</method>
<method name="set_ranges"
c:identifier="soup_message_headers_set_ranges"
version="2.26">
<doc xml:space="preserve">Sets @hdrs's Range header to request the indicated ranges. (If you
only want to request a single range, you can use
soup_message_headers_set_range().)</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="hdrs" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</instance-parameter>
<parameter name="ranges" transfer-ownership="none">
<doc xml:space="preserve">an array of #SoupRange</doc>
<type name="Range" c:type="SoupRange*"/>
</parameter>
<parameter name="length" transfer-ownership="none">
<doc xml:space="preserve">the length of @range</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</method>
</record>
<callback name="MessageHeadersForeachFunc"
c:type="SoupMessageHeadersForeachFunc">
<doc xml:space="preserve">The callback passed to soup_message_headers_foreach().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">the header name</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">the header value</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" closure="2">
<doc xml:space="preserve">the data passed to soup_message_headers_foreach()</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<record name="MessageHeadersIter" c:type="SoupMessageHeadersIter">
<doc xml:space="preserve">An opaque type used to iterate over a %SoupMessageHeaders
structure.
After intializing the iterator with
soup_message_headers_iter_init(), call
soup_message_headers_iter_next() to fetch data from it.
You may not modify the headers while iterating over them.</doc>
<field name="dummy" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="3">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
<method name="next" c:identifier="soup_message_headers_iter_next">
<doc xml:space="preserve">Yields the next name/value pair in the %SoupMessageHeaders being
iterated by @iter. If @iter has already yielded the last header,
then soup_message_headers_iter_next() will return %FALSE and @name
and @value will be unchanged.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if another name and value were returned, %FALSE
if the end of the headers has been reached.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="iter"
direction="inout"
caller-allocates="0"
transfer-ownership="none">
<doc xml:space="preserve">a %SoupMessageHeadersIter</doc>
<type name="MessageHeadersIter" c:type="SoupMessageHeadersIter*"/>
</instance-parameter>
<parameter name="name"
direction="out"
caller-allocates="0"
transfer-ownership="none">
<doc xml:space="preserve">pointer to a variable to return
the header name in</doc>
<type name="utf8" c:type="const char**"/>
</parameter>
<parameter name="value"
direction="out"
caller-allocates="0"
transfer-ownership="none">
<doc xml:space="preserve">pointer to a variable to return
the header value in</doc>
<type name="utf8" c:type="const char**"/>
</parameter>
</parameters>
</method>
<function name="init" c:identifier="soup_message_headers_iter_init">
<doc xml:space="preserve">Initializes @iter for iterating @hdrs.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="iter"
direction="out"
caller-allocates="1"
transfer-ownership="none">
<doc xml:space="preserve">a pointer to a %SoupMessageHeadersIter
structure</doc>
<type name="MessageHeadersIter" c:type="SoupMessageHeadersIter*"/>
</parameter>
<parameter name="hdrs" transfer-ownership="none">
<doc xml:space="preserve">a %SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</parameter>
</parameters>
</function>
</record>
<enumeration name="MessageHeadersType"
glib:type-name="SoupMessageHeadersType"
glib:get-type="soup_message_headers_type_get_type"
c:type="SoupMessageHeadersType">
<doc xml:space="preserve">Value passed to soup_message_headers_new() to set certain default
behaviors.</doc>
<member name="request"
value="0"
c:identifier="SOUP_MESSAGE_HEADERS_REQUEST"
glib:nick="request">
<doc xml:space="preserve">request headers</doc>
</member>
<member name="response"
value="1"
c:identifier="SOUP_MESSAGE_HEADERS_RESPONSE"
glib:nick="response">
<doc xml:space="preserve">response headers</doc>
</member>
<member name="multipart"
value="2"
c:identifier="SOUP_MESSAGE_HEADERS_MULTIPART"
glib:nick="multipart">
<doc xml:space="preserve">multipart body part headers</doc>
</member>
</enumeration>
<enumeration name="MessagePriority"
glib:type-name="SoupMessagePriority"
glib:get-type="soup_message_priority_get_type"
c:type="SoupMessagePriority">
<doc xml:space="preserve">Priorities that can be set on a #SoupMessage to instruct the
message queue to process it before any other message with lower
priority.</doc>
<member name="very_low"
value="0"
c:identifier="SOUP_MESSAGE_PRIORITY_VERY_LOW"
glib:nick="very-low">
<doc xml:space="preserve">The lowest priority, the messages
with this priority will be the last ones to be attended.</doc>
</member>
<member name="low"
value="1"
c:identifier="SOUP_MESSAGE_PRIORITY_LOW"
glib:nick="low">
<doc xml:space="preserve">Use this for low priority messages, a
#SoupMessage with the default priority will be processed first.</doc>
</member>
<member name="normal"
value="2"
c:identifier="SOUP_MESSAGE_PRIORITY_NORMAL"
glib:nick="normal">
<doc xml:space="preserve">The default priotity, this is the
priority assigned to the #SoupMessage by default.</doc>
</member>
<member name="high"
value="3"
c:identifier="SOUP_MESSAGE_PRIORITY_HIGH"
glib:nick="high">
<doc xml:space="preserve">High priority, a #SoupMessage with
this priority will be processed before the ones with the default
priority.</doc>
</member>
<member name="very_high"
value="4"
c:identifier="SOUP_MESSAGE_PRIORITY_VERY_HIGH"
glib:nick="very-high">
<doc xml:space="preserve">The highest priority, use this
for very urgent #SoupMessage as they will be the first ones to be
attended.</doc>
</member>
</enumeration>
<record name="MessageQueue" c:type="SoupMessageQueue" disguised="1">
</record>
<record name="MessageQueueItem"
c:type="SoupMessageQueueItem"
disguised="1">
</record>
<record name="Multipart"
c:type="SoupMultipart"
version="2.26"
glib:type-name="SoupMultipart"
glib:get-type="soup_multipart_get_type"
c:symbol-prefix="multipart">
<doc xml:space="preserve">Represents a multipart HTTP message body, parsed according to the
syntax of RFC 2046. Of particular interest to HTTP are
<literal>multipart/byte-ranges</literal> and
<literal>multipart/form-data</literal>.
Although the headers of a #SoupMultipart body part will contain the
full headers from that body part, libsoup does not interpret them
according to MIME rules. For example, each body part is assumed to
have "binary" Content-Transfer-Encoding, even if its headers
explicitly state otherwise. In other words, don't try to use
#SoupMultipart for handling real MIME multiparts.</doc>
<constructor name="new" c:identifier="soup_multipart_new" version="2.26">
<doc xml:space="preserve">Creates a new empty #SoupMultipart with a randomly-generated
boundary string. Note that @mime_type must be the full MIME type,
including "multipart/".</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new empty #SoupMultipart of the given @mime_type</doc>
<type name="Multipart" c:type="SoupMultipart*"/>
</return-value>
<parameters>
<parameter name="mime_type" transfer-ownership="none">
<doc xml:space="preserve">the MIME type of the multipart to create.</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_from_message"
c:identifier="soup_multipart_new_from_message"
version="2.26">
<doc xml:space="preserve">Parses @headers and @body to form a new #SoupMultipart</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">a new #SoupMultipart (or %NULL if the
message couldn't be parsed or wasn't multipart).</doc>
<type name="Multipart" c:type="SoupMultipart*"/>
</return-value>
<parameters>
<parameter name="headers" transfer-ownership="none">
<doc xml:space="preserve">the headers of the HTTP message to parse</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</parameter>
<parameter name="body" transfer-ownership="none">
<doc xml:space="preserve">the body of the HTTP message to parse</doc>
<type name="MessageBody" c:type="SoupMessageBody*"/>
</parameter>
</parameters>
</constructor>
<method name="append_form_file"
c:identifier="soup_multipart_append_form_file"
version="2.26">
<doc xml:space="preserve">Adds a new MIME part containing @body to @multipart, using
"Content-Disposition: form-data", as per the HTML forms
specification. See soup_form_request_new_from_multipart() for more
details.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="multipart" transfer-ownership="none">
<doc xml:space="preserve">a multipart (presumably of type "multipart/form-data")</doc>
<type name="Multipart" c:type="SoupMultipart*"/>
</instance-parameter>
<parameter name="control_name" transfer-ownership="none">
<doc xml:space="preserve">the name of the control associated with this file</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="filename" transfer-ownership="none">
<doc xml:space="preserve">the name of the file, or %NULL if not known</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="content_type" transfer-ownership="none">
<doc xml:space="preserve">the MIME type of the file, or %NULL if not known</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="body" transfer-ownership="none">
<doc xml:space="preserve">the file data</doc>
<type name="Buffer" c:type="SoupBuffer*"/>
</parameter>
</parameters>
</method>
<method name="append_form_string"
c:identifier="soup_multipart_append_form_string"
version="2.26">
<doc xml:space="preserve">Adds a new MIME part containing @data to @multipart, using
"Content-Disposition: form-data", as per the HTML forms
specification. See soup_form_request_new_from_multipart() for more
details.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="multipart" transfer-ownership="none">
<doc xml:space="preserve">a multipart (presumably of type "multipart/form-data")</doc>
<type name="Multipart" c:type="SoupMultipart*"/>
</instance-parameter>
<parameter name="control_name" transfer-ownership="none">
<doc xml:space="preserve">the name of the control associated with @data</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">the body data</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="append_part"
c:identifier="soup_multipart_append_part"
version="2.26">
<doc xml:space="preserve">Adds a new MIME part to @multipart with the given headers and body.
(The multipart will make its own copies of @headers and @body, so
you should free your copies if you are not using them for anything
else.)</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="multipart" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMultipart</doc>
<type name="Multipart" c:type="SoupMultipart*"/>
</instance-parameter>
<parameter name="headers" transfer-ownership="none">
<doc xml:space="preserve">the MIME part headers</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</parameter>
<parameter name="body" transfer-ownership="none">
<doc xml:space="preserve">the MIME part body</doc>
<type name="Buffer" c:type="SoupBuffer*"/>
</parameter>
</parameters>
</method>
<method name="free" c:identifier="soup_multipart_free" version="2.26">
<doc xml:space="preserve">Frees @multipart</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="multipart" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMultipart</doc>
<type name="Multipart" c:type="SoupMultipart*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_length"
c:identifier="soup_multipart_get_length"
version="2.26">
<doc xml:space="preserve">Gets the number of body parts in @multipart</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the number of body parts in @multipart</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<instance-parameter name="multipart" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMultipart</doc>
<type name="Multipart" c:type="SoupMultipart*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_part"
c:identifier="soup_multipart_get_part"
version="2.26">
<doc xml:space="preserve">Gets the indicated body part from @multipart.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE on success, %FALSE if @part is out of range (in
which case @headers and @body won't be set)</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="multipart" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMultipart</doc>
<type name="Multipart" c:type="SoupMultipart*"/>
</instance-parameter>
<parameter name="part" transfer-ownership="none">
<doc xml:space="preserve">the part number to get (counting from 0)</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="headers"
direction="out"
caller-allocates="0"
transfer-ownership="none">
<doc xml:space="preserve">return location for the MIME part
headers</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders**"/>
</parameter>
<parameter name="body"
direction="out"
caller-allocates="0"
transfer-ownership="none">
<doc xml:space="preserve">return location for the MIME part
body</doc>
<type name="Buffer" c:type="SoupBuffer**"/>
</parameter>
</parameters>
</method>
<method name="to_message"
c:identifier="soup_multipart_to_message"
version="2.26">
<doc xml:space="preserve">Serializes @multipart to @dest_headers and @dest_body.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="multipart" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMultipart</doc>
<type name="Multipart" c:type="SoupMultipart*"/>
</instance-parameter>
<parameter name="dest_headers" transfer-ownership="none">
<doc xml:space="preserve">the headers of the HTTP message to serialize @multipart to</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</parameter>
<parameter name="dest_body" transfer-ownership="none">
<doc xml:space="preserve">the body of the HTTP message to serialize @multipart to</doc>
<type name="MessageBody" c:type="SoupMessageBody*"/>
</parameter>
</parameters>
</method>
</record>
<class name="MultipartInputStream"
c:symbol-prefix="multipart_input_stream"
c:type="SoupMultipartInputStream"
parent="Gio.FilterInputStream"
glib:type-name="SoupMultipartInputStream"
glib:get-type="soup_multipart_input_stream_get_type"
glib:type-struct="MultipartInputStreamClass">
<implements name="Gio.PollableInputStream"/>
<constructor name="new"
c:identifier="soup_multipart_input_stream_new"
version="2.40">
<doc xml:space="preserve">Creates a new #SoupMultipartInputStream that wraps the
#GInputStream obtained by sending the #SoupRequest. Reads should
not be done directly through this object, use the input streams
returned by soup_multipart_input_stream_next_part() or its async
counterpart instead.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #SoupMultipartInputStream</doc>
<type name="MultipartInputStream"
c:type="SoupMultipartInputStream*"/>
</return-value>
<parameters>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the #SoupMessage the response is related to.</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="base_stream" transfer-ownership="none">
<doc xml:space="preserve">the #GInputStream returned by sending the request.</doc>
<type name="Gio.InputStream" c:type="GInputStream*"/>
</parameter>
</parameters>
</constructor>
<method name="get_headers"
c:identifier="soup_multipart_input_stream_get_headers"
version="2.40">
<doc xml:space="preserve">Obtains the headers for the part currently being processed. Note
that the #SoupMessageHeaders that are returned are owned by the
#SoupMultipartInputStream and will be replaced when a call is made
to soup_multipart_input_stream_next_part() or its async
counterpart, so if keeping the headers is required, a copy must be
made.
Note that if a part had no headers at all an empty #SoupMessageHeaders
will be returned.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">a #SoupMessageHeaders
containing the headers for the part currently being processed or
%NULL if the headers failed to parse.</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</return-value>
<parameters>
<instance-parameter name="multipart" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMultipartInputStream.</doc>
<type name="MultipartInputStream"
c:type="SoupMultipartInputStream*"/>
</instance-parameter>
</parameters>
</method>
<method name="next_part"
c:identifier="soup_multipart_input_stream_next_part"
version="2.40"
throws="1">
<doc xml:space="preserve">Obtains an input stream for the next part. When dealing with a
multipart response the input stream needs to be wrapped in a
#SoupMultipartInputStream and this function or its async
counterpart need to be called to obtain the first part for
reading.
After calling this function,
soup_multipart_input_stream_get_headers() can be used to obtain the
headers for the first part. A read of 0 bytes indicates the end of
the part; a new call to this function should be done at that point,
to obtain the next part.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">a new #GInputStream, or
%NULL if there are no more parts</doc>
<type name="Gio.InputStream" c:type="GInputStream*"/>
</return-value>
<parameters>
<instance-parameter name="multipart" transfer-ownership="none">
<doc xml:space="preserve">the #SoupMultipartInputStream</doc>
<type name="MultipartInputStream"
c:type="SoupMultipartInputStream*"/>
</instance-parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GCancellable</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
</parameters>
</method>
<method name="next_part_async"
c:identifier="soup_multipart_input_stream_next_part_async"
version="2.40">
<doc xml:space="preserve">Obtains a #GInputStream for the next request. See
soup_multipart_input_stream_next_part() for details on the
workflow.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="multipart" transfer-ownership="none">
<doc xml:space="preserve">the #SoupMultipartInputStream.</doc>
<type name="MultipartInputStream"
c:type="SoupMultipartInputStream*"/>
</instance-parameter>
<parameter name="io_priority" transfer-ownership="none">
<doc xml:space="preserve">the I/O priority for the request.</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GCancellable.</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async"
closure="3">
<doc xml:space="preserve">callback to call when request is satisfied.</doc>
<type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">data for @callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</method>
<method name="next_part_finish"
c:identifier="soup_multipart_input_stream_next_part_finish"
version="2.40"
throws="1">
<doc xml:space="preserve">Finishes an asynchronous request for the next part.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">a newly created
#GInputStream for reading the next part or %NULL if there are no
more parts.</doc>
<type name="Gio.InputStream" c:type="GInputStream*"/>
</return-value>
<parameters>
<instance-parameter name="multipart" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMultipartInputStream.</doc>
<type name="MultipartInputStream"
c:type="SoupMultipartInputStream*"/>
</instance-parameter>
<parameter name="result" transfer-ownership="none">
<doc xml:space="preserve">a #GAsyncResult.</doc>
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
</parameter>
</parameters>
</method>
<property name="message"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="Message"/>
</property>
<field name="parent_instance">
<type name="Gio.FilterInputStream" c:type="GFilterInputStream"/>
</field>
<field name="priv" readable="0" private="1">
<type name="MultipartInputStreamPrivate"
c:type="SoupMultipartInputStreamPrivate*"/>
</field>
</class>
<record name="MultipartInputStreamClass"
c:type="SoupMultipartInputStreamClass"
glib:is-gtype-struct-for="MultipartInputStream">
<field name="parent_class">
<type name="Gio.FilterInputStreamClass"
c:type="GFilterInputStreamClass"/>
</field>
</record>
<record name="MultipartInputStreamPrivate"
c:type="SoupMultipartInputStreamPrivate"
disguised="1">
</record>
<constant name="PASSWORD_MANAGER_H"
value="1"
c:type="SOUP_PASSWORD_MANAGER_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="PROXY_RESOLVER_DEFAULT_H"
value="1"
c:type="SOUP_PROXY_RESOLVER_DEFAULT_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="PROXY_URI_RESOLVER_H"
value="1"
c:type="SOUP_PROXY_URI_RESOLVER_H">
<type name="gint" c:type="gint"/>
</constant>
<interface name="PasswordManager"
c:symbol-prefix="password_manager"
c:type="SoupPasswordManager"
glib:type-name="SoupPasswordManager"
glib:get-type="soup_password_manager_get_type"
glib:type-struct="PasswordManagerInterface">
<prerequisite name="SessionFeature"/>
<virtual-method name="get_passwords_async" invoker="get_passwords_async">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="password_manager"
transfer-ownership="none">
<type name="PasswordManager" c:type="SoupPasswordManager*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="auth" transfer-ownership="none">
<type name="Auth" c:type="SoupAuth*"/>
</parameter>
<parameter name="retrying" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
<parameter name="async_context" transfer-ownership="none">
<type name="GLib.MainContext" c:type="GMainContext*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
scope="async"
closure="6">
<type name="PasswordManagerCallback"
c:type="SoupPasswordManagerCallback"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" closure="6">
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="get_passwords_sync" invoker="get_passwords_sync">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="password_manager"
transfer-ownership="none">
<type name="PasswordManager" c:type="SoupPasswordManager*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="auth" transfer-ownership="none">
<type name="Auth" c:type="SoupAuth*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
</parameters>
</virtual-method>
<method name="get_passwords_async"
c:identifier="soup_password_manager_get_passwords_async">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="password_manager"
transfer-ownership="none">
<type name="PasswordManager" c:type="SoupPasswordManager*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="auth" transfer-ownership="none">
<type name="Auth" c:type="SoupAuth*"/>
</parameter>
<parameter name="retrying" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
<parameter name="async_context" transfer-ownership="none">
<type name="GLib.MainContext" c:type="GMainContext*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
scope="async"
closure="6">
<type name="PasswordManagerCallback"
c:type="SoupPasswordManagerCallback"/>
</parameter>
<parameter name="user_data" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</method>
<method name="get_passwords_sync"
c:identifier="soup_password_manager_get_passwords_sync">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="password_manager"
transfer-ownership="none">
<type name="PasswordManager" c:type="SoupPasswordManager*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="auth" transfer-ownership="none">
<type name="Auth" c:type="SoupAuth*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
</parameters>
</method>
</interface>
<callback name="PasswordManagerCallback"
c:type="SoupPasswordManagerCallback">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="password_manager" transfer-ownership="none">
<type name="PasswordManager" c:type="SoupPasswordManager*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="auth" transfer-ownership="none">
<type name="Auth" c:type="SoupAuth*"/>
</parameter>
<parameter name="retrying" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" closure="4">
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<record name="PasswordManagerInterface"
c:type="SoupPasswordManagerInterface"
glib:is-gtype-struct-for="PasswordManager">
<field name="base">
<type name="GObject.TypeInterface" c:type="GTypeInterface"/>
</field>
<field name="get_passwords_async">
<callback name="get_passwords_async">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="password_manager" transfer-ownership="none">
<type name="PasswordManager" c:type="SoupPasswordManager*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="auth" transfer-ownership="none">
<type name="Auth" c:type="SoupAuth*"/>
</parameter>
<parameter name="retrying" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
<parameter name="async_context" transfer-ownership="none">
<type name="GLib.MainContext" c:type="GMainContext*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
scope="async"
closure="7">
<type name="PasswordManagerCallback"
c:type="SoupPasswordManagerCallback"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" closure="7">
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
</field>
<field name="get_passwords_sync">
<callback name="get_passwords_sync">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="password_manager" transfer-ownership="none">
<type name="PasswordManager" c:type="SoupPasswordManager*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="auth" transfer-ownership="none">
<type name="Auth" c:type="SoupAuth*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
</parameters>
</callback>
</field>
</record>
<class name="ProxyResolverDefault"
c:symbol-prefix="proxy_resolver_default"
c:type="SoupProxyResolverDefault"
parent="GObject.Object"
glib:type-name="SoupProxyResolverDefault"
glib:get-type="soup_proxy_resolver_default_get_type"
glib:type-struct="ProxyResolverDefaultClass">
<implements name="ProxyURIResolver"/>
<implements name="SessionFeature"/>
<property name="gproxy-resolver"
readable="0"
writable="1"
transfer-ownership="none">
<type name="Gio.ProxyResolver"/>
</property>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
</class>
<record name="ProxyResolverDefaultClass"
c:type="SoupProxyResolverDefaultClass"
glib:is-gtype-struct-for="ProxyResolverDefault">
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<interface name="ProxyURIResolver"
c:symbol-prefix="proxy_uri_resolver"
c:type="SoupProxyURIResolver"
glib:type-name="SoupProxyURIResolver"
glib:get-type="soup_proxy_uri_resolver_get_type"
glib:type-struct="ProxyURIResolverInterface">
<prerequisite name="SessionFeature"/>
<virtual-method name="get_proxy_uri_async"
invoker="get_proxy_uri_async"
version="2.26.3"
deprecated="1">
<doc xml:space="preserve">Asynchronously determines a proxy URI to use for @msg and calls
@callback.</doc>
<doc-deprecated xml:space="preserve">#SoupProxyURIResolver is deprecated in favor of
#GProxyResolver</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="proxy_uri_resolver"
transfer-ownership="none">
<doc xml:space="preserve">the #SoupProxyURIResolver</doc>
<type name="ProxyURIResolver" c:type="SoupProxyURIResolver*"/>
</instance-parameter>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">the #SoupURI you want a proxy for</doc>
<type name="URI" c:type="SoupURI*"/>
</parameter>
<parameter name="async_context"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the #GMainContext to invoke @callback in</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, or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
scope="async"
closure="4">
<doc xml:space="preserve">callback to invoke with the proxy address</doc>
<type name="ProxyURIResolverCallback"
c:type="SoupProxyURIResolverCallback"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" closure="4">
<doc xml:space="preserve">data for @callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="get_proxy_uri_sync"
invoker="get_proxy_uri_sync"
version="2.26.3"
deprecated="1">
<doc xml:space="preserve">Synchronously determines a proxy URI to use for @uri. If @uri
should be sent via proxy, *@proxy_uri will be set to the URI of the
proxy, else it will be set to %NULL.</doc>
<doc-deprecated xml:space="preserve">#SoupProxyURIResolver is deprecated in favor of
#GProxyResolver</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%SOUP_STATUS_OK if successful, or a transport-level
error.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="proxy_uri_resolver"
transfer-ownership="none">
<doc xml:space="preserve">the #SoupProxyURIResolver</doc>
<type name="ProxyURIResolver" c:type="SoupProxyURIResolver*"/>
</instance-parameter>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">the #SoupURI you want a proxy for</doc>
<type name="URI" c:type="SoupURI*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GCancellable, or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="proxy_uri"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">on return, will contain the proxy URI</doc>
<type name="URI" c:type="SoupURI**"/>
</parameter>
</parameters>
</virtual-method>
<method name="get_proxy_uri_async"
c:identifier="soup_proxy_uri_resolver_get_proxy_uri_async"
version="2.26.3"
deprecated="1">
<doc xml:space="preserve">Asynchronously determines a proxy URI to use for @msg and calls
@callback.</doc>
<doc-deprecated xml:space="preserve">#SoupProxyURIResolver is deprecated in favor of
#GProxyResolver</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="proxy_uri_resolver"
transfer-ownership="none">
<doc xml:space="preserve">the #SoupProxyURIResolver</doc>
<type name="ProxyURIResolver" c:type="SoupProxyURIResolver*"/>
</instance-parameter>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">the #SoupURI you want a proxy for</doc>
<type name="URI" c:type="SoupURI*"/>
</parameter>
<parameter name="async_context"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the #GMainContext to invoke @callback in</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, or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
scope="async"
closure="4">
<doc xml:space="preserve">callback to invoke with the proxy address</doc>
<type name="ProxyURIResolverCallback"
c:type="SoupProxyURIResolverCallback"/>
</parameter>
<parameter name="user_data" transfer-ownership="none">
<doc xml:space="preserve">data for @callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</method>
<method name="get_proxy_uri_sync"
c:identifier="soup_proxy_uri_resolver_get_proxy_uri_sync"
version="2.26.3"
deprecated="1">
<doc xml:space="preserve">Synchronously determines a proxy URI to use for @uri. If @uri
should be sent via proxy, *@proxy_uri will be set to the URI of the
proxy, else it will be set to %NULL.</doc>
<doc-deprecated xml:space="preserve">#SoupProxyURIResolver is deprecated in favor of
#GProxyResolver</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%SOUP_STATUS_OK if successful, or a transport-level
error.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="proxy_uri_resolver"
transfer-ownership="none">
<doc xml:space="preserve">the #SoupProxyURIResolver</doc>
<type name="ProxyURIResolver" c:type="SoupProxyURIResolver*"/>
</instance-parameter>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">the #SoupURI you want a proxy for</doc>
<type name="URI" c:type="SoupURI*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GCancellable, or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="proxy_uri"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">on return, will contain the proxy URI</doc>
<type name="URI" c:type="SoupURI**"/>
</parameter>
</parameters>
</method>
</interface>
<callback name="ProxyURIResolverCallback"
c:type="SoupProxyURIResolverCallback">
<doc xml:space="preserve">Callback for soup_proxy_uri_resolver_get_proxy_uri_async()</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="resolver" transfer-ownership="none">
<doc xml:space="preserve">the #SoupProxyURIResolver</doc>
<type name="ProxyURIResolver" c:type="SoupProxyURIResolver*"/>
</parameter>
<parameter name="status" transfer-ownership="none">
<doc xml:space="preserve">a #SoupStatus</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="proxy_uri" transfer-ownership="none">
<doc xml:space="preserve">the resolved proxy URI, or %NULL</doc>
<type name="URI" c:type="SoupURI*"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" closure="3">
<doc xml:space="preserve">data passed to soup_proxy_uri_resolver_get_proxy_uri_async()</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<record name="ProxyURIResolverInterface"
c:type="SoupProxyURIResolverInterface"
glib:is-gtype-struct-for="ProxyURIResolver">
<field name="base">
<type name="GObject.TypeInterface" c:type="GTypeInterface"/>
</field>
<field name="get_proxy_uri_async">
<callback name="get_proxy_uri_async">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="proxy_uri_resolver" transfer-ownership="none">
<doc xml:space="preserve">the #SoupProxyURIResolver</doc>
<type name="ProxyURIResolver" c:type="SoupProxyURIResolver*"/>
</parameter>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">the #SoupURI you want a proxy for</doc>
<type name="URI" c:type="SoupURI*"/>
</parameter>
<parameter name="async_context"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the #GMainContext to invoke @callback in</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, or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
scope="async"
closure="5">
<doc xml:space="preserve">callback to invoke with the proxy address</doc>
<type name="ProxyURIResolverCallback"
c:type="SoupProxyURIResolverCallback"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" closure="5">
<doc xml:space="preserve">data for @callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
</field>
<field name="get_proxy_uri_sync">
<callback name="get_proxy_uri_sync">
<return-value transfer-ownership="none">
<doc xml:space="preserve">%SOUP_STATUS_OK if successful, or a transport-level
error.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<parameter name="proxy_uri_resolver" transfer-ownership="none">
<doc xml:space="preserve">the #SoupProxyURIResolver</doc>
<type name="ProxyURIResolver" c:type="SoupProxyURIResolver*"/>
</parameter>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">the #SoupURI you want a proxy for</doc>
<type name="URI" c:type="SoupURI*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GCancellable, or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="proxy_uri"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">on return, will contain the proxy URI</doc>
<type name="URI" c:type="SoupURI**"/>
</parameter>
</parameters>
</callback>
</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>
<constant name="REQUESTER_H" value="1" c:type="SOUP_REQUESTER_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="REQUEST_DATA_H" value="1" c:type="SOUP_REQUEST_DATA_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="REQUEST_FILE_H" value="1" c:type="SOUP_REQUEST_FILE_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="REQUEST_H" value="1" c:type="SOUP_REQUEST_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="REQUEST_HTTP_H" value="1" c:type="SOUP_REQUEST_HTTP_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="REQUEST_SESSION"
value="session"
c:type="SOUP_REQUEST_SESSION"
version="2.42">
<doc xml:space="preserve">Alias for the #SoupRequest:session property, qv.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="REQUEST_URI"
value="uri"
c:type="SOUP_REQUEST_URI"
version="2.42">
<doc xml:space="preserve">Alias for the #SoupRequest:uri property, qv.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<record name="Range" c:type="SoupRange" version="2.26">
<doc xml:space="preserve">Represents a byte range as used in the Range header.
If @end is non-negative, then @start and @end represent the bounds
of of the range, counting from 0. (Eg, the first 500 bytes would be
represented as @start = 0 and @end = 499.)
If @end is -1 and @start is non-negative, then this represents a
range starting at @start and ending with the last byte of the
requested resource body. (Eg, all but the first 500 bytes would be
@start = 500, and @end = -1.)
If @end is -1 and @start is negative, then it represents a "suffix
range", referring to the last -@start bytes of the resource body.
(Eg, the last 500 bytes would be @start = -500 and @end = -1.)</doc>
<field name="start" writable="1">
<doc xml:space="preserve">the start of the range</doc>
<type name="gint64" c:type="goffset"/>
</field>
<field name="end" writable="1">
<doc xml:space="preserve">the end of the range</doc>
<type name="gint64" c:type="goffset"/>
</field>
</record>
<class name="Request"
c:symbol-prefix="request"
c:type="SoupRequest"
version="2.42"
parent="GObject.Object"
glib:type-name="SoupRequest"
glib:get-type="soup_request_get_type"
glib:type-struct="RequestClass">
<doc xml:space="preserve">A request to retrieve a particular URI.</doc>
<implements name="Gio.Initable"/>
<virtual-method name="check_uri" throws="1">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="req_base" transfer-ownership="none">
<type name="Request" c:type="SoupRequest*"/>
</instance-parameter>
<parameter name="uri" transfer-ownership="none">
<type name="URI" c:type="SoupURI*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="get_content_length"
invoker="get_content_length"
version="2.42">
<doc xml:space="preserve">Gets the length of the data represented by @request. For most
request types, this will not be known until after you call
soup_request_send() or soup_request_send_finish().</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the length of the data represented by @request,
or -1 if not known.</doc>
<type name="gint64" c:type="goffset"/>
</return-value>
<parameters>
<instance-parameter name="request" transfer-ownership="none">
<doc xml:space="preserve">a #SoupRequest</doc>
<type name="Request" c:type="SoupRequest*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="get_content_type"
invoker="get_content_type"
version="2.42">
<doc xml:space="preserve">Gets the type of the data represented by @request. For most request
types, this will not be known until after you call
soup_request_send() or soup_request_send_finish().
As in the HTTP Content-Type header, this may include parameters
after the MIME type.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">the type of the data represented by
@request, or %NULL if not known.</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<instance-parameter name="request" transfer-ownership="none">
<doc xml:space="preserve">a #SoupRequest</doc>
<type name="Request" c:type="SoupRequest*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="send" invoker="send" version="2.42" throws="1">
<doc xml:space="preserve">Synchronously requests the URI pointed to by @request, and returns
a #GInputStream that can be used to read its contents.
Note that you cannot use this method with #SoupRequests attached to
a #SoupSessionAsync.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GInputStream that can be used to
read from the URI pointed to by @request.</doc>
<type name="Gio.InputStream" c:type="GInputStream*"/>
</return-value>
<parameters>
<instance-parameter name="request" transfer-ownership="none">
<doc xml:space="preserve">a #SoupRequest</doc>
<type name="Request" c:type="SoupRequest*"/>
</instance-parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GCancellable or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="send_async" invoker="send_async" version="2.42">
<doc xml:space="preserve">Begins an asynchronously request for the URI pointed to by
@request.
Note that you cannot use this method with #SoupRequests attached to
a #SoupSessionSync.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="request" transfer-ownership="none">
<doc xml:space="preserve">a #SoupRequest</doc>
<type name="Request" c:type="SoupRequest*"/>
</instance-parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GCancellable or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async"
closure="2">
<doc xml:space="preserve">a #GAsyncReadyCallback</doc>
<type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" closure="2">
<doc xml:space="preserve">user data passed to @callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="send_finish"
invoker="send_finish"
version="2.42"
throws="1">
<doc xml:space="preserve">Gets the result of a soup_request_send_async().</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GInputStream that can be used to
read from the URI pointed to by @request.</doc>
<type name="Gio.InputStream" c:type="GInputStream*"/>
</return-value>
<parameters>
<instance-parameter name="request" transfer-ownership="none">
<doc xml:space="preserve">a #SoupRequest</doc>
<type name="Request" c:type="SoupRequest*"/>
</instance-parameter>
<parameter name="result" transfer-ownership="none">
<doc xml:space="preserve">the #GAsyncResult</doc>
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
</parameter>
</parameters>
</virtual-method>
<method name="get_content_length"
c:identifier="soup_request_get_content_length"
version="2.42">
<doc xml:space="preserve">Gets the length of the data represented by @request. For most
request types, this will not be known until after you call
soup_request_send() or soup_request_send_finish().</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the length of the data represented by @request,
or -1 if not known.</doc>
<type name="gint64" c:type="goffset"/>
</return-value>
<parameters>
<instance-parameter name="request" transfer-ownership="none">
<doc xml:space="preserve">a #SoupRequest</doc>
<type name="Request" c:type="SoupRequest*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_content_type"
c:identifier="soup_request_get_content_type"
version="2.42">
<doc xml:space="preserve">Gets the type of the data represented by @request. For most request
types, this will not be known until after you call
soup_request_send() or soup_request_send_finish().
As in the HTTP Content-Type header, this may include parameters
after the MIME type.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">the type of the data represented by
@request, or %NULL if not known.</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<instance-parameter name="request" transfer-ownership="none">
<doc xml:space="preserve">a #SoupRequest</doc>
<type name="Request" c:type="SoupRequest*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_session"
c:identifier="soup_request_get_session"
version="2.42">
<doc xml:space="preserve">Gets @request's #SoupSession</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">@request's #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</return-value>
<parameters>
<instance-parameter name="request" transfer-ownership="none">
<doc xml:space="preserve">a #SoupRequest</doc>
<type name="Request" c:type="SoupRequest*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_uri"
c:identifier="soup_request_get_uri"
version="2.42">
<doc xml:space="preserve">Gets @request's URI</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">@request's URI</doc>
<type name="URI" c:type="SoupURI*"/>
</return-value>
<parameters>
<instance-parameter name="request" transfer-ownership="none">
<doc xml:space="preserve">a #SoupRequest</doc>
<type name="Request" c:type="SoupRequest*"/>
</instance-parameter>
</parameters>
</method>
<method name="send"
c:identifier="soup_request_send"
version="2.42"
throws="1">
<doc xml:space="preserve">Synchronously requests the URI pointed to by @request, and returns
a #GInputStream that can be used to read its contents.
Note that you cannot use this method with #SoupRequests attached to
a #SoupSessionAsync.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GInputStream that can be used to
read from the URI pointed to by @request.</doc>
<type name="Gio.InputStream" c:type="GInputStream*"/>
</return-value>
<parameters>
<instance-parameter name="request" transfer-ownership="none">
<doc xml:space="preserve">a #SoupRequest</doc>
<type name="Request" c:type="SoupRequest*"/>
</instance-parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GCancellable or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
</parameters>
</method>
<method name="send_async"
c:identifier="soup_request_send_async"
version="2.42">
<doc xml:space="preserve">Begins an asynchronously request for the URI pointed to by
@request.
Note that you cannot use this method with #SoupRequests attached to
a #SoupSessionSync.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="request" transfer-ownership="none">
<doc xml:space="preserve">a #SoupRequest</doc>
<type name="Request" c:type="SoupRequest*"/>
</instance-parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GCancellable or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async"
closure="2">
<doc xml:space="preserve">a #GAsyncReadyCallback</doc>
<type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
</parameter>
<parameter name="user_data" transfer-ownership="none">
<doc xml:space="preserve">user data passed to @callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</method>
<method name="send_finish"
c:identifier="soup_request_send_finish"
version="2.42"
throws="1">
<doc xml:space="preserve">Gets the result of a soup_request_send_async().</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GInputStream that can be used to
read from the URI pointed to by @request.</doc>
<type name="Gio.InputStream" c:type="GInputStream*"/>
</return-value>
<parameters>
<instance-parameter name="request" transfer-ownership="none">
<doc xml:space="preserve">a #SoupRequest</doc>
<type name="Request" c:type="SoupRequest*"/>
</instance-parameter>
<parameter name="result" transfer-ownership="none">
<doc xml:space="preserve">the #GAsyncResult</doc>
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
</parameter>
</parameters>
</method>
<property name="session"
version="2.42"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve">The request's #SoupSession.</doc>
<type name="Session"/>
</property>
<property name="uri"
version="2.42"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve">The request URI.</doc>
<type name="URI"/>
</property>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
<field name="priv">
<type name="RequestPrivate" c:type="SoupRequestPrivate*"/>
</field>
</class>
<record name="RequestClass"
c:type="SoupRequestClass"
glib:is-gtype-struct-for="Request">
<field name="parent">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="schemes">
<type name="utf8" c:type="const char**"/>
</field>
<field name="check_uri">
<callback name="check_uri" throws="1">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="req_base" transfer-ownership="none">
<type name="Request" c:type="SoupRequest*"/>
</parameter>
<parameter name="uri" transfer-ownership="none">
<type name="URI" c:type="SoupURI*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="send">
<callback name="send" throws="1">
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GInputStream that can be used to
read from the URI pointed to by @request.</doc>
<type name="Gio.InputStream" c:type="GInputStream*"/>
</return-value>
<parameters>
<parameter name="request" transfer-ownership="none">
<doc xml:space="preserve">a #SoupRequest</doc>
<type name="Request" c:type="SoupRequest*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GCancellable or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="send_async">
<callback name="send_async">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="request" transfer-ownership="none">
<doc xml:space="preserve">a #SoupRequest</doc>
<type name="Request" c:type="SoupRequest*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GCancellable or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async"
closure="3">
<doc xml:space="preserve">a #GAsyncReadyCallback</doc>
<type name="Gio.AsyncReadyCallback"
c:type="GAsyncReadyCallback"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" closure="3">
<doc xml:space="preserve">user data passed to @callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
</field>
<field name="send_finish">
<callback name="send_finish" throws="1">
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GInputStream that can be used to
read from the URI pointed to by @request.</doc>
<type name="Gio.InputStream" c:type="GInputStream*"/>
</return-value>
<parameters>
<parameter name="request" transfer-ownership="none">
<doc xml:space="preserve">a #SoupRequest</doc>
<type name="Request" c:type="SoupRequest*"/>
</parameter>
<parameter name="result" transfer-ownership="none">
<doc xml:space="preserve">the #GAsyncResult</doc>
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="get_content_length">
<callback name="get_content_length">
<return-value transfer-ownership="none">
<doc xml:space="preserve">the length of the data represented by @request,
or -1 if not known.</doc>
<type name="gint64" c:type="goffset"/>
</return-value>
<parameters>
<parameter name="request" transfer-ownership="none">
<doc xml:space="preserve">a #SoupRequest</doc>
<type name="Request" c:type="SoupRequest*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="get_content_type">
<callback name="get_content_type">
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">the type of the data represented by
@request, or %NULL if not known.</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<parameter name="request" transfer-ownership="none">
<doc xml:space="preserve">a #SoupRequest</doc>
<type name="Request" c:type="SoupRequest*"/>
</parameter>
</parameters>
</callback>
</field>
</record>
<class name="RequestData"
c:symbol-prefix="request_data"
c:type="SoupRequestData"
parent="Request"
glib:type-name="SoupRequestData"
glib:get-type="soup_request_data_get_type"
glib:type-struct="RequestDataClass">
<implements name="Gio.Initable"/>
<field name="parent">
<type name="Request" c:type="SoupRequest"/>
</field>
<field name="priv">
<type name="RequestDataPrivate" c:type="SoupRequestDataPrivate*"/>
</field>
</class>
<record name="RequestDataClass"
c:type="SoupRequestDataClass"
glib:is-gtype-struct-for="RequestData">
<field name="parent">
<type name="RequestClass" c:type="SoupRequestClass"/>
</field>
</record>
<record name="RequestDataPrivate"
c:type="SoupRequestDataPrivate"
disguised="1">
</record>
<enumeration name="RequestError"
version="2.42"
glib:type-name="SoupRequestError"
glib:get-type="soup_request_error_get_type"
c:type="SoupRequestError"
glib:error-domain="soup_request_error_quark">
<doc xml:space="preserve">A #SoupRequest error.</doc>
<member name="bad_uri"
value="0"
c:identifier="SOUP_REQUEST_ERROR_BAD_URI"
glib:nick="bad-uri">
<doc xml:space="preserve">the URI could not be parsed</doc>
</member>
<member name="unsupported_uri_scheme"
value="1"
c:identifier="SOUP_REQUEST_ERROR_UNSUPPORTED_URI_SCHEME"
glib:nick="unsupported-uri-scheme">
<doc xml:space="preserve">the URI scheme is not
supported by this #SoupSession</doc>
</member>
<member name="parsing"
value="2"
c:identifier="SOUP_REQUEST_ERROR_PARSING"
glib:nick="parsing">
<doc xml:space="preserve">the server's response could not
be parsed</doc>
</member>
<member name="encoding"
value="3"
c:identifier="SOUP_REQUEST_ERROR_ENCODING"
glib:nick="encoding">
<doc xml:space="preserve">the server's response was in an
unsupported format</doc>
</member>
<function name="quark" c:identifier="soup_request_error_quark">
<return-value transfer-ownership="none">
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
</enumeration>
<class name="RequestFile"
c:symbol-prefix="request_file"
c:type="SoupRequestFile"
parent="Request"
glib:type-name="SoupRequestFile"
glib:get-type="soup_request_file_get_type"
glib:type-struct="RequestFileClass">
<implements name="Gio.Initable"/>
<method name="get_file"
c:identifier="soup_request_file_get_file"
version="2.40">
<doc xml:space="preserve">Gets a #GFile corresponding to @file's URI</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GFile corresponding to @file</doc>
<type name="Gio.File" c:type="GFile*"/>
</return-value>
<parameters>
<instance-parameter name="file" transfer-ownership="none">
<doc xml:space="preserve">a #SoupRequestFile</doc>
<type name="RequestFile" c:type="SoupRequestFile*"/>
</instance-parameter>
</parameters>
</method>
<field name="parent">
<type name="Request" c:type="SoupRequest"/>
</field>
<field name="priv">
<type name="RequestFilePrivate" c:type="SoupRequestFilePrivate*"/>
</field>
</class>
<record name="RequestFileClass"
c:type="SoupRequestFileClass"
glib:is-gtype-struct-for="RequestFile">
<field name="parent">
<type name="RequestClass" c:type="SoupRequestClass"/>
</field>
</record>
<record name="RequestFilePrivate"
c:type="SoupRequestFilePrivate"
disguised="1">
</record>
<class name="RequestHTTP"
c:symbol-prefix="request_http"
c:type="SoupRequestHTTP"
parent="Request"
glib:type-name="SoupRequestHTTP"
glib:get-type="soup_request_http_get_type"
glib:type-struct="RequestHTTPClass">
<implements name="Gio.Initable"/>
<method name="get_message"
c:identifier="soup_request_http_get_message"
version="2.40">
<doc xml:space="preserve">Gets a new reference to the #SoupMessage associated to this SoupRequest</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new reference to the #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</return-value>
<parameters>
<instance-parameter name="http" transfer-ownership="none">
<doc xml:space="preserve">a #SoupRequestHTTP object</doc>
<type name="RequestHTTP" c:type="SoupRequestHTTP*"/>
</instance-parameter>
</parameters>
</method>
<field name="parent">
<type name="Request" c:type="SoupRequest"/>
</field>
<field name="priv">
<type name="RequestHTTPPrivate" c:type="SoupRequestHTTPPrivate*"/>
</field>
</class>
<record name="RequestHTTPClass"
c:type="SoupRequestHTTPClass"
glib:is-gtype-struct-for="RequestHTTP">
<field name="parent">
<type name="RequestClass" c:type="SoupRequestClass"/>
</field>
</record>
<record name="RequestHTTPPrivate"
c:type="SoupRequestHTTPPrivate"
disguised="1">
</record>
<record name="RequestPrivate" c:type="SoupRequestPrivate" disguised="1">
</record>
<class name="Requester"
c:symbol-prefix="requester"
c:type="SoupRequester"
parent="GObject.Object"
glib:type-name="SoupRequester"
glib:get-type="soup_requester_get_type"
glib:type-struct="RequesterClass">
<implements name="SessionFeature"/>
<constructor name="new" c:identifier="soup_requester_new">
<return-value transfer-ownership="full">
<type name="Requester" c:type="SoupRequester*"/>
</return-value>
</constructor>
<method name="request" c:identifier="soup_requester_request" throws="1">
<return-value transfer-ownership="full">
<type name="Request" c:type="SoupRequest*"/>
</return-value>
<parameters>
<instance-parameter name="requester" transfer-ownership="none">
<type name="Requester" c:type="SoupRequester*"/>
</instance-parameter>
<parameter name="uri_string" transfer-ownership="none">
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="request_uri"
c:identifier="soup_requester_request_uri"
throws="1">
<return-value transfer-ownership="full">
<type name="Request" c:type="SoupRequest*"/>
</return-value>
<parameters>
<instance-parameter name="requester" transfer-ownership="none">
<type name="Requester" c:type="SoupRequester*"/>
</instance-parameter>
<parameter name="uri" transfer-ownership="none">
<type name="URI" c:type="SoupURI*"/>
</parameter>
</parameters>
</method>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
<field name="priv">
<type name="RequesterPrivate" c:type="SoupRequesterPrivate*"/>
</field>
</class>
<record name="RequesterClass"
c:type="SoupRequesterClass"
glib:is-gtype-struct-for="Requester">
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<enumeration name="RequesterError"
glib:type-name="SoupRequesterError"
glib:get-type="soup_requester_error_get_type"
c:type="SoupRequesterError"
glib:error-domain="soup_requester_error_quark">
<member name="bad_uri"
value="0"
c:identifier="SOUP_REQUESTER_ERROR_BAD_URI"
glib:nick="bad-uri">
</member>
<member name="unsupported_uri_scheme"
value="1"
c:identifier="SOUP_REQUESTER_ERROR_UNSUPPORTED_URI_SCHEME"
glib:nick="unsupported-uri-scheme">
</member>
<function name="quark" c:identifier="soup_requester_error_quark">
<return-value transfer-ownership="none">
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
</enumeration>
<record name="RequesterPrivate"
c:type="SoupRequesterPrivate"
disguised="1">
</record>
<constant name="SERVER_ASYNC_CONTEXT"
value="async-context"
c:type="SOUP_SERVER_ASYNC_CONTEXT"
deprecated="1">
<doc xml:space="preserve">Alias for the deprecated #SoupServer:async-context
property, qv.</doc>
<doc-deprecated xml:space="preserve">The new API uses the thread-default #GMainContext
rather than having an explicitly-specified one.</doc-deprecated>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SERVER_H" value="1" c:type="SOUP_SERVER_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="SERVER_HTTPS_ALIASES"
value="https-aliases"
c:type="SOUP_SERVER_HTTPS_ALIASES"
version="2.44">
<doc xml:space="preserve">Alias for the #SoupServer:https-aliases property, qv.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SERVER_HTTP_ALIASES"
value="http-aliases"
c:type="SOUP_SERVER_HTTP_ALIASES"
version="2.44">
<doc xml:space="preserve">Alias for the #SoupServer:http-aliases property, qv.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SERVER_INTERFACE"
value="interface"
c:type="SOUP_SERVER_INTERFACE"
deprecated="1">
<doc xml:space="preserve">Alias for the #SoupServer:interface property, qv.</doc>
<doc-deprecated xml:space="preserve">#SoupServers can listen on multiple interfaces
at once now. Use soup_server_listen(), etc, to listen on an
interface, and soup_server_get_uris() to see what addresses
are being listened on.</doc-deprecated>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SERVER_PORT"
value="port"
c:type="SOUP_SERVER_PORT"
deprecated="1">
<doc xml:space="preserve">Alias for the deprecated #SoupServer:port property, qv.</doc>
<doc-deprecated xml:space="preserve">#SoupServers can listen on multiple interfaces
at once now. Use soup_server_listen(), etc, to listen on a
port, and soup_server_get_uris() to see what ports are
being listened on.</doc-deprecated>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SERVER_RAW_PATHS"
value="raw-paths"
c:type="SOUP_SERVER_RAW_PATHS">
<doc xml:space="preserve">Alias for the #SoupServer:raw-paths property. (If %TRUE,
percent-encoding in the Request-URI path will not be
automatically decoded.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SERVER_SERVER_HEADER"
value="server-header"
c:type="SOUP_SERVER_SERVER_HEADER">
<doc xml:space="preserve">Alias for the #SoupServer:server-header property, qv.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SERVER_SSL_CERT_FILE"
value="ssl-cert-file"
c:type="SOUP_SERVER_SSL_CERT_FILE"
deprecated="1">
<doc xml:space="preserve">Alias for the #SoupServer:ssl-cert-file property, qv.</doc>
<doc-deprecated xml:space="preserve">use #SoupServer:tls-certificate or
soup_server_set_ssl_certificate().</doc-deprecated>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SERVER_SSL_KEY_FILE"
value="ssl-key-file"
c:type="SOUP_SERVER_SSL_KEY_FILE"
deprecated="1">
<doc xml:space="preserve">Alias for the #SoupServer:ssl-key-file property, qv.</doc>
<doc-deprecated xml:space="preserve">use #SoupServer:tls-certificate or
soup_server_set_ssl_certificate().</doc-deprecated>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SERVER_TLS_CERTIFICATE"
value="tls-certificate"
c:type="SOUP_SERVER_TLS_CERTIFICATE"
version="2.38">
<doc xml:space="preserve">Alias for the #SoupServer:tls-certificate property, qv.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SESSION_ACCEPT_LANGUAGE"
value="accept-language"
c:type="SOUP_SESSION_ACCEPT_LANGUAGE"
version="2.30">
<doc xml:space="preserve">Alias for the #SoupSession:accept-language property, qv.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SESSION_ACCEPT_LANGUAGE_AUTO"
value="accept-language-auto"
c:type="SOUP_SESSION_ACCEPT_LANGUAGE_AUTO"
version="2.30">
<doc xml:space="preserve">Alias for the #SoupSession:accept-language-auto property, qv.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SESSION_ADD_FEATURE"
value="add-feature"
c:type="SOUP_SESSION_ADD_FEATURE"
version="2.24"
introspectable="0">
<doc xml:space="preserve">Alias for the #SoupSession:add-feature property, qv.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SESSION_ADD_FEATURE_BY_TYPE"
value="add-feature-by-type"
c:type="SOUP_SESSION_ADD_FEATURE_BY_TYPE"
version="2.24"
introspectable="0">
<doc xml:space="preserve">Alias for the #SoupSession:add-feature-by-type property, qv.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SESSION_ASYNC_CONTEXT"
value="async-context"
c:type="SOUP_SESSION_ASYNC_CONTEXT">
<doc xml:space="preserve">Alias for the #SoupSession:async-context property, qv.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SESSION_ASYNC_H" value="1" c:type="SOUP_SESSION_ASYNC_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="SESSION_FEATURE_H"
value="1"
c:type="SOUP_SESSION_FEATURE_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="SESSION_H" value="1" c:type="SOUP_SESSION_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="SESSION_HTTPS_ALIASES"
value="https-aliases"
c:type="SOUP_SESSION_HTTPS_ALIASES"
version="2.38">
<doc xml:space="preserve">Alias for the #SoupSession:https-aliases property, qv.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SESSION_HTTP_ALIASES"
value="http-aliases"
c:type="SOUP_SESSION_HTTP_ALIASES"
version="2.38">
<doc xml:space="preserve">Alias for the #SoupSession:http-aliases property, qv.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SESSION_IDLE_TIMEOUT"
value="idle-timeout"
c:type="SOUP_SESSION_IDLE_TIMEOUT"
version="2.24">
<doc xml:space="preserve">Alias for the #SoupSession:idle-timeout property, qv.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SESSION_LOCAL_ADDRESS"
value="local-address"
c:type="SOUP_SESSION_LOCAL_ADDRESS"
version="2.42">
<doc xml:space="preserve">Alias for the #SoupSession:local-address property, qv.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SESSION_MAX_CONNS"
value="max-conns"
c:type="SOUP_SESSION_MAX_CONNS">
<doc xml:space="preserve">Alias for the #SoupSession:max-conns property, qv.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SESSION_MAX_CONNS_PER_HOST"
value="max-conns-per-host"
c:type="SOUP_SESSION_MAX_CONNS_PER_HOST">
<doc xml:space="preserve">Alias for the #SoupSession:max-conns-per-host property, qv.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SESSION_PROXY_RESOLVER"
value="proxy-resolver"
c:type="SOUP_SESSION_PROXY_RESOLVER">
<doc xml:space="preserve">Alias for the #SoupSession:proxy-resolver property, qv.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SESSION_PROXY_URI"
value="proxy-uri"
c:type="SOUP_SESSION_PROXY_URI">
<doc xml:space="preserve">Alias for the #SoupSession:proxy-uri property, qv.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SESSION_REMOVE_FEATURE_BY_TYPE"
value="remove-feature-by-type"
c:type="SOUP_SESSION_REMOVE_FEATURE_BY_TYPE"
version="2.24"
introspectable="0">
<doc xml:space="preserve">Alias for the #SoupSession:remove-feature-by-type property,
qv.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SESSION_SSL_CA_FILE"
value="ssl-ca-file"
c:type="SOUP_SESSION_SSL_CA_FILE">
<doc xml:space="preserve">Alias for the #SoupSession:ssl-ca-file property, qv.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SESSION_SSL_STRICT"
value="ssl-strict"
c:type="SOUP_SESSION_SSL_STRICT"
version="2.30">
<doc xml:space="preserve">Alias for the #SoupSession:ssl-strict property, qv.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SESSION_SSL_USE_SYSTEM_CA_FILE"
value="ssl-use-system-ca-file"
c:type="SOUP_SESSION_SSL_USE_SYSTEM_CA_FILE"
version="2.38">
<doc xml:space="preserve">Alias for the #SoupSession:ssl-use-system-ca-file property,
qv.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SESSION_SYNC_H" value="1" c:type="SOUP_SESSION_SYNC_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="SESSION_TIMEOUT"
value="timeout"
c:type="SOUP_SESSION_TIMEOUT">
<doc xml:space="preserve">Alias for the #SoupSession:timeout property, qv.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SESSION_TLS_DATABASE"
value="tls-database"
c:type="SOUP_SESSION_TLS_DATABASE"
version="2.38">
<doc xml:space="preserve">Alias for the #SoupSession:tls-database property, qv.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SESSION_TLS_INTERACTION"
value="tls-interaction"
c:type="SOUP_SESSION_TLS_INTERACTION"
version="2.48">
<doc xml:space="preserve">Alias for the #SoupSession:tls-interaction property, qv.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SESSION_USER_AGENT"
value="user-agent"
c:type="SOUP_SESSION_USER_AGENT">
<doc xml:space="preserve">Alias for the #SoupSession:user-agent property, qv.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SESSION_USE_NTLM"
value="use-ntlm"
c:type="SOUP_SESSION_USE_NTLM">
<doc xml:space="preserve">Alias for the #SoupSession:use-ntlm property, qv.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SESSION_USE_THREAD_CONTEXT"
value="use-thread-context"
c:type="SOUP_SESSION_USE_THREAD_CONTEXT"
version="2.38">
<doc xml:space="preserve">Alias for the #SoupSession:use-thread-context property, qv.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SOCKET_ASYNC_CONTEXT"
value="async-context"
c:type="SOUP_SOCKET_ASYNC_CONTEXT">
<doc xml:space="preserve">Alias for the #SoupSocket:async-context property. (The
socket's #GMainContext.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SOCKET_FLAG_NONBLOCKING"
value="non-blocking"
c:type="SOUP_SOCKET_FLAG_NONBLOCKING">
<doc xml:space="preserve">Alias for the #SoupSocket:non-blocking property. (Whether
or not the socket uses non-blocking I/O.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SOCKET_H" value="1" c:type="SOUP_SOCKET_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="SOCKET_IS_SERVER"
value="is-server"
c:type="SOUP_SOCKET_IS_SERVER">
<doc xml:space="preserve">Alias for the #SoupSocket:is-server property, qv.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SOCKET_LOCAL_ADDRESS"
value="local-address"
c:type="SOUP_SOCKET_LOCAL_ADDRESS">
<doc xml:space="preserve">Alias for the #SoupSocket:local-address property. (Address
of local end of socket.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SOCKET_REMOTE_ADDRESS"
value="remote-address"
c:type="SOUP_SOCKET_REMOTE_ADDRESS">
<doc xml:space="preserve">Alias for the #SoupSocket:remote-address property. (Address
of remote end of socket.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SOCKET_SSL_CREDENTIALS"
value="ssl-creds"
c:type="SOUP_SOCKET_SSL_CREDENTIALS">
<doc xml:space="preserve">Alias for the #SoupSocket:ssl-creds property.
(SSL credential information.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SOCKET_SSL_FALLBACK"
value="ssl-fallback"
c:type="SOUP_SOCKET_SSL_FALLBACK">
<doc xml:space="preserve">Alias for the #SoupSocket:ssl-fallback property.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SOCKET_SSL_STRICT"
value="ssl-strict"
c:type="SOUP_SOCKET_SSL_STRICT">
<doc xml:space="preserve">Alias for the #SoupSocket:ssl-strict property.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SOCKET_TIMEOUT"
value="timeout"
c:type="SOUP_SOCKET_TIMEOUT">
<doc xml:space="preserve">Alias for the #SoupSocket:timeout property. (The timeout
in seconds for blocking socket I/O operations.)</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SOCKET_TLS_CERTIFICATE"
value="tls-certificate"
c:type="SOUP_SOCKET_TLS_CERTIFICATE"
version="2.34">
<doc xml:space="preserve">Alias for the #SoupSocket:tls-certificate
property. Note that this property's value is only useful
if the socket is for a TLS connection, and only reliable
after some data has been transferred to or from it.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SOCKET_TLS_ERRORS"
value="tls-errors"
c:type="SOUP_SOCKET_TLS_ERRORS"
version="2.34">
<doc xml:space="preserve">Alias for the #SoupSocket:tls-errors
property. Note that this property's value is only useful
if the socket is for a TLS connection, and only reliable
after some data has been transferred to or from it.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SOCKET_TRUSTED_CERTIFICATE"
value="trusted-certificate"
c:type="SOUP_SOCKET_TRUSTED_CERTIFICATE">
<doc xml:space="preserve">Alias for the #SoupSocket:trusted-certificate
property.</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="SOCKET_USE_THREAD_CONTEXT"
value="use-thread-context"
c:type="SOUP_SOCKET_USE_THREAD_CONTEXT"
version="2.38">
<doc xml:space="preserve">Alias for the #SoupSocket:use-thread-context property. (Use
g_main_context_get_thread_default())</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="STATUS_H" value="1" c:type="SOUP_STATUS_H">
<type name="gint" c:type="gint"/>
</constant>
<class name="Server"
c:symbol-prefix="server"
c:type="SoupServer"
parent="GObject.Object"
glib:type-name="SoupServer"
glib:get-type="soup_server_get_type"
glib:type-struct="ServerClass">
<constructor name="new"
c:identifier="soup_server_new"
introspectable="0">
<doc xml:space="preserve">Creates a new #SoupServer. This is exactly equivalent to calling
g_object_new() and specifying %SOUP_TYPE_SERVER as the type.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">a new #SoupServer. If you are using
certain legacy properties, this may also return %NULL if an error
occurs.</doc>
<type name="Server" c:type="SoupServer*"/>
</return-value>
<parameters>
<parameter name="optname1" transfer-ownership="none">
<doc xml:space="preserve">name of first property to set</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">value of @optname1, followed by additional property/value pairs</doc>
<varargs/>
</parameter>
</parameters>
</constructor>
<virtual-method name="request_aborted">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="server" transfer-ownership="none">
<type name="Server" c:type="SoupServer*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="client" transfer-ownership="none">
<type name="ClientContext" c:type="SoupClientContext*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="request_finished">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="server" transfer-ownership="none">
<type name="Server" c:type="SoupServer*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="client" transfer-ownership="none">
<type name="ClientContext" c:type="SoupClientContext*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="request_read">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="server" transfer-ownership="none">
<type name="Server" c:type="SoupServer*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="client" transfer-ownership="none">
<type name="ClientContext" c:type="SoupClientContext*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="request_started">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="server" transfer-ownership="none">
<type name="Server" c:type="SoupServer*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="client" transfer-ownership="none">
<type name="ClientContext" c:type="SoupClientContext*"/>
</parameter>
</parameters>
</virtual-method>
<method name="accept_iostream"
c:identifier="soup_server_accept_iostream"
version="2.50"
throws="1">
<doc xml:space="preserve">Add a new client stream to the @server.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE on success, %FALSE if the stream could not be
accepted or any other error occurred (in which case @error will be
set).</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="server" transfer-ownership="none">
<doc xml:space="preserve">a #SoupServer</doc>
<type name="Server" c:type="SoupServer*"/>
</instance-parameter>
<parameter name="stream" transfer-ownership="none">
<doc xml:space="preserve">a #GIOStream</doc>
<type name="Gio.IOStream" c:type="GIOStream*"/>
</parameter>
<parameter name="local_addr"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the local #GSocketAddress associated with the @stream</doc>
<type name="Gio.SocketAddress" c:type="GSocketAddress*"/>
</parameter>
<parameter name="remote_addr"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the remote #GSocketAddress associated with the @stream</doc>
<type name="Gio.SocketAddress" c:type="GSocketAddress*"/>
</parameter>
</parameters>
</method>
<method name="add_auth_domain"
c:identifier="soup_server_add_auth_domain">
<doc xml:space="preserve">Adds an authentication domain to @server. Each auth domain will
have the chance to require authentication for each request that
comes in; normally auth domains will require authentication for
requests on certain paths that they have been set up to watch, or
that meet other criteria set by the caller. If an auth domain
determines that a request requires authentication (and the request
doesn't contain authentication), @server will automatically reject
the request with an appropriate status (401 Unauthorized or 407
Proxy Authentication Required). If the request used the
"100-continue" Expectation, @server will reject it before the
request body is sent.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="server" transfer-ownership="none">
<doc xml:space="preserve">a #SoupServer</doc>
<type name="Server" c:type="SoupServer*"/>
</instance-parameter>
<parameter name="auth_domain" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuthDomain</doc>
<type name="AuthDomain" c:type="SoupAuthDomain*"/>
</parameter>
</parameters>
</method>
<method name="add_early_handler"
c:identifier="soup_server_add_early_handler"
version="2.50">
<doc xml:space="preserve">Adds an "early" handler to @server for requests under @path. Note
that "normal" and "early" handlers are matched up together, so if
you add a normal handler for "/foo" and an early handler for
"/foo/bar", then a request to "/foo/bar" (or any path below it)
will run only the early handler. (But if you add both handlers at
the same path, then both will get run.)
For requests under @path (that have not already been assigned a
status code by a #SoupAuthDomain or a signal handler), @callback
will be invoked after receiving the request headers, but before
receiving the request body; the message's #SoupMessage:method and
#SoupMessage:request-headers fields will be filled in.
Early handlers are generally used for processing requests with
request bodies in a streaming fashion. If you determine that the
request will contain a message body, normally you would call
soup_message_body_set_accumulate() on the message's
#SoupMessage:request-body to turn off request-body accumulation,
and connect to the message's #SoupMessage::got-chunk signal to
process each chunk as it comes in.
To complete the message processing after the full message body has
been read, you can either also connect to #SoupMessage::got-body,
or else you can register a non-early handler for @path as well. As
long as you have not set the #SoupMessage:status-code by the time
#SoupMessage::got-body is emitted, the non-early handler will be
run as well.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="server" transfer-ownership="none">
<doc xml:space="preserve">a #SoupServer</doc>
<type name="Server" c:type="SoupServer*"/>
</instance-parameter>
<parameter name="path"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the toplevel path for the handler</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
scope="notified"
closure="2"
destroy="3">
<doc xml:space="preserve">callback to invoke for requests under @path</doc>
<type name="ServerCallback" c:type="SoupServerCallback"/>
</parameter>
<parameter name="user_data" transfer-ownership="none">
<doc xml:space="preserve">data for @callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="destroy" transfer-ownership="none" scope="async">
<doc xml:space="preserve">destroy notifier to free @user_data</doc>
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
</parameter>
</parameters>
</method>
<method name="add_handler" c:identifier="soup_server_add_handler">
<doc xml:space="preserve">Adds a handler to @server for requests under @path. If @path is
%NULL or "/", then this will be the default handler for all
requests that don't have a more specific handler. (Note though that
if you want to handle requests to the special "*" URI, you must
explicitly register a handler for "*"; the default handler will not
be used for that case.)
For requests under @path (that have not already been assigned a
status code by a #SoupAuthDomain, an early #SoupServerHandler, or a
signal handler), @callback will be invoked after receiving the
request body; the message's #SoupMessage:method,
#SoupMessage:request-headers, and #SoupMessage:request-body fields
will be filled in.
After determining what to do with the request, the callback must at
a minimum call soup_message_set_status() (or
soup_message_set_status_full()) on the message to set the response
status code. Additionally, it may set response headers and/or fill
in the response body.
If the callback cannot fully fill in the response before returning
(eg, if it needs to wait for information from a database, or
another network server), it should call soup_server_pause_message()
to tell @server to not send the response right away. When the
response is ready, call soup_server_unpause_message() to cause it
to be sent.
To send the response body a bit at a time using "chunked" encoding,
first call soup_message_headers_set_encoding() to set
%SOUP_ENCODING_CHUNKED on the #SoupMessage:response-headers. Then call
soup_message_body_append() (or soup_message_body_append_buffer())
to append each chunk as it becomes ready, and
soup_server_unpause_message() to make sure it's running. (The
server will automatically pause the message if it is using chunked
encoding but no more chunks are available.) When you are done, call
soup_message_body_complete() to indicate that no more chunks are
coming.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="server" transfer-ownership="none">
<doc xml:space="preserve">a #SoupServer</doc>
<type name="Server" c:type="SoupServer*"/>
</instance-parameter>
<parameter name="path"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the toplevel path for the handler</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
scope="notified"
closure="2"
destroy="3">
<doc xml:space="preserve">callback to invoke for requests under @path</doc>
<type name="ServerCallback" c:type="SoupServerCallback"/>
</parameter>
<parameter name="user_data" transfer-ownership="none">
<doc xml:space="preserve">data for @callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="destroy" transfer-ownership="none" scope="async">
<doc xml:space="preserve">destroy notifier to free @user_data</doc>
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
</parameter>
</parameters>
</method>
<method name="add_websocket_handler"
c:identifier="soup_server_add_websocket_handler">
<doc xml:space="preserve">Adds a WebSocket handler to @server for requests under @path. (If
@path is %NULL or "/", then this will be the default handler for
all requests that don't have a more specific handler.)
When a path has a WebSocket handler registered, @server will check
incoming requests for WebSocket handshakes after all other handlers
have run (unless some earlier handler has already set a status code
on the message), and update the request's status, response headers,
and response body accordingly.
If @origin is non-%NULL, then only requests containing a matching
"Origin" header will be accepted. If @protocols is non-%NULL, then
only requests containing a compatible "Sec-WebSocket-Protocols"
header will be accepted. More complicated requirements can be
handled by adding a normal handler to @path, and having it perform
whatever checks are needed (possibly calling
soup_server_check_websocket_handshake() one or more times), and
setting a failure status code if the handshake should be rejected.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="server" transfer-ownership="none">
<doc xml:space="preserve">a #SoupServer</doc>
<type name="Server" c:type="SoupServer*"/>
</instance-parameter>
<parameter name="path"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the toplevel path for the handler</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="origin"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the origin of the connection</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="protocols"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the protocols
supported by this handler</doc>
<array c:type="char**">
<type name="utf8" c:type="char*"/>
</array>
</parameter>
<parameter name="callback"
transfer-ownership="none"
scope="notified"
closure="4"
destroy="5">
<doc xml:space="preserve">callback to invoke for successful WebSocket requests under @path</doc>
<type name="ServerWebsocketCallback"
c:type="SoupServerWebsocketCallback"/>
</parameter>
<parameter name="user_data" transfer-ownership="none">
<doc xml:space="preserve">data for @callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="destroy" transfer-ownership="none" scope="async">
<doc xml:space="preserve">destroy notifier to free @user_data</doc>
<type name="GLib.DestroyNotify" c:type="GDestroyNotify"/>
</parameter>
</parameters>
</method>
<method name="disconnect" c:identifier="soup_server_disconnect">
<doc xml:space="preserve">Closes and frees @server's listening sockets. If you are using the
old #SoupServer APIs, this also includes the effect of
soup_server_quit().
Note that if there are currently requests in progress on @server,
that they will continue to be processed if @server's #GMainContext
is still running.
You can call soup_server_listen(), etc, after calling this function
if you want to start listening again.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="server" transfer-ownership="none">
<doc xml:space="preserve">a #SoupServer</doc>
<type name="Server" c:type="SoupServer*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_async_context"
c:identifier="soup_server_get_async_context"
deprecated="1">
<doc xml:space="preserve">Gets @server's async_context, if you are using the old API. (With
the new API, the server runs in the thread's thread-default
#GMainContext, regardless of what this method returns.)
This does not add a ref to the context, so you will need to ref it
yourself if you want it to outlive its server.</doc>
<doc-deprecated xml:space="preserve">If you are using soup_server_listen(), etc, then
the server listens on the thread-default #GMainContext, and this
property is ignored.</doc-deprecated>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">@server's #GMainContext,
which may be %NULL</doc>
<type name="GLib.MainContext" c:type="GMainContext*"/>
</return-value>
<parameters>
<instance-parameter name="server" transfer-ownership="none">
<doc xml:space="preserve">a #SoupServer</doc>
<type name="Server" c:type="SoupServer*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_listener"
c:identifier="soup_server_get_listener"
deprecated="1">
<doc xml:space="preserve">Gets @server's listening socket, if you are using the old API.
You should treat this socket as read-only; writing to it or
modifiying it may cause @server to malfunction.</doc>
<doc-deprecated xml:space="preserve">If you are using soup_server_listen(), etc, then use
soup_server_get_listeners() to get a list of all listening sockets,
but note that that function returns #GSockets, not #SoupSockets.</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the listening socket.</doc>
<type name="Socket" c:type="SoupSocket*"/>
</return-value>
<parameters>
<instance-parameter name="server" transfer-ownership="none">
<doc xml:space="preserve">a #SoupServer</doc>
<type name="Server" c:type="SoupServer*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_listeners" c:identifier="soup_server_get_listeners">
<doc xml:space="preserve">Gets @server's list of listening sockets.
You should treat these sockets as read-only; writing to or
modifiying any of these sockets may cause @server to malfunction.
(Beware that in contrast to the old soup_server_get_listener(), this
function returns #GSockets, not #SoupSockets.)</doc>
<return-value transfer-ownership="container">
<doc xml:space="preserve">a
list of listening sockets.</doc>
<type name="GLib.SList" c:type="GSList*">
<type name="Gio.Socket"/>
</type>
</return-value>
<parameters>
<instance-parameter name="server" transfer-ownership="none">
<doc xml:space="preserve">a #SoupServer</doc>
<type name="Server" c:type="SoupServer*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_port"
c:identifier="soup_server_get_port"
deprecated="1">
<doc xml:space="preserve">Gets the TCP port that @server is listening on, if you are using
the old API.</doc>
<doc-deprecated xml:space="preserve">If you are using soup_server_listen(), etc, then use
soup_server_get_uris() to get a list of all listening addresses.</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the port @server is listening on.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="server" transfer-ownership="none">
<doc xml:space="preserve">a #SoupServer</doc>
<type name="Server" c:type="SoupServer*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_uris"
c:identifier="soup_server_get_uris"
version="2.48">
<doc xml:space="preserve">Gets a list of URIs corresponding to the interfaces @server is
listening on. These will contain IP addresses, not hostnames, and
will also indicate whether the given listener is http or https.
Note that if you used soup_server_listen_all(), the returned URIs
will use the addresses <literal>0.0.0.0</literal> and
<literal>::</literal>, rather than actually returning separate URIs
for each interface on the system.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a list of
#SoupURIs, which you must free when you are done with it.</doc>
<type name="GLib.SList" c:type="GSList*">
<type name="URI"/>
</type>
</return-value>
<parameters>
<instance-parameter name="server" transfer-ownership="none">
<doc xml:space="preserve">a #SoupServer</doc>
<type name="Server" c:type="SoupServer*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_https" c:identifier="soup_server_is_https">
<doc xml:space="preserve">Checks whether @server is capable of https.
In order for a server to run https, you must call
soup_server_set_ssl_cert_file(), or set the
#SoupServer:tls-certificate property, to provide it with a
certificate to use.
If you are using the deprecated single-listener APIs, then a return
value of %TRUE indicates that the #SoupServer serves https
exclusively. If you are using soup_server_listen(), etc, then a
%TRUE return value merely indicates that the server is
<emphasis>able</emphasis> to do https, regardless of whether it
actually currently is or not. Use soup_server_get_uris() to see if
it currently has any https listeners.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @server is configured to serve https.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="server" transfer-ownership="none">
<doc xml:space="preserve">a #SoupServer</doc>
<type name="Server" c:type="SoupServer*"/>
</instance-parameter>
</parameters>
</method>
<method name="listen"
c:identifier="soup_server_listen"
version="2.48"
throws="1">
<doc xml:space="preserve">This attempts to set up @server to listen for connections on
@address.
If @options includes %SOUP_SERVER_LISTEN_HTTPS, and @server has
been configured for TLS, then @server will listen for https
connections on this port. Otherwise it will listen for plain http.
You may call this method (along with the other "listen" methods)
any number of times on a server, if you want to listen on multiple
ports, or set up both http and https service.
After calling this method, @server will begin accepting and
processing connections as soon as the appropriate #GMainContext is
run.
Note that #SoupServer never makes use of dual IPv4/IPv6 sockets; if
@address is an IPv6 address, it will only accept IPv6 connections.
You must configure IPv4 listening separately.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE on success, %FALSE if @address could not be
bound or any other error occurred (in which case @error will be
set).</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="server" transfer-ownership="none">
<doc xml:space="preserve">a #SoupServer</doc>
<type name="Server" c:type="SoupServer*"/>
</instance-parameter>
<parameter name="address" transfer-ownership="none">
<doc xml:space="preserve">the address of the interface to listen on</doc>
<type name="Gio.SocketAddress" c:type="GSocketAddress*"/>
</parameter>
<parameter name="options" transfer-ownership="none">
<doc xml:space="preserve">listening options for this server</doc>
<type name="ServerListenOptions" c:type="SoupServerListenOptions"/>
</parameter>
</parameters>
</method>
<method name="listen_all"
c:identifier="soup_server_listen_all"
version="2.48"
throws="1">
<doc xml:space="preserve">This attempts to set up @server to listen for connections on all
interfaces on the system. (That is, it listens on the addresses
<literal>0.0.0.0</literal> and/or <literal>::</literal>, depending
on whether @options includes %SOUP_SERVER_LISTEN_IPV4_ONLY,
%SOUP_SERVER_LISTEN_IPV6_ONLY, or neither.) If @port is specified,
@server will listen on that port. If it is 0, @server will find an
unused port to listen on. (In that case, you can use
soup_server_get_uris() to find out what port it ended up choosing.)
See soup_server_listen() for more details.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE on success, %FALSE if @port could not be bound
or any other error occurred (in which case @error will be set).</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="server" transfer-ownership="none">
<doc xml:space="preserve">a #SoupServer</doc>
<type name="Server" c:type="SoupServer*"/>
</instance-parameter>
<parameter name="port" transfer-ownership="none">
<doc xml:space="preserve">the port to listen on, or 0</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="options" transfer-ownership="none">
<doc xml:space="preserve">listening options for this server</doc>
<type name="ServerListenOptions" c:type="SoupServerListenOptions"/>
</parameter>
</parameters>
</method>
<method name="listen_fd"
c:identifier="soup_server_listen_fd"
version="2.48"
throws="1">
<doc xml:space="preserve">This attempts to set up @server to listen for connections on
@fd.
See soup_server_listen() for more details.
Note that @server will close @fd when you free it or call
soup_server_disconnect().</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE on success, %FALSE if an error occurred (in
which case @error will be set).</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="server" transfer-ownership="none">
<doc xml:space="preserve">a #SoupServer</doc>
<type name="Server" c:type="SoupServer*"/>
</instance-parameter>
<parameter name="fd" transfer-ownership="none">
<doc xml:space="preserve">the file descriptor of a listening socket</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="options" transfer-ownership="none">
<doc xml:space="preserve">listening options for this server</doc>
<type name="ServerListenOptions" c:type="SoupServerListenOptions"/>
</parameter>
</parameters>
</method>
<method name="listen_local"
c:identifier="soup_server_listen_local"
version="2.48"
throws="1">
<doc xml:space="preserve">This attempts to set up @server to listen for connections on
"localhost" (that is, <literal>127.0.0.1</literal> and/or
<literal>::1</literal>, depending on whether @options includes
%SOUP_SERVER_LISTEN_IPV4_ONLY, %SOUP_SERVER_LISTEN_IPV6_ONLY, or
neither). If @port is specified, @server will listen on that port.
If it is 0, @server will find an unused port to listen on. (In that
case, you can use soup_server_get_uris() to find out what port it
ended up choosing.)
See soup_server_listen() for more details.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE on success, %FALSE if @port could not be bound
or any other error occurred (in which case @error will be set).</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="server" transfer-ownership="none">
<doc xml:space="preserve">a #SoupServer</doc>
<type name="Server" c:type="SoupServer*"/>
</instance-parameter>
<parameter name="port" transfer-ownership="none">
<doc xml:space="preserve">the port to listen on, or 0</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="options" transfer-ownership="none">
<doc xml:space="preserve">listening options for this server</doc>
<type name="ServerListenOptions" c:type="SoupServerListenOptions"/>
</parameter>
</parameters>
</method>
<method name="listen_socket"
c:identifier="soup_server_listen_socket"
version="2.48"
throws="1">
<doc xml:space="preserve">This attempts to set up @server to listen for connections on
@socket.
See soup_server_listen() for more details.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE on success, %FALSE if an error occurred (in
which case @error will be set).</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="server" transfer-ownership="none">
<doc xml:space="preserve">a #SoupServer</doc>
<type name="Server" c:type="SoupServer*"/>
</instance-parameter>
<parameter name="socket" transfer-ownership="none">
<doc xml:space="preserve">a listening #GSocket</doc>
<type name="Gio.Socket" c:type="GSocket*"/>
</parameter>
<parameter name="options" transfer-ownership="none">
<doc xml:space="preserve">listening options for this server</doc>
<type name="ServerListenOptions" c:type="SoupServerListenOptions"/>
</parameter>
</parameters>
</method>
<method name="pause_message" c:identifier="soup_server_pause_message">
<doc xml:space="preserve">Pauses I/O on @msg. This can be used when you need to return from
the server handler without having the full response ready yet. Use
soup_server_unpause_message() to resume I/O.
This must only be called on #SoupMessages which were created by the
#SoupServer and are currently doing I/O, such as those passed into a
#SoupServerCallback or emitted in a #SoupServer::request-read signal.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="server" transfer-ownership="none">
<doc xml:space="preserve">a #SoupServer</doc>
<type name="Server" c:type="SoupServer*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage associated with @server.</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</method>
<method name="quit" c:identifier="soup_server_quit" deprecated="1">
<doc xml:space="preserve">Stops processing for @server, if you are using the old API. Call
this to clean up after soup_server_run_async(), or to terminate a
call to soup_server_run().
Note that messages currently in progress will continue to be
handled, if the main loop associated with the server is resumed or
kept running.
@server is still in a working state after this call; you can start
and stop a server as many times as you want.</doc>
<doc-deprecated xml:space="preserve">When using soup_server_listen(), etc, the server will
always listen for connections, and will process them whenever the
thread-default #GMainContext is running.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="server" transfer-ownership="none">
<doc xml:space="preserve">a #SoupServer</doc>
<type name="Server" c:type="SoupServer*"/>
</instance-parameter>
</parameters>
</method>
<method name="remove_auth_domain"
c:identifier="soup_server_remove_auth_domain">
<doc xml:space="preserve">Removes @auth_domain from @server.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="server" transfer-ownership="none">
<doc xml:space="preserve">a #SoupServer</doc>
<type name="Server" c:type="SoupServer*"/>
</instance-parameter>
<parameter name="auth_domain" transfer-ownership="none">
<doc xml:space="preserve">a #SoupAuthDomain</doc>
<type name="AuthDomain" c:type="SoupAuthDomain*"/>
</parameter>
</parameters>
</method>
<method name="remove_handler" c:identifier="soup_server_remove_handler">
<doc xml:space="preserve">Removes all handlers (early and normal) registered at @path.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="server" transfer-ownership="none">
<doc xml:space="preserve">a #SoupServer</doc>
<type name="Server" c:type="SoupServer*"/>
</instance-parameter>
<parameter name="path" transfer-ownership="none">
<doc xml:space="preserve">the toplevel path for the handler</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="run" c:identifier="soup_server_run" deprecated="1">
<doc xml:space="preserve">Starts @server, if you are using the old API, causing it to listen
for and process incoming connections. Unlike
soup_server_run_async(), this creates a #GMainLoop and runs it, and
it will not return until someone calls soup_server_quit() to stop
the server.</doc>
<doc-deprecated xml:space="preserve">When using soup_server_listen(), etc, the server will
always listen for connections, and will process them whenever the
thread-default #GMainContext is running.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="server" transfer-ownership="none">
<doc xml:space="preserve">a #SoupServer</doc>
<type name="Server" c:type="SoupServer*"/>
</instance-parameter>
</parameters>
</method>
<method name="run_async"
c:identifier="soup_server_run_async"
deprecated="1">
<doc xml:space="preserve">Starts @server, if you are using the old API, causing it to listen
for and process incoming connections.
The server runs in @server's #GMainContext. It will not actually
perform any processing unless the appropriate main loop is running.
In the simple case where you did not set the server's
%SOUP_SERVER_ASYNC_CONTEXT property, this means the server will run
whenever the glib main loop is running.</doc>
<doc-deprecated xml:space="preserve">When using soup_server_listen(), etc, the server will
always listen for connections, and will process them whenever the
thread-default #GMainContext is running.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="server" transfer-ownership="none">
<doc xml:space="preserve">a #SoupServer</doc>
<type name="Server" c:type="SoupServer*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_ssl_cert_file"
c:identifier="soup_server_set_ssl_cert_file"
version="2.48"
throws="1">
<doc xml:space="preserve">Sets @server up to do https, using the SSL/TLS certificate
specified by @ssl_cert_file and @ssl_key_file (which may point to
the same file).
Alternatively, you can set the #SoupServer:tls-certificate property
at construction time, if you already have a #GTlsCertificate.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">success or failure.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="server" transfer-ownership="none">
<doc xml:space="preserve">a #SoupServer</doc>
<type name="Server" c:type="SoupServer*"/>
</instance-parameter>
<parameter name="ssl_cert_file" transfer-ownership="none">
<doc xml:space="preserve">path to a file containing a PEM-encoded SSL/TLS
certificate.</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="ssl_key_file" transfer-ownership="none">
<doc xml:space="preserve">path to a file containing a PEM-encoded private key.</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="unpause_message"
c:identifier="soup_server_unpause_message">
<doc xml:space="preserve">Resumes I/O on @msg. Use this to resume after calling
soup_server_pause_message(), or after adding a new chunk to a
chunked response.
I/O won't actually resume until you return to the main loop.
This must only be called on #SoupMessages which were created by the
#SoupServer and are currently doing I/O, such as those passed into a
#SoupServerCallback or emitted in a #SoupServer::request-read signal.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="server" transfer-ownership="none">
<doc xml:space="preserve">a #SoupServer</doc>
<type name="Server" c:type="SoupServer*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage associated with @server.</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</method>
<property name="async-context"
deprecated="1"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve">The server's #GMainContext, if you are using the old API.
Servers created using soup_server_listen() will listen on
the #GMainContext that was the thread-default context at
the time soup_server_listen() was called.</doc>
<doc-deprecated xml:space="preserve">The new API uses the thread-default #GMainContext
rather than having an explicitly-specified one.</doc-deprecated>
<type name="gpointer" c:type="gpointer"/>
</property>
<property name="http-aliases"
version="2.44"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve">A %NULL-terminated array of URI schemes that should be
considered to be aliases for "http". Eg, if this included
<literal>"dav"</literal>, than a URI of
<literal>dav://example.com/path</literal> would be treated
identically to <literal>http://example.com/path</literal>.
In particular, this is needed in cases where a client
sends requests with absolute URIs, where those URIs do
not use "http:".
The default value is an array containing the single element
<literal>"*"</literal>, a special value which means that
any scheme except "https" is considered to be an alias for
"http".
See also #SoupServer:https-aliases.</doc>
<array>
<type name="utf8"/>
</array>
</property>
<property name="https-aliases"
version="2.44"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve">A comma-delimited list of URI schemes that should be
considered to be aliases for "https". See
#SoupServer:http-aliases for more information.
The default value is %NULL, meaning that no URI schemes
are considered aliases for "https".</doc>
<array>
<type name="utf8"/>
</array>
</property>
<property name="interface"
deprecated="1"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve">The address of the network interface the server is
listening on, if you are using the old #SoupServer API.
(This will not be set if you use soup_server_listen(),
etc.)</doc>
<doc-deprecated xml:space="preserve">#SoupServers can listen on multiple interfaces
at once now. Use soup_server_listen(), etc, to listen on an
interface, and soup_server_get_uris() to see what addresses
are being listened on.</doc-deprecated>
<type name="Address"/>
</property>
<property name="port"
deprecated="1"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve">The port the server is listening on, if you are using the
old #SoupServer API. (This will not be set if you use
soup_server_listen(), etc.)</doc>
<doc-deprecated xml:space="preserve">#SoupServers can listen on multiple interfaces
at once now. Use soup_server_listen(), etc, to listen on a
port, and soup_server_get_uris() to see what ports are
being listened on.</doc-deprecated>
<type name="guint" c:type="guint"/>
</property>
<property name="raw-paths"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="server-header"
writable="1"
construct="1"
transfer-ownership="none">
<doc xml:space="preserve">If non-%NULL, the value to use for the "Server" header on
#SoupMessage<!-- -->s processed by this server.
The Server header is the server equivalent of the
User-Agent header, and provides information about the
server and its components. It contains a list of one or
more product tokens, separated by whitespace, with the most
significant product token coming first. The tokens must be
brief, ASCII, and mostly alphanumeric (although "-", "_",
and "." are also allowed), and may optionally include a "/"
followed by a version string. You may also put comments,
enclosed in parentheses, between or after the tokens.
Some HTTP server implementations intentionally do not use
version numbers in their Server header, so that
installations running older versions of the server don't
end up advertising their vulnerability to specific security
holes.
As with #SoupSession:user_agent, if you set a
#SoupServer:server_header property that has trailing whitespace,
#SoupServer will append its own product token (eg,
"<literal>libsoup/2.3.2</literal>") to the end of the
header for you.</doc>
<type name="utf8" c:type="gchar*"/>
</property>
<property name="ssl-cert-file"
deprecated="1"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve">Path to a file containing a PEM-encoded certificate.
If you set this property and #SoupServer:ssl-key-file at
construct time, then soup_server_new() will try to read the
files; if it cannot, it will return %NULL, with no explicit
indication of what went wrong (and logging a warning with
newer versions of glib, since returning %NULL from a
constructor is illegal).</doc>
<doc-deprecated xml:space="preserve">use #SoupServer:tls-certificate or
soup_server_set_ssl_certificate().</doc-deprecated>
<type name="utf8" c:type="gchar*"/>
</property>
<property name="ssl-key-file"
deprecated="1"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve">Path to a file containing a PEM-encoded private key. See
#SoupServer:ssl-cert-file for more information about how this
is used.</doc>
<doc-deprecated xml:space="preserve">use #SoupServer:tls-certificate or
soup_server_set_ssl_certificate().</doc-deprecated>
<type name="utf8" c:type="gchar*"/>
</property>
<property name="tls-certificate"
version="2.38"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve">A #GTlsCertificate that has a #GTlsCertificate:private-key
set. If this is set, then the server will be able to speak
https in addition to (or instead of) plain http.
Alternatively, you can call soup_server_set_ssl_cert_file()
to have #SoupServer read in a a certificate from a file.</doc>
<type name="Gio.TlsCertificate"/>
</property>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
<glib:signal name="request-aborted" when="first">
<doc xml:space="preserve">Emitted when processing has failed for a message; this
could mean either that it could not be read (if
#SoupServer::request_read has not been emitted for it yet),
or that the response could not be written back (if
#SoupServer::request_read has been emitted but
#SoupServer::request_finished has not been).
@message is in an undefined state when this signal is
emitted; the signal exists primarily to allow the server to
free any state that it may have allocated in
#SoupServer::request_started.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="message" transfer-ownership="none">
<doc xml:space="preserve">the message</doc>
<type name="Message"/>
</parameter>
<parameter name="client" transfer-ownership="none">
<doc xml:space="preserve">the client context</doc>
<type name="ClientContext"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="request-finished" when="first">
<doc xml:space="preserve">Emitted when the server has finished writing a response to
a request.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="message" transfer-ownership="none">
<doc xml:space="preserve">the message</doc>
<type name="Message"/>
</parameter>
<parameter name="client" transfer-ownership="none">
<doc xml:space="preserve">the client context</doc>
<type name="ClientContext"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="request-read" when="first">
<doc xml:space="preserve">Emitted when the server has successfully read a request.
@message will have all of its request-side information
filled in, and if the message was authenticated, @client
will have information about that. This signal is emitted
before any (non-early) handlers are called for the message,
and if it sets the message's #status_code, then normal
handler processing will be skipped.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="message" transfer-ownership="none">
<doc xml:space="preserve">the message</doc>
<type name="Message"/>
</parameter>
<parameter name="client" transfer-ownership="none">
<doc xml:space="preserve">the client context</doc>
<type name="ClientContext"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="request-started" when="first">
<doc xml:space="preserve">Emitted when the server has started reading a new request.
@message will be completely blank; not even the
Request-Line will have been read yet. About the only thing
you can usefully do with it is connect to its signals.
If the request is read successfully, this will eventually
be followed by a #SoupServer::request_read signal. If a
response is then sent, the request processing will end with
a #SoupServer::request_finished signal. If a network error
occurs, the processing will instead end with
#SoupServer::request_aborted.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="message" transfer-ownership="none">
<doc xml:space="preserve">the new message</doc>
<type name="Message"/>
</parameter>
<parameter name="client" transfer-ownership="none">
<doc xml:space="preserve">the client context</doc>
<type name="ClientContext"/>
</parameter>
</parameters>
</glib:signal>
</class>
<callback name="ServerCallback" c:type="SoupServerCallback">
<doc xml:space="preserve">A callback used to handle requests to a #SoupServer.
@path and @query contain the likewise-named components of the
Request-URI, subject to certain assumptions. By default,
#SoupServer decodes all percent-encoding in the URI path, such that
"/foo%<!-- -->2Fbar" is treated the same as "/foo/bar". If your
server is serving resources in some non-POSIX-filesystem namespace,
you may want to distinguish those as two distinct paths. In that
case, you can set the %SOUP_SERVER_RAW_PATHS property when creating
the #SoupServer, and it will leave those characters undecoded. (You
may want to call soup_uri_normalize() to decode any percent-encoded
characters that you aren't handling specially.)
@query contains the query component of the Request-URI parsed
according to the rules for HTML form handling. Although this is the
only commonly-used query string format in HTTP, there is nothing
that actually requires that HTTP URIs use that format; if your
server needs to use some other format, you can just ignore @query,
and call soup_message_get_uri() and parse the URI's query field
yourself.
See soup_server_add_handler() and soup_server_add_early_handler()
for details of what handlers can/should do.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="server" transfer-ownership="none">
<doc xml:space="preserve">the #SoupServer</doc>
<type name="Server" c:type="SoupServer*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the message being processed</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="path" transfer-ownership="none">
<doc xml:space="preserve">the path component of @msg's Request-URI</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="query"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the parsed query
component of @msg's Request-URI</doc>
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="utf8"/>
<type name="utf8"/>
</type>
</parameter>
<parameter name="client" transfer-ownership="none">
<doc xml:space="preserve">additional contextual information about the client</doc>
<type name="ClientContext" c:type="SoupClientContext*"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" closure="5">
<doc xml:space="preserve">the data passed to soup_server_add_handler() or
soup_server_add_early_handler().</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<record name="ServerClass"
c:type="SoupServerClass"
glib:is-gtype-struct-for="Server">
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="request_started">
<callback name="request_started">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="server" transfer-ownership="none">
<type name="Server" c:type="SoupServer*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="client" transfer-ownership="none">
<type name="ClientContext" c:type="SoupClientContext*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="request_read">
<callback name="request_read">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="server" transfer-ownership="none">
<type name="Server" c:type="SoupServer*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="client" transfer-ownership="none">
<type name="ClientContext" c:type="SoupClientContext*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="request_finished">
<callback name="request_finished">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="server" transfer-ownership="none">
<type name="Server" c:type="SoupServer*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="client" transfer-ownership="none">
<type name="ClientContext" c:type="SoupClientContext*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="request_aborted">
<callback name="request_aborted">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="server" transfer-ownership="none">
<type name="Server" c:type="SoupServer*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="client" transfer-ownership="none">
<type name="ClientContext" c:type="SoupClientContext*"/>
</parameter>
</parameters>
</callback>
</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>
<bitfield name="ServerListenOptions"
version="2.48"
glib:type-name="SoupServerListenOptions"
glib:get-type="soup_server_listen_options_get_type"
c:type="SoupServerListenOptions">
<doc xml:space="preserve">Options to pass to soup_server_listen(), etc.
%SOUP_SERVER_LISTEN_IPV4_ONLY and %SOUP_SERVER_LISTEN_IPV6_ONLY
only make sense with soup_server_listen_all() and
soup_server_listen_local(), not plain soup_server_listen() (which
simply listens on whatever kind of socket you give it). And you
cannot specify both of them in a single call.</doc>
<member name="https"
value="1"
c:identifier="SOUP_SERVER_LISTEN_HTTPS"
glib:nick="https">
<doc xml:space="preserve">Listen for https connections rather
than plain http.</doc>
</member>
<member name="ipv4_only"
value="2"
c:identifier="SOUP_SERVER_LISTEN_IPV4_ONLY"
glib:nick="ipv4-only">
<doc xml:space="preserve">Only listen on IPv4 interfaces.</doc>
</member>
<member name="ipv6_only"
value="4"
c:identifier="SOUP_SERVER_LISTEN_IPV6_ONLY"
glib:nick="ipv6-only">
<doc xml:space="preserve">Only listen on IPv6 interfaces.</doc>
</member>
</bitfield>
<callback name="ServerWebsocketCallback"
c:type="SoupServerWebsocketCallback">
<doc xml:space="preserve">A callback used to handle WebSocket requests to a #SoupServer. The
callback will be invoked after sending the handshake response back
to the client (and is only invoked if the handshake was
successful).
@path contains the path of the Request-URI, subject to the same
rules as #SoupServerCallback (qv).</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="server" transfer-ownership="none">
<doc xml:space="preserve">the #SoupServer</doc>
<type name="Server" c:type="SoupServer*"/>
</parameter>
<parameter name="connection" transfer-ownership="none">
<doc xml:space="preserve">the newly created WebSocket connection</doc>
<type name="WebsocketConnection" c:type="SoupWebsocketConnection*"/>
</parameter>
<parameter name="path" transfer-ownership="none">
<doc xml:space="preserve">the path component of @msg's Request-URI</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="client" transfer-ownership="none">
<doc xml:space="preserve">additional contextual information about the client</doc>
<type name="ClientContext" c:type="SoupClientContext*"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" closure="4">
<doc xml:space="preserve">the data passed to @soup_server_add_handler</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<class name="Session"
c:symbol-prefix="session"
c:type="SoupSession"
parent="GObject.Object"
glib:type-name="SoupSession"
glib:get-type="soup_session_get_type"
glib:type-struct="SessionClass">
<constructor name="new" c:identifier="soup_session_new" version="2.42">
<doc xml:space="preserve">Creates a #SoupSession with the default options.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the new session.</doc>
<type name="Session" c:type="SoupSession*"/>
</return-value>
</constructor>
<constructor name="new_with_options"
c:identifier="soup_session_new_with_options"
version="2.42"
introspectable="0">
<doc xml:space="preserve">Creates a #SoupSession with the specified options.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the new session.</doc>
<type name="Session" c:type="SoupSession*"/>
</return-value>
<parameters>
<parameter name="optname1" transfer-ownership="none">
<doc xml:space="preserve">name of first property to set</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">value of @optname1, followed by additional property/value pairs</doc>
<varargs/>
</parameter>
</parameters>
</constructor>
<virtual-method name="auth_required">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="auth" transfer-ownership="none">
<type name="Auth" c:type="SoupAuth*"/>
</parameter>
<parameter name="retrying" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="authenticate">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="auth" transfer-ownership="none">
<type name="Auth" c:type="SoupAuth*"/>
</parameter>
<parameter name="retrying" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="cancel_message" invoker="cancel_message">
<doc xml:space="preserve">Causes @session to immediately finish processing @msg (regardless
of its current state) with a final status_code of @status_code. You
may call this at any time after handing @msg off to @session; if
@session has started sending the request but has not yet received
the complete response, then it will close the request's connection.
Note that with requests that have side effects (eg,
<literal>POST</literal>, <literal>PUT</literal>,
<literal>DELETE</literal>) it is possible that you might cancel the
request after the server acts on it, but before it returns a
response, leaving the remote resource in an unknown state.
If the message is cancelled while its response body is being read,
then the response body in @msg will be left partially-filled-in.
The response headers, on the other hand, will always be either
empty or complete.
Beware that with the deprecated #SoupSessionAsync, messages queued
with soup_session_queue_message() will have their callbacks invoked
before soup_session_cancel_message() returns. The plain
#SoupSession does not have this behavior; cancelling an
asynchronous message will merely queue its callback to be run after
returning to the main loop.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the message to cancel</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="status_code" transfer-ownership="none">
<doc xml:space="preserve">status code to set on @msg (generally
%SOUP_STATUS_CANCELLED)</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="flush_queue">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="kick">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="queue_message" invoker="queue_message">
<doc xml:space="preserve">Queues the message @msg for asynchronously sending the request and
receiving a response in the current thread-default #GMainContext.
If @msg has been processed before, any resources related to the
time it was last sent are freed.
Upon message completion, the callback specified in @callback will
be invoked. If after returning from this callback the message has not
been requeued, @msg will be unreffed.
(The behavior above applies to a plain #SoupSession; if you are
using #SoupSessionAsync or #SoupSessionSync, then the #GMainContext
that is used depends on the settings of #SoupSession:async-context
and #SoupSession:use-thread-context, and for #SoupSessionSync, the
message will actually be sent and processed in another thread, with
only the final callback occurring in the indicated #GMainContext.)
Contrast this method with soup_session_send_async(), which also
asynchronously sends a message, but returns before reading the
response body, and allows you to read the response via a
#GInputStream.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="full">
<doc xml:space="preserve">the message to queue</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async"
closure="2">
<doc xml:space="preserve">a #SoupSessionCallback which will
be called after the message completes or when an unrecoverable error occurs.</doc>
<type name="SessionCallback" c:type="SoupSessionCallback"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1"
closure="2">
<doc xml:space="preserve">a pointer passed to @callback.</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="request_started">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="socket" transfer-ownership="none">
<type name="Socket" c:type="SoupSocket*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="requeue_message" invoker="requeue_message">
<doc xml:space="preserve">This causes @msg to be placed back on the queue to be attempted
again.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the message to requeue</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="send_message" invoker="send_message">
<doc xml:space="preserve">Synchronously send @msg. This call will not return until the
transfer is finished successfully or there is an unrecoverable
error.
Unlike with soup_session_queue_message(), @msg is not freed upon
return.
(Note that if you call this method on a #SoupSessionAsync, it will
still use asynchronous I/O internally, running the glib main loop
to process the message, which may also cause other events to be
processed.)
Contrast this method with soup_session_send(), which also
synchronously sends a message, but returns before reading the
response body, and allows you to read the response via a
#GInputStream.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the HTTP status code of the response</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the message to send</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</virtual-method>
<method name="abort" c:identifier="soup_session_abort">
<doc xml:space="preserve">Cancels all pending requests in @session and closes all idle
persistent connections.
The message cancellation has the same semantics as with
soup_session_cancel_message(); asynchronous requests on a
#SoupSessionAsync will have their callback called before
soup_session_abort() returns. Requests on a plain #SoupSession will
not.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">the session</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
</parameters>
</method>
<method name="add_feature"
c:identifier="soup_session_add_feature"
version="2.24">
<doc xml:space="preserve">Adds @feature's functionality to @session. You can also add a
feature to the session at construct time by using the
%SOUP_SESSION_ADD_FEATURE property.
See the main #SoupSession documentation for information on what
features are present in sessions by default.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="feature" transfer-ownership="none">
<doc xml:space="preserve">an object that implements #SoupSessionFeature</doc>
<type name="SessionFeature" c:type="SoupSessionFeature*"/>
</parameter>
</parameters>
</method>
<method name="add_feature_by_type"
c:identifier="soup_session_add_feature_by_type"
version="2.24">
<doc xml:space="preserve">If @feature_type is the type of a class that implements
#SoupSessionFeature, this creates a new feature of that type and
adds it to @session as with soup_session_add_feature(). You can use
this when you don't need to customize the new feature in any way.
If @feature_type is not a #SoupSessionFeature type, this gives each
existing feature on @session the chance to accept @feature_type as
a "subfeature". This can be used to add new #SoupAuth or
#SoupRequest types, for instance.
You can also add a feature to the session at construct time by
using the %SOUP_SESSION_ADD_FEATURE_BY_TYPE property.
See the main #SoupSession documentation for information on what
features are present in sessions by default.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="feature_type" transfer-ownership="none">
<doc xml:space="preserve">a #GType</doc>
<type name="GType" c:type="GType"/>
</parameter>
</parameters>
</method>
<method name="cancel_message" c:identifier="soup_session_cancel_message">
<doc xml:space="preserve">Causes @session to immediately finish processing @msg (regardless
of its current state) with a final status_code of @status_code. You
may call this at any time after handing @msg off to @session; if
@session has started sending the request but has not yet received
the complete response, then it will close the request's connection.
Note that with requests that have side effects (eg,
<literal>POST</literal>, <literal>PUT</literal>,
<literal>DELETE</literal>) it is possible that you might cancel the
request after the server acts on it, but before it returns a
response, leaving the remote resource in an unknown state.
If the message is cancelled while its response body is being read,
then the response body in @msg will be left partially-filled-in.
The response headers, on the other hand, will always be either
empty or complete.
Beware that with the deprecated #SoupSessionAsync, messages queued
with soup_session_queue_message() will have their callbacks invoked
before soup_session_cancel_message() returns. The plain
#SoupSession does not have this behavior; cancelling an
asynchronous message will merely queue its callback to be run after
returning to the main loop.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the message to cancel</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="status_code" transfer-ownership="none">
<doc xml:space="preserve">status code to set on @msg (generally
%SOUP_STATUS_CANCELLED)</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="get_async_context"
c:identifier="soup_session_get_async_context">
<doc xml:space="preserve">Gets @session's #SoupSession:async-context. This does not add a ref
to the context, so you will need to ref it yourself if you want it
to outlive its session.
For a modern #SoupSession, this will always just return the
thread-default #GMainContext, and so is not especially useful.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">@session's #GMainContext,
which may be %NULL</doc>
<type name="GLib.MainContext" c:type="GMainContext*"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_feature"
c:identifier="soup_session_get_feature"
version="2.26">
<doc xml:space="preserve">Gets the first feature in @session of type @feature_type. For
features where there may be more than one feature of a given type,
use soup_session_get_features().</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">a #SoupSessionFeature, or
%NULL. The feature is owned by @session.</doc>
<type name="SessionFeature" c:type="SoupSessionFeature*"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="feature_type" transfer-ownership="none">
<doc xml:space="preserve">the #GType of the feature to get</doc>
<type name="GType" c:type="GType"/>
</parameter>
</parameters>
</method>
<method name="get_feature_for_message"
c:identifier="soup_session_get_feature_for_message"
version="2.28">
<doc xml:space="preserve">Gets the first feature in @session of type @feature_type, provided
that it is not disabled for @msg. As with
soup_session_get_feature(), this should only be used for features
where @feature_type is only expected to match a single feature. In
particular, if there are two matching features, and the first is
disabled on @msg, and the second is not, then this will return
%NULL, not the second feature.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">a #SoupSessionFeature, or %NULL. The
feature is owned by @session.</doc>
<type name="SessionFeature" c:type="SoupSessionFeature*"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="feature_type" transfer-ownership="none">
<doc xml:space="preserve">the #GType of the feature to get</doc>
<type name="GType" c:type="GType"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</method>
<method name="get_features"
c:identifier="soup_session_get_features"
version="2.26">
<doc xml:space="preserve">Generates a list of @session's features of type @feature_type. (If
you want to see all features, you can pass %SOUP_TYPE_SESSION_FEATURE
for @feature_type.)</doc>
<return-value transfer-ownership="container">
<doc xml:space="preserve">
a list of features. You must free the list, but not its contents</doc>
<type name="GLib.SList" c:type="GSList*">
<type name="SessionFeature"/>
</type>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="feature_type" transfer-ownership="none">
<doc xml:space="preserve">the #GType of the class of features to get</doc>
<type name="GType" c:type="GType"/>
</parameter>
</parameters>
</method>
<method name="has_feature"
c:identifier="soup_session_has_feature"
version="2.42">
<doc xml:space="preserve">Tests if @session has at a feature of type @feature_type (which can
be the type of either a #SoupSessionFeature, or else a subtype of
some class managed by another feature, such as #SoupAuth or
#SoupRequest).</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE or %FALSE</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="feature_type" transfer-ownership="none">
<doc xml:space="preserve">the #GType of the class of features to check for</doc>
<type name="GType" c:type="GType"/>
</parameter>
</parameters>
</method>
<method name="pause_message" c:identifier="soup_session_pause_message">
<doc xml:space="preserve">Pauses HTTP I/O on @msg. Call soup_session_unpause_message() to
resume I/O.
This may only be called for asynchronous messages (those sent on a
#SoupSessionAsync or using soup_session_queue_message()).</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage currently running on @session</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</method>
<method name="prefetch_dns"
c:identifier="soup_session_prefetch_dns"
version="2.38">
<doc xml:space="preserve">Tells @session that an URI from the given @hostname may be requested
shortly, and so the session can try to prepare by resolving the
domain name in advance, in order to work more quickly once the URI
is actually requested.
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.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="hostname" transfer-ownership="none">
<doc xml:space="preserve">a hostname to be resolved</doc>
<type name="utf8" c:type="const char*"/>
</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"
nullable="1"
allow-none="1"
scope="async"
closure="3">
<doc xml:space="preserve">callback to call with the
result, or %NULL</doc>
<type name="AddressCallback" c:type="SoupAddressCallback"/>
</parameter>
<parameter name="user_data" transfer-ownership="none">
<doc xml:space="preserve">data for @callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</method>
<method name="prepare_for_uri"
c:identifier="soup_session_prepare_for_uri"
version="2.30"
deprecated="1"
deprecated-version="2.38">
<doc xml:space="preserve">Tells @session that @uri may be requested shortly, and so the
session can try to prepare (resolving the domain name, obtaining
proxy address, etc.) in order to work more quickly once the URI is
actually requested.</doc>
<doc-deprecated xml:space="preserve">use soup_session_prefetch_dns() instead</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI which may be required</doc>
<type name="URI" c:type="SoupURI*"/>
</parameter>
</parameters>
</method>
<method name="queue_message" c:identifier="soup_session_queue_message">
<doc xml:space="preserve">Queues the message @msg for asynchronously sending the request and
receiving a response in the current thread-default #GMainContext.
If @msg has been processed before, any resources related to the
time it was last sent are freed.
Upon message completion, the callback specified in @callback will
be invoked. If after returning from this callback the message has not
been requeued, @msg will be unreffed.
(The behavior above applies to a plain #SoupSession; if you are
using #SoupSessionAsync or #SoupSessionSync, then the #GMainContext
that is used depends on the settings of #SoupSession:async-context
and #SoupSession:use-thread-context, and for #SoupSessionSync, the
message will actually be sent and processed in another thread, with
only the final callback occurring in the indicated #GMainContext.)
Contrast this method with soup_session_send_async(), which also
asynchronously sends a message, but returns before reading the
response body, and allows you to read the response via a
#GInputStream.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="full">
<doc xml:space="preserve">the message to queue</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async"
closure="2">
<doc xml:space="preserve">a #SoupSessionCallback which will
be called after the message completes or when an unrecoverable error occurs.</doc>
<type name="SessionCallback" c:type="SoupSessionCallback"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a pointer passed to @callback.</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</method>
<method name="redirect_message"
c:identifier="soup_session_redirect_message"
version="2.38">
<doc xml:space="preserve">Updates @msg's URI according to its status code and "Location"
header, and requeues it on @session. Use this when you have set
%SOUP_MESSAGE_NO_REDIRECT on a message, but have decided to allow a
particular redirection to occur, or if you want to allow a
redirection that #SoupSession will not perform automatically (eg,
redirecting a non-safe method such as DELETE).
If @msg's status code indicates that it should be retried as a GET
request, then @msg will be modified accordingly.
If @msg has already been redirected too many times, this will
cause it to fail with %SOUP_STATUS_TOO_MANY_REDIRECTS.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if a redirection was applied, %FALSE if not
(eg, because there was no Location header, or it could not be
parsed).</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">the session</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage that has received a 3xx response</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</method>
<method name="remove_feature"
c:identifier="soup_session_remove_feature"
version="2.24">
<doc xml:space="preserve">Removes @feature's functionality from @session.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="feature" transfer-ownership="none">
<doc xml:space="preserve">a feature that has previously been added to @session</doc>
<type name="SessionFeature" c:type="SoupSessionFeature*"/>
</parameter>
</parameters>
</method>
<method name="remove_feature_by_type"
c:identifier="soup_session_remove_feature_by_type"
version="2.24">
<doc xml:space="preserve">Removes all features of type @feature_type (or any subclass of
@feature_type) from @session. You can also remove standard features
from the session at construct time by using the
%SOUP_SESSION_REMOVE_FEATURE_BY_TYPE property.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="feature_type" transfer-ownership="none">
<doc xml:space="preserve">a #GType</doc>
<type name="GType" c:type="GType"/>
</parameter>
</parameters>
</method>
<method name="request"
c:identifier="soup_session_request"
version="2.42"
throws="1">
<doc xml:space="preserve">Creates a #SoupRequest for retrieving @uri_string.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #SoupRequest, or
%NULL on error.</doc>
<type name="Request" c:type="SoupRequest*"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="uri_string" transfer-ownership="none">
<doc xml:space="preserve">a URI, in string form</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="request_http"
c:identifier="soup_session_request_http"
version="2.42"
throws="1">
<doc xml:space="preserve">Creates a #SoupRequest for retrieving @uri_string, which must be an
"http" or "https" URI (or another protocol listed in @session's
#SoupSession:http-aliases or #SoupSession:https-aliases).</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #SoupRequestHTTP, or
%NULL on error.</doc>
<type name="RequestHTTP" c:type="SoupRequestHTTP*"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="method" transfer-ownership="none">
<doc xml:space="preserve">an HTTP method</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="uri_string" transfer-ownership="none">
<doc xml:space="preserve">a URI, in string form</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="request_http_uri"
c:identifier="soup_session_request_http_uri"
version="2.42"
throws="1">
<doc xml:space="preserve">Creates a #SoupRequest for retrieving @uri, which must be an
"http" or "https" URI (or another protocol listed in @session's
#SoupSession:http-aliases or #SoupSession:https-aliases).</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #SoupRequestHTTP, or
%NULL on error.</doc>
<type name="RequestHTTP" c:type="SoupRequestHTTP*"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="method" transfer-ownership="none">
<doc xml:space="preserve">an HTTP method</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI representing the URI to retrieve</doc>
<type name="URI" c:type="SoupURI*"/>
</parameter>
</parameters>
</method>
<method name="request_uri"
c:identifier="soup_session_request_uri"
version="2.42"
throws="1">
<doc xml:space="preserve">Creates a #SoupRequest for retrieving @uri.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #SoupRequest, or
%NULL on error.</doc>
<type name="Request" c:type="SoupRequest*"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI representing the URI to retrieve</doc>
<type name="URI" c:type="SoupURI*"/>
</parameter>
</parameters>
</method>
<method name="requeue_message"
c:identifier="soup_session_requeue_message">
<doc xml:space="preserve">This causes @msg to be placed back on the queue to be attempted
again.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the message to requeue</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</method>
<method name="send"
c:identifier="soup_session_send"
version="2.42"
throws="1">
<doc xml:space="preserve">Synchronously sends @msg and waits for the beginning of a response.
On success, a #GInputStream will be returned which you can use to
read the response body. ("Success" here means only that an HTTP
response was received and understood; it does not necessarily mean
that a 2xx class status code was received.)
If non-%NULL, @cancellable can be used to cancel the request;
soup_session_send() will return a %G_IO_ERROR_CANCELLED error. Note
that with requests that have side effects (eg,
<literal>POST</literal>, <literal>PUT</literal>,
<literal>DELETE</literal>) it is possible that you might cancel the
request after the server acts on it, but before it returns a
response, leaving the remote resource in an unknown state.
If @msg is requeued due to a redirect or authentication, the
initial (3xx/401/407) response body will be suppressed, and
soup_session_send() will only return once a final response has been
received.
Contrast this method with soup_session_send_message(), which also
synchronously sends a #SoupMessage, but doesn't return until the
response has been completely read.
(Note that this method cannot be called on the deprecated
#SoupSessionAsync subclass.)</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GInputStream for reading the
response body, or %NULL on error.</doc>
<type name="Gio.InputStream" c:type="GInputStream*"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GCancellable</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
</parameters>
</method>
<method name="send_async"
c:identifier="soup_session_send_async"
version="2.42">
<doc xml:space="preserve">Asynchronously sends @msg and waits for the beginning of a
response. When @callback is called, then either @msg has been sent,
and its response headers received, or else an error has occurred.
Call soup_session_send_finish() to get a #GInputStream for reading
the response body.
See soup_session_send() for more details on the general semantics.
Contrast this method with soup_session_queue_message(), which also
asynchronously sends a #SoupMessage, but doesn't invoke its
callback until the response has been completely read.
(Note that this method cannot be called on the deprecated
#SoupSessionSync subclass, and can only be called on
#SoupSessionAsync if you have set the
#SoupSession:use-thread-context property.)</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GCancellable</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async"
closure="3">
<doc xml:space="preserve">the callback to invoke</doc>
<type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
</parameter>
<parameter name="user_data" transfer-ownership="none">
<doc xml:space="preserve">data for @callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</method>
<method name="send_finish"
c:identifier="soup_session_send_finish"
version="2.42"
throws="1">
<doc xml:space="preserve">Gets the response to a soup_session_send_async() call and (if
successful), returns a #GInputStream that can be used to read the
response body.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GInputStream for reading the
response body, or %NULL on error.</doc>
<type name="Gio.InputStream" c:type="GInputStream*"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="result" transfer-ownership="none">
<doc xml:space="preserve">the #GAsyncResult passed to your callback</doc>
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
</parameter>
</parameters>
</method>
<method name="send_message" c:identifier="soup_session_send_message">
<doc xml:space="preserve">Synchronously send @msg. This call will not return until the
transfer is finished successfully or there is an unrecoverable
error.
Unlike with soup_session_queue_message(), @msg is not freed upon
return.
(Note that if you call this method on a #SoupSessionAsync, it will
still use asynchronous I/O internally, running the glib main loop
to process the message, which may also cause other events to be
processed.)
Contrast this method with soup_session_send(), which also
synchronously sends a message, but returns before reading the
response body, and allows you to read the response via a
#GInputStream.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the HTTP status code of the response</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the message to send</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</method>
<method name="steal_connection"
c:identifier="soup_session_steal_connection"
version="2.50">
<doc xml:space="preserve">"Steals" the HTTP connection associated with @msg from @session.
This happens immediately, regardless of the current state of the
connection, and @msg's callback will not be called. You can steal
the connection from a #SoupMessage signal handler if you need to
wait for part or all of the response to be received first.
Calling this function may cause @msg to be freed if you are not
holding any other reference to it.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the #GIOStream formerly associated
with @msg (or %NULL if @msg was no longer associated with a
connection). No guarantees are made about what kind of #GIOStream
is returned.</doc>
<type name="Gio.IOStream" c:type="GIOStream*"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the message whose connection is to be stolen</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</method>
<method name="unpause_message"
c:identifier="soup_session_unpause_message">
<doc xml:space="preserve">Resumes HTTP I/O on @msg. Use this to resume after calling
soup_session_pause_message().
If @msg is being sent via blocking I/O, this will resume reading or
writing immediately. If @msg is using non-blocking I/O, then
reading or writing won't resume until you return to the main loop.
This may only be called for asynchronous messages (those sent on a
#SoupSessionAsync or using soup_session_queue_message()).</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage currently running on @session</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</method>
<method name="websocket_connect_async"
c:identifier="soup_session_websocket_connect_async"
version="2.50">
<doc xml:space="preserve">Asynchronously creates a #SoupWebsocketConnection to communicate
with a remote server.
All necessary WebSocket-related headers will be added to @msg, and
it will then be sent and asynchronously processed normally
(including handling of redirection and HTTP authentication).
If the server returns "101 Switching Protocols", then @msg's status
code and response headers will be updated, and then the WebSocket
handshake will be completed. On success,
soup_websocket_connect_finish() will return a new
#SoupWebsocketConnection. On failure it will return a #GError.
If the server returns a status other than "101 Switching
Protocols", then @msg will contain the complete response headers
and body from the server's response, and
soup_websocket_connect_finish() will return
%SOUP_WEBSOCKET_ERROR_NOT_WEBSOCKET.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">#SoupMessage indicating the WebSocket server to connect to</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="origin"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">origin of the connection</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="protocols"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a
%NULL-terminated array of protocols supported</doc>
<array c:type="char**">
<type name="utf8" c:type="char*"/>
</array>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GCancellable</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async"
closure="5">
<doc xml:space="preserve">the callback to invoke</doc>
<type name="Gio.AsyncReadyCallback" c:type="GAsyncReadyCallback"/>
</parameter>
<parameter name="user_data" transfer-ownership="none">
<doc xml:space="preserve">data for @callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</method>
<method name="websocket_connect_finish"
c:identifier="soup_session_websocket_connect_finish"
version="2.50"
throws="1">
<doc xml:space="preserve">Gets the #SoupWebsocketConnection response to a
soup_session_websocket_connect_async() call and (if successful),
returns a #SoupWebsockConnection that can be used to communicate
with the server.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #SoupWebsocketConnection, or
%NULL on error.</doc>
<type name="WebsocketConnection" c:type="SoupWebsocketConnection*"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="result" transfer-ownership="none">
<doc xml:space="preserve">the #GAsyncResult passed to your callback</doc>
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
</parameter>
</parameters>
</method>
<method name="would_redirect"
c:identifier="soup_session_would_redirect"
version="2.38">
<doc xml:space="preserve">Checks if @msg contains a response that would cause @session to
redirect it to a new URL (ignoring @msg's %SOUP_MESSAGE_NO_REDIRECT
flag, and the number of times it has already been redirected).</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">whether @msg would be redirected</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</instance-parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage that has response headers</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</method>
<property name="accept-language"
version="2.30"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve">If non-%NULL, the value to use for the "Accept-Language" header
on #SoupMessage<!-- -->s sent from this session.
Setting this will disable
#SoupSession:accept-language-auto.</doc>
<type name="utf8" c:type="gchar*"/>
</property>
<property name="accept-language-auto"
version="2.30"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve">If %TRUE, #SoupSession will automatically set the string
for the "Accept-Language" header on every #SoupMessage
sent, based on the return value of g_get_language_names().
Setting this will override any previous value of
#SoupSession:accept-language.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="add-feature"
version="2.24"
introspectable="0"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve">Add a feature object to the session. (Shortcut for calling
soup_session_add_feature().)</doc>
<type name="SessionFeature"/>
</property>
<property name="add-feature-by-type"
version="2.24"
introspectable="0"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve">Add a feature object of the given type to the session.
(Shortcut for calling soup_session_add_feature_by_type().)</doc>
<type name="GType" c:type="GType"/>
</property>
<property name="async-context"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve">The #GMainContext that miscellaneous session-related
asynchronous callbacks are invoked on. (Eg, setting
#SoupSession:idle-timeout will add a timeout source on this
context.)
For a plain #SoupSession, this property is always set to
the #GMainContext that is the thread-default at the time
the session was created, and cannot be overridden. For the
deprecated #SoupSession subclasses, the default value is
%NULL, meaning to use the global default #GMainContext.
If #SoupSession:use-thread-context is %FALSE, this context
will also be used for asynchronous HTTP I/O.</doc>
<type name="gpointer" c:type="gpointer"/>
</property>
<property name="http-aliases"
version="2.38"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve">A %NULL-terminated array of URI schemes that should be
considered to be aliases for "http". Eg, if this included
<literal>"dav"</literal>, than a URI of
<literal>dav://example.com/path</literal> would be treated
identically to <literal>http://example.com/path</literal>.
In a plain #SoupSession, the default value is %NULL,
meaning that only "http" is recognized as meaning "http".
In #SoupSessionAsync and #SoupSessionSync, for backward
compatibility, the default value is an array containing the
single element <literal>"*"</literal>, a special value
which means that any scheme except "https" is considered to
be an alias for "http".
See also #SoupSession:https-aliases.</doc>
<array>
<type name="utf8"/>
</array>
</property>
<property name="https-aliases"
version="2.38"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve">A comma-delimited list of URI schemes that should be
considered to be aliases for "https". See
#SoupSession:http-aliases for more information.
The default value is %NULL, meaning that no URI schemes
are considered aliases for "https".</doc>
<array>
<type name="utf8"/>
</array>
</property>
<property name="idle-timeout"
version="2.24"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve">Connection lifetime (in seconds) when idle. Any connection
left idle longer than this will be closed.
Although you can change this property at any time, it will
only affect newly-created connections, not currently-open
ones. You can call soup_session_abort() after setting this
if you want to ensure that all future connections will have
this timeout value.
Note that the default value of 60 seconds only applies to
plain #SoupSessions. If you are using #SoupSessionAsync or
#SoupSessionSync, the default value is 0 (meaning idle
connections will never time out).</doc>
<type name="guint" c:type="guint"/>
</property>
<property name="local-address"
version="2.42"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve">Sets the #SoupAddress to use for the client side of
the connection.
Use this property if you want for instance to bind the
local socket to a specific IP address.</doc>
<type name="Address"/>
</property>
<property name="max-conns" writable="1" transfer-ownership="none">
<type name="gint" c:type="gint"/>
</property>
<property name="max-conns-per-host"
writable="1"
transfer-ownership="none">
<type name="gint" c:type="gint"/>
</property>
<property name="proxy-resolver"
version="2.42"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve">A #GProxyResolver to use with this session. Setting this
will clear the #SoupSession:proxy-uri property, and remove
any <type>SoupProxyURIResolver</type> features that have
been added to the session.
By default, in a plain #SoupSession, this is set to the
default #GProxyResolver, but you can set it to %NULL if you
don't want to use proxies, or set it to your own
#GProxyResolver if you want to control what proxies get
used.</doc>
<type name="Gio.ProxyResolver"/>
</property>
<property name="proxy-uri" writable="1" transfer-ownership="none">
<doc xml:space="preserve">A proxy to use for all http and https requests in this
session. Setting this will clear the
#SoupSession:proxy-resolver property, and remove any
<type>SoupProxyURIResolver</type> features that have been
added to the session. Setting this property will also
cancel all currently pending messages.
Note that #SoupSession will normally handle looking up the
user's proxy settings for you; you should only use
#SoupSession:proxy-uri if you need to override the user's
normal proxy settings.
Also note that this proxy will be used for
<emphasis>all</emphasis> requests; even requests to
<literal>localhost</literal>. If you need more control over
proxies, you can create a #GSimpleProxyResolver and set the
#SoupSession:proxy-resolver property.</doc>
<type name="URI"/>
</property>
<property name="remove-feature-by-type"
version="2.24"
introspectable="0"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve">Remove feature objects from the session. (Shortcut for
calling soup_session_remove_feature_by_type().)</doc>
<type name="GType" c:type="GType"/>
</property>
<property name="ssl-ca-file"
deprecated="1"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve">File containing SSL CA certificates.
If the specified file does not exist or cannot be read,
then libsoup will print a warning, and then behave as
though it had read in a empty CA file, meaning that all SSL
certificates will be considered invalid.</doc>
<doc-deprecated xml:space="preserve">use #SoupSession:ssl-use-system-ca-file, or
else #SoupSession:tls-database with a #GTlsFileDatabase
(which allows you to do explicit error handling).</doc-deprecated>
<type name="utf8" c:type="gchar*"/>
</property>
<property name="ssl-strict"
version="2.30"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve">Normally, if #SoupSession:tls-database is set (including if
it was set via #SoupSession:ssl-use-system-ca-file or
#SoupSession:ssl-ca-file), then libsoup will reject any
certificate that is invalid (ie, expired) or that is not
signed by one of the given CA certificates, and the
#SoupMessage will fail with the status
%SOUP_STATUS_SSL_FAILED.
If you set #SoupSession:ssl-strict to %FALSE, then all
certificates will be accepted, and you will need to call
soup_message_get_https_status() to distinguish valid from
invalid certificates. (This can be used, eg, if you want to
accept invalid certificates after giving some sort of
warning.)
For a plain #SoupSession, if the session has no CA file or
TLS database, and this property is %TRUE, then all
certificates will be rejected. However, beware that the
deprecated #SoupSession subclasses (#SoupSessionAsync and
#SoupSessionSync) have the opposite behavior: if there is
no CA file or TLS database, then all certificates are always
accepted, and this property has no effect.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="ssl-use-system-ca-file"
version="2.38"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve">Setting this to %TRUE is equivalent to setting
#SoupSession:tls-database to the default system CA database.
(and likewise, setting #SoupSession:tls-database to the
default database by hand will cause this property to
become %TRUE).
Setting this to %FALSE (when it was previously %TRUE) will
clear the #SoupSession:tls-database field.
See #SoupSession:ssl-strict for more information on how
https certificate validation is handled.
Note that the default value of %TRUE only applies to plain
#SoupSessions. If you are using #SoupSessionAsync or
#SoupSessionSync, the default value is %FALSE, for backward
compatibility.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="timeout" writable="1" transfer-ownership="none">
<doc xml:space="preserve">The timeout (in seconds) for socket I/O operations
(including connecting to a server, and waiting for a reply
to an HTTP request).
Although you can change this property at any time, it will
only affect newly-created connections, not currently-open
ones. You can call soup_session_abort() after setting this
if you want to ensure that all future connections will have
this timeout value.
Note that the default value of 60 seconds only applies to
plain #SoupSessions. If you are using #SoupSessionAsync or
#SoupSessionSync, the default value is 0 (meaning socket I/O
will not time out).
Not to be confused with #SoupSession:idle-timeout (which is
the length of time that idle persistent connections will be
kept open).</doc>
<type name="guint" c:type="guint"/>
</property>
<property name="tls-database"
version="2.38"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve">Sets the #GTlsDatabase to use for validating SSL/TLS
certificates.
Note that setting the #SoupSession:ssl-ca-file or
#SoupSession:ssl-use-system-ca-file property will cause
this property to be set to a #GTlsDatabase corresponding to
the indicated file or system default.
See #SoupSession:ssl-strict for more information on how
https certificate validation is handled.
If you are using a plain #SoupSession then
#SoupSession:ssl-use-system-ca-file will be %TRUE by
default, and so this property will be a copy of the system
CA database. If you are using #SoupSessionAsync or
#SoupSessionSync, this property will be %NULL by default.</doc>
<type name="Gio.TlsDatabase"/>
</property>
<property name="tls-interaction"
version="2.48"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve">A #GTlsInteraction object that will be passed on to any
#GTlsConnections created by the session. (This can be used to
provide client-side certificates, for example.)</doc>
<type name="Gio.TlsInteraction"/>
</property>
<property name="use-ntlm"
deprecated="1"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve">Whether or not to use NTLM authentication.</doc>
<doc-deprecated xml:space="preserve">use soup_session_add_feature_by_type() with
#SOUP_TYPE_AUTH_NTLM.</doc-deprecated>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="use-thread-context"
version="2.38"
writable="1"
transfer-ownership="none">
<doc xml:space="preserve">If %TRUE (which it always is on a plain #SoupSession),
asynchronous HTTP requests in this session will run in
whatever the thread-default #GMainContext is at the time
they are started, rather than always occurring in
#SoupSession:async-context.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="user-agent" writable="1" transfer-ownership="none">
<doc xml:space="preserve">If non-%NULL, the value to use for the "User-Agent" header
on #SoupMessage<!-- -->s sent from this session.
RFC 2616 says: "The User-Agent request-header field
contains information about the user agent originating the
request. This is for statistical purposes, the tracing of
protocol violations, and automated recognition of user
agents for the sake of tailoring responses to avoid
particular user agent limitations. User agents SHOULD
include this field with requests."
The User-Agent header contains a list of one or more
product tokens, separated by whitespace, with the most
significant product token coming first. The tokens must be
brief, ASCII, and mostly alphanumeric (although "-", "_",
and "." are also allowed), and may optionally include a "/"
followed by a version string. You may also put comments,
enclosed in parentheses, between or after the tokens.
If you set a #SoupSession:user_agent property that has trailing
whitespace, #SoupSession will append its own product token
(eg, "<literal>libsoup/2.3.2</literal>") to the end of the
header for you.</doc>
<type name="utf8" c:type="gchar*"/>
</property>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
<glib:signal name="authenticate" when="first">
<doc xml:space="preserve">Emitted when the session requires authentication. If
credentials are available call soup_auth_authenticate() on
@auth. If these credentials fail, the signal will be
emitted again, with @retrying set to %TRUE, which will
continue until you return without calling
soup_auth_authenticate() on @auth.
Note that this may be emitted before @msg's body has been
fully read.
If you call soup_session_pause_message() on @msg before
returning, then you can authenticate @auth asynchronously
(as long as you g_object_ref() it to make sure it doesn't
get destroyed), and then unpause @msg when you are ready
for it to continue.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the #SoupMessage being sent</doc>
<type name="Message"/>
</parameter>
<parameter name="auth" transfer-ownership="none">
<doc xml:space="preserve">the #SoupAuth to authenticate</doc>
<type name="Auth"/>
</parameter>
<parameter name="retrying" transfer-ownership="none">
<doc xml:space="preserve">%TRUE if this is the second (or later) attempt</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="connection-created" when="first" version="2.30">
<doc xml:space="preserve">Emitted when a new connection is created. This is an
internal signal intended only to be used for debugging
purposes, and may go away in the future.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="connection" transfer-ownership="none">
<doc xml:space="preserve">the connection</doc>
<type name="GObject.Object"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="request-queued" when="first" version="2.24">
<doc xml:space="preserve">Emitted when a request is queued on @session. (Note that
"queued" doesn't just mean soup_session_queue_message();
soup_session_send_message() implicitly queues the message
as well.)
When sending a request, first #SoupSession::request_queued
is emitted, indicating that the session has become aware of
the request.
Once a connection is available to send the request on, the
session emits #SoupSession::request_started. Then, various
#SoupMessage signals are emitted as the message is
processed. If the message is requeued, it will emit
#SoupMessage::restarted, which will then be followed by
another #SoupSession::request_started and another set of
#SoupMessage signals when the message is re-sent.
Eventually, the message will emit #SoupMessage::finished.
Normally, this signals the completion of message
processing. However, it is possible that the application
will requeue the message from the "finished" handler (or
equivalently, from the soup_session_queue_message()
callback). In that case, the process will loop back to
#SoupSession::request_started.
Eventually, a message will reach "finished" and not be
requeued. At that point, the session will emit
#SoupSession::request_unqueued to indicate that it is done
with the message.
To sum up: #SoupSession::request_queued and
#SoupSession::request_unqueued are guaranteed to be emitted
exactly once, but #SoupSession::request_started and
#SoupMessage::finished (and all of the other #SoupMessage
signals) may be invoked multiple times for a given message.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the request that was queued</doc>
<type name="Message"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="request-started"
when="first"
deprecated="1"
deprecated-version="2.50.">
<doc xml:space="preserve">Emitted just before a request is sent. See
#SoupSession::request_queued for a detailed description of
the message lifecycle within a session.</doc>
<doc-deprecated xml:space="preserve">Use #SoupMessage::starting instead.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the request being sent</doc>
<type name="Message"/>
</parameter>
<parameter name="socket" transfer-ownership="none">
<doc xml:space="preserve">the socket the request is being sent on</doc>
<type name="Socket"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="request-unqueued" when="first" version="2.24">
<doc xml:space="preserve">Emitted when a request is removed from @session's queue,
indicating that @session is done with it. See
#SoupSession::request_queued for a detailed description of the
message lifecycle within a session.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the request that was unqueued</doc>
<type name="Message"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="tunneling" when="first" version="2.30">
<doc xml:space="preserve">Emitted when an SSL tunnel is being created on a proxy
connection. This is an internal signal intended only to be
used for debugging purposes, and may go away in the future.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="connection" transfer-ownership="none">
<doc xml:space="preserve">the connection</doc>
<type name="GObject.Object"/>
</parameter>
</parameters>
</glib:signal>
</class>
<class name="SessionAsync"
c:symbol-prefix="session_async"
c:type="SoupSessionAsync"
parent="Session"
glib:type-name="SoupSessionAsync"
glib:get-type="soup_session_async_get_type"
glib:type-struct="SessionAsyncClass">
<constructor name="new"
c:identifier="soup_session_async_new"
deprecated="1">
<doc xml:space="preserve">Creates an asynchronous #SoupSession with the default options.</doc>
<doc-deprecated xml:space="preserve">#SoupSessionAsync is deprecated; use a plain
#SoupSession, created with soup_session_new(). See the <link
linkend="libsoup-session-porting">porting guide</link>.</doc-deprecated>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the new session.</doc>
<type name="Session" c:type="SoupSession*"/>
</return-value>
</constructor>
<constructor name="new_with_options"
c:identifier="soup_session_async_new_with_options"
introspectable="0"
deprecated="1">
<doc xml:space="preserve">Creates an asynchronous #SoupSession with the specified options.</doc>
<doc-deprecated xml:space="preserve">#SoupSessionAsync is deprecated; use a plain
#SoupSession, created with soup_session_new_with_options(). See the
<link linkend="libsoup-session-porting">porting guide</link>.</doc-deprecated>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the new session.</doc>
<type name="Session" c:type="SoupSession*"/>
</return-value>
<parameters>
<parameter name="optname1" transfer-ownership="none">
<doc xml:space="preserve">name of first property to set</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">value of @optname1, followed by additional property/value pairs</doc>
<varargs/>
</parameter>
</parameters>
</constructor>
<field name="parent">
<type name="Session" c:type="SoupSession"/>
</field>
</class>
<record name="SessionAsyncClass"
c:type="SoupSessionAsyncClass"
glib:is-gtype-struct-for="SessionAsync">
<field name="parent_class">
<type name="SessionClass" c:type="SoupSessionClass"/>
</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>
<callback name="SessionCallback" c:type="SoupSessionCallback">
<doc xml:space="preserve">Prototype for the callback passed to soup_session_queue_message(),
qv.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">the session</doc>
<type name="Session" c:type="SoupSession*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the message that has finished</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" closure="2">
<doc xml:space="preserve">the data passed to soup_session_queue_message</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<record name="SessionClass"
c:type="SoupSessionClass"
glib:is-gtype-struct-for="Session">
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="request_started">
<callback name="request_started">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="session" transfer-ownership="none">
<type name="Session" c:type="SoupSession*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="socket" transfer-ownership="none">
<type name="Socket" c:type="SoupSocket*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="authenticate">
<callback name="authenticate">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="session" transfer-ownership="none">
<type name="Session" c:type="SoupSession*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="auth" transfer-ownership="none">
<type name="Auth" c:type="SoupAuth*"/>
</parameter>
<parameter name="retrying" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</callback>
</field>
<field name="queue_message">
<callback name="queue_message">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</parameter>
<parameter name="msg" transfer-ownership="full">
<doc xml:space="preserve">the message to queue</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
nullable="1"
allow-none="1"
scope="async"
closure="3">
<doc xml:space="preserve">a #SoupSessionCallback which will
be called after the message completes or when an unrecoverable error occurs.</doc>
<type name="SessionCallback" c:type="SoupSessionCallback"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1"
closure="3">
<doc xml:space="preserve">a pointer passed to @callback.</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
</field>
<field name="requeue_message">
<callback name="requeue_message">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the message to requeue</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="send_message">
<callback name="send_message">
<return-value transfer-ownership="none">
<doc xml:space="preserve">the HTTP status code of the response</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the message to send</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="cancel_message">
<callback name="cancel_message">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="session" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSession</doc>
<type name="Session" c:type="SoupSession*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">the message to cancel</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="status_code" transfer-ownership="none">
<doc xml:space="preserve">status code to set on @msg (generally
%SOUP_STATUS_CANCELLED)</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</callback>
</field>
<field name="auth_required">
<callback name="auth_required">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="session" transfer-ownership="none">
<type name="Session" c:type="SoupSession*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="auth" transfer-ownership="none">
<type name="Auth" c:type="SoupAuth*"/>
</parameter>
<parameter name="retrying" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</callback>
</field>
<field name="flush_queue">
<callback name="flush_queue">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="session" transfer-ownership="none">
<type name="Session" c:type="SoupSession*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="kick">
<callback name="kick">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="session" transfer-ownership="none">
<type name="Session" c:type="SoupSession*"/>
</parameter>
</parameters>
</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>
<interface name="SessionFeature"
c:symbol-prefix="session_feature"
c:type="SoupSessionFeature"
version="2.24"
glib:type-name="SoupSessionFeature"
glib:get-type="soup_session_feature_get_type"
glib:type-struct="SessionFeatureInterface">
<doc xml:space="preserve">An object that implement some sort of optional feature for
#SoupSession.</doc>
<virtual-method name="add_feature" invoker="add_feature" version="2.34">
<doc xml:space="preserve">Adds a "sub-feature" of type @type to the base feature @feature.
This is used for features that can be extended with multiple
different types. Eg, the authentication manager can be extended
with subtypes of #SoupAuth.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @feature accepted @type as a subfeature.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="feature" transfer-ownership="none">
<doc xml:space="preserve">the "base" feature</doc>
<type name="SessionFeature" c:type="SoupSessionFeature*"/>
</instance-parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">the #GType of a "sub-feature"</doc>
<type name="GType" c:type="GType"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="attach" invoker="attach">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="feature" transfer-ownership="none">
<type name="SessionFeature" c:type="SoupSessionFeature*"/>
</instance-parameter>
<parameter name="session" transfer-ownership="none">
<type name="Session" c:type="SoupSession*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="detach" invoker="detach">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="feature" transfer-ownership="none">
<type name="SessionFeature" c:type="SoupSessionFeature*"/>
</instance-parameter>
<parameter name="session" transfer-ownership="none">
<type name="Session" c:type="SoupSession*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="has_feature" invoker="has_feature" version="2.34">
<doc xml:space="preserve">Tests if @feature has a "sub-feature" of type @type. See
soup_session_feature_add_feature().</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @feature has a subfeature of type @type</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="feature" transfer-ownership="none">
<doc xml:space="preserve">the "base" feature</doc>
<type name="SessionFeature" c:type="SoupSessionFeature*"/>
</instance-parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">the #GType of a "sub-feature"</doc>
<type name="GType" c:type="GType"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="remove_feature"
invoker="remove_feature"
version="2.34">
<doc xml:space="preserve">Removes the "sub-feature" of type @type from the base feature
@feature. See soup_session_feature_add_feature().</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @type was removed from @feature</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="feature" transfer-ownership="none">
<doc xml:space="preserve">the "base" feature</doc>
<type name="SessionFeature" c:type="SoupSessionFeature*"/>
</instance-parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">the #GType of a "sub-feature"</doc>
<type name="GType" c:type="GType"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="request_queued">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="feature" transfer-ownership="none">
<type name="SessionFeature" c:type="SoupSessionFeature*"/>
</instance-parameter>
<parameter name="session" transfer-ownership="none">
<type name="Session" c:type="SoupSession*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="request_started">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="feature" transfer-ownership="none">
<type name="SessionFeature" c:type="SoupSessionFeature*"/>
</instance-parameter>
<parameter name="session" transfer-ownership="none">
<type name="Session" c:type="SoupSession*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="socket" transfer-ownership="none">
<type name="Socket" c:type="SoupSocket*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="request_unqueued">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="feature" transfer-ownership="none">
<type name="SessionFeature" c:type="SoupSessionFeature*"/>
</instance-parameter>
<parameter name="session" transfer-ownership="none">
<type name="Session" c:type="SoupSession*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</virtual-method>
<method name="add_feature"
c:identifier="soup_session_feature_add_feature"
version="2.34">
<doc xml:space="preserve">Adds a "sub-feature" of type @type to the base feature @feature.
This is used for features that can be extended with multiple
different types. Eg, the authentication manager can be extended
with subtypes of #SoupAuth.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @feature accepted @type as a subfeature.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="feature" transfer-ownership="none">
<doc xml:space="preserve">the "base" feature</doc>
<type name="SessionFeature" c:type="SoupSessionFeature*"/>
</instance-parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">the #GType of a "sub-feature"</doc>
<type name="GType" c:type="GType"/>
</parameter>
</parameters>
</method>
<method name="attach" c:identifier="soup_session_feature_attach">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="feature" transfer-ownership="none">
<type name="SessionFeature" c:type="SoupSessionFeature*"/>
</instance-parameter>
<parameter name="session" transfer-ownership="none">
<type name="Session" c:type="SoupSession*"/>
</parameter>
</parameters>
</method>
<method name="detach" c:identifier="soup_session_feature_detach">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="feature" transfer-ownership="none">
<type name="SessionFeature" c:type="SoupSessionFeature*"/>
</instance-parameter>
<parameter name="session" transfer-ownership="none">
<type name="Session" c:type="SoupSession*"/>
</parameter>
</parameters>
</method>
<method name="has_feature"
c:identifier="soup_session_feature_has_feature"
version="2.34">
<doc xml:space="preserve">Tests if @feature has a "sub-feature" of type @type. See
soup_session_feature_add_feature().</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @feature has a subfeature of type @type</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="feature" transfer-ownership="none">
<doc xml:space="preserve">the "base" feature</doc>
<type name="SessionFeature" c:type="SoupSessionFeature*"/>
</instance-parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">the #GType of a "sub-feature"</doc>
<type name="GType" c:type="GType"/>
</parameter>
</parameters>
</method>
<method name="remove_feature"
c:identifier="soup_session_feature_remove_feature"
version="2.34">
<doc xml:space="preserve">Removes the "sub-feature" of type @type from the base feature
@feature. See soup_session_feature_add_feature().</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @type was removed from @feature</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="feature" transfer-ownership="none">
<doc xml:space="preserve">the "base" feature</doc>
<type name="SessionFeature" c:type="SoupSessionFeature*"/>
</instance-parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">the #GType of a "sub-feature"</doc>
<type name="GType" c:type="GType"/>
</parameter>
</parameters>
</method>
</interface>
<record name="SessionFeatureInterface"
c:type="SoupSessionFeatureInterface"
glib:is-gtype-struct-for="SessionFeature"
version="2.24">
<doc xml:space="preserve">The interface implemented by #SoupSessionFeature<!-- -->s.</doc>
<field name="parent">
<doc xml:space="preserve">The parent interface.</doc>
<type name="GObject.TypeInterface" c:type="GTypeInterface"/>
</field>
<field name="attach">
<callback name="attach">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="feature" transfer-ownership="none">
<type name="SessionFeature" c:type="SoupSessionFeature*"/>
</parameter>
<parameter name="session" transfer-ownership="none">
<type name="Session" c:type="SoupSession*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="detach">
<callback name="detach">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="feature" transfer-ownership="none">
<type name="SessionFeature" c:type="SoupSessionFeature*"/>
</parameter>
<parameter name="session" transfer-ownership="none">
<type name="Session" c:type="SoupSession*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="request_queued">
<callback name="request_queued">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="feature" transfer-ownership="none">
<type name="SessionFeature" c:type="SoupSessionFeature*"/>
</parameter>
<parameter name="session" transfer-ownership="none">
<type name="Session" c:type="SoupSession*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="request_started">
<callback name="request_started">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="feature" transfer-ownership="none">
<type name="SessionFeature" c:type="SoupSessionFeature*"/>
</parameter>
<parameter name="session" transfer-ownership="none">
<type name="Session" c:type="SoupSession*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="socket" transfer-ownership="none">
<type name="Socket" c:type="SoupSocket*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="request_unqueued">
<callback name="request_unqueued">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="feature" transfer-ownership="none">
<type name="SessionFeature" c:type="SoupSessionFeature*"/>
</parameter>
<parameter name="session" transfer-ownership="none">
<type name="Session" c:type="SoupSession*"/>
</parameter>
<parameter name="msg" transfer-ownership="none">
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="add_feature">
<callback name="add_feature">
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @feature accepted @type as a subfeature.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="feature" transfer-ownership="none">
<doc xml:space="preserve">the "base" feature</doc>
<type name="SessionFeature" c:type="SoupSessionFeature*"/>
</parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">the #GType of a "sub-feature"</doc>
<type name="GType" c:type="GType"/>
</parameter>
</parameters>
</callback>
</field>
<field name="remove_feature">
<callback name="remove_feature">
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @type was removed from @feature</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="feature" transfer-ownership="none">
<doc xml:space="preserve">the "base" feature</doc>
<type name="SessionFeature" c:type="SoupSessionFeature*"/>
</parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">the #GType of a "sub-feature"</doc>
<type name="GType" c:type="GType"/>
</parameter>
</parameters>
</callback>
</field>
<field name="has_feature">
<callback name="has_feature">
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @feature has a subfeature of type @type</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="feature" transfer-ownership="none">
<doc xml:space="preserve">the "base" feature</doc>
<type name="SessionFeature" c:type="SoupSessionFeature*"/>
</parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">the #GType of a "sub-feature"</doc>
<type name="GType" c:type="GType"/>
</parameter>
</parameters>
</callback>
</field>
</record>
<class name="SessionSync"
c:symbol-prefix="session_sync"
c:type="SoupSessionSync"
parent="Session"
glib:type-name="SoupSessionSync"
glib:get-type="soup_session_sync_get_type"
glib:type-struct="SessionSyncClass">
<constructor name="new"
c:identifier="soup_session_sync_new"
deprecated="1">
<doc xml:space="preserve">Creates an synchronous #SoupSession with the default options.</doc>
<doc-deprecated xml:space="preserve">#SoupSessionSync is deprecated; use a plain
#SoupSession, created with soup_session_new(). See the <link
linkend="libsoup-session-porting">porting guide</link>.</doc-deprecated>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the new session.</doc>
<type name="Session" c:type="SoupSession*"/>
</return-value>
</constructor>
<constructor name="new_with_options"
c:identifier="soup_session_sync_new_with_options"
introspectable="0"
deprecated="1">
<doc xml:space="preserve">Creates an synchronous #SoupSession with the specified options.</doc>
<doc-deprecated xml:space="preserve">#SoupSessionSync is deprecated; use a plain
#SoupSession, created with soup_session_new_with_options(). See the
<link linkend="libsoup-session-porting">porting guide</link>.</doc-deprecated>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the new session.</doc>
<type name="Session" c:type="SoupSession*"/>
</return-value>
<parameters>
<parameter name="optname1" transfer-ownership="none">
<doc xml:space="preserve">name of first property to set</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">value of @optname1, followed by additional property/value pairs</doc>
<varargs/>
</parameter>
</parameters>
</constructor>
<field name="parent">
<type name="Session" c:type="SoupSession"/>
</field>
</class>
<record name="SessionSyncClass"
c:type="SoupSessionSyncClass"
glib:is-gtype-struct-for="SessionSync">
<field name="parent_class">
<type name="SessionClass" c:type="SoupSessionClass"/>
</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>
<class name="Socket"
c:symbol-prefix="socket"
c:type="SoupSocket"
parent="GObject.Object"
glib:type-name="SoupSocket"
glib:get-type="soup_socket_get_type"
glib:type-struct="SocketClass">
<implements name="Gio.Initable"/>
<constructor name="new"
c:identifier="soup_socket_new"
introspectable="0">
<doc xml:space="preserve">Creates a new (disconnected) socket</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the new socket</doc>
<type name="Socket" c:type="SoupSocket*"/>
</return-value>
<parameters>
<parameter name="optname1" transfer-ownership="none">
<doc xml:space="preserve">name of first property to set (or %NULL)</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">value of @optname1, followed by additional property/value pairs</doc>
<varargs/>
</parameter>
</parameters>
</constructor>
<virtual-method name="disconnected">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="sock" transfer-ownership="none">
<type name="Socket" c:type="SoupSocket*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="new_connection">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="listener" transfer-ownership="none">
<type name="Socket" c:type="SoupSocket*"/>
</instance-parameter>
<parameter name="new_sock" transfer-ownership="none">
<type name="Socket" c:type="SoupSocket*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="readable">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="sock" transfer-ownership="none">
<type name="Socket" c:type="SoupSocket*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="writable">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="sock" transfer-ownership="none">
<type name="Socket" c:type="SoupSocket*"/>
</instance-parameter>
</parameters>
</virtual-method>
<method name="connect_async" c:identifier="soup_socket_connect_async">
<doc xml:space="preserve">Begins asynchronously connecting to @sock's remote address. The
socket will call @callback when it succeeds or fails (but not
before returning from this function).
If @cancellable is non-%NULL, it can be used to cancel the
connection. @callback will still be invoked in this case, with a
status of %SOUP_STATUS_CANCELLED.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="sock" transfer-ownership="none">
<doc xml:space="preserve">a client #SoupSocket (which must not already be connected)</doc>
<type name="Socket" c:type="SoupSocket*"/>
</instance-parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GCancellable, or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
<parameter name="callback"
transfer-ownership="none"
scope="async"
closure="2">
<doc xml:space="preserve">callback to call after connecting</doc>
<type name="SocketCallback" c:type="SoupSocketCallback"/>
</parameter>
<parameter name="user_data" transfer-ownership="none">
<doc xml:space="preserve">data to pass to @callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</method>
<method name="connect_sync" c:identifier="soup_socket_connect_sync">
<doc xml:space="preserve">Attempt to synchronously connect @sock to its remote address.
If @cancellable is non-%NULL, it can be used to cancel the
connection, in which case soup_socket_connect_sync() will return
%SOUP_STATUS_CANCELLED.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a success or failure code.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="sock" transfer-ownership="none">
<doc xml:space="preserve">a client #SoupSocket (which must not already be connected)</doc>
<type name="Socket" c:type="SoupSocket*"/>
</instance-parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GCancellable, or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
</parameters>
</method>
<method name="disconnect" c:identifier="soup_socket_disconnect">
<doc xml:space="preserve">Disconnects @sock. Any further read or write attempts on it will
fail.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="sock" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSocket</doc>
<type name="Socket" c:type="SoupSocket*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_fd" c:identifier="soup_socket_get_fd">
<doc xml:space="preserve">Gets @sock's underlying file descriptor.
Note that fiddling with the file descriptor may break the
#SoupSocket.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">@sock's file descriptor.</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<instance-parameter name="sock" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSocket</doc>
<type name="Socket" c:type="SoupSocket*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_local_address"
c:identifier="soup_socket_get_local_address">
<doc xml:space="preserve">Returns the #SoupAddress corresponding to the local end of @sock.
Calling this method on an unconnected socket is considered to be
an error, and produces undefined results.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the #SoupAddress</doc>
<type name="Address" c:type="SoupAddress*"/>
</return-value>
<parameters>
<instance-parameter name="sock" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSocket</doc>
<type name="Socket" c:type="SoupSocket*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_remote_address"
c:identifier="soup_socket_get_remote_address">
<doc xml:space="preserve">Returns the #SoupAddress corresponding to the remote end of @sock.
Calling this method on an unconnected socket is considered to be
an error, and produces undefined results.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the #SoupAddress</doc>
<type name="Address" c:type="SoupAddress*"/>
</return-value>
<parameters>
<instance-parameter name="sock" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSocket</doc>
<type name="Socket" c:type="SoupSocket*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_connected" c:identifier="soup_socket_is_connected">
<doc xml:space="preserve">Tests if @sock is connected to another host</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE or %FALSE.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="sock" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSocket</doc>
<type name="Socket" c:type="SoupSocket*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_ssl" c:identifier="soup_socket_is_ssl">
<doc xml:space="preserve">Tests if @sock is doing (or has attempted to do) SSL.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @sock has SSL credentials set</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="sock" transfer-ownership="none">
<doc xml:space="preserve">a #SoupSocket</doc>
<type name="Socket" c:type="SoupSocket*"/>
</instance-parameter>
</parameters>
</method>
<method name="listen" c:identifier="soup_socket_listen">
<doc xml:space="preserve">Makes @sock start listening on its local address. When connections
come in, @sock will emit #SoupSocket::new_connection.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">whether or not @sock is now listening.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="sock" transfer-ownership="none">
<doc xml:space="preserve">a server #SoupSocket (which must not already be connected or
listening)</doc>
<type name="Socket" c:type="SoupSocket*"/>
</instance-parameter>
</parameters>
</method>
<method name="read" c:identifier="soup_socket_read" throws="1">
<doc xml:space="preserve">Attempts to read up to @len bytes from @sock into @buffer. If some
data is successfully read, soup_socket_read() will return
%SOUP_SOCKET_OK, and *@nread will contain the number of bytes
actually read (which may be less than @len).
If @sock is non-blocking, and no data is available, the return
value will be %SOUP_SOCKET_WOULD_BLOCK. In this case, the caller
can connect to the #SoupSocket::readable signal to know when there
is more data to read. (NB: You MUST read all available data off the
socket first. #SoupSocket::readable is only emitted after
soup_socket_read() returns %SOUP_SOCKET_WOULD_BLOCK, and it is only
emitted once. See the documentation for #SoupSocket:non-blocking.)</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #SoupSocketIOStatus, as described above (or
%SOUP_SOCKET_EOF if the socket is no longer connected, or
%SOUP_SOCKET_ERROR on any other error, in which case @error will
also be set).</doc>
<type name="SocketIOStatus" c:type="SoupSocketIOStatus"/>
</return-value>
<parameters>
<instance-parameter name="sock" transfer-ownership="none">
<doc xml:space="preserve">the socket</doc>
<type name="Socket" c:type="SoupSocket*"/>
</instance-parameter>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">buffer to read
into</doc>
<array length="1" zero-terminated="0" c:type="gpointer">
<type name="guint8"/>
</array>
</parameter>
<parameter name="len" transfer-ownership="none">
<doc xml:space="preserve">size of @buffer in bytes</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
<parameter name="nread"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">on return, the number of bytes read into @buffer</doc>
<type name="gsize" c:type="gsize*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GCancellable, or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
</parameters>
</method>
<method name="read_until"
c:identifier="soup_socket_read_until"
throws="1">
<doc xml:space="preserve">Like soup_socket_read(), but reads no further than the first
occurrence of @boundary. (If the boundary is found, it will be
included in the returned data, and *@got_boundary will be set to
%TRUE.) Any data after the boundary will returned in future reads.
soup_socket_read_until() will almost always return fewer than @len
bytes: if the boundary is found, then it will only return the bytes
up until the end of the boundary, and if the boundary is not found,
then it will leave the last <literal>(boundary_len - 1)</literal>
bytes in its internal buffer, in case they form the start of the
boundary string. Thus, @len normally needs to be at least 1 byte
longer than @boundary_len if you want to make any progress at all.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">as for soup_socket_read()</doc>
<type name="SocketIOStatus" c:type="SoupSocketIOStatus"/>
</return-value>
<parameters>
<instance-parameter name="sock" transfer-ownership="none">
<doc xml:space="preserve">the socket</doc>
<type name="Socket" c:type="SoupSocket*"/>
</instance-parameter>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">buffer to read
into</doc>
<array length="1" zero-terminated="0" c:type="gpointer">
<type name="guint8"/>
</array>
</parameter>
<parameter name="len" transfer-ownership="none">
<doc xml:space="preserve">size of @buffer in bytes</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
<parameter name="boundary" transfer-ownership="none">
<doc xml:space="preserve">boundary to read until</doc>
<type name="gpointer" c:type="gconstpointer"/>
</parameter>
<parameter name="boundary_len" transfer-ownership="none">
<doc xml:space="preserve">length of @boundary in bytes</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
<parameter name="nread"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">on return, the number of bytes read into @buffer</doc>
<type name="gsize" c:type="gsize*"/>
</parameter>
<parameter name="got_boundary" transfer-ownership="none">
<doc xml:space="preserve">on return, whether or not the data in @buffer
ends with the boundary string</doc>
<type name="gboolean" c:type="gboolean*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GCancellable, or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
</parameters>
</method>
<method name="start_proxy_ssl"
c:identifier="soup_socket_start_proxy_ssl">
<doc xml:space="preserve">Starts using SSL on @socket, expecting to find a host named
@ssl_host.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">success or failure</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="sock" transfer-ownership="none">
<doc xml:space="preserve">the socket</doc>
<type name="Socket" c:type="SoupSocket*"/>
</instance-parameter>
<parameter name="ssl_host" transfer-ownership="none">
<doc xml:space="preserve">hostname of the SSL server</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GCancellable</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
</parameters>
</method>
<method name="start_ssl" c:identifier="soup_socket_start_ssl">
<doc xml:space="preserve">Starts using SSL on @socket.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">success or failure</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="sock" transfer-ownership="none">
<doc xml:space="preserve">the socket</doc>
<type name="Socket" c:type="SoupSocket*"/>
</instance-parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GCancellable</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
</parameters>
</method>
<method name="write" c:identifier="soup_socket_write" throws="1">
<doc xml:space="preserve">Attempts to write @len bytes from @buffer to @sock. If some data is
successfully written, the return status will be %SOUP_SOCKET_OK,
and *@nwrote will contain the number of bytes actually written
(which may be less than @len).
If @sock is non-blocking, and no data could be written right away,
the return value will be %SOUP_SOCKET_WOULD_BLOCK. In this case,
the caller can connect to the #SoupSocket::writable signal to know
when more data can be written. (NB: #SoupSocket::writable is only
emitted after soup_socket_write() returns %SOUP_SOCKET_WOULD_BLOCK,
and it is only emitted once. See the documentation for
#SoupSocket:non-blocking.)</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a #SoupSocketIOStatus, as described above (or
%SOUP_SOCKET_EOF or %SOUP_SOCKET_ERROR. @error will be set if the
return value is %SOUP_SOCKET_ERROR.)</doc>
<type name="SocketIOStatus" c:type="SoupSocketIOStatus"/>
</return-value>
<parameters>
<instance-parameter name="sock" transfer-ownership="none">
<doc xml:space="preserve">the socket</doc>
<type name="Socket" c:type="SoupSocket*"/>
</instance-parameter>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">data to write</doc>
<array length="1" zero-terminated="0" c:type="gconstpointer">
<type name="guint8"/>
</array>
</parameter>
<parameter name="len" transfer-ownership="none">
<doc xml:space="preserve">size of @buffer, in bytes</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
<parameter name="nwrote"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">on return, number of bytes written</doc>
<type name="gsize" c:type="gsize*"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GCancellable, or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
</parameters>
</method>
<property name="async-context"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</property>
<property name="fd"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gint" c:type="gint"/>
</property>
<property name="gsocket"
readable="0"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="Gio.Socket"/>
</property>
<property name="iostream"
readable="0"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="Gio.IOStream"/>
</property>
<property name="ipv6-only" writable="1" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="is-server" transfer-ownership="none">
<doc xml:space="preserve">Whether or not the socket is a server socket.
Note that for "ordinary" #SoupSockets this will be set for
both listening sockets and the sockets emitted by
#SoupSocket::new-connection, but for sockets created by
setting #SoupSocket:fd, it will only be set for listening
sockets.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="local-address"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="Address"/>
</property>
<property name="non-blocking" writable="1" transfer-ownership="none">
<doc xml:space="preserve">Whether or not the socket uses non-blocking I/O.
#SoupSocket's I/O methods are designed around the idea of
using a single codepath for both synchronous and
asynchronous I/O. If you want to read off a #SoupSocket,
the "correct" way to do it is to call soup_socket_read() or
soup_socket_read_until() repeatedly until you have read
everything you want. If it returns %SOUP_SOCKET_WOULD_BLOCK
at any point, stop reading and wait for it to emit the
#SoupSocket::readable signal. Then go back to the
reading-as-much-as-you-can loop. Likewise, for writing to a
#SoupSocket, you should call soup_socket_write() either
until you have written everything, or it returns
%SOUP_SOCKET_WOULD_BLOCK (in which case you wait for
#SoupSocket::writable and then go back into the loop).
Code written this way will work correctly with both
blocking and non-blocking sockets; blocking sockets will
simply never return %SOUP_SOCKET_WOULD_BLOCK, and so the
code that handles that case just won't get used for them.</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="remote-address"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="Address"/>
</property>
<property name="socket-properties"
introspectable="0"
readable="0"
writable="1"
transfer-ownership="none">
<type/>
</property>
<property name="ssl-creds" writable="1" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</property>
<property name="ssl-fallback"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="ssl-strict"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="timeout" writable="1" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</property>
<property name="tls-certificate" transfer-ownership="none">
<type name="Gio.TlsCertificate"/>
</property>
<property name="tls-errors" transfer-ownership="none">
<type name="Gio.TlsCertificateFlags"/>
</property>
<property name="trusted-certificate" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="use-thread-context"
version="2.38"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve">Use g_main_context_get_thread_default().</doc>
<type name="gboolean" c:type="gboolean"/>
</property>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
<glib:signal name="disconnected" when="last">
<doc xml:space="preserve">Emitted when the socket is disconnected, for whatever
reason.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
<glib:signal name="event" when="last" version="2.38">
<doc xml:space="preserve">Emitted when a network-related event occurs. See
#GSocketClient::event for more details.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="event" transfer-ownership="none">
<doc xml:space="preserve">the event that occurred</doc>
<type name="Gio.SocketClientEvent"/>
</parameter>
<parameter name="connection" transfer-ownership="none">
<doc xml:space="preserve">the current connection state</doc>
<type name="Gio.IOStream"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="new-connection" when="first">
<doc xml:space="preserve">Emitted when a listening socket (set up with
soup_socket_listen()) receives a new connection.
You must ref the @new if you want to keep it; otherwise it
will be destroyed after the signal is emitted.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="new" transfer-ownership="none">
<doc xml:space="preserve">the new socket</doc>
<type name="Socket"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="readable" when="last">
<doc xml:space="preserve">Emitted when an async socket is readable. See
soup_socket_read(), soup_socket_read_until() and
#SoupSocket:non-blocking.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
<glib:signal name="writable" when="last">
<doc xml:space="preserve">Emitted when an async socket is writable. See
soup_socket_write() and #SoupSocket:non-blocking.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
</class>
<callback name="SocketCallback" c:type="SoupSocketCallback">
<doc xml:space="preserve">The callback function passed to soup_socket_connect_async().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="sock" transfer-ownership="none">
<doc xml:space="preserve">the #SoupSocket</doc>
<type name="Socket" c:type="SoupSocket*"/>
</parameter>
<parameter name="status" transfer-ownership="none">
<doc xml:space="preserve">an HTTP status code indicating success or failure</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" closure="2">
<doc xml:space="preserve">the data passed to soup_socket_connect_async()</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<record name="SocketClass"
c:type="SoupSocketClass"
glib:is-gtype-struct-for="Socket">
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="readable">
<callback name="readable">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="sock" transfer-ownership="none">
<type name="Socket" c:type="SoupSocket*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="writable">
<callback name="writable">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="sock" transfer-ownership="none">
<type name="Socket" c:type="SoupSocket*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="disconnected">
<callback name="disconnected">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="sock" transfer-ownership="none">
<type name="Socket" c:type="SoupSocket*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="new_connection">
<callback name="new_connection">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="listener" transfer-ownership="none">
<type name="Socket" c:type="SoupSocket*"/>
</parameter>
<parameter name="new_sock" transfer-ownership="none">
<type name="Socket" c:type="SoupSocket*"/>
</parameter>
</parameters>
</callback>
</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="SocketIOStatus"
glib:type-name="SoupSocketIOStatus"
glib:get-type="soup_socket_io_status_get_type"
c:type="SoupSocketIOStatus">
<doc xml:space="preserve">Return value from the #SoupSocket IO methods.</doc>
<member name="ok" value="0" c:identifier="SOUP_SOCKET_OK" glib:nick="ok">
<doc xml:space="preserve">Success</doc>
</member>
<member name="would_block"
value="1"
c:identifier="SOUP_SOCKET_WOULD_BLOCK"
glib:nick="would-block">
<doc xml:space="preserve">Cannot read/write any more at this time</doc>
</member>
<member name="eof"
value="2"
c:identifier="SOUP_SOCKET_EOF"
glib:nick="eof">
<doc xml:space="preserve">End of file</doc>
</member>
<member name="error"
value="3"
c:identifier="SOUP_SOCKET_ERROR"
glib:nick="error">
<doc xml:space="preserve">Other error</doc>
</member>
</enumeration>
<enumeration name="Status"
glib:type-name="SoupStatus"
glib:get-type="soup_status_get_type"
c:type="SoupStatus">
<doc xml:space="preserve">These represent the known HTTP status code values, plus various
network and internal errors.
Note that no libsoup functions take or return this type directly;
any function that works with status codes will accept unrecognized
status codes as well.
Prior to 2.44 this type was called
<literal>SoupKnownStatusCode</literal>, but the individual values
have always had the names they have now.</doc>
<member name="none"
value="0"
c:identifier="SOUP_STATUS_NONE"
glib:nick="none">
<doc xml:space="preserve">No status available. (Eg, the message has not
been sent yet)</doc>
</member>
<member name="cancelled"
value="1"
c:identifier="SOUP_STATUS_CANCELLED"
glib:nick="cancelled">
<doc xml:space="preserve">Message was cancelled locally</doc>
</member>
<member name="cant_resolve"
value="2"
c:identifier="SOUP_STATUS_CANT_RESOLVE"
glib:nick="cant-resolve">
<doc xml:space="preserve">Unable to resolve destination host name</doc>
</member>
<member name="cant_resolve_proxy"
value="3"
c:identifier="SOUP_STATUS_CANT_RESOLVE_PROXY"
glib:nick="cant-resolve-proxy">
<doc xml:space="preserve">Unable to resolve proxy host name</doc>
</member>
<member name="cant_connect"
value="4"
c:identifier="SOUP_STATUS_CANT_CONNECT"
glib:nick="cant-connect">
<doc xml:space="preserve">Unable to connect to remote host</doc>
</member>
<member name="cant_connect_proxy"
value="5"
c:identifier="SOUP_STATUS_CANT_CONNECT_PROXY"
glib:nick="cant-connect-proxy">
<doc xml:space="preserve">Unable to connect to proxy</doc>
</member>
<member name="ssl_failed"
value="6"
c:identifier="SOUP_STATUS_SSL_FAILED"
glib:nick="ssl-failed">
<doc xml:space="preserve">SSL/TLS negotiation failed</doc>
</member>
<member name="io_error"
value="7"
c:identifier="SOUP_STATUS_IO_ERROR"
glib:nick="io-error">
<doc xml:space="preserve">A network error occurred, or the other end
closed the connection unexpectedly</doc>
</member>
<member name="malformed"
value="8"
c:identifier="SOUP_STATUS_MALFORMED"
glib:nick="malformed">
<doc xml:space="preserve">Malformed data (usually a programmer error)</doc>
</member>
<member name="try_again"
value="9"
c:identifier="SOUP_STATUS_TRY_AGAIN"
glib:nick="try-again">
<doc xml:space="preserve">Used internally</doc>
</member>
<member name="too_many_redirects"
value="10"
c:identifier="SOUP_STATUS_TOO_MANY_REDIRECTS"
glib:nick="too-many-redirects">
<doc xml:space="preserve">There were too many redirections</doc>
</member>
<member name="tls_failed"
value="11"
c:identifier="SOUP_STATUS_TLS_FAILED"
glib:nick="tls-failed">
<doc xml:space="preserve">Used internally</doc>
</member>
<member name="continue"
value="100"
c:identifier="SOUP_STATUS_CONTINUE"
glib:nick="continue">
<doc xml:space="preserve">100 Continue (HTTP)</doc>
</member>
<member name="switching_protocols"
value="101"
c:identifier="SOUP_STATUS_SWITCHING_PROTOCOLS"
glib:nick="switching-protocols">
<doc xml:space="preserve">101 Switching Protocols (HTTP)</doc>
</member>
<member name="processing"
value="102"
c:identifier="SOUP_STATUS_PROCESSING"
glib:nick="processing">
<doc xml:space="preserve">102 Processing (WebDAV)</doc>
</member>
<member name="ok"
value="200"
c:identifier="SOUP_STATUS_OK"
glib:nick="ok">
<doc xml:space="preserve">200 Success (HTTP). Also used by many lower-level
soup routines to indicate success.</doc>
</member>
<member name="created"
value="201"
c:identifier="SOUP_STATUS_CREATED"
glib:nick="created">
<doc xml:space="preserve">201 Created (HTTP)</doc>
</member>
<member name="accepted"
value="202"
c:identifier="SOUP_STATUS_ACCEPTED"
glib:nick="accepted">
<doc xml:space="preserve">202 Accepted (HTTP)</doc>
</member>
<member name="non_authoritative"
value="203"
c:identifier="SOUP_STATUS_NON_AUTHORITATIVE"
glib:nick="non-authoritative">
<doc xml:space="preserve">203 Non-Authoritative Information
(HTTP)</doc>
</member>
<member name="no_content"
value="204"
c:identifier="SOUP_STATUS_NO_CONTENT"
glib:nick="no-content">
<doc xml:space="preserve">204 No Content (HTTP)</doc>
</member>
<member name="reset_content"
value="205"
c:identifier="SOUP_STATUS_RESET_CONTENT"
glib:nick="reset-content">
<doc xml:space="preserve">205 Reset Content (HTTP)</doc>
</member>
<member name="partial_content"
value="206"
c:identifier="SOUP_STATUS_PARTIAL_CONTENT"
glib:nick="partial-content">
<doc xml:space="preserve">206 Partial Content (HTTP)</doc>
</member>
<member name="multi_status"
value="207"
c:identifier="SOUP_STATUS_MULTI_STATUS"
glib:nick="multi-status">
<doc xml:space="preserve">207 Multi-Status (WebDAV)</doc>
</member>
<member name="multiple_choices"
value="300"
c:identifier="SOUP_STATUS_MULTIPLE_CHOICES"
glib:nick="multiple-choices">
<doc xml:space="preserve">300 Multiple Choices (HTTP)</doc>
</member>
<member name="moved_permanently"
value="301"
c:identifier="SOUP_STATUS_MOVED_PERMANENTLY"
glib:nick="moved-permanently">
<doc xml:space="preserve">301 Moved Permanently (HTTP)</doc>
</member>
<member name="found"
value="302"
c:identifier="SOUP_STATUS_FOUND"
glib:nick="found">
<doc xml:space="preserve">302 Found (HTTP)</doc>
</member>
<member name="moved_temporarily"
value="302"
c:identifier="SOUP_STATUS_MOVED_TEMPORARILY"
glib:nick="moved-temporarily">
<doc xml:space="preserve">302 Moved Temporarily (old name,
RFC 2068)</doc>
</member>
<member name="see_other"
value="303"
c:identifier="SOUP_STATUS_SEE_OTHER"
glib:nick="see-other">
<doc xml:space="preserve">303 See Other (HTTP)</doc>
</member>
<member name="not_modified"
value="304"
c:identifier="SOUP_STATUS_NOT_MODIFIED"
glib:nick="not-modified">
<doc xml:space="preserve">304 Not Modified (HTTP)</doc>
</member>
<member name="use_proxy"
value="305"
c:identifier="SOUP_STATUS_USE_PROXY"
glib:nick="use-proxy">
<doc xml:space="preserve">305 Use Proxy (HTTP)</doc>
</member>
<member name="not_appearing_in_this_protocol"
value="306"
c:identifier="SOUP_STATUS_NOT_APPEARING_IN_THIS_PROTOCOL"
glib:nick="not-appearing-in-this-protocol">
<doc xml:space="preserve">306 [Unused] (HTTP)</doc>
</member>
<member name="temporary_redirect"
value="307"
c:identifier="SOUP_STATUS_TEMPORARY_REDIRECT"
glib:nick="temporary-redirect">
<doc xml:space="preserve">307 Temporary Redirect (HTTP)</doc>
</member>
<member name="bad_request"
value="400"
c:identifier="SOUP_STATUS_BAD_REQUEST"
glib:nick="bad-request">
<doc xml:space="preserve">400 Bad Request (HTTP)</doc>
</member>
<member name="unauthorized"
value="401"
c:identifier="SOUP_STATUS_UNAUTHORIZED"
glib:nick="unauthorized">
<doc xml:space="preserve">401 Unauthorized (HTTP)</doc>
</member>
<member name="payment_required"
value="402"
c:identifier="SOUP_STATUS_PAYMENT_REQUIRED"
glib:nick="payment-required">
<doc xml:space="preserve">402 Payment Required (HTTP)</doc>
</member>
<member name="forbidden"
value="403"
c:identifier="SOUP_STATUS_FORBIDDEN"
glib:nick="forbidden">
<doc xml:space="preserve">403 Forbidden (HTTP)</doc>
</member>
<member name="not_found"
value="404"
c:identifier="SOUP_STATUS_NOT_FOUND"
glib:nick="not-found">
<doc xml:space="preserve">404 Not Found (HTTP)</doc>
</member>
<member name="method_not_allowed"
value="405"
c:identifier="SOUP_STATUS_METHOD_NOT_ALLOWED"
glib:nick="method-not-allowed">
<doc xml:space="preserve">405 Method Not Allowed (HTTP)</doc>
</member>
<member name="not_acceptable"
value="406"
c:identifier="SOUP_STATUS_NOT_ACCEPTABLE"
glib:nick="not-acceptable">
<doc xml:space="preserve">406 Not Acceptable (HTTP)</doc>
</member>
<member name="proxy_authentication_required"
value="407"
c:identifier="SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED"
glib:nick="proxy-authentication-required">
<doc xml:space="preserve">407 Proxy Authentication
Required (HTTP)</doc>
</member>
<member name="proxy_unauthorized"
value="407"
c:identifier="SOUP_STATUS_PROXY_UNAUTHORIZED"
glib:nick="proxy-unauthorized">
<doc xml:space="preserve">shorter alias for
%SOUP_STATUS_PROXY_AUTHENTICATION_REQUIRED</doc>
</member>
<member name="request_timeout"
value="408"
c:identifier="SOUP_STATUS_REQUEST_TIMEOUT"
glib:nick="request-timeout">
<doc xml:space="preserve">408 Request Timeout (HTTP)</doc>
</member>
<member name="conflict"
value="409"
c:identifier="SOUP_STATUS_CONFLICT"
glib:nick="conflict">
<doc xml:space="preserve">409 Conflict (HTTP)</doc>
</member>
<member name="gone"
value="410"
c:identifier="SOUP_STATUS_GONE"
glib:nick="gone">
<doc xml:space="preserve">410 Gone (HTTP)</doc>
</member>
<member name="length_required"
value="411"
c:identifier="SOUP_STATUS_LENGTH_REQUIRED"
glib:nick="length-required">
<doc xml:space="preserve">411 Length Required (HTTP)</doc>
</member>
<member name="precondition_failed"
value="412"
c:identifier="SOUP_STATUS_PRECONDITION_FAILED"
glib:nick="precondition-failed">
<doc xml:space="preserve">412 Precondition Failed (HTTP)</doc>
</member>
<member name="request_entity_too_large"
value="413"
c:identifier="SOUP_STATUS_REQUEST_ENTITY_TOO_LARGE"
glib:nick="request-entity-too-large">
<doc xml:space="preserve">413 Request Entity Too Large
(HTTP)</doc>
</member>
<member name="request_uri_too_long"
value="414"
c:identifier="SOUP_STATUS_REQUEST_URI_TOO_LONG"
glib:nick="request-uri-too-long">
<doc xml:space="preserve">414 Request-URI Too Long (HTTP)</doc>
</member>
<member name="unsupported_media_type"
value="415"
c:identifier="SOUP_STATUS_UNSUPPORTED_MEDIA_TYPE"
glib:nick="unsupported-media-type">
<doc xml:space="preserve">415 Unsupported Media Type
(HTTP)</doc>
</member>
<member name="requested_range_not_satisfiable"
value="416"
c:identifier="SOUP_STATUS_REQUESTED_RANGE_NOT_SATISFIABLE"
glib:nick="requested-range-not-satisfiable">
<doc xml:space="preserve">416 Requested Range
Not Satisfiable (HTTP)</doc>
</member>
<member name="invalid_range"
value="416"
c:identifier="SOUP_STATUS_INVALID_RANGE"
glib:nick="invalid-range">
<doc xml:space="preserve">shorter alias for
%SOUP_STATUS_REQUESTED_RANGE_NOT_SATISFIABLE</doc>
</member>
<member name="expectation_failed"
value="417"
c:identifier="SOUP_STATUS_EXPECTATION_FAILED"
glib:nick="expectation-failed">
<doc xml:space="preserve">417 Expectation Failed (HTTP)</doc>
</member>
<member name="unprocessable_entity"
value="422"
c:identifier="SOUP_STATUS_UNPROCESSABLE_ENTITY"
glib:nick="unprocessable-entity">
<doc xml:space="preserve">422 Unprocessable Entity
(WebDAV)</doc>
</member>
<member name="locked"
value="423"
c:identifier="SOUP_STATUS_LOCKED"
glib:nick="locked">
<doc xml:space="preserve">423 Locked (WebDAV)</doc>
</member>
<member name="failed_dependency"
value="424"
c:identifier="SOUP_STATUS_FAILED_DEPENDENCY"
glib:nick="failed-dependency">
<doc xml:space="preserve">424 Failed Dependency (WebDAV)</doc>
</member>
<member name="internal_server_error"
value="500"
c:identifier="SOUP_STATUS_INTERNAL_SERVER_ERROR"
glib:nick="internal-server-error">
<doc xml:space="preserve">500 Internal Server Error
(HTTP)</doc>
</member>
<member name="not_implemented"
value="501"
c:identifier="SOUP_STATUS_NOT_IMPLEMENTED"
glib:nick="not-implemented">
<doc xml:space="preserve">501 Not Implemented (HTTP)</doc>
</member>
<member name="bad_gateway"
value="502"
c:identifier="SOUP_STATUS_BAD_GATEWAY"
glib:nick="bad-gateway">
<doc xml:space="preserve">502 Bad Gateway (HTTP)</doc>
</member>
<member name="service_unavailable"
value="503"
c:identifier="SOUP_STATUS_SERVICE_UNAVAILABLE"
glib:nick="service-unavailable">
<doc xml:space="preserve">503 Service Unavailable (HTTP)</doc>
</member>
<member name="gateway_timeout"
value="504"
c:identifier="SOUP_STATUS_GATEWAY_TIMEOUT"
glib:nick="gateway-timeout">
<doc xml:space="preserve">504 Gateway Timeout (HTTP)</doc>
</member>
<member name="http_version_not_supported"
value="505"
c:identifier="SOUP_STATUS_HTTP_VERSION_NOT_SUPPORTED"
glib:nick="http-version-not-supported">
<doc xml:space="preserve">505 HTTP Version Not
Supported (HTTP)</doc>
</member>
<member name="insufficient_storage"
value="507"
c:identifier="SOUP_STATUS_INSUFFICIENT_STORAGE"
glib:nick="insufficient-storage">
<doc xml:space="preserve">507 Insufficient Storage
(WebDAV)</doc>
</member>
<member name="not_extended"
value="510"
c:identifier="SOUP_STATUS_NOT_EXTENDED"
glib:nick="not-extended">
<doc xml:space="preserve">510 Not Extended (RFC 2774)</doc>
</member>
<function name="get_phrase" c:identifier="soup_status_get_phrase">
<doc xml:space="preserve">Looks up the stock HTTP description of @status_code. This is used
by soup_message_set_status() to get the correct text to go with a
given status code.
<emphasis>There is no reason for you to ever use this
function.</emphasis> If you wanted the textual description for the
#SoupMessage:status_code of a given #SoupMessage, you should just
look at the message's #SoupMessage:reason_phrase. However, you
should only do that for use in debugging messages; HTTP reason
phrases are not localized, and are not generally very descriptive
anyway, and so they should never be presented to the user directly.
Instead, you should create you own error messages based on the
status code, and on what you were trying to do.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the (terse, English) description of @status_code</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<parameter name="status_code" transfer-ownership="none">
<doc xml:space="preserve">an HTTP status code</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</function>
<function name="proxify"
c:identifier="soup_status_proxify"
version="2.26">
<doc xml:space="preserve">Turns %SOUP_STATUS_CANT_RESOLVE into
%SOUP_STATUS_CANT_RESOLVE_PROXY and %SOUP_STATUS_CANT_CONNECT into
%SOUP_STATUS_CANT_CONNECT_PROXY. Other status codes are passed
through unchanged.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the "proxified" equivalent of @status_code.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<parameter name="status_code" transfer-ownership="none">
<doc xml:space="preserve">a status code</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</function>
</enumeration>
<enumeration name="TLDError"
version="2.40"
glib:type-name="SoupTLDError"
glib:get-type="soup_tld_error_get_type"
c:type="SoupTLDError"
glib:error-domain="soup_tld_error_quark">
<doc xml:space="preserve">Error codes for %SOUP_TLD_ERROR.</doc>
<member name="invalid_hostname"
value="0"
c:identifier="SOUP_TLD_ERROR_INVALID_HOSTNAME"
glib:nick="invalid-hostname">
<doc xml:space="preserve">A hostname was syntactically
invalid.</doc>
</member>
<member name="is_ip_address"
value="1"
c:identifier="SOUP_TLD_ERROR_IS_IP_ADDRESS"
glib:nick="is-ip-address">
<doc xml:space="preserve">The passed-in "hostname" was
actually an IP address (and thus has no base domain or
public suffix).</doc>
</member>
<member name="not_enough_domains"
value="2"
c:identifier="SOUP_TLD_ERROR_NOT_ENOUGH_DOMAINS"
glib:nick="not-enough-domains">
<doc xml:space="preserve">The passed-in hostname
did not have enough components. Eg, calling
soup_tld_get_base_domain() on <literal>"co.uk"</literal>.</doc>
</member>
<member name="no_base_domain"
value="3"
c:identifier="SOUP_TLD_ERROR_NO_BASE_DOMAIN"
glib:nick="no-base-domain">
<doc xml:space="preserve">The passed-in hostname has
no recognized public suffix.</doc>
</member>
<function name="quark" c:identifier="soup_tld_error_quark">
<return-value transfer-ownership="none">
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
</enumeration>
<constant name="TYPES_H" value="1" c:type="SOUP_TYPES_H">
<type name="gint" c:type="gint"/>
</constant>
<record name="URI"
c:type="SoupURI"
glib:type-name="SoupURI"
glib:get-type="soup_uri_get_type"
c:symbol-prefix="uri">
<doc xml:space="preserve">A #SoupURI represents a (parsed) URI. #SoupURI supports RFC 3986
(URI Generic Syntax), and can parse any valid URI. However, libsoup
only uses "http" and "https" URIs internally; You can use
SOUP_URI_VALID_FOR_HTTP() to test if a #SoupURI is a valid HTTP
URI.
@scheme will always be set in any URI. It is an interned string and
is always all lowercase. (If you parse a URI with a non-lowercase
scheme, it will be converted to lowercase.) The macros
%SOUP_URI_SCHEME_HTTP and %SOUP_URI_SCHEME_HTTPS provide the
interned values for "http" and "https" and can be compared against
URI @scheme values.
@user and @password are parsed as defined in the older URI specs
(ie, separated by a colon; RFC 3986 only talks about a single
"userinfo" field). Note that @password is not included in the
output of soup_uri_to_string(). libsoup does not normally use these
fields; authentication is handled via #SoupSession signals.
@host contains the hostname, and @port the port specified in the
URI. If the URI doesn't contain a hostname, @host will be %NULL,
and if it doesn't specify a port, @port may be 0. However, for
"http" and "https" URIs, @host is guaranteed to be non-%NULL
(trying to parse an http URI with no @host will return %NULL), and
@port will always be non-0 (because libsoup knows the default value
to use when it is not specified in the URI).
@path is always non-%NULL. For http/https URIs, @path will never be
an empty string either; if the input URI has no path, the parsed
#SoupURI will have a @path of "/".
@query and @fragment are optional for all URI types.
soup_form_decode() may be useful for parsing @query.
Note that @path, @query, and @fragment may contain
%<!-- -->-encoded characters. soup_uri_new() calls
soup_uri_normalize() on them, but not soup_uri_decode(). This is
necessary to ensure that soup_uri_to_string() will generate a URI
that has exactly the same meaning as the original. (In theory,
#SoupURI should leave @user, @password, and @host partially-encoded
as well, but this would be more annoying than useful.)</doc>
<field name="scheme" writable="1">
<doc xml:space="preserve">the URI scheme (eg, "http")</doc>
<type name="utf8" c:type="const char*"/>
</field>
<field name="user" writable="1">
<doc xml:space="preserve">a username, or %NULL</doc>
<type name="utf8" c:type="char*"/>
</field>
<field name="password" writable="1">
<doc xml:space="preserve">a password, or %NULL</doc>
<type name="utf8" c:type="char*"/>
</field>
<field name="host" writable="1">
<doc xml:space="preserve">the hostname or IP address</doc>
<type name="utf8" c:type="char*"/>
</field>
<field name="port" writable="1">
<doc xml:space="preserve">the port number on @host</doc>
<type name="guint" c:type="guint"/>
</field>
<field name="path" writable="1">
<doc xml:space="preserve">the path on @host</doc>
<type name="utf8" c:type="char*"/>
</field>
<field name="query" writable="1">
<doc xml:space="preserve">a query for @path, or %NULL</doc>
<type name="utf8" c:type="char*"/>
</field>
<field name="fragment" writable="1">
<doc xml:space="preserve">a fragment identifier within @path, or %NULL</doc>
<type name="utf8" c:type="char*"/>
</field>
<constructor name="new" c:identifier="soup_uri_new">
<doc xml:space="preserve">Parses an absolute URI.
You can also pass %NULL for @uri_string if you want to get back an
"empty" #SoupURI that you can fill in by hand. (You will need to
call at least soup_uri_set_scheme() and soup_uri_set_path(), since
those fields are required.)</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">a #SoupURI, or %NULL if the given string
was found to be invalid.</doc>
<type name="URI" c:type="SoupURI*"/>
</return-value>
<parameters>
<parameter name="uri_string"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a URI</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</constructor>
<method name="copy" c:identifier="soup_uri_copy">
<doc xml:space="preserve">Copies @uri</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a copy of @uri, which must be freed with soup_uri_free()</doc>
<type name="URI" c:type="SoupURI*"/>
</return-value>
<parameters>
<instance-parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI</doc>
<type name="URI" c:type="SoupURI*"/>
</instance-parameter>
</parameters>
</method>
<method name="copy_host"
c:identifier="soup_uri_copy_host"
version="2.28">
<doc xml:space="preserve">Makes a copy of @uri, considering only the protocol, host, and port</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the new #SoupURI</doc>
<type name="URI" c:type="SoupURI*"/>
</return-value>
<parameters>
<instance-parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI</doc>
<type name="URI" c:type="SoupURI*"/>
</instance-parameter>
</parameters>
</method>
<method name="equal" c:identifier="soup_uri_equal">
<doc xml:space="preserve">Tests whether or not @uri1 and @uri2 are equal in all parts</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE or %FALSE</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="uri1" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI</doc>
<type name="URI" c:type="SoupURI*"/>
</instance-parameter>
<parameter name="uri2" transfer-ownership="none">
<doc xml:space="preserve">another #SoupURI</doc>
<type name="URI" c:type="SoupURI*"/>
</parameter>
</parameters>
</method>
<method name="free" c:identifier="soup_uri_free">
<doc xml:space="preserve">Frees @uri.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI</doc>
<type name="URI" c:type="SoupURI*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_fragment"
c:identifier="soup_uri_get_fragment"
version="2.32">
<doc xml:space="preserve">Gets @uri's fragment.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">@uri's fragment.</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<instance-parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI</doc>
<type name="URI" c:type="SoupURI*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_host" c:identifier="soup_uri_get_host" version="2.32">
<doc xml:space="preserve">Gets @uri's host.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">@uri's host.</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<instance-parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI</doc>
<type name="URI" c:type="SoupURI*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_password"
c:identifier="soup_uri_get_password"
version="2.32">
<doc xml:space="preserve">Gets @uri's password.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">@uri's password.</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<instance-parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI</doc>
<type name="URI" c:type="SoupURI*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_path" c:identifier="soup_uri_get_path" version="2.32">
<doc xml:space="preserve">Gets @uri's path.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">@uri's path.</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<instance-parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI</doc>
<type name="URI" c:type="SoupURI*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_port" c:identifier="soup_uri_get_port" version="2.32">
<doc xml:space="preserve">Gets @uri's port.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">@uri's port.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI</doc>
<type name="URI" c:type="SoupURI*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_query"
c:identifier="soup_uri_get_query"
version="2.32">
<doc xml:space="preserve">Gets @uri's query.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">@uri's query.</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<instance-parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI</doc>
<type name="URI" c:type="SoupURI*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_scheme"
c:identifier="soup_uri_get_scheme"
version="2.32">
<doc xml:space="preserve">Gets @uri's scheme.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">@uri's scheme.</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<instance-parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI</doc>
<type name="URI" c:type="SoupURI*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_user" c:identifier="soup_uri_get_user" version="2.32">
<doc xml:space="preserve">Gets @uri's user.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">@uri's user.</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<instance-parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI</doc>
<type name="URI" c:type="SoupURI*"/>
</instance-parameter>
</parameters>
</method>
<method name="host_equal"
c:identifier="soup_uri_host_equal"
version="2.28">
<doc xml:space="preserve">Compares @v1 and @v2, considering only the scheme, host, and port.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">whether or not the URIs are equal in scheme, host,
and port.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="v1" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI with a non-%NULL @host member</doc>
<type name="URI" c:type="gconstpointer"/>
</instance-parameter>
<parameter name="v2" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI with a non-%NULL @host member</doc>
<type name="URI" c:type="gconstpointer"/>
</parameter>
</parameters>
</method>
<method name="host_hash"
c:identifier="soup_uri_host_hash"
version="2.28">
<doc xml:space="preserve">Hashes @key, considering only the scheme, host, and port.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a hash</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="key" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI with a non-%NULL @host member</doc>
<type name="URI" c:type="gconstpointer"/>
</instance-parameter>
</parameters>
</method>
<method name="new_with_base" c:identifier="soup_uri_new_with_base">
<doc xml:space="preserve">Parses @uri_string relative to @base.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a parsed #SoupURI.</doc>
<type name="URI" c:type="SoupURI*"/>
</return-value>
<parameters>
<instance-parameter name="base" transfer-ownership="none">
<doc xml:space="preserve">a base URI</doc>
<type name="URI" c:type="SoupURI*"/>
</instance-parameter>
<parameter name="uri_string" transfer-ownership="none">
<doc xml:space="preserve">the URI</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="set_fragment" c:identifier="soup_uri_set_fragment">
<doc xml:space="preserve">Sets @uri's fragment to @fragment.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI</doc>
<type name="URI" c:type="SoupURI*"/>
</instance-parameter>
<parameter name="fragment"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the fragment</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="set_host" c:identifier="soup_uri_set_host">
<doc xml:space="preserve">Sets @uri's host to @host.
If @host is an IPv6 IP address, it should not include the brackets
required by the URI syntax; they will be added automatically when
converting @uri to a string.
http and https URIs should not have a %NULL @host.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI</doc>
<type name="URI" c:type="SoupURI*"/>
</instance-parameter>
<parameter name="host"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the hostname or IP address, or %NULL</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="set_password" c:identifier="soup_uri_set_password">
<doc xml:space="preserve">Sets @uri's password to @password.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI</doc>
<type name="URI" c:type="SoupURI*"/>
</instance-parameter>
<parameter name="password"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the password, or %NULL</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="set_path" c:identifier="soup_uri_set_path">
<doc xml:space="preserve">Sets @uri's path to @path.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI</doc>
<type name="URI" c:type="SoupURI*"/>
</instance-parameter>
<parameter name="path" transfer-ownership="none">
<doc xml:space="preserve">the non-%NULL path</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="set_port" c:identifier="soup_uri_set_port">
<doc xml:space="preserve">Sets @uri's port to @port. If @port is 0, @uri will not have an
explicitly-specified port.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI</doc>
<type name="URI" c:type="SoupURI*"/>
</instance-parameter>
<parameter name="port" transfer-ownership="none">
<doc xml:space="preserve">the port, or 0</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="set_query" c:identifier="soup_uri_set_query">
<doc xml:space="preserve">Sets @uri's query to @query.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI</doc>
<type name="URI" c:type="SoupURI*"/>
</instance-parameter>
<parameter name="query"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the query</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="set_query_from_fields"
c:identifier="soup_uri_set_query_from_fields"
introspectable="0">
<doc xml:space="preserve">Sets @uri's query to the result of encoding the given form fields
and values according to the * HTML form rules. See
soup_form_encode() for more information.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI</doc>
<type name="URI" c:type="SoupURI*"/>
</instance-parameter>
<parameter name="first_field" transfer-ownership="none">
<doc xml:space="preserve">name of the first form field to encode into query</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">value of @first_field, followed by additional field names
and values, terminated by %NULL.</doc>
<varargs/>
</parameter>
</parameters>
</method>
<method name="set_query_from_form"
c:identifier="soup_uri_set_query_from_form">
<doc xml:space="preserve">Sets @uri's query to the result of encoding @form according to the
HTML form rules. See soup_form_encode_hash() for more information.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI</doc>
<type name="URI" c:type="SoupURI*"/>
</instance-parameter>
<parameter name="form" transfer-ownership="none">
<doc xml:space="preserve">a #GHashTable containing HTML form
information</doc>
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="utf8"/>
<type name="utf8"/>
</type>
</parameter>
</parameters>
</method>
<method name="set_scheme" c:identifier="soup_uri_set_scheme">
<doc xml:space="preserve">Sets @uri's scheme to @scheme. This will also set @uri's port to
the default port for @scheme, if known.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI</doc>
<type name="URI" c:type="SoupURI*"/>
</instance-parameter>
<parameter name="scheme" transfer-ownership="none">
<doc xml:space="preserve">the URI scheme</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="set_user" c:identifier="soup_uri_set_user">
<doc xml:space="preserve">Sets @uri's user to @user.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI</doc>
<type name="URI" c:type="SoupURI*"/>
</instance-parameter>
<parameter name="user"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the username, or %NULL</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="to_string" c:identifier="soup_uri_to_string">
<doc xml:space="preserve">Returns a string representing @uri.
If @just_path_and_query is %TRUE, this concatenates the path and query
together. That is, it constructs the string that would be needed in
the Request-Line of an HTTP request for @uri.
Note that the output will never contain a password, even if @uri
does.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a string representing @uri, which the caller must free.</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<instance-parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI</doc>
<type name="URI" c:type="SoupURI*"/>
</instance-parameter>
<parameter name="just_path_and_query" transfer-ownership="none">
<doc xml:space="preserve">if %TRUE, output just the path and query portions</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="uses_default_port"
c:identifier="soup_uri_uses_default_port">
<doc xml:space="preserve">Tests if @uri uses the default port for its scheme. (Eg, 80 for
http.) (This only works for http, https and ftp; libsoup does not know
the default ports of other protocols.)</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE or %FALSE</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">a #SoupURI</doc>
<type name="URI" c:type="SoupURI*"/>
</instance-parameter>
</parameters>
</method>
<function name="decode" c:identifier="soup_uri_decode">
<doc xml:space="preserve">Fully %<!-- -->-decodes @part.
In the past, this would return %NULL if @part contained invalid
percent-encoding, but now it just ignores the problem (as
soup_uri_new() already did).</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the decoded URI part.</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<parameter name="part" transfer-ownership="none">
<doc xml:space="preserve">a URI part</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</function>
<function name="encode" c:identifier="soup_uri_encode">
<doc xml:space="preserve">This %<!-- -->-encodes the given URI part and returns the escaped
version in allocated memory, which the caller must free when it is
done.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the encoded URI part</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<parameter name="part" transfer-ownership="none">
<doc xml:space="preserve">a URI part</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="escape_extra"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">additional reserved characters to
escape (or %NULL)</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</function>
<function name="normalize" c:identifier="soup_uri_normalize">
<doc xml:space="preserve">%<!-- -->-decodes any "unreserved" characters (or characters in
@unescape_extra) in @part.
"Unreserved" characters are those that are not allowed to be used
for punctuation according to the URI spec. For example, letters are
unreserved, so soup_uri_normalize() will turn
<literal>http://example.com/foo/b%<!-- -->61r</literal> into
<literal>http://example.com/foo/bar</literal>, which is guaranteed
to mean the same thing. However, "/" is "reserved", so
<literal>http://example.com/foo%<!-- -->2Fbar</literal> would not
be changed, because it might mean something different to the
server.
In the past, this would return %NULL if @part contained invalid
percent-encoding, but now it just ignores the problem (as
soup_uri_new() already did).</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the normalized URI part</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<parameter name="part" transfer-ownership="none">
<doc xml:space="preserve">a URI part</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="unescape_extra"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">reserved characters to unescape (or %NULL)</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</function>
</record>
<constant name="URI_H" value="1" c:type="SOUP_URI_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="VALUE_UTILS_H" value="1" c:type="SOUP_VALUE_UTILS_H">
<type name="gint" c:type="gint"/>
</constant>
<enumeration name="WebsocketCloseCode"
version="2.50"
glib:type-name="SoupWebsocketCloseCode"
glib:get-type="soup_websocket_close_code_get_type"
c:type="SoupWebsocketCloseCode">
<doc xml:space="preserve">Pre-defined close codes that can be passed to
soup_websocket_connection_close() or received from
soup_websocket_connection_get_close_code(). (However, other codes
are also allowed.)</doc>
<member name="normal"
value="1000"
c:identifier="SOUP_WEBSOCKET_CLOSE_NORMAL"
glib:nick="normal">
<doc xml:space="preserve">a normal, non-error close</doc>
</member>
<member name="going_away"
value="1001"
c:identifier="SOUP_WEBSOCKET_CLOSE_GOING_AWAY"
glib:nick="going-away">
<doc xml:space="preserve">the client/server is going away</doc>
</member>
<member name="protocol_error"
value="1002"
c:identifier="SOUP_WEBSOCKET_CLOSE_PROTOCOL_ERROR"
glib:nick="protocol-error">
<doc xml:space="preserve">a protocol error occurred</doc>
</member>
<member name="unsupported_data"
value="1003"
c:identifier="SOUP_WEBSOCKET_CLOSE_UNSUPPORTED_DATA"
glib:nick="unsupported-data">
<doc xml:space="preserve">the endpoint received data
of a type that it does not support.</doc>
</member>
<member name="no_status"
value="1005"
c:identifier="SOUP_WEBSOCKET_CLOSE_NO_STATUS"
glib:nick="no-status">
<doc xml:space="preserve">reserved value indicating that
no close code was present; must not be sent.</doc>
</member>
<member name="abnormal"
value="1006"
c:identifier="SOUP_WEBSOCKET_CLOSE_ABNORMAL"
glib:nick="abnormal">
<doc xml:space="preserve">reserved value indicating that
the connection was closed abnormally; must not be sent.</doc>
</member>
<member name="bad_data"
value="1007"
c:identifier="SOUP_WEBSOCKET_CLOSE_BAD_DATA"
glib:nick="bad-data">
<doc xml:space="preserve">the endpoint received data that
was invalid (eg, non-UTF-8 data in a text message).</doc>
</member>
<member name="policy_violation"
value="1008"
c:identifier="SOUP_WEBSOCKET_CLOSE_POLICY_VIOLATION"
glib:nick="policy-violation">
<doc xml:space="preserve">generic error code
indicating some sort of policy violation.</doc>
</member>
<member name="too_big"
value="1009"
c:identifier="SOUP_WEBSOCKET_CLOSE_TOO_BIG"
glib:nick="too-big">
<doc xml:space="preserve">the endpoint received a message
that is too big to process.</doc>
</member>
<member name="no_extension"
value="1010"
c:identifier="SOUP_WEBSOCKET_CLOSE_NO_EXTENSION"
glib:nick="no-extension">
<doc xml:space="preserve">the client is closing the
connection because the server failed to negotiate a required
extension.</doc>
</member>
<member name="server_error"
value="1011"
c:identifier="SOUP_WEBSOCKET_CLOSE_SERVER_ERROR"
glib:nick="server-error">
<doc xml:space="preserve">the server is closing the
connection because it was unable to fulfill the request.</doc>
</member>
<member name="tls_handshake"
value="1015"
c:identifier="SOUP_WEBSOCKET_CLOSE_TLS_HANDSHAKE"
glib:nick="tls-handshake">
<doc xml:space="preserve">reserved value indicating that
the TLS handshake failed; must not be sent.</doc>
</member>
</enumeration>
<class name="WebsocketConnection"
c:symbol-prefix="websocket_connection"
c:type="SoupWebsocketConnection"
version="2.50"
parent="GObject.Object"
glib:type-name="SoupWebsocketConnection"
glib:get-type="soup_websocket_connection_get_type"
glib:type-struct="WebsocketConnectionClass">
<doc xml:space="preserve">A class representing a WebSocket connection.</doc>
<constructor name="new"
c:identifier="soup_websocket_connection_new"
version="2.50">
<doc xml:space="preserve">Creates a #SoupWebsocketConnection on @stream. This should be
called after completing the handshake to begin using the WebSocket
protocol.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #SoupWebsocketConnection</doc>
<type name="WebsocketConnection" c:type="SoupWebsocketConnection*"/>
</return-value>
<parameters>
<parameter name="stream" transfer-ownership="none">
<doc xml:space="preserve">a #GIOStream connected to the WebSocket server</doc>
<type name="Gio.IOStream" c:type="GIOStream*"/>
</parameter>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">the URI of the connection</doc>
<type name="URI" c:type="SoupURI*"/>
</parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">the type of connection (client/side)</doc>
<type name="WebsocketConnectionType"
c:type="SoupWebsocketConnectionType"/>
</parameter>
<parameter name="origin"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the Origin of the client</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="protocol"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the subprotocol in use</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</constructor>
<virtual-method name="closed">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="WebsocketConnection"
c:type="SoupWebsocketConnection*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="closing">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="WebsocketConnection"
c:type="SoupWebsocketConnection*"/>
</instance-parameter>
</parameters>
</virtual-method>
<virtual-method name="error">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="WebsocketConnection"
c:type="SoupWebsocketConnection*"/>
</instance-parameter>
<parameter name="error" transfer-ownership="none">
<type name="GLib.Error" c:type="GError*"/>
</parameter>
</parameters>
</virtual-method>
<virtual-method name="message">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<type name="WebsocketConnection"
c:type="SoupWebsocketConnection*"/>
</instance-parameter>
<parameter name="type" transfer-ownership="none">
<type name="WebsocketDataType" c:type="SoupWebsocketDataType"/>
</parameter>
<parameter name="message" transfer-ownership="none">
<type name="GLib.Bytes" c:type="GBytes*"/>
</parameter>
</parameters>
</virtual-method>
<method name="close"
c:identifier="soup_websocket_connection_close"
version="2.50">
<doc xml:space="preserve">Close the connection in an orderly fashion.
Note that until the #SoupWebsocketConnection::closed signal fires, the connection
is not yet completely closed. The close message is not even sent until the
main loop runs.
The @code and @data are sent to the peer along with the close request.
Note that the @data must be UTF-8 valid.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">the WebSocket</doc>
<type name="WebsocketConnection"
c:type="SoupWebsocketConnection*"/>
</instance-parameter>
<parameter name="code" transfer-ownership="none">
<doc xml:space="preserve">close code</doc>
<type name="gushort" c:type="gushort"/>
</parameter>
<parameter name="data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">close data</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<method name="get_close_code"
c:identifier="soup_websocket_connection_get_close_code"
version="2.50">
<doc xml:space="preserve">Get the close code received from the WebSocket peer.
This only becomes valid once the WebSocket is in the
%SOUP_WEBSOCKET_STATE_CLOSED state. The value will often be in the
#SoupWebsocketCloseCode enumeration, but may also be an application
defined close code.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the close code or zero.</doc>
<type name="gushort" c:type="gushort"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">the WebSocket</doc>
<type name="WebsocketConnection"
c:type="SoupWebsocketConnection*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_close_data"
c:identifier="soup_websocket_connection_get_close_data"
version="2.50">
<doc xml:space="preserve">Get the close data received from the WebSocket peer.
This only becomes valid once the WebSocket is in the
%SOUP_WEBSOCKET_STATE_CLOSED state. The data may be freed once
the main loop is run, so copy it if you need to keep it around.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the close data or %NULL</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">the WebSocket</doc>
<type name="WebsocketConnection"
c:type="SoupWebsocketConnection*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_connection_type"
c:identifier="soup_websocket_connection_get_connection_type"
version="2.50">
<doc xml:space="preserve">Get the connection type (client/server) of the connection.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the connection type</doc>
<type name="WebsocketConnectionType"
c:type="SoupWebsocketConnectionType"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">the WebSocket</doc>
<type name="WebsocketConnection"
c:type="SoupWebsocketConnection*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_io_stream"
c:identifier="soup_websocket_connection_get_io_stream"
version="2.50">
<doc xml:space="preserve">Get the I/O stream the WebSocket is communicating over.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the WebSocket's I/O stream.</doc>
<type name="Gio.IOStream" c:type="GIOStream*"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">the WebSocket</doc>
<type name="WebsocketConnection"
c:type="SoupWebsocketConnection*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_origin"
c:identifier="soup_websocket_connection_get_origin"
version="2.50">
<doc xml:space="preserve">Get the origin of the WebSocket.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">the origin, or %NULL</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">the WebSocket</doc>
<type name="WebsocketConnection"
c:type="SoupWebsocketConnection*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_protocol"
c:identifier="soup_websocket_connection_get_protocol"
version="2.50">
<doc xml:space="preserve">Get the protocol chosen via negotiation with the peer.</doc>
<return-value transfer-ownership="none" nullable="1">
<doc xml:space="preserve">the chosen protocol, or %NULL</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">the WebSocket</doc>
<type name="WebsocketConnection"
c:type="SoupWebsocketConnection*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_state"
c:identifier="soup_websocket_connection_get_state"
version="2.50">
<doc xml:space="preserve">Get the current state of the WebSocket.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the state</doc>
<type name="WebsocketState" c:type="SoupWebsocketState"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">the WebSocket</doc>
<type name="WebsocketConnection"
c:type="SoupWebsocketConnection*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_uri"
c:identifier="soup_websocket_connection_get_uri"
version="2.50">
<doc xml:space="preserve">Get the URI of the WebSocket.
For servers this represents the address of the WebSocket, and
for clients it is the address connected to.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the URI</doc>
<type name="URI" c:type="SoupURI*"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">the WebSocket</doc>
<type name="WebsocketConnection"
c:type="SoupWebsocketConnection*"/>
</instance-parameter>
</parameters>
</method>
<method name="send_binary"
c:identifier="soup_websocket_connection_send_binary"
version="2.50">
<doc xml:space="preserve">Send a binary message to the peer.
The message is queued to be sent and will be sent when the main loop
is run.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">the WebSocket</doc>
<type name="WebsocketConnection"
c:type="SoupWebsocketConnection*"/>
</instance-parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">the message contents</doc>
<array length="1" zero-terminated="0" c:type="gconstpointer">
<type name="guint8"/>
</array>
</parameter>
<parameter name="length" transfer-ownership="none">
<doc xml:space="preserve">the length of @data</doc>
<type name="gsize" c:type="gsize"/>
</parameter>
</parameters>
</method>
<method name="send_text"
c:identifier="soup_websocket_connection_send_text"
version="2.50">
<doc xml:space="preserve">Send a text (UTF-8) message to the peer.
The message is queued to be sent and will be sent when the main loop
is run.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">the WebSocket</doc>
<type name="WebsocketConnection"
c:type="SoupWebsocketConnection*"/>
</instance-parameter>
<parameter name="text" transfer-ownership="none">
<doc xml:space="preserve">the message contents</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
<property name="connection-type"
version="2.50"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve">The type of connection (client/server).</doc>
<type name="WebsocketConnectionType"/>
</property>
<property name="io-stream"
version="2.50"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve">The underlying IO stream the WebSocket is communicating
over.
The input and output streams must be pollable streams.</doc>
<type name="Gio.IOStream"/>
</property>
<property name="origin"
version="2.50"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve">The client's Origin.</doc>
<type name="utf8" c:type="gchar*"/>
</property>
<property name="protocol"
version="2.50"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve">The chosen protocol, or %NULL if a protocol was not agreed
upon.</doc>
<type name="utf8" c:type="gchar*"/>
</property>
<property name="state" version="2.50" transfer-ownership="none">
<doc xml:space="preserve">The current state of the WebSocket.</doc>
<type name="WebsocketState"/>
</property>
<property name="uri"
version="2.50"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:space="preserve">The URI of the WebSocket.
For servers this represents the address of the WebSocket,
and for clients it is the address connected to.</doc>
<type name="URI"/>
</property>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
<field name="pv" readable="0" private="1">
<type name="WebsocketConnectionPrivate"
c:type="SoupWebsocketConnectionPrivate*"/>
</field>
<glib:signal name="closed" when="first" version="2.50">
<doc xml:space="preserve">Emitted when the connection has completely closed, either
due to an orderly close from the peer, one initiated via
soup_websocket_connection_close() or a fatal error
condition that caused a close.
This signal will be emitted once.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
<glib:signal name="closing" when="last" version="2.50">
<doc xml:space="preserve">This signal will be emitted during an orderly close.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
<glib:signal name="error" when="first" version="2.50">
<doc xml:space="preserve">Emitted when an error occurred on the WebSocket. This may
be fired multiple times. Fatal errors will be followed by
the #SoupWebsocketConnection::closed signal being emitted.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="error" transfer-ownership="none">
<doc xml:space="preserve">the error that occured</doc>
<type name="GLib.Error"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="message" when="first" version="2.50">
<doc xml:space="preserve">Emitted when we receive a message from the peer.
As a convenience, the @message data will always be
NUL-terminated, but the NUL byte will not be included in
the length count.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">the type of message contents</doc>
<type name="gint" c:type="gint"/>
</parameter>
<parameter name="message" transfer-ownership="none">
<doc xml:space="preserve">the message data</doc>
<type name="GLib.Bytes"/>
</parameter>
</parameters>
</glib:signal>
</class>
<record name="WebsocketConnectionClass"
c:type="SoupWebsocketConnectionClass"
glib:is-gtype-struct-for="WebsocketConnection"
version="2.50">
<doc xml:space="preserve">The abstract base class for #SoupWebsocketConnection</doc>
<field name="parent">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="message">
<callback name="message">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="self" transfer-ownership="none">
<type name="WebsocketConnection"
c:type="SoupWebsocketConnection*"/>
</parameter>
<parameter name="type" transfer-ownership="none">
<type name="WebsocketDataType" c:type="SoupWebsocketDataType"/>
</parameter>
<parameter name="message" transfer-ownership="none">
<type name="GLib.Bytes" c:type="GBytes*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="error">
<callback name="error">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="self" transfer-ownership="none">
<type name="WebsocketConnection"
c:type="SoupWebsocketConnection*"/>
</parameter>
<parameter name="error" transfer-ownership="none">
<type name="GLib.Error" c:type="GError*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="closing">
<callback name="closing">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="self" transfer-ownership="none">
<type name="WebsocketConnection"
c:type="SoupWebsocketConnection*"/>
</parameter>
</parameters>
</callback>
</field>
<field name="closed">
<callback name="closed">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="self" transfer-ownership="none">
<type name="WebsocketConnection"
c:type="SoupWebsocketConnection*"/>
</parameter>
</parameters>
</callback>
</field>
</record>
<record name="WebsocketConnectionPrivate"
c:type="SoupWebsocketConnectionPrivate"
disguised="1">
</record>
<enumeration name="WebsocketConnectionType"
version="2.50"
glib:type-name="SoupWebsocketConnectionType"
glib:get-type="soup_websocket_connection_type_get_type"
c:type="SoupWebsocketConnectionType">
<doc xml:space="preserve">The type of a #SoupWebsocketConnection.</doc>
<member name="unknown"
value="0"
c:identifier="SOUP_WEBSOCKET_CONNECTION_UNKNOWN"
glib:nick="unknown">
<doc xml:space="preserve">unknown/invalid connection</doc>
</member>
<member name="client"
value="1"
c:identifier="SOUP_WEBSOCKET_CONNECTION_CLIENT"
glib:nick="client">
<doc xml:space="preserve">a client-side connection</doc>
</member>
<member name="server"
value="2"
c:identifier="SOUP_WEBSOCKET_CONNECTION_SERVER"
glib:nick="server">
<doc xml:space="preserve">a server-side connection</doc>
</member>
</enumeration>
<enumeration name="WebsocketDataType"
version="2.50"
glib:type-name="SoupWebsocketDataType"
glib:get-type="soup_websocket_data_type_get_type"
c:type="SoupWebsocketDataType">
<doc xml:space="preserve">The type of data contained in a #SoupWebsocketConnection::message
signal.</doc>
<member name="text"
value="1"
c:identifier="SOUP_WEBSOCKET_DATA_TEXT"
glib:nick="text">
<doc xml:space="preserve">UTF-8 text</doc>
</member>
<member name="binary"
value="2"
c:identifier="SOUP_WEBSOCKET_DATA_BINARY"
glib:nick="binary">
<doc xml:space="preserve">binary data</doc>
</member>
</enumeration>
<enumeration name="WebsocketError"
version="2.50"
glib:type-name="SoupWebsocketError"
glib:get-type="soup_websocket_error_get_type"
c:type="SoupWebsocketError">
<doc xml:space="preserve">WebSocket-related errors.</doc>
<member name="failed"
value="0"
c:identifier="SOUP_WEBSOCKET_ERROR_FAILED"
glib:nick="failed">
<doc xml:space="preserve">a generic error</doc>
</member>
<member name="not_websocket"
value="1"
c:identifier="SOUP_WEBSOCKET_ERROR_NOT_WEBSOCKET"
glib:nick="not-websocket">
<doc xml:space="preserve">attempted to handshake with a
server that does not appear to understand WebSockets.</doc>
</member>
<member name="bad_handshake"
value="2"
c:identifier="SOUP_WEBSOCKET_ERROR_BAD_HANDSHAKE"
glib:nick="bad-handshake">
<doc xml:space="preserve">the WebSocket handshake failed
because some detail was invalid (eg, incorrect accept key).</doc>
</member>
<member name="bad_origin"
value="3"
c:identifier="SOUP_WEBSOCKET_ERROR_BAD_ORIGIN"
glib:nick="bad-origin">
<doc xml:space="preserve">the WebSocket handshake failed
because the "Origin" header was not an allowed value.</doc>
</member>
<function name="get_quark" c:identifier="soup_websocket_error_get_quark">
<return-value transfer-ownership="none">
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
</enumeration>
<enumeration name="WebsocketState"
version="2.50"
glib:type-name="SoupWebsocketState"
glib:get-type="soup_websocket_state_get_type"
c:type="SoupWebsocketState">
<doc xml:space="preserve">The state of the WebSocket connection.</doc>
<member name="open"
value="1"
c:identifier="SOUP_WEBSOCKET_STATE_OPEN"
glib:nick="open">
<doc xml:space="preserve">the connection is ready to send messages</doc>
</member>
<member name="closing"
value="2"
c:identifier="SOUP_WEBSOCKET_STATE_CLOSING"
glib:nick="closing">
<doc xml:space="preserve">the connection is in the process of
closing down; messages may be received, but not sent</doc>
</member>
<member name="closed"
value="3"
c:identifier="SOUP_WEBSOCKET_STATE_CLOSED"
glib:nick="closed">
<doc xml:space="preserve">the connection is completely closed down</doc>
</member>
</enumeration>
<enumeration name="XMLRPCError"
glib:type-name="SoupXMLRPCError"
glib:get-type="soup_xmlrpc_error_get_type"
c:type="SoupXMLRPCError"
glib:error-domain="soup_xmlrpc_error_quark">
<member name="arguments"
value="0"
c:identifier="SOUP_XMLRPC_ERROR_ARGUMENTS"
glib:nick="arguments">
</member>
<member name="retval"
value="1"
c:identifier="SOUP_XMLRPC_ERROR_RETVAL"
glib:nick="retval">
</member>
<function name="quark" c:identifier="soup_xmlrpc_error_quark">
<return-value transfer-ownership="none">
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
</enumeration>
<enumeration name="XMLRPCFault"
glib:type-name="SoupXMLRPCFault"
glib:get-type="soup_xmlrpc_fault_get_type"
c:type="SoupXMLRPCFault">
<doc xml:space="preserve">Pre-defined XML-RPC fault codes from <ulink
url="http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php">http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php</ulink>.
These are an extension, not part of the XML-RPC spec; you can't
assume servers will use them.</doc>
<member name="parse_error_not_well_formed"
value="-32700"
c:identifier="SOUP_XMLRPC_FAULT_PARSE_ERROR_NOT_WELL_FORMED"
glib:nick="parse-error-not-well-formed">
<doc xml:space="preserve">request was not
well-formed</doc>
</member>
<member name="parse_error_unsupported_encoding"
value="-32701"
c:identifier="SOUP_XMLRPC_FAULT_PARSE_ERROR_UNSUPPORTED_ENCODING"
glib:nick="parse-error-unsupported-encoding">
<doc xml:space="preserve">request was in
an unsupported encoding</doc>
</member>
<member name="parse_error_invalid_character_for_encoding"
value="-32702"
c:identifier="SOUP_XMLRPC_FAULT_PARSE_ERROR_INVALID_CHARACTER_FOR_ENCODING"
glib:nick="parse-error-invalid-character-for-encoding">
<doc xml:space="preserve">request contained an invalid character</doc>
</member>
<member name="server_error_invalid_xml_rpc"
value="-32600"
c:identifier="SOUP_XMLRPC_FAULT_SERVER_ERROR_INVALID_XML_RPC"
glib:nick="server-error-invalid-xml-rpc">
<doc xml:space="preserve">request was not
valid XML-RPC</doc>
</member>
<member name="server_error_requested_method_not_found"
value="-32601"
c:identifier="SOUP_XMLRPC_FAULT_SERVER_ERROR_REQUESTED_METHOD_NOT_FOUND"
glib:nick="server-error-requested-method-not-found">
<doc xml:space="preserve">method
not found</doc>
</member>
<member name="server_error_invalid_method_parameters"
value="-32602"
c:identifier="SOUP_XMLRPC_FAULT_SERVER_ERROR_INVALID_METHOD_PARAMETERS"
glib:nick="server-error-invalid-method-parameters">
<doc xml:space="preserve">invalid
parameters</doc>
</member>
<member name="server_error_internal_xml_rpc_error"
value="-32603"
c:identifier="SOUP_XMLRPC_FAULT_SERVER_ERROR_INTERNAL_XML_RPC_ERROR"
glib:nick="server-error-internal-xml-rpc-error">
<doc xml:space="preserve">internal
error</doc>
</member>
<member name="application_error"
value="-32500"
c:identifier="SOUP_XMLRPC_FAULT_APPLICATION_ERROR"
glib:nick="application-error">
<doc xml:space="preserve">start of reserved range for
application error codes</doc>
</member>
<member name="system_error"
value="-32400"
c:identifier="SOUP_XMLRPC_FAULT_SYSTEM_ERROR"
glib:nick="system-error">
<doc xml:space="preserve">start of reserved range for
system error codes</doc>
</member>
<member name="transport_error"
value="-32300"
c:identifier="SOUP_XMLRPC_FAULT_TRANSPORT_ERROR"
glib:nick="transport-error">
<doc xml:space="preserve">start of reserved range for
transport error codes</doc>
</member>
<function name="quark" c:identifier="soup_xmlrpc_fault_quark">
<return-value transfer-ownership="none">
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
</enumeration>
<record name="XMLRPCParams"
c:type="SoupXMLRPCParams"
disguised="1"
version="2.52">
<doc xml:space="preserve">Opaque structure containing XML-RPC methodCall parameter values.
Can be parsed using soup_xmlrpc_params_parse() and freed with
soup_xmlrpc_params_free().</doc>
<method name="free"
c:identifier="soup_xmlrpc_params_free"
version="2.52">
<doc xml:space="preserve">Free a #SoupXMLRPCParams returned by soup_xmlrpc_parse_request().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">a SoupXMLRPCParams</doc>
<type name="XMLRPCParams" c:type="SoupXMLRPCParams*"/>
</instance-parameter>
</parameters>
</method>
<method name="parse"
c:identifier="soup_xmlrpc_params_parse"
version="2.52"
throws="1">
<doc xml:space="preserve">Parse method parameters returned by soup_xmlrpc_parse_request().
Deserialization details:
- If @signature is provided, &lt;int&gt; and &lt;i4&gt; can be deserialized
to byte, int16, uint16, int32, uint32, int64 or uint64. Otherwise
it will be deserialized to int32. If the value is out of range
for the target type it will return an error.
- &lt;struct&gt; will be deserialized to "a{sv}". @signature could define
another value type (e.g. "a{ss}").
- &lt;array&gt; will be deserialized to "av". @signature could define
another element type (e.g. "as") or could be a tuple (e.g. "(ss)").
- &lt;base64&gt; will be deserialized to "ay".
- &lt;string&gt; will be deserialized to "s".
- &lt;dateTime.iso8601&gt; will be deserialized to an unspecified variant
type. If @signature is provided it must have the generic "v" type, which
means there is no guarantee that it's actually a datetime that has been
received. soup_xmlrpc_variant_get_datetime() must be used to parse and
type check this special variant.
- @signature must not have maybes, otherwise an error is returned.
- Dictionaries must have string keys, otherwise an error is returned.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new (non-floating) #GVariant, or %NULL</doc>
<type name="GLib.Variant" c:type="GVariant*"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">A #SoupXMLRPCParams</doc>
<type name="XMLRPCParams" c:type="SoupXMLRPCParams*"/>
</instance-parameter>
<parameter name="signature"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A valid #GVariant type string, or %NULL</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</method>
</record>
<constant name="XMLRPC_H" value="1" c:type="SOUP_XMLRPC_H">
<type name="gint" c:type="gint"/>
</constant>
<constant name="XMLRPC_OLD_H" value="1" c:type="SOUP_XMLRPC_OLD_H">
<type name="gint" c:type="gint"/>
</constant>
<function name="add_completion"
c:identifier="soup_add_completion"
version="2.24"
introspectable="0">
<doc xml:space="preserve">Adds @function to be executed from inside @async_context with the
default priority. Use this when you want to complete an action in
@async_context's main loop, as soon as possible.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GSource, which can be removed from @async_context
with g_source_destroy().</doc>
<type name="GLib.Source" c:type="GSource*"/>
</return-value>
<parameters>
<parameter name="async_context"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the #GMainContext to dispatch the I/O
watch in, or %NULL for the default context</doc>
<type name="GLib.MainContext" c:type="GMainContext*"/>
</parameter>
<parameter name="function" transfer-ownership="none" closure="2">
<doc xml:space="preserve">the callback to invoke</doc>
<type name="GLib.SourceFunc" c:type="GSourceFunc"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">user data to pass to @function</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</function>
<function name="add_idle" c:identifier="soup_add_idle" introspectable="0">
<doc xml:space="preserve">Adds an idle event as with g_idle_add(), but using the given
@async_context.
If you want @function to run "right away", use
soup_add_completion(), since that sets a higher priority on the
#GSource than soup_add_idle() does.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GSource, which can be removed from @async_context
with g_source_destroy().</doc>
<type name="GLib.Source" c:type="GSource*"/>
</return-value>
<parameters>
<parameter name="async_context"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the #GMainContext to dispatch the I/O
watch in, or %NULL for the default context</doc>
<type name="GLib.MainContext" c:type="GMainContext*"/>
</parameter>
<parameter name="function" transfer-ownership="none" closure="2">
<doc xml:space="preserve">the callback to invoke at idle time</doc>
<type name="GLib.SourceFunc" c:type="GSourceFunc"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">user data to pass to @function</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</function>
<function name="add_io_watch"
c:identifier="soup_add_io_watch"
introspectable="0">
<doc xml:space="preserve">Adds an I/O watch as with g_io_add_watch(), but using the given
@async_context.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GSource, which can be removed from @async_context
with g_source_destroy().</doc>
<type name="GLib.Source" c:type="GSource*"/>
</return-value>
<parameters>
<parameter name="async_context"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the #GMainContext to dispatch the I/O
watch in, or %NULL for the default context</doc>
<type name="GLib.MainContext" c:type="GMainContext*"/>
</parameter>
<parameter name="chan" transfer-ownership="none">
<doc xml:space="preserve">the #GIOChannel to watch</doc>
<type name="GLib.IOChannel" c:type="GIOChannel*"/>
</parameter>
<parameter name="condition" transfer-ownership="none">
<doc xml:space="preserve">the condition to watch for</doc>
<type name="GLib.IOCondition" c:type="GIOCondition"/>
</parameter>
<parameter name="function" transfer-ownership="none" closure="4">
<doc xml:space="preserve">the callback to invoke when @condition occurs</doc>
<type name="GLib.IOFunc" c:type="GIOFunc"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">user data to pass to @function</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</function>
<function name="add_timeout"
c:identifier="soup_add_timeout"
introspectable="0">
<doc xml:space="preserve">Adds a timeout as with g_timeout_add(), but using the given
@async_context.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GSource, which can be removed from @async_context
with g_source_destroy().</doc>
<type name="GLib.Source" c:type="GSource*"/>
</return-value>
<parameters>
<parameter name="async_context"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the #GMainContext to dispatch the I/O
watch in, or %NULL for the default context</doc>
<type name="GLib.MainContext" c:type="GMainContext*"/>
</parameter>
<parameter name="interval" transfer-ownership="none">
<doc xml:space="preserve">the timeout interval, in milliseconds</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="function" transfer-ownership="none" closure="3">
<doc xml:space="preserve">the callback to invoke at timeout time</doc>
<type name="GLib.SourceFunc" c:type="GSourceFunc"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:space="preserve">user data to pass to @function</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</function>
<function name="cookie_parse"
c:identifier="soup_cookie_parse"
moved-to="Cookie.parse"
version="2.24">
<doc xml:space="preserve">Parses @header and returns a #SoupCookie. (If @header contains
multiple cookies, only the first one will be parsed.)
If @header does not have "path" or "domain" attributes, they will
be defaulted from @origin. If @origin is %NULL, path will default
to "/", but domain will be left as %NULL. Note that this is not a
valid state for a #SoupCookie, and you will need to fill in some
appropriate string for the domain if you want to actually make use
of the cookie.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">a new #SoupCookie, or %NULL if it could
not be parsed, or contained an illegal "domain" attribute for a
cookie originating from @origin.</doc>
<type name="Cookie" c:type="SoupCookie*"/>
</return-value>
<parameters>
<parameter name="header" transfer-ownership="none">
<doc xml:space="preserve">a cookie string (eg, the value of a Set-Cookie header)</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="origin" transfer-ownership="none">
<doc xml:space="preserve">origin of the cookie, or %NULL</doc>
<type name="URI" c:type="SoupURI*"/>
</parameter>
</parameters>
</function>
<function name="cookies_free"
c:identifier="soup_cookies_free"
version="2.24"
introspectable="0">
<doc xml:space="preserve">Frees @cookies.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="cookies" transfer-ownership="none">
<doc xml:space="preserve">a #GSList of #SoupCookie</doc>
<type name="GLib.SList" c:type="GSList*">
<type name="Cookie"/>
</type>
</parameter>
</parameters>
</function>
<function name="cookies_from_request"
c:identifier="soup_cookies_from_request"
version="2.24">
<doc xml:space="preserve">Parses @msg's Cookie request header and returns a #GSList of
#SoupCookie<!-- -->s. As the "Cookie" header, unlike "Set-Cookie",
only contains cookie names and values, none of the other
#SoupCookie fields will be filled in. (Thus, you can't generally
pass a cookie returned from this method directly to
soup_cookies_to_response().)</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GSList
of #SoupCookie<!-- -->s, which can be freed with
soup_cookies_free().</doc>
<type name="GLib.SList" c:type="GSList*">
<type name="Cookie"/>
</type>
</return-value>
<parameters>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage containing a "Cookie" request header</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</function>
<function name="cookies_from_response"
c:identifier="soup_cookies_from_response"
version="2.24">
<doc xml:space="preserve">Parses @msg's Set-Cookie response headers and returns a #GSList of
#SoupCookie<!-- -->s. Cookies that do not specify "path" or
"domain" attributes will have their values defaulted from @msg.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GSList
of #SoupCookie<!-- -->s, which can be freed with
soup_cookies_free().</doc>
<type name="GLib.SList" c:type="GSList*">
<type name="Cookie"/>
</type>
</return-value>
<parameters>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage containing a "Set-Cookie" response header</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</function>
<function name="cookies_to_cookie_header"
c:identifier="soup_cookies_to_cookie_header"
version="2.24">
<doc xml:space="preserve">Serializes a #GSList of #SoupCookie into a string suitable for
setting as the value of the "Cookie" header.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the serialization of @cookies</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<parameter name="cookies" transfer-ownership="none">
<doc xml:space="preserve">a #GSList of #SoupCookie</doc>
<type name="GLib.SList" c:type="GSList*">
<type name="Cookie"/>
</type>
</parameter>
</parameters>
</function>
<function name="cookies_to_request"
c:identifier="soup_cookies_to_request"
version="2.24">
<doc xml:space="preserve">Adds the name and value of each cookie in @cookies to @msg's
"Cookie" request. (If @msg already has a "Cookie" request header,
these cookies will be appended to the cookies already present. Be
careful that you do not append the same cookies twice, eg, when
requeuing a message.)</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="cookies" transfer-ownership="none">
<doc xml:space="preserve">a #GSList of #SoupCookie</doc>
<type name="GLib.SList" c:type="GSList*">
<type name="Cookie"/>
</type>
</parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</function>
<function name="cookies_to_response"
c:identifier="soup_cookies_to_response"
version="2.24">
<doc xml:space="preserve">Appends a "Set-Cookie" response header to @msg for each cookie in
@cookies. (This is in addition to any other "Set-Cookie" headers
@msg may already have.)</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="cookies" transfer-ownership="none">
<doc xml:space="preserve">a #GSList of #SoupCookie</doc>
<type name="GLib.SList" c:type="GSList*">
<type name="Cookie"/>
</type>
</parameter>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</function>
<function name="form_decode" c:identifier="soup_form_decode">
<doc xml:space="preserve">Decodes @form, which is an urlencoded dataset as defined in the
HTML 4.01 spec.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a hash
table containing the name/value pairs from @encoded_form, which you
can free with g_hash_table_destroy().</doc>
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="utf8"/>
<type name="utf8"/>
</type>
</return-value>
<parameters>
<parameter name="encoded_form" transfer-ownership="none">
<doc xml:space="preserve">data of type "application/x-www-form-urlencoded"</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</function>
<function name="form_decode_multipart"
c:identifier="soup_form_decode_multipart"
version="2.26">
<doc xml:space="preserve">Decodes the "multipart/form-data" request in @msg; this is a
convenience method for the case when you have a single file upload
control in a form. (Or when you don't have any file upload
controls, but are still using "multipart/form-data" anyway.) Pass
the name of the file upload control in @file_control_name, and
soup_form_decode_multipart() will extract the uploaded file data
into @filename, @content_type, and @file. All of the other form
control data will be returned (as strings, as with
soup_form_decode()) in the returned #GHashTable.
You may pass %NULL for @filename, @content_type and/or @file if you do not
care about those fields. soup_form_decode_multipart() may also
return %NULL in those fields if the client did not provide that
information. You must free the returned filename and content-type
with g_free(), and the returned file data with soup_buffer_free().
If you have a form with more than one file upload control, you will
need to decode it manually, using soup_multipart_new_from_message()
and soup_multipart_get_part().</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">
a hash table containing the name/value pairs (other than
@file_control_name) from @msg, which you can free with
g_hash_table_destroy(). On error, it will return %NULL.</doc>
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="utf8"/>
<type name="utf8"/>
</type>
</return-value>
<parameters>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage containing a "multipart/form-data" request body</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="file_control_name"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the name of the HTML file upload control, or %NULL</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="filename"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">return location for the name of the uploaded file, or %NULL</doc>
<type name="utf8" c:type="char**"/>
</parameter>
<parameter name="content_type"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">return location for the MIME type of the uploaded file, or %NULL</doc>
<type name="utf8" c:type="char**"/>
</parameter>
<parameter name="file"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">return location for the uploaded file data, or %NULL</doc>
<type name="Buffer" c:type="SoupBuffer**"/>
</parameter>
</parameters>
</function>
<function name="form_encode"
c:identifier="soup_form_encode"
introspectable="0">
<doc xml:space="preserve">Encodes the given field names and values into a value of type
"application/x-www-form-urlencoded", as defined in the HTML 4.01
spec.
This method requires you to know the names of the form fields (or
at the very least, the total number of fields) at compile time; for
working with dynamic forms, use soup_form_encode_hash() or
soup_form_encode_datalist().</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the encoded form</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<parameter name="first_field" transfer-ownership="none">
<doc xml:space="preserve">name of the first form field</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">value of @first_field, followed by additional field names
and values, terminated by %NULL.</doc>
<varargs/>
</parameter>
</parameters>
</function>
<function name="form_encode_datalist"
c:identifier="soup_form_encode_datalist">
<doc xml:space="preserve">Encodes @form_data_set into a value of type
"application/x-www-form-urlencoded", as defined in the HTML 4.01
spec. Unlike soup_form_encode_hash(), this preserves the ordering
of the form elements, which may be required in some situations.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the encoded form</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<parameter name="form_data_set" transfer-ownership="none">
<doc xml:space="preserve">a datalist containing name/value pairs</doc>
<type name="GLib.Data" c:type="GData**"/>
</parameter>
</parameters>
</function>
<function name="form_encode_hash" c:identifier="soup_form_encode_hash">
<doc xml:space="preserve">Encodes @form_data_set into a value of type
"application/x-www-form-urlencoded", as defined in the HTML 4.01
spec.
Note that the HTML spec states that "The control names/values are
listed in the order they appear in the document." Since this method
takes a hash table, it cannot enforce that; if you care about the
ordering of the form fields, use soup_form_encode_datalist().</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the encoded form</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<parameter name="form_data_set" transfer-ownership="none">
<doc xml:space="preserve">a hash table containing
name/value pairs (as strings)</doc>
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="utf8"/>
<type name="utf8"/>
</type>
</parameter>
</parameters>
</function>
<function name="form_encode_valist"
c:identifier="soup_form_encode_valist"
introspectable="0">
<doc xml:space="preserve">See soup_form_encode(). This is mostly an internal method, used by
various other methods such as soup_uri_set_query_from_fields() and
soup_form_request_new().</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the encoded form</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<parameter name="first_field" transfer-ownership="none">
<doc xml:space="preserve">name of the first form field</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="args" transfer-ownership="none">
<doc xml:space="preserve">pointer to additional values, as in soup_form_encode()</doc>
<type name="va_list" c:type="va_list"/>
</parameter>
</parameters>
</function>
<function name="form_request_new"
c:identifier="soup_form_request_new"
introspectable="0">
<doc xml:space="preserve">Creates a new %SoupMessage and sets it up to send the given data
to @uri via @method. (That is, if @method is "GET", it will encode
the form data into @uri's query field, and if @method is "POST", it
will encode it into the %SoupMessage's request_body.)</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the new %SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</return-value>
<parameters>
<parameter name="method" transfer-ownership="none">
<doc xml:space="preserve">the HTTP method, either "GET" or "POST"</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">the URI to send the form data to</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="first_field" transfer-ownership="none">
<doc xml:space="preserve">name of the first form field</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">value of @first_field, followed by additional field names
and values, terminated by %NULL.</doc>
<varargs/>
</parameter>
</parameters>
</function>
<function name="form_request_new_from_datalist"
c:identifier="soup_form_request_new_from_datalist">
<doc xml:space="preserve">Creates a new %SoupMessage and sets it up to send @form_data_set to
@uri via @method, as with soup_form_request_new().</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the new %SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</return-value>
<parameters>
<parameter name="method" transfer-ownership="none">
<doc xml:space="preserve">the HTTP method, either "GET" or "POST"</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">the URI to send the form data to</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="form_data_set" transfer-ownership="none">
<doc xml:space="preserve">the data to send to @uri</doc>
<type name="GLib.Data" c:type="GData**"/>
</parameter>
</parameters>
</function>
<function name="form_request_new_from_hash"
c:identifier="soup_form_request_new_from_hash">
<doc xml:space="preserve">Creates a new %SoupMessage and sets it up to send @form_data_set to
@uri via @method, as with soup_form_request_new().</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the new %SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</return-value>
<parameters>
<parameter name="method" transfer-ownership="none">
<doc xml:space="preserve">the HTTP method, either "GET" or "POST"</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">the URI to send the form data to</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="form_data_set" transfer-ownership="none">
<doc xml:space="preserve">the data to send to @uri</doc>
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="utf8"/>
<type name="utf8"/>
</type>
</parameter>
</parameters>
</function>
<function name="form_request_new_from_multipart"
c:identifier="soup_form_request_new_from_multipart"
version="2.26">
<doc xml:space="preserve">Creates a new %SoupMessage and sets it up to send @multipart to
@uri via POST.
To send a <literal>"multipart/form-data"</literal> POST, first
create a #SoupMultipart, using %SOUP_FORM_MIME_TYPE_MULTIPART as
the MIME type. Then use soup_multipart_append_form_string() and
soup_multipart_append_form_file() to add the value of each form
control to the multipart. (These are just convenience methods, and
you can use soup_multipart_append_part() if you need greater
control over the part headers.) Finally, call
soup_form_request_new_from_multipart() to serialize the multipart
structure and create a #SoupMessage.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the new %SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</return-value>
<parameters>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">the URI to send the form data to</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="multipart" transfer-ownership="none">
<doc xml:space="preserve">a "multipart/form-data" #SoupMultipart</doc>
<type name="Multipart" c:type="SoupMultipart*"/>
</parameter>
</parameters>
</function>
<function name="header_contains" c:identifier="soup_header_contains">
<doc xml:space="preserve">Parses @header to see if it contains the token @token (matched
case-insensitively). Note that this can't be used with lists
that have qvalues.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">whether or not @header contains @token</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="header" transfer-ownership="none">
<doc xml:space="preserve">An HTTP header suitable for parsing with
soup_header_parse_list()</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="token" transfer-ownership="none">
<doc xml:space="preserve">a token</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</function>
<function name="header_free_list"
c:identifier="soup_header_free_list"
introspectable="0">
<doc xml:space="preserve">Frees @list.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="list" transfer-ownership="none">
<doc xml:space="preserve">a #GSList returned from soup_header_parse_list() or
soup_header_parse_quality_list()</doc>
<type name="GLib.SList" c:type="GSList*">
<type name="gpointer" c:type="gpointer"/>
</type>
</parameter>
</parameters>
</function>
<function name="header_free_param_list"
c:identifier="soup_header_free_param_list">
<doc xml:space="preserve">Frees @param_list.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="param_list" transfer-ownership="none">
<doc xml:space="preserve">a #GHashTable returned from soup_header_parse_param_list()
or soup_header_parse_semi_param_list()</doc>
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="utf8"/>
<type name="utf8"/>
</type>
</parameter>
</parameters>
</function>
<function name="header_g_string_append_param"
c:identifier="soup_header_g_string_append_param"
version="2.26">
<doc xml:space="preserve">Appends something like <literal>@name=@value</literal> to @string,
taking care to quote @value if needed, and if so, to escape any
quotes or backslashes in @value.
Alternatively, if @value is a non-ASCII UTF-8 string, it will be
appended using RFC5987 syntax. Although in theory this is supposed
to work anywhere in HTTP that uses this style of parameter, in
reality, it can only be used portably with the Content-Disposition
"filename" parameter.
If @value is %NULL, this will just append @name to @string.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="string" transfer-ownership="none">
<doc xml:space="preserve">a #GString being used to construct an HTTP header value</doc>
<type name="GLib.String" c:type="GString*"/>
</parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">a parameter name</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">a parameter value, or %NULL</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</function>
<function name="header_g_string_append_param_quoted"
c:identifier="soup_header_g_string_append_param_quoted"
version="2.30">
<doc xml:space="preserve">Appends something like <literal>@name="@value"</literal> to
@string, taking care to escape any quotes or backslashes in @value.
If @value is (non-ASCII) UTF-8, this will instead use RFC 5987
encoding, just like soup_header_g_string_append_param().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="string" transfer-ownership="none">
<doc xml:space="preserve">a #GString being used to construct an HTTP header value</doc>
<type name="GLib.String" c:type="GString*"/>
</parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">a parameter name</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">a parameter value</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</function>
<function name="header_parse_list" c:identifier="soup_header_parse_list">
<doc xml:space="preserve">Parses a header whose content is described by RFC2616 as
"#something", where "something" does not itself contain commas,
except as part of quoted-strings.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GSList of
list elements, as allocated strings</doc>
<type name="GLib.SList" c:type="GSList*">
<type name="utf8"/>
</type>
</return-value>
<parameters>
<parameter name="header" transfer-ownership="none">
<doc xml:space="preserve">a header value</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</function>
<function name="header_parse_param_list"
c:identifier="soup_header_parse_param_list">
<doc xml:space="preserve">Parses a header which is a comma-delimited list of something like:
<literal>token [ "=" ( token | quoted-string ) ]</literal>.
Tokens that don't have an associated value will still be added to
the resulting hash table, but with a %NULL value.
This also handles RFC5987 encoding (which in HTTP is mostly used
for giving UTF8-encoded filenames in the Content-Disposition
header).</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a
#GHashTable of list elements, which can be freed with
soup_header_free_param_list().</doc>
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="utf8"/>
<type name="utf8"/>
</type>
</return-value>
<parameters>
<parameter name="header" transfer-ownership="none">
<doc xml:space="preserve">a header value</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</function>
<function name="header_parse_quality_list"
c:identifier="soup_header_parse_quality_list">
<doc xml:space="preserve">Parses a header whose content is a list of items with optional
"qvalue"s (eg, Accept, Accept-Charset, Accept-Encoding,
Accept-Language, TE).
If @unacceptable is not %NULL, then on return, it will contain the
items with qvalue 0. Either way, those items will be removed from
the main list.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GSList of
acceptable values (as allocated strings), highest-qvalue first.</doc>
<type name="GLib.SList" c:type="GSList*">
<type name="utf8"/>
</type>
</return-value>
<parameters>
<parameter name="header" transfer-ownership="none">
<doc xml:space="preserve">a header value</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="unacceptable"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">on
return, will contain a list of unacceptable values</doc>
<type name="GLib.SList" c:type="GSList**">
<type name="utf8"/>
</type>
</parameter>
</parameters>
</function>
<function name="header_parse_semi_param_list"
c:identifier="soup_header_parse_semi_param_list"
version="2.24">
<doc xml:space="preserve">Parses a header which is a semicolon-delimited list of something
like: <literal>token [ "=" ( token | quoted-string ) ]</literal>.
Tokens that don't have an associated value will still be added to
the resulting hash table, but with a %NULL value.
This also handles RFC5987 encoding (which in HTTP is mostly used
for giving UTF8-encoded filenames in the Content-Disposition
header).</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a
#GHashTable of list elements, which can be freed with
soup_header_free_param_list().</doc>
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="utf8"/>
<type name="utf8"/>
</type>
</return-value>
<parameters>
<parameter name="header" transfer-ownership="none">
<doc xml:space="preserve">a header value</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</function>
<function name="headers_parse"
c:identifier="soup_headers_parse"
version="2.26">
<doc xml:space="preserve">Parses the headers of an HTTP request or response in @str and
stores the results in @dest. Beware that @dest may be modified even
on failure.
This is a low-level method; normally you would use
soup_headers_parse_request() or soup_headers_parse_response().</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">success or failure</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="str" transfer-ownership="none">
<doc xml:space="preserve">the header string (including the Request-Line or Status-Line,
but not the trailing blank line)</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="len" transfer-ownership="none">
<doc xml:space="preserve">length of @str</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="dest" transfer-ownership="none">
<doc xml:space="preserve">#SoupMessageHeaders to store the header values in</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</parameter>
</parameters>
</function>
<function name="headers_parse_request"
c:identifier="soup_headers_parse_request">
<doc xml:space="preserve">Parses the headers of an HTTP request in @str and stores the
results in @req_method, @req_path, @ver, and @req_headers.
Beware that @req_headers may be modified even on failure.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%SOUP_STATUS_OK if the headers could be parsed, or an
HTTP error to be returned to the client if they could not be.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<parameter name="str" transfer-ownership="none">
<doc xml:space="preserve">the headers (up to, but not including, the trailing blank line)</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="len" transfer-ownership="none">
<doc xml:space="preserve">length of @str</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="req_headers" transfer-ownership="none">
<doc xml:space="preserve">#SoupMessageHeaders to store the header values in</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</parameter>
<parameter name="req_method"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">if non-%NULL, will be filled in with the
request method</doc>
<type name="utf8" c:type="char**"/>
</parameter>
<parameter name="req_path"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">if non-%NULL, will be filled in with the
request path</doc>
<type name="utf8" c:type="char**"/>
</parameter>
<parameter name="ver"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">if non-%NULL, will be filled in with the HTTP
version</doc>
<type name="HTTPVersion" c:type="SoupHTTPVersion*"/>
</parameter>
</parameters>
</function>
<function name="headers_parse_response"
c:identifier="soup_headers_parse_response">
<doc xml:space="preserve">Parses the headers of an HTTP response in @str and stores the
results in @ver, @status_code, @reason_phrase, and @headers.
Beware that @headers may be modified even on failure.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">success or failure.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="str" transfer-ownership="none">
<doc xml:space="preserve">the headers (up to, but not including, the trailing blank line)</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="len" transfer-ownership="none">
<doc xml:space="preserve">length of @str</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="headers" transfer-ownership="none">
<doc xml:space="preserve">#SoupMessageHeaders to store the header values in</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</parameter>
<parameter name="ver"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">if non-%NULL, will be filled in with the HTTP
version</doc>
<type name="HTTPVersion" c:type="SoupHTTPVersion*"/>
</parameter>
<parameter name="status_code"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">if non-%NULL, will be filled in with
the status code</doc>
<type name="guint" c:type="guint*"/>
</parameter>
<parameter name="reason_phrase"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">if non-%NULL, will be filled in with
the reason phrase</doc>
<type name="utf8" c:type="char**"/>
</parameter>
</parameters>
</function>
<function name="headers_parse_status_line"
c:identifier="soup_headers_parse_status_line">
<doc xml:space="preserve">Parses the HTTP Status-Line string in @status_line into @ver,
@status_code, and @reason_phrase. @status_line must be terminated by
either "\0" or "\r\n".</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @status_line was parsed successfully.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="status_line" transfer-ownership="none">
<doc xml:space="preserve">an HTTP Status-Line</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="ver"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">if non-%NULL, will be filled in with the HTTP
version</doc>
<type name="HTTPVersion" c:type="SoupHTTPVersion*"/>
</parameter>
<parameter name="status_code"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">if non-%NULL, will be filled in with
the status code</doc>
<type name="guint" c:type="guint*"/>
</parameter>
<parameter name="reason_phrase"
direction="out"
caller-allocates="0"
transfer-ownership="full"
optional="1"
allow-none="1">
<doc xml:space="preserve">if non-%NULL, will be filled in with
the reason phrase</doc>
<type name="utf8" c:type="char**"/>
</parameter>
</parameters>
</function>
<function name="http_error_quark" c:identifier="soup_http_error_quark">
<return-value transfer-ownership="none">
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
<function name="message_headers_iter_init"
c:identifier="soup_message_headers_iter_init"
moved-to="MessageHeadersIter.init">
<doc xml:space="preserve">Initializes @iter for iterating @hdrs.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="iter"
direction="out"
caller-allocates="1"
transfer-ownership="none">
<doc xml:space="preserve">a pointer to a %SoupMessageHeadersIter
structure</doc>
<type name="MessageHeadersIter" c:type="SoupMessageHeadersIter*"/>
</parameter>
<parameter name="hdrs" transfer-ownership="none">
<doc xml:space="preserve">a %SoupMessageHeaders</doc>
<type name="MessageHeaders" c:type="SoupMessageHeaders*"/>
</parameter>
</parameters>
</function>
<function name="request_error_quark"
c:identifier="soup_request_error_quark"
moved-to="RequestError.quark">
<return-value transfer-ownership="none">
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
<function name="requester_error_quark"
c:identifier="soup_requester_error_quark"
moved-to="RequesterError.quark">
<return-value transfer-ownership="none">
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
<function name="status_get_phrase"
c:identifier="soup_status_get_phrase"
moved-to="Status.get_phrase">
<doc xml:space="preserve">Looks up the stock HTTP description of @status_code. This is used
by soup_message_set_status() to get the correct text to go with a
given status code.
<emphasis>There is no reason for you to ever use this
function.</emphasis> If you wanted the textual description for the
#SoupMessage:status_code of a given #SoupMessage, you should just
look at the message's #SoupMessage:reason_phrase. However, you
should only do that for use in debugging messages; HTTP reason
phrases are not localized, and are not generally very descriptive
anyway, and so they should never be presented to the user directly.
Instead, you should create you own error messages based on the
status code, and on what you were trying to do.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the (terse, English) description of @status_code</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<parameter name="status_code" transfer-ownership="none">
<doc xml:space="preserve">an HTTP status code</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</function>
<function name="status_proxify"
c:identifier="soup_status_proxify"
moved-to="Status.proxify"
version="2.26">
<doc xml:space="preserve">Turns %SOUP_STATUS_CANT_RESOLVE into
%SOUP_STATUS_CANT_RESOLVE_PROXY and %SOUP_STATUS_CANT_CONNECT into
%SOUP_STATUS_CANT_CONNECT_PROXY. Other status codes are passed
through unchanged.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the "proxified" equivalent of @status_code.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<parameter name="status_code" transfer-ownership="none">
<doc xml:space="preserve">a status code</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</function>
<function name="str_case_equal" c:identifier="soup_str_case_equal">
<doc xml:space="preserve">Compares @v1 and @v2 in a case-insensitive manner</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if they are equal (modulo case)</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="v1" transfer-ownership="none">
<doc xml:space="preserve">an ASCII string</doc>
<type name="gpointer" c:type="gconstpointer"/>
</parameter>
<parameter name="v2" transfer-ownership="none">
<doc xml:space="preserve">another ASCII string</doc>
<type name="gpointer" c:type="gconstpointer"/>
</parameter>
</parameters>
</function>
<function name="str_case_hash" c:identifier="soup_str_case_hash">
<doc xml:space="preserve">Hashes @key in a case-insensitive manner.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the hash code.</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<parameter name="key" transfer-ownership="none">
<doc xml:space="preserve">ASCII string to hash</doc>
<type name="gpointer" c:type="gconstpointer"/>
</parameter>
</parameters>
</function>
<function name="tld_domain_is_public_suffix"
c:identifier="soup_tld_domain_is_public_suffix"
version="2.40">
<doc xml:space="preserve">Looks whether the @domain passed as argument is a public domain
suffix (.org, .com, .co.uk, etc) or not.
Prior to libsoup 2.46, this function required that @domain be in
UTF-8 if it was an IDN. From 2.46 on, the name can be in either
UTF-8 or ASCII format (and the return value will be in the same
format).</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if it is a public domain, %FALSE otherwise.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="domain" transfer-ownership="none">
<doc xml:space="preserve">a domain name</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</function>
<function name="tld_error_quark"
c:identifier="soup_tld_error_quark"
moved-to="TLDError.quark">
<return-value transfer-ownership="none">
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
<function name="tld_get_base_domain"
c:identifier="soup_tld_get_base_domain"
version="2.40"
throws="1">
<doc xml:space="preserve">Finds the base domain for a given @hostname. The base domain is
composed by the top level domain (such as .org, .com, .co.uk, etc)
plus the second level domain, for example for myhost.mydomain.com
it will return mydomain.com.
Note that %NULL will be returned for private URLs (those not ending
with any well known TLD) because choosing a base domain for them
would be totally arbitrary.
Prior to libsoup 2.46, this function required that @hostname be in
UTF-8 if it was an IDN. From 2.46 on, the name can be in either
UTF-8 or ASCII format (and the return value will be in the same
format).</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a pointer to the start of the base domain in @hostname. If
an error occurs, %NULL will be returned and @error set.</doc>
<type name="utf8" c:type="const char*"/>
</return-value>
<parameters>
<parameter name="hostname" transfer-ownership="none">
<doc xml:space="preserve">a hostname</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</function>
<function name="uri_decode"
c:identifier="soup_uri_decode"
moved-to="URI.decode">
<doc xml:space="preserve">Fully %<!-- -->-decodes @part.
In the past, this would return %NULL if @part contained invalid
percent-encoding, but now it just ignores the problem (as
soup_uri_new() already did).</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the decoded URI part.</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<parameter name="part" transfer-ownership="none">
<doc xml:space="preserve">a URI part</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</function>
<function name="uri_encode"
c:identifier="soup_uri_encode"
moved-to="URI.encode">
<doc xml:space="preserve">This %<!-- -->-encodes the given URI part and returns the escaped
version in allocated memory, which the caller must free when it is
done.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the encoded URI part</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<parameter name="part" transfer-ownership="none">
<doc xml:space="preserve">a URI part</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="escape_extra"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">additional reserved characters to
escape (or %NULL)</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</function>
<function name="uri_normalize"
c:identifier="soup_uri_normalize"
moved-to="URI.normalize">
<doc xml:space="preserve">%<!-- -->-decodes any "unreserved" characters (or characters in
@unescape_extra) in @part.
"Unreserved" characters are those that are not allowed to be used
for punctuation according to the URI spec. For example, letters are
unreserved, so soup_uri_normalize() will turn
<literal>http://example.com/foo/b%<!-- -->61r</literal> into
<literal>http://example.com/foo/bar</literal>, which is guaranteed
to mean the same thing. However, "/" is "reserved", so
<literal>http://example.com/foo%<!-- -->2Fbar</literal> would not
be changed, because it might mean something different to the
server.
In the past, this would return %NULL if @part contained invalid
percent-encoding, but now it just ignores the problem (as
soup_uri_new() already did).</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the normalized URI part</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<parameter name="part" transfer-ownership="none">
<doc xml:space="preserve">a URI part</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="unescape_extra"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">reserved characters to unescape (or %NULL)</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</function>
<function name="value_array_append"
c:identifier="soup_value_array_append"
introspectable="0"
deprecated="1">
<doc xml:space="preserve">Appends the provided value of type @type to @array as with
g_value_array_append(). (The provided data is copied rather than
being inserted directly.)</doc>
<doc-deprecated xml:space="preserve">Use #GVariant API instead.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="array" transfer-ownership="none">
<doc xml:space="preserve">a #GValueArray</doc>
<type name="GObject.ValueArray" c:type="GValueArray*"/>
</parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">a #GType</doc>
<type name="GType" c:type="GType"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">a value of type @type</doc>
<varargs/>
</parameter>
</parameters>
</function>
<function name="value_array_append_vals"
c:identifier="soup_value_array_append_vals"
introspectable="0"
deprecated="1">
<doc xml:space="preserve">Appends the provided values into @array as with
g_value_array_append(). (The provided data is copied rather than
being inserted directly.)</doc>
<doc-deprecated xml:space="preserve">Use #GVariant API instead.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="array" transfer-ownership="none">
<doc xml:space="preserve">a #GValueArray</doc>
<type name="GObject.ValueArray" c:type="GValueArray*"/>
</parameter>
<parameter name="first_type" transfer-ownership="none">
<doc xml:space="preserve">the type of the first value to add</doc>
<type name="GType" c:type="GType"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">the first value to add, followed by other type/value
pairs, terminated by %G_TYPE_INVALID</doc>
<varargs/>
</parameter>
</parameters>
</function>
<function name="value_array_from_args"
c:identifier="soup_value_array_from_args"
introspectable="0"
deprecated="1">
<doc xml:space="preserve">Creates a #GValueArray from the provided arguments, which must
consist of pairs of a #GType and a value of that type, terminated
by %G_TYPE_INVALID. (The array will contain copies of the provided
data rather than pointing to the passed-in data directly.)</doc>
<doc-deprecated xml:space="preserve">Use #GVariant API instead.</doc-deprecated>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">a new #GValueArray, or %NULL if an error
occurred.</doc>
<type name="GObject.ValueArray" c:type="GValueArray*"/>
</return-value>
<parameters>
<parameter name="args" transfer-ownership="none">
<doc xml:space="preserve">arguments to create a #GValueArray from</doc>
<type name="va_list" c:type="va_list"/>
</parameter>
</parameters>
</function>
<function name="value_array_get_nth"
c:identifier="soup_value_array_get_nth"
introspectable="0"
deprecated="1">
<doc xml:space="preserve">Gets the @index_ element of @array and stores its value into the
provided location.</doc>
<doc-deprecated xml:space="preserve">Use #GVariant API instead.</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @array contained a value with index @index_
and type @type, %FALSE if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="array" transfer-ownership="none">
<doc xml:space="preserve">a #GValueArray</doc>
<type name="GObject.ValueArray" c:type="GValueArray*"/>
</parameter>
<parameter name="index_" transfer-ownership="none">
<doc xml:space="preserve">the index to look up</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">a #GType</doc>
<type name="GType" c:type="GType"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">a value of type pointer-to-@type</doc>
<varargs/>
</parameter>
</parameters>
</function>
<function name="value_array_insert"
c:identifier="soup_value_array_insert"
introspectable="0"
deprecated="1">
<doc xml:space="preserve">Inserts the provided value of type @type into @array as with
g_value_array_insert(). (The provided data is copied rather than
being inserted directly.)</doc>
<doc-deprecated xml:space="preserve">Use #GVariant API instead.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="array" transfer-ownership="none">
<doc xml:space="preserve">a #GValueArray</doc>
<type name="GObject.ValueArray" c:type="GValueArray*"/>
</parameter>
<parameter name="index_" transfer-ownership="none">
<doc xml:space="preserve">the index to insert at</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">a #GType</doc>
<type name="GType" c:type="GType"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">a value of type @type</doc>
<varargs/>
</parameter>
</parameters>
</function>
<function name="value_array_new"
c:identifier="soup_value_array_new"
deprecated="1">
<doc xml:space="preserve">Creates a new %GValueArray. (This is just a wrapper around
g_value_array_new(), for naming consistency purposes.)</doc>
<doc-deprecated xml:space="preserve">Use #GVariant API instead.</doc-deprecated>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new %GValueArray</doc>
<type name="GObject.ValueArray" c:type="GValueArray*"/>
</return-value>
</function>
<function name="value_array_new_with_vals"
c:identifier="soup_value_array_new_with_vals"
introspectable="0"
deprecated="1">
<doc xml:space="preserve">Creates a new %GValueArray and copies the provided values
into it.</doc>
<doc-deprecated xml:space="preserve">Use #GVariant API instead.</doc-deprecated>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new %GValueArray</doc>
<type name="GObject.ValueArray" c:type="GValueArray*"/>
</return-value>
<parameters>
<parameter name="first_type" transfer-ownership="none">
<doc xml:space="preserve">the type of the first value to add</doc>
<type name="GType" c:type="GType"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">the first value to add, followed by other type/value
pairs, terminated by %G_TYPE_INVALID</doc>
<varargs/>
</parameter>
</parameters>
</function>
<function name="value_array_to_args"
c:identifier="soup_value_array_to_args"
introspectable="0"
deprecated="1">
<doc xml:space="preserve">Extracts a #GValueArray into the provided arguments, which must
consist of pairs of a #GType and a value of pointer-to-that-type,
terminated by %G_TYPE_INVALID. The returned values will point to the
same memory as the values in the array.</doc>
<doc-deprecated xml:space="preserve">Use #GVariant API instead.</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">success or failure</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="array" transfer-ownership="none">
<doc xml:space="preserve">a #GValueArray</doc>
<type name="GObject.ValueArray" c:type="GValueArray*"/>
</parameter>
<parameter name="args" transfer-ownership="none">
<doc xml:space="preserve">arguments to extract @array into</doc>
<type name="va_list" c:type="va_list"/>
</parameter>
</parameters>
</function>
<function name="value_hash_insert"
c:identifier="soup_value_hash_insert"
introspectable="0"
deprecated="1">
<doc xml:space="preserve">Inserts the provided value of type @type into @hash. (Unlike with
g_hash_table_insert(), both the key and the value are copied).</doc>
<doc-deprecated xml:space="preserve">Use #GVariant API instead.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="hash" transfer-ownership="none">
<doc xml:space="preserve">a value hash</doc>
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="utf8"/>
<type name="GObject.Value"/>
</type>
</parameter>
<parameter name="key" transfer-ownership="none">
<doc xml:space="preserve">the key</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">a #GType</doc>
<type name="GType" c:type="GType"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">a value of type @type</doc>
<varargs/>
</parameter>
</parameters>
</function>
<function name="value_hash_insert_vals"
c:identifier="soup_value_hash_insert_vals"
introspectable="0"
deprecated="1">
<doc xml:space="preserve">Inserts the given data into @hash. As with
soup_value_hash_insert(), the keys and values are copied rather
than being inserted directly.</doc>
<doc-deprecated xml:space="preserve">Use #GVariant API instead.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="hash" transfer-ownership="none">
<doc xml:space="preserve">a value hash</doc>
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="utf8"/>
<type name="GObject.Value"/>
</type>
</parameter>
<parameter name="first_key" transfer-ownership="none">
<doc xml:space="preserve">the key for the first value</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">the type of @first_key, followed by the value, followed
by additional key/type/value triplets, terminated by %NULL</doc>
<varargs/>
</parameter>
</parameters>
</function>
<function name="value_hash_insert_value"
c:identifier="soup_value_hash_insert_value"
deprecated="1">
<doc xml:space="preserve">Inserts @value into @hash. (Unlike with g_hash_table_insert(), both
the key and the value are copied).</doc>
<doc-deprecated xml:space="preserve">Use #GVariant API instead.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="hash" transfer-ownership="none">
<doc xml:space="preserve">a value hash</doc>
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="utf8"/>
<type name="GObject.Value"/>
</type>
</parameter>
<parameter name="key" transfer-ownership="none">
<doc xml:space="preserve">the key</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">a value</doc>
<type name="GObject.Value" c:type="GValue*"/>
</parameter>
</parameters>
</function>
<function name="value_hash_lookup"
c:identifier="soup_value_hash_lookup"
introspectable="0"
deprecated="1">
<doc xml:space="preserve">Looks up @key in @hash and stores its value into the provided
location.</doc>
<doc-deprecated xml:space="preserve">Use #GVariant API instead.</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @hash contained a value with key @key and
type @type, %FALSE if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="hash" transfer-ownership="none">
<doc xml:space="preserve">a value hash</doc>
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="utf8"/>
<type name="GObject.Value"/>
</type>
</parameter>
<parameter name="key" transfer-ownership="none">
<doc xml:space="preserve">the key to look up</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">a #GType</doc>
<type name="GType" c:type="GType"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">a value of type pointer-to-@type</doc>
<varargs/>
</parameter>
</parameters>
</function>
<function name="value_hash_lookup_vals"
c:identifier="soup_value_hash_lookup_vals"
introspectable="0"
deprecated="1">
<doc xml:space="preserve">Looks up a number of keys in @hash and returns their values.</doc>
<doc-deprecated xml:space="preserve">Use #GVariant API instead.</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if all of the keys were found, %FALSE
if any were missing; note that you will generally need to
initialize each destination variable to a reasonable default
value, since there is no way to tell which keys were found
and which were not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="hash" transfer-ownership="none">
<doc xml:space="preserve">a value hash</doc>
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="utf8"/>
<type name="GObject.Value"/>
</type>
</parameter>
<parameter name="first_key" transfer-ownership="none">
<doc xml:space="preserve">the first key to look up</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">the type of @first_key, a pointer to that type, and
then additional key/type/pointer triplets, terminated
by %NULL.</doc>
<varargs/>
</parameter>
</parameters>
</function>
<function name="value_hash_new"
c:identifier="soup_value_hash_new"
deprecated="1">
<doc xml:space="preserve">Creates a #GHashTable whose keys are strings and whose values
are #GValue.</doc>
<doc-deprecated xml:space="preserve">Use #GVariant API instead.</doc-deprecated>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new
empty #GHashTable</doc>
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="utf8"/>
<type name="GObject.Value"/>
</type>
</return-value>
</function>
<function name="value_hash_new_with_vals"
c:identifier="soup_value_hash_new_with_vals"
introspectable="0"
deprecated="1">
<doc xml:space="preserve">Creates a #GHashTable whose keys are strings and whose values
are #GValue, and initializes it with the provided data. As
with soup_value_hash_insert(), the keys and values are copied
rather than being inserted directly.</doc>
<doc-deprecated xml:space="preserve">Use #GVariant API instead.</doc-deprecated>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new
#GHashTable, initialized with the given values</doc>
<type name="GLib.HashTable" c:type="GHashTable*">
<type name="utf8"/>
<type name="GObject.Value"/>
</type>
</return-value>
<parameters>
<parameter name="first_key" transfer-ownership="none">
<doc xml:space="preserve">the key for the first value</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">the type of @first_key, followed by the value, followed
by additional key/type/value triplets, terminated by %NULL</doc>
<varargs/>
</parameter>
</parameters>
</function>
<function name="websocket_client_prepare_handshake"
c:identifier="soup_websocket_client_prepare_handshake"
version="2.50">
<doc xml:space="preserve">Adds the necessary headers to @msg to request a WebSocket
handshake. The message body and non-WebSocket-related headers are
not modified.
This is a low-level function; if you use
soup_session_websocket_connect_async() to create a WebSocket
connection, it will call this for you.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">a #SoupMessage</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="origin"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">the "Origin" header to set</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="protocols"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">list of
protocols to offer</doc>
<array c:type="char**">
<type name="utf8" c:type="char*"/>
</array>
</parameter>
</parameters>
</function>
<function name="websocket_client_verify_handshake"
c:identifier="soup_websocket_client_verify_handshake"
version="2.50"
throws="1">
<doc xml:space="preserve">Looks at the response status code and headers in @msg and
determines if they contain a valid WebSocket handshake response
(given the handshake request in @msg's request headers).
This is a low-level function; if you use
soup_session_websocket_connect_async() to create a WebSocket
connection, it will call this for you.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @msg contains a completed valid WebSocket
handshake, %FALSE and an error if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">#SoupMessage containing both client and server sides of a
WebSocket handshake</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
</parameters>
</function>
<function name="websocket_error_get_quark"
c:identifier="soup_websocket_error_get_quark"
moved-to="WebsocketError.get_quark">
<return-value transfer-ownership="none">
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
<function name="websocket_server_check_handshake"
c:identifier="soup_websocket_server_check_handshake"
version="2.50"
throws="1">
<doc xml:space="preserve">Examines the method and request headers in @msg and determines
whether @msg contains a valid handshake request.
If @origin is non-%NULL, then only requests containing a matching
"Origin" header will be accepted. If @protocols is non-%NULL, then
only requests containing a compatible "Sec-WebSocket-Protocols"
header will be accepted.
Normally soup_websocket_server_process_handshake() will take care
of this for you, and if you use soup_server_add_websocket_handler()
to handle accepting WebSocket connections, it will call that for
you. However, this function may be useful if you need to perform
more complicated validation; eg, accepting multiple different Origins,
or handling different protocols depending on the path.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @msg contained a valid WebSocket handshake,
%FALSE and an error if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">#SoupMessage containing the client side of a WebSocket handshake</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="origin"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">expected Origin header</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="protocols"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">allowed WebSocket
protocols.</doc>
<array c:type="char**">
<type name="utf8" c:type="char*"/>
</array>
</parameter>
</parameters>
</function>
<function name="websocket_server_process_handshake"
c:identifier="soup_websocket_server_process_handshake"
version="2.50">
<doc xml:space="preserve">Examines the method and request headers in @msg and (assuming @msg
contains a valid handshake request), fills in the handshake
response.
If @expected_origin is non-%NULL, then only requests containing a matching
"Origin" header will be accepted. If @protocols is non-%NULL, then
only requests containing a compatible "Sec-WebSocket-Protocols"
header will be accepted.
This is a low-level function; if you use
soup_server_add_websocket_handler() to handle accepting WebSocket
connections, it will call this for you.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @msg contained a valid WebSocket handshake
request and was updated to contain a handshake response. %FALSE if not.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">#SoupMessage containing the client side of a WebSocket handshake</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="expected_origin"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">expected Origin header</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="protocols"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">allowed WebSocket
protocols.</doc>
<array c:type="char**">
<type name="utf8" c:type="char*"/>
</array>
</parameter>
</parameters>
</function>
<function name="xmlrpc_build_fault"
c:identifier="soup_xmlrpc_build_fault"
introspectable="0">
<doc xml:space="preserve">This creates an XML-RPC fault response and returns it as a string.
(To create a successful response, use
soup_xmlrpc_build_method_response().)</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the text of the fault</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<parameter name="fault_code" transfer-ownership="none">
<doc xml:space="preserve">the fault code</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="fault_format" transfer-ownership="none">
<doc xml:space="preserve">a printf()-style format string</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">the parameters to @fault_format</doc>
<varargs/>
</parameter>
</parameters>
</function>
<function name="xmlrpc_build_method_call"
c:identifier="soup_xmlrpc_build_method_call"
deprecated="1">
<doc xml:space="preserve">This creates an XML-RPC methodCall and returns it as a string.
This is the low-level method that soup_xmlrpc_request_new() is
built on.
@params is an array of #GValue representing the parameters to
@method. (It is *not* a #GValueArray, although if you have a
#GValueArray, you can just pass its <literal>values</literal>f and
<literal>n_values</literal> fields.)
The correspondence between glib types and XML-RPC types is:
int: #int (%G_TYPE_INT)
boolean: #gboolean (%G_TYPE_BOOLEAN)
string: #char* (%G_TYPE_STRING)
double: #double (%G_TYPE_DOUBLE)
datetime.iso8601: #SoupDate (%SOUP_TYPE_DATE)
base64: #GByteArray (%SOUP_TYPE_BYTE_ARRAY)
struct: #GHashTable (%G_TYPE_HASH_TABLE)
array: #GValueArray (%G_TYPE_VALUE_ARRAY)
For structs, use a #GHashTable that maps strings to #GValue;
soup_value_hash_new() and related methods can help with this.</doc>
<doc-deprecated xml:space="preserve">Use soup_xmlrpc_build_request() instead.</doc-deprecated>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">the text of the methodCall, or %NULL on
error</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<parameter name="method_name" transfer-ownership="none">
<doc xml:space="preserve">the name of the XML-RPC method</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="params" transfer-ownership="none">
<doc xml:space="preserve">arguments to @method</doc>
<array length="2" zero-terminated="0" c:type="GValue*">
<type name="GObject.Value" c:type="GValue"/>
</array>
</parameter>
<parameter name="n_params" transfer-ownership="none">
<doc xml:space="preserve">length of @params</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</function>
<function name="xmlrpc_build_method_response"
c:identifier="soup_xmlrpc_build_method_response"
deprecated="1">
<doc xml:space="preserve">This creates a (successful) XML-RPC methodResponse and returns it
as a string. To create a fault response, use
soup_xmlrpc_build_fault().
The glib type to XML-RPC type mapping is as with
soup_xmlrpc_build_method_call(), qv.</doc>
<doc-deprecated xml:space="preserve">Use soup_xmlrpc_build_response() instead.</doc-deprecated>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">the text of the methodResponse, or %NULL
on error</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">the return value</doc>
<type name="GObject.Value" c:type="GValue*"/>
</parameter>
</parameters>
</function>
<function name="xmlrpc_build_request"
c:identifier="soup_xmlrpc_build_request"
version="2.52"
throws="1">
<doc xml:space="preserve">This creates an XML-RPC methodCall and returns it as a string.
This is the low-level method that soup_xmlrpc_message_new() is
built on.
@params is a #GVariant tuple representing the method parameters.
Serialization details:
- "a{s*}" and "{s*}" are serialized as &lt;struct&gt;
- "ay" is serialized as &lt;base64&gt;
- Other arrays and tuples are serialized as &lt;array&gt;
- booleans are serialized as &lt;boolean&gt;
- byte, int16, uint16 and int32 are serialized as &lt;int&gt;
- uint32 and int64 are serialized as the nonstandard &lt;i8&gt; type
- doubles are serialized as &lt;double&gt;
- Strings are serialized as &lt;string&gt;
- Variants (i.e. "v" type) are unwrapped and their child is serialized.
- #GVariants created by soup_xmlrpc_variant_new_datetime() are serialized as
&lt;dateTime.iso8601&gt;
- Other types are not supported and will return %NULL and set @error.
This notably includes: object-paths, signatures, uint64, handles, maybes
and dictionaries with non-string keys.
If @params is floating, it is consumed.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the text of the methodCall, or %NULL on error.</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<parameter name="method_name" transfer-ownership="none">
<doc xml:space="preserve">the name of the XML-RPC method</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="params" transfer-ownership="none">
<doc xml:space="preserve">a #GVariant tuple</doc>
<type name="GLib.Variant" c:type="GVariant*"/>
</parameter>
</parameters>
</function>
<function name="xmlrpc_build_response"
c:identifier="soup_xmlrpc_build_response"
version="2.52"
throws="1">
<doc xml:space="preserve">This creates a (successful) XML-RPC methodResponse and returns it
as a string. To create a fault response, use soup_xmlrpc_build_fault(). This
is the low-level method that soup_xmlrpc_message_set_response() is built on.
See soup_xmlrpc_build_request() for serialization details, but note
that since a method can only have a single return value, @value
should not be a tuple here (unless the return value is an array).
If @value is floating, it is consumed.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the text of the methodResponse, or %NULL on error.</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">the return value</doc>
<type name="GLib.Variant" c:type="GVariant*"/>
</parameter>
</parameters>
</function>
<function name="xmlrpc_error_quark"
c:identifier="soup_xmlrpc_error_quark"
moved-to="XMLRPCError.quark">
<return-value transfer-ownership="none">
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
<function name="xmlrpc_extract_method_call"
c:identifier="soup_xmlrpc_extract_method_call"
introspectable="0"
deprecated="1">
<doc xml:space="preserve">Parses @method_call to get the name and parameters, and puts
the parameters into variables of the appropriate types.
The parameters are handled similarly to
@soup_xmlrpc_build_method_call, with pairs of types and values,
terminated by %G_TYPE_INVALID, except that values are pointers to
variables of the indicated type, rather than values of the type.
See also soup_xmlrpc_parse_method_call(), which can be used if
you don't know the types of the parameters.</doc>
<doc-deprecated xml:space="preserve">Use soup_xmlrpc_parse_request_full() instead.</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">success or failure.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="method_call" transfer-ownership="none">
<doc xml:space="preserve">the XML-RPC methodCall string</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="length" transfer-ownership="none">
<doc xml:space="preserve">the length of @method_call, or -1 if it is NUL-terminated</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="method_name"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">on return, the methodName from @method_call</doc>
<type name="utf8" c:type="char**"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">return types and locations for parameters</doc>
<varargs/>
</parameter>
</parameters>
</function>
<function name="xmlrpc_extract_method_response"
c:identifier="soup_xmlrpc_extract_method_response"
introspectable="0"
deprecated="1">
<doc xml:space="preserve">Parses @method_response and extracts the return value into
a variable of the correct type.
If @method_response is a fault, the return value will be unset,
and @error will be set to an error of type %SOUP_XMLRPC_FAULT, with
the error #code containing the fault code, and the error #message
containing the fault string. (If @method_response cannot be parsed
at all, soup_xmlrpc_extract_method_response() will return %FALSE,
but @error will be unset.)</doc>
<doc-deprecated xml:space="preserve">Use soup_xmlrpc_parse_response() instead.</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if a return value was parsed, %FALSE if the
response was of the wrong type, or contained a fault.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="method_response" transfer-ownership="none">
<doc xml:space="preserve">the XML-RPC methodResponse string</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="length" transfer-ownership="none">
<doc xml:space="preserve">the length of @method_response, or -1 if it is NUL-terminated</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="error" transfer-ownership="none">
<doc xml:space="preserve">error return value</doc>
<type name="GLib.Error" c:type="GError**"/>
</parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">the expected type of the return value</doc>
<type name="GType" c:type="GType"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">location for return value</doc>
<varargs/>
</parameter>
</parameters>
</function>
<function name="xmlrpc_fault_quark"
c:identifier="soup_xmlrpc_fault_quark"
moved-to="XMLRPCFault.quark">
<return-value transfer-ownership="none">
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
<function name="xmlrpc_message_new"
c:identifier="soup_xmlrpc_message_new"
version="2.52"
throws="1">
<doc xml:space="preserve">Creates an XML-RPC methodCall and returns a #SoupMessage, ready
to send, for that method call.
See soup_xmlrpc_build_request() for serialization details.
If @params is floating, it is consumed.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #SoupMessage encoding the
indicated XML-RPC request, or %NULL on error.</doc>
<type name="Message" c:type="SoupMessage*"/>
</return-value>
<parameters>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">URI of the XML-RPC service</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="method_name" transfer-ownership="none">
<doc xml:space="preserve">the name of the XML-RPC method to invoke at @uri</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="params" transfer-ownership="none">
<doc xml:space="preserve">a #GVariant tuple</doc>
<type name="GLib.Variant" c:type="GVariant*"/>
</parameter>
</parameters>
</function>
<function name="xmlrpc_message_set_fault"
c:identifier="soup_xmlrpc_message_set_fault"
version="2.52"
introspectable="0">
<doc xml:space="preserve">Sets the status code and response body of @msg to indicate an
unsuccessful XML-RPC call, with the error described by @fault_code
and @fault_format.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">an XML-RPC request</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="fault_code" transfer-ownership="none">
<doc xml:space="preserve">the fault code</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="fault_format" transfer-ownership="none">
<doc xml:space="preserve">a printf()-style format string</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">the parameters to @fault_format</doc>
<varargs/>
</parameter>
</parameters>
</function>
<function name="xmlrpc_message_set_response"
c:identifier="soup_xmlrpc_message_set_response"
version="2.52"
throws="1">
<doc xml:space="preserve">Sets the status code and response body of @msg to indicate a
successful XML-RPC call, with a return value given by @value. To set a
fault response, use soup_xmlrpc_message_set_fault().
See soup_xmlrpc_build_request() for serialization details.
If @value is floating, it is consumed.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE on success, %FALSE otherwise.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">an XML-RPC request</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">a #GVariant</doc>
<type name="GLib.Variant" c:type="GVariant*"/>
</parameter>
</parameters>
</function>
<function name="xmlrpc_parse_method_call"
c:identifier="soup_xmlrpc_parse_method_call"
deprecated="1">
<doc xml:space="preserve">Parses @method_call to get the name and parameters, and returns the
parameter values in a #GValueArray; see also
soup_xmlrpc_extract_method_call(), which is more convenient if you
know in advance what the types of the parameters will be.</doc>
<doc-deprecated xml:space="preserve">Use soup_xmlrpc_parse_request_full() instead.</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">success or failure.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="method_call" transfer-ownership="none">
<doc xml:space="preserve">the XML-RPC methodCall string</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="length" transfer-ownership="none">
<doc xml:space="preserve">the length of @method_call, or -1 if it is NUL-terminated</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="method_name"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">on return, the methodName from @method_call</doc>
<type name="utf8" c:type="char**"/>
</parameter>
<parameter name="params"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">on return, the parameters from @method_call</doc>
<type name="GObject.ValueArray" c:type="GValueArray**"/>
</parameter>
</parameters>
</function>
<function name="xmlrpc_parse_method_response"
c:identifier="soup_xmlrpc_parse_method_response"
deprecated="1"
throws="1">
<doc xml:space="preserve">Parses @method_response and returns the return value in @value. If
@method_response is a fault, @value will be unchanged, and @error
will be set to an error of type %SOUP_XMLRPC_FAULT, with the error
#code containing the fault code, and the error #message containing
the fault string. (If @method_response cannot be parsed at all,
soup_xmlrpc_parse_method_response() will return %FALSE, but @error
will be unset.)</doc>
<doc-deprecated xml:space="preserve">Use soup_xmlrpc_parse_response() instead.</doc-deprecated>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if a return value was parsed, %FALSE if the
response could not be parsed, or contained a fault.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="method_response" transfer-ownership="none">
<doc xml:space="preserve">the XML-RPC methodResponse string</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="length" transfer-ownership="none">
<doc xml:space="preserve">the length of @method_response, or -1 if it is NUL-terminated</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="value"
direction="out"
caller-allocates="1"
transfer-ownership="none">
<doc xml:space="preserve">on return, the return value from @method_call</doc>
<type name="GObject.Value" c:type="GValue*"/>
</parameter>
</parameters>
</function>
<function name="xmlrpc_parse_request"
c:identifier="soup_xmlrpc_parse_request"
version="2.52"
throws="1">
<doc xml:space="preserve">Parses @method_call and return the method name. Method parameters can be
parsed later using soup_xmlrpc_params_parse().</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">method's name, or %NULL on error.</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<parameter name="method_call" transfer-ownership="none">
<doc xml:space="preserve">the XML-RPC methodCall string</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="length" transfer-ownership="none">
<doc xml:space="preserve">the length of @method_call, or -1 if it is NUL-terminated</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="params"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">on success, a new #SoupXMLRPCParams</doc>
<type name="XMLRPCParams" c:type="SoupXMLRPCParams**"/>
</parameter>
</parameters>
</function>
<function name="xmlrpc_parse_response"
c:identifier="soup_xmlrpc_parse_response"
version="2.52"
throws="1">
<doc xml:space="preserve">Parses @method_response and returns the return value. If
@method_response is a fault, %NULL is returned, and @error
will be set to an error in the %SOUP_XMLRPC_FAULT domain, with the error
code containing the fault code, and the error message containing
the fault string. If @method_response cannot be parsed, %NULL is returned,
and @error will be set to an error in the %SOUP_XMLRPC_ERROR domain.
See soup_xmlrpc_params_parse() for deserialization details.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new (non-floating) #GVariant, or %NULL</doc>
<type name="GLib.Variant" c:type="GVariant*"/>
</return-value>
<parameters>
<parameter name="method_response" transfer-ownership="none">
<doc xml:space="preserve">the XML-RPC methodResponse string</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="length" transfer-ownership="none">
<doc xml:space="preserve">the length of @method_response, or -1 if it is NUL-terminated</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="signature"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A valid #GVariant type string, or %NULL</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</function>
<function name="xmlrpc_request_new"
c:identifier="soup_xmlrpc_request_new"
introspectable="0"
deprecated="1">
<doc xml:space="preserve">Creates an XML-RPC methodCall and returns a #SoupMessage, ready
to send, for that method call.
The parameters are passed as type/value pairs; ie, first a #GType,
and then a value of the appropriate type, finally terminated by
%G_TYPE_INVALID.</doc>
<doc-deprecated xml:space="preserve">Use soup_xmlrpc_message_new() instead.</doc-deprecated>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #SoupMessage encoding the
indicated XML-RPC request.</doc>
<type name="Message" c:type="SoupMessage*"/>
</return-value>
<parameters>
<parameter name="uri" transfer-ownership="none">
<doc xml:space="preserve">URI of the XML-RPC service</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="method_name" transfer-ownership="none">
<doc xml:space="preserve">the name of the XML-RPC method to invoke at @uri</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">parameters for @method</doc>
<varargs/>
</parameter>
</parameters>
</function>
<function name="xmlrpc_set_fault"
c:identifier="soup_xmlrpc_set_fault"
introspectable="0"
deprecated="1">
<doc xml:space="preserve">Sets the status code and response body of @msg to indicate an
unsuccessful XML-RPC call, with the error described by @fault_code
and @fault_format.</doc>
<doc-deprecated xml:space="preserve">Use soup_xmlrpc_message_set_fault() instead.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">an XML-RPC request</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="fault_code" transfer-ownership="none">
<doc xml:space="preserve">the fault code</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="fault_format" transfer-ownership="none">
<doc xml:space="preserve">a printf()-style format string</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">the parameters to @fault_format</doc>
<varargs/>
</parameter>
</parameters>
</function>
<function name="xmlrpc_set_response"
c:identifier="soup_xmlrpc_set_response"
introspectable="0"
deprecated="1">
<doc xml:space="preserve">Sets the status code and response body of @msg to indicate a
successful XML-RPC call, with a return value given by @type and the
following varargs argument, of the type indicated by @type.</doc>
<doc-deprecated xml:space="preserve">Use soup_xmlrpc_message_set_response() instead.</doc-deprecated>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="msg" transfer-ownership="none">
<doc xml:space="preserve">an XML-RPC request</doc>
<type name="Message" c:type="SoupMessage*"/>
</parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">the type of the response value</doc>
<type name="GType" c:type="GType"/>
</parameter>
<parameter name="..." transfer-ownership="none">
<doc xml:space="preserve">the response value</doc>
<varargs/>
</parameter>
</parameters>
</function>
<function name="xmlrpc_variant_get_datetime"
c:identifier="soup_xmlrpc_variant_get_datetime"
version="2.52"
throws="1">
<doc xml:space="preserve">Get the #SoupDate from special #GVariant created by
soup_xmlrpc_variant_new_datetime() or by parsing a &lt;dateTime.iso8601&gt;
node. See soup_xmlrpc_params_parse().
If @variant does not contain a datetime it will return an error but it is not
considered a programmer error because it generally means parameters received
are not in the expected type.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a new #SoupDate, or %NULL on error.</doc>
<type name="Date" c:type="SoupDate*"/>
</return-value>
<parameters>
<parameter name="variant" transfer-ownership="none">
<doc xml:space="preserve">a #GVariant</doc>
<type name="GLib.Variant" c:type="GVariant*"/>
</parameter>
</parameters>
</function>
<function name="xmlrpc_variant_new_datetime"
c:identifier="soup_xmlrpc_variant_new_datetime"
version="2.52">
<doc xml:space="preserve">Construct a special #GVariant used to serialize a &lt;dateTime.iso8601&gt;
node. See soup_xmlrpc_build_request().
The actual type of the returned #GVariant is unspecified and "v" or "*"
should be used in variant format strings. For example:
<informalexample><programlisting>
args = g_variant_new ("(v)", soup_xmlrpc_variant_new_datetime (date));
</programlisting></informalexample></doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a floating #GVariant.</doc>
<type name="GLib.Variant" c:type="GVariant*"/>
</return-value>
<parameters>
<parameter name="date" transfer-ownership="none">
<doc xml:space="preserve">a #SoupDate</doc>
<type name="Date" c:type="SoupDate*"/>
</parameter>
</parameters>
</function>
</namespace>
</repository>
|