/usr/share/gir-1.0/Nice-0.1.gir is in libnice-dev 0.1.14-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 | <?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="GObject" version="2.0"/>
<include name="Gio" version="2.0"/>
<package name="nice"/>
<namespace name="Nice"
version="0.1"
shared-library=""
c:identifier-prefixes="Nice"
c:symbol-prefixes="nice">
<constant name="AGENT_MAX_REMOTE_CANDIDATES"
value="25"
c:type="NICE_AGENT_MAX_REMOTE_CANDIDATES">
<doc xml:space="preserve">A hard limit for the number of remote candidates. This
limit is enforced to protect against malevolent remote
clients.</doc>
<type name="gint" c:type="gint"/>
</constant>
<record name="Address" c:type="NiceAddress">
<doc xml:space="preserve">The #NiceAddress structure that represents an IPv4 or IPv6 address.</doc>
<union name="s" c:type="s">
<field name="addr" writable="1">
<type name="gpointer" c:type="sockaddr"/>
</field>
<field name="ip4" writable="1">
<type name="gpointer" c:type="sockaddr_in"/>
</field>
<field name="ip6" writable="1">
<type name="gpointer" c:type="sockaddr_in6"/>
</field>
</union>
<method name="copy_to_sockaddr"
c:identifier="nice_address_copy_to_sockaddr">
<doc xml:space="preserve">Fills the sockaddr structure @sin with the address contained in @addr</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">The #NiceAddress to query</doc>
<type name="Address" c:type="const NiceAddress*"/>
</instance-parameter>
<parameter name="sin"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">The sockaddr to fill</doc>
<type name="gpointer" c:type="sockaddr*"/>
</parameter>
</parameters>
</method>
<method name="dup" c:identifier="nice_address_dup" introspectable="0">
<doc xml:space="preserve">Creates a new #NiceAddress with the same address as @addr</doc>
<return-value>
<doc xml:space="preserve">The new #NiceAddress</doc>
<type name="Address" c:type="NiceAddress*"/>
</return-value>
<parameters>
<instance-parameter name="addr" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAddress to dup</doc>
<type name="Address" c:type="const NiceAddress*"/>
</instance-parameter>
</parameters>
</method>
<method name="equal" c:identifier="nice_address_equal">
<doc xml:space="preserve">Compares two #NiceAddress structures to see if they contain the same address
and the same port.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @a and @b are the same address, %FALSE if they are different</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="a" transfer-ownership="none">
<doc xml:space="preserve">First #NiceAddress to compare</doc>
<type name="Address" c:type="const NiceAddress*"/>
</instance-parameter>
<parameter name="b" transfer-ownership="none">
<doc xml:space="preserve">Second #NiceAddress to compare</doc>
<type name="Address" c:type="const NiceAddress*"/>
</parameter>
</parameters>
</method>
<method name="equal_no_port"
c:identifier="nice_address_equal_no_port"
version="0.1.8">
<doc xml:space="preserve">Compares two #NiceAddress structures to see if they contain the same address,
ignoring the port.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @a and @b are the same address, %FALSE if they
are different</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="a" transfer-ownership="none">
<doc xml:space="preserve">First #NiceAddress to compare</doc>
<type name="Address" c:type="const NiceAddress*"/>
</instance-parameter>
<parameter name="b" transfer-ownership="none">
<doc xml:space="preserve">Second #NiceAddress to compare</doc>
<type name="Address" c:type="const NiceAddress*"/>
</parameter>
</parameters>
</method>
<method name="free" c:identifier="nice_address_free">
<doc xml:space="preserve">Frees a #NiceAddress created with nice_address_new() or nice_address_dup()</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">The #NiceAddress to free</doc>
<type name="Address" c:type="NiceAddress*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_port" c:identifier="nice_address_get_port">
<doc xml:space="preserve">Retreive the port of @addr</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The port of @addr</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="addr" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAddress to query</doc>
<type name="Address" c:type="const NiceAddress*"/>
</instance-parameter>
</parameters>
</method>
<method name="init" c:identifier="nice_address_init">
<doc xml:space="preserve">Initialize a #NiceAddress into an undefined address</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">The #NiceAddress to init</doc>
<type name="Address" c:type="NiceAddress*"/>
</instance-parameter>
</parameters>
</method>
<method name="ip_version" c:identifier="nice_address_ip_version">
<doc xml:space="preserve">Returns the IP version of the address</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">4 for IPv4, 6 for IPv6 and 0 for undefined address</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<instance-parameter name="addr" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAddress to query</doc>
<type name="Address" c:type="const NiceAddress*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_private" c:identifier="nice_address_is_private">
<doc xml:space="preserve">Verifies if the address in @addr is a private address or not</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @addr is a private address, %FALSE otherwise</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="addr" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAddress to query</doc>
<type name="Address" c:type="const NiceAddress*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_valid" c:identifier="nice_address_is_valid">
<doc xml:space="preserve">Validate whether the #NiceAddress @addr is a valid IPv4 or IPv6 address</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @addr is valid, %FALSE otherwise</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="addr" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAddress to query</doc>
<type name="Address" c:type="const NiceAddress*"/>
</instance-parameter>
</parameters>
</method>
<method name="set_from_sockaddr"
c:identifier="nice_address_set_from_sockaddr">
<doc xml:space="preserve">Sets an IPv4 or IPv6 address from the sockaddr structure @sin</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">The #NiceAddress to modify</doc>
<type name="Address" c:type="NiceAddress*"/>
</instance-parameter>
<parameter name="sin"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">The sockaddr to set</doc>
<type name="gpointer" c:type="const sockaddr*"/>
</parameter>
</parameters>
</method>
<method name="set_from_string"
c:identifier="nice_address_set_from_string">
<doc xml:space="preserve">Sets an IPv4 or IPv6 address from the string @str</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if success, %FALSE on error</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="addr" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAddress to modify</doc>
<type name="Address" c:type="NiceAddress*"/>
</instance-parameter>
<parameter name="str" transfer-ownership="none">
<doc xml:space="preserve">The string to set</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_ipv4" c:identifier="nice_address_set_ipv4">
<doc xml:space="preserve">Set @addr to an IPv4 address using the data from @addr_ipv4
<note>
<para>
This function will reset the port to 0, so make sure you call it before
nice_address_set_port()
</para>
</note></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">The #NiceAddress to modify</doc>
<type name="Address" c:type="NiceAddress*"/>
</instance-parameter>
<parameter name="addr_ipv4" transfer-ownership="none">
<doc xml:space="preserve">The IPv4 address</doc>
<type name="guint32" c:type="guint32"/>
</parameter>
</parameters>
</method>
<method name="set_ipv6" c:identifier="nice_address_set_ipv6">
<doc xml:space="preserve">Set @addr to an IPv6 address using the data from @addr_ipv6
<note>
<para>
This function will reset the port to 0, so make sure you call it before
nice_address_set_port()
</para>
</note></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">The #NiceAddress to modify</doc>
<type name="Address" c:type="NiceAddress*"/>
</instance-parameter>
<parameter name="addr_ipv6" transfer-ownership="none">
<doc xml:space="preserve">The IPv6 address</doc>
<type name="guint8" c:type="const guchar*"/>
</parameter>
</parameters>
</method>
<method name="set_port" c:identifier="nice_address_set_port">
<doc xml:space="preserve">Set the port of @addr to @port</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">The #NiceAddress to modify</doc>
<type name="Address" c:type="NiceAddress*"/>
</instance-parameter>
<parameter name="port" transfer-ownership="none">
<doc xml:space="preserve">The port to set</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="to_string" c:identifier="nice_address_to_string">
<doc xml:space="preserve">Transforms the address @addr into a human readable string</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">The #NiceAddress to query</doc>
<type name="Address" c:type="const NiceAddress*"/>
</instance-parameter>
<parameter name="dst" transfer-ownership="none">
<doc xml:space="preserve">The string to fill</doc>
<type name="utf8" c:type="gchar*"/>
</parameter>
</parameters>
</method>
<function name="new" c:identifier="nice_address_new" introspectable="0">
<doc xml:space="preserve">Create a new #NiceAddress with undefined address
You must free it with nice_address_free()</doc>
<return-value>
<doc xml:space="preserve">The new #NiceAddress</doc>
<type name="Address" c:type="NiceAddress*"/>
</return-value>
</function>
</record>
<class name="Agent"
c:symbol-prefix="agent"
c:type="NiceAgent"
parent="GObject.Object"
glib:type-name="NiceAgent"
glib:get-type="nice_agent_get_type"
glib:type-struct="AgentClass">
<doc xml:space="preserve">The #NiceAgent is the main GObject of the libnice library and represents
the ICE agent.</doc>
<constructor name="new" c:identifier="nice_agent_new">
<doc xml:space="preserve">Create a new #NiceAgent.
The returned object must be freed with g_object_unref()</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">The new agent GObject</doc>
<type name="Agent" c:type="NiceAgent*"/>
</return-value>
<parameters>
<parameter name="ctx" transfer-ownership="none">
<doc xml:space="preserve">The Glib Mainloop Context to use for timers</doc>
<type name="GLib.MainContext" c:type="GMainContext*"/>
</parameter>
<parameter name="compat" transfer-ownership="none">
<doc xml:space="preserve">The compatibility mode of the agent</doc>
<type name="Compatibility" c:type="NiceCompatibility"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_reliable"
c:identifier="nice_agent_new_reliable"
version="0.0.11">
<doc xml:space="preserve">Create a new #NiceAgent in reliable mode. If the connectivity is established
through ICE-UDP, then a #PseudoTcpSocket will be transparently used to
ensure reliability of the messages.
The returned object must be freed with g_object_unref()
<para> See also: #NiceAgent::reliable-transport-writable </para></doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">The new agent GObject</doc>
<type name="Agent" c:type="NiceAgent*"/>
</return-value>
<parameters>
<parameter name="ctx" transfer-ownership="none">
<doc xml:space="preserve">The Glib Mainloop Context to use for timers</doc>
<type name="GLib.MainContext" c:type="GMainContext*"/>
</parameter>
<parameter name="compat" transfer-ownership="none">
<doc xml:space="preserve">The compatibility mode of the agent</doc>
<type name="Compatibility" c:type="NiceCompatibility"/>
</parameter>
</parameters>
</constructor>
<method name="add_local_address"
c:identifier="nice_agent_add_local_address">
<doc xml:space="preserve">Add a local address from which to derive local host candidates for
candidate gathering.
<para>
Since 0.0.5, if this method is not called, libnice will automatically
discover the local addresses available
</para>
See also: nice_agent_gather_candidates()</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE on success, %FALSE on fatal (memory allocation) errors</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="addr" transfer-ownership="none">
<doc xml:space="preserve">The address to listen to
If the port is 0, then a random port will be chosen by the system</doc>
<type name="Address" c:type="NiceAddress*"/>
</parameter>
</parameters>
</method>
<method name="add_stream" c:identifier="nice_agent_add_stream">
<doc xml:space="preserve">Adds a data stream to @agent containing @n_components components. The
returned stream ID is guaranteed to be positive on success.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The ID of the new stream, 0 on failure</doc>
<type name="guint" c:type="guint"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="n_components" transfer-ownership="none">
<doc xml:space="preserve">The number of components to add to the stream</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="attach_recv"
c:identifier="nice_agent_attach_recv"
introspectable="0">
<doc xml:space="preserve">Attaches the stream's component's sockets to the Glib Mainloop Context in
order to be notified whenever data becomes available for a component,
and to enable #NiceAgent to receive STUN messages (during the
establishment of ICE connectivity).
This must not be used in combination with nice_agent_recv_messages() (or
#NiceIOStream or #NiceInputStream) on the same stream/component pair.
Calling nice_agent_attach_recv() with a %NULL @func will detach any existing
callback and cause reception to be paused for the given stream/component
pair. You must iterate the previously specified #GMainContext sufficiently to
ensure all pending I/O callbacks have been received before calling this
function to unset @func, otherwise data loss of received packets may occur.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE on success, %FALSE if the stream or component IDs are invalid.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of stream</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="component_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the component</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="ctx" transfer-ownership="none">
<doc xml:space="preserve">The Glib Mainloop Context to use for listening on the component</doc>
<type name="GLib.MainContext" c:type="GMainContext*"/>
</parameter>
<parameter name="func" transfer-ownership="none" closure="4">
<doc xml:space="preserve">The callback function to be called when data is received on
the stream's component (will not be called for STUN messages that
should be handled by #NiceAgent itself)</doc>
<type name="AgentRecvFunc" c:type="NiceAgentRecvFunc"/>
</parameter>
<parameter name="data"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">user data associated with the callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</method>
<method name="forget_relays"
c:identifier="nice_agent_forget_relays"
version="0.1.6">
<doc xml:space="preserve">Forget all the relay servers previously added using
nice_agent_set_relay_info(). Currently connected streams will keep
using the relay as long as they have not been restarted and haven't
succesfully negotiated a different path.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%FALSE if the component could not be found, %TRUE otherwise</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the stream</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="component_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the component</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="gather_candidates"
c:identifier="nice_agent_gather_candidates">
<doc xml:space="preserve">Allocate and start listening on local candidate ports and start the remote
candidate gathering process.
Once done, #NiceAgent::candidate-gathering-done is called for the stream.
As soon as this function is called, #NiceAgent::new-candidate signals may be
emitted, even before this function returns.
nice_agent_get_local_candidates() will only return non-empty results after
calling this function.
<para>See also: nice_agent_add_local_address()</para>
<para>See also: nice_agent_set_port_range()</para></doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%FALSE if the stream ID is invalid or if a host candidate couldn't
be allocated on the requested interfaces/ports; %TRUE otherwise
<note>
<para>
Local addresses can be previously set with nice_agent_add_local_address()
</para>
<para>
Since 0.0.5, If no local address was previously added, then the nice agent
will automatically detect the local address using
nice_interfaces_get_local_ips()
</para>
</note></doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the stream to start</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="generate_local_candidate_sdp"
c:identifier="nice_agent_generate_local_candidate_sdp"
version="0.1.4">
<doc xml:space="preserve">Generate an SDP string representing a local candidate.
<para>See also: nice_agent_parse_remote_candidate_sdp() </para>
<para>See also: nice_agent_generate_local_sdp() </para>
<para>See also: nice_agent_generate_local_stream_sdp() </para></doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A string representing the SDP for the candidate. Must be freed
with g_free() once done.</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="candidate" transfer-ownership="none">
<doc xml:space="preserve">The candidate to generate</doc>
<type name="Candidate" c:type="NiceCandidate*"/>
</parameter>
</parameters>
</method>
<method name="generate_local_sdp"
c:identifier="nice_agent_generate_local_sdp"
version="0.1.4">
<doc xml:space="preserve">Generate an SDP string containing the local candidates and credentials for
all streams and components in the agent.
<note>
<para>
The SDP will not contain any codec lines and the 'm' line will not list
any payload types.
</para>
<para>
It is highly recommended to set names on the streams prior to calling this
function. Unnamed streams will show up as '-' in the 'm' line, but the SDP
will not be parseable with nice_agent_parse_remote_sdp() if a stream is
unnamed.
</para>
<para>
The default candidate in the SDP will be selected based on the lowest
priority candidate for the first component.
</para>
</note>
<para>See also: nice_agent_set_stream_name() </para>
<para>See also: nice_agent_parse_remote_sdp() </para>
<para>See also: nice_agent_generate_local_stream_sdp() </para>
<para>See also: nice_agent_generate_local_candidate_sdp() </para>
<para>See also: nice_agent_get_default_local_candidate() </para></doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A string representing the local SDP. Must be freed with g_free()
once done.</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
</parameters>
</method>
<method name="generate_local_stream_sdp"
c:identifier="nice_agent_generate_local_stream_sdp"
version="0.1.4">
<doc xml:space="preserve">Generate an SDP string containing the local candidates and credentials
for a stream.
<note>
<para>
The SDP will not contain any codec lines and the 'm' line will not list
any payload types.
</para>
<para>
It is highly recommended to set the name of the stream prior to calling this
function. Unnamed streams will show up as '-' in the 'm' line.
</para>
<para>
The default candidate in the SDP will be selected based on the lowest
priority candidate.
</para>
</note>
<para>See also: nice_agent_set_stream_name() </para>
<para>See also: nice_agent_parse_remote_stream_sdp() </para>
<para>See also: nice_agent_generate_local_sdp() </para>
<para>See also: nice_agent_generate_local_candidate_sdp() </para>
<para>See also: nice_agent_get_default_local_candidate() </para></doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A string representing the local SDP for the stream. Must be freed
with g_free() once done.</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the stream</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="include_non_ice" transfer-ownership="none">
<doc xml:space="preserve">Whether or not to include non ICE specific lines
(m=, c= and a=rtcp: lines)</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="get_component_state"
c:identifier="nice_agent_get_component_state"
version="0.1.8">
<doc xml:space="preserve">Retrieves the current state of a component.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the #NiceComponentState of the component and
%NICE_COMPONENT_STATE_FAILED if the component was invalid.</doc>
<type name="ComponentState" c:type="NiceComponentState"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the stream</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="component_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the component</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="get_default_local_candidate"
c:identifier="nice_agent_get_default_local_candidate">
<doc xml:space="preserve">This helper function will return the recommended default candidate to be
used for non-ICE compatible clients. This will usually be the candidate
with the lowest priority, since it will be the longest path but the one with
the most chances of success.
<note>
<para>
This function is only useful in order to manually generate the
local SDP
</para>
</note></doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">The candidate to be used as the default candidate, or %NULL in case
of error. Must be freed with nice_candidate_free() once done.</doc>
<type name="Candidate" c:type="NiceCandidate*"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the stream</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="component_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the component</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="get_io_stream"
c:identifier="nice_agent_get_io_stream"
version="0.1.5">
<doc xml:space="preserve">Gets a #GIOStream wrapper around the given stream and component in
@agent. The I/O stream will be valid for as long as @stream_id is valid.
The #GInputStream and #GOutputStream implement #GPollableInputStream and
#GPollableOutputStream.
This function may only be called on reliable #NiceAgents. It is a
programming error to try and create an I/O stream wrapper for an
unreliable stream.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A #GIOStream.</doc>
<type name="Gio.IOStream" c:type="GIOStream*"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">A #NiceAgent</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the stream to wrap</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="component_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the component to wrap</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="get_local_candidates"
c:identifier="nice_agent_get_local_candidates">
<doc xml:space="preserve">Retrieve from the agent the list of all local candidates
for a stream's component
<note>
<para>
The caller owns the returned GSList as well as the candidates contained
within it.
To get full results, the client should wait for the
#NiceAgent::candidate-gathering-done signal.
</para>
</note></doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GSList of
#NiceCandidate objects representing the local candidates of @agent</doc>
<type name="GLib.SList" c:type="GSList*">
<type name="Candidate"/>
</type>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the stream</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="component_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the component</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="get_local_credentials"
c:identifier="nice_agent_get_local_credentials">
<doc xml:space="preserve">Gets the local credentials for stream @stream_id. This may be called any time
after creating a stream using nice_agent_add_stream().
An error will be returned if this is called for a non-existent stream, or if
either of @ufrag or @pwd are %NULL.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE on success, %FALSE on error.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the stream</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="ufrag"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">return location for a nul-terminated string
containing an ICE username fragment; must be freed with g_free()</doc>
<type name="utf8" c:type="gchar**"/>
</parameter>
<parameter name="pwd"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">return location for a nul-terminated string
containing an ICE password; must be freed with g_free()</doc>
<type name="utf8" c:type="gchar**"/>
</parameter>
</parameters>
</method>
<method name="get_remote_candidates"
c:identifier="nice_agent_get_remote_candidates">
<doc xml:space="preserve">Get a list of the remote candidates set on a stream's component
<note>
<para>
The caller owns the returned GSList as well as the candidates contained
within it.
</para>
<para>
The list of remote candidates can change during processing.
The client should register for the #NiceAgent::new-remote-candidate signal
to get notified of new remote candidates.
</para>
</note></doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a #GSList of
#NiceCandidates objects representing the remote candidates set on the @agent</doc>
<type name="GLib.SList" c:type="GSList*">
<type name="Candidate"/>
</type>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the stream</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="component_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the component</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="get_selected_pair"
c:identifier="nice_agent_get_selected_pair">
<doc xml:space="preserve">Retreive the selected candidate pair for media transmission
for a given stream's component.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE on success, %FALSE if there is no selected candidate pair</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the stream</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="component_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the component</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="local" transfer-ownership="none">
<doc xml:space="preserve">The local selected candidate</doc>
<type name="Candidate" c:type="NiceCandidate**"/>
</parameter>
<parameter name="remote" transfer-ownership="none">
<doc xml:space="preserve">The remote selected candidate</doc>
<type name="Candidate" c:type="NiceCandidate**"/>
</parameter>
</parameters>
</method>
<method name="get_selected_socket"
c:identifier="nice_agent_get_selected_socket"
version="0.1.5">
<doc xml:space="preserve">Retreive the local socket associated with the selected candidate pair
for media transmission for a given stream's component.
This is useful for adding ICE support to legacy applications that already
have a protocol that maintains a connection. If the socket is duplicated
before unrefing the agent, the application can take over and continue to use
it. New applications are encouraged to use the built in libnice stream
handling instead and let libnice handle the connection maintenance.
Users of this method are encouraged to not use a TURN relay or any kind
of proxy, as in this case, the socket will not be available to the
application because the packets are encapsulated.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">pointer to the #GSocket, or %NULL if
there is no selected candidate or if the selected candidate is a relayed
candidate.</doc>
<type name="Gio.Socket" c:type="GSocket*"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the stream</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="component_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the component</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="get_stream_name"
c:identifier="nice_agent_get_stream_name"
version="0.1.4">
<doc xml:space="preserve">This function will return the name assigned to a stream.
<para>See also: nice_agent_set_stream_name()</para></doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The name of the stream. The name is only valid while the stream
exists or until it changes through a call to nice_agent_set_stream_name().</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the stream to change</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="parse_remote_candidate_sdp"
c:identifier="nice_agent_parse_remote_candidate_sdp"
version="0.1.4">
<doc xml:space="preserve">Parse an SDP string and extracts the candidate from it.
<para>See also: nice_agent_generate_local_candidate_sdp() </para>
<para>See also: nice_agent_parse_remote_sdp() </para>
<para>See also: nice_agent_parse_remote_stream_sdp() </para></doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">The parsed candidate or %NULL if there was an error.</doc>
<type name="Candidate" c:type="NiceCandidate*"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the stream the candidate belongs to</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="sdp" transfer-ownership="none">
<doc xml:space="preserve">The remote SDP to parse</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="parse_remote_sdp"
c:identifier="nice_agent_parse_remote_sdp"
version="0.1.4">
<doc xml:space="preserve">Parse an SDP string and extracts candidates and credentials from it and sets
them on the agent.
<note>
<para>
This function will return an error if a stream has not been assigned a name
with nice_agent_set_stream_name() as it becomes troublesome to assign the
streams from the agent to the streams in the SDP.
</para>
</note>
<para>See also: nice_agent_set_stream_name() </para>
<para>See also: nice_agent_generate_local_sdp() </para>
<para>See also: nice_agent_parse_remote_stream_sdp() </para>
<para>See also: nice_agent_parse_remote_candidate_sdp() </para></doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The number of candidates added, negative on errors</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="sdp" transfer-ownership="none">
<doc xml:space="preserve">The remote SDP to parse</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="parse_remote_stream_sdp"
c:identifier="nice_agent_parse_remote_stream_sdp"
version="0.1.4">
<doc xml:space="preserve">Parse an SDP string representing a single stream and extracts candidates
and credentials from it.
<para>See also: nice_agent_generate_local_stream_sdp() </para>
<para>See also: nice_agent_parse_remote_sdp() </para>
<para>See also: nice_agent_parse_remote_candidate_sdp() </para></doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A #GSList of
candidates parsed from the SDP, or %NULL in case of errors</doc>
<type name="GLib.SList" c:type="GSList*">
<type name="Candidate"/>
</type>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the stream to parse</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="sdp" transfer-ownership="none">
<doc xml:space="preserve">The remote SDP to parse</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="ufrag" transfer-ownership="none">
<doc xml:space="preserve">Pointer to store the ice ufrag if non %NULL. Must be freed with
g_free() after use</doc>
<type name="utf8" c:type="gchar**"/>
</parameter>
<parameter name="pwd" transfer-ownership="none">
<doc xml:space="preserve">Pointer to store the ice password if non %NULL. Must be freed with
g_free() after use</doc>
<type name="utf8" c:type="gchar**"/>
</parameter>
</parameters>
</method>
<method name="recv"
c:identifier="nice_agent_recv"
version="0.1.5"
throws="1">
<doc xml:space="preserve">A single-message version of nice_agent_recv_messages().</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the number of bytes written to @buf on success (guaranteed to be
greater than 0 unless @buf_len is 0), 0 if in reliable mode and the remote
peer closed the stream, or -1 on error</doc>
<type name="gssize" c:type="gssize"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">a #NiceAgent</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">the ID of the stream to receive on</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="component_id" transfer-ownership="none">
<doc xml:space="preserve">the ID of the component to receive on</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="buf"
direction="out"
caller-allocates="1"
transfer-ownership="none">
<doc xml:space="preserve">caller-allocated buffer
to write the received data into, of length at least @buf_len</doc>
<array length="3" zero-terminated="0" c:type="guint8*">
<type name="guint8" c:type="guint8"/>
</array>
</parameter>
<parameter name="buf_len"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">length of @buf</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 to allow the operation to be
cancelled from another thread, or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
</parameters>
</method>
<method name="recv_messages"
c:identifier="nice_agent_recv_messages"
version="0.1.5"
throws="1">
<doc xml:space="preserve">Block on receiving data from the given stream/component combination on
@agent, returning only once exactly @n_messages messages have been received
and written into @messages, the stream is closed by the other end or by
calling nice_agent_remove_stream(), or @cancellable is cancelled.
Any STUN packets received will not be added to @messages; instead,
they'll be passed for processing to #NiceAgent itself. Since #NiceAgent
does not poll for messages on its own, it's therefore essential to keep
calling this function for ICE connection establishment to work.
In the non-error case, in reliable mode, this will block until all buffers in
all @n_messages have been filled with received data (i.e. @messages is
treated as a large, flat array of buffers). In non-reliable mode, it will
block until @n_messages messages have been received, each of which does not
have to fill all the buffers in its #NiceInputMessage. In the non-reliable
case, each #NiceInputMessage must have enough buffers to contain an entire
message (65536 bytes), or any excess data may be silently dropped.
For each received message, #NiceInputMessage::length will be set to the
number of valid bytes stored in the message’s buffers. The bytes are stored
sequentially in the buffers; there are no gaps apart from at the end of the
buffer array (in non-reliable mode). If non-%NULL on input,
#NiceInputMessage::from will have the address of the sending peer stored in
it. The base addresses, sizes, and number of buffers in each message will not
be modified in any case.
This must not be used in combination with nice_agent_attach_recv() on the
same stream/component pair.
If the stream/component pair doesn’t exist, or if a suitable candidate socket
hasn’t yet been selected for it, a %G_IO_ERROR_BROKEN_PIPE error will be
returned. A %G_IO_ERROR_CANCELLED error will be returned if the operation was
cancelled. %G_IO_ERROR_FAILED will be returned for other errors.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the number of valid messages written to @messages on success
(guaranteed to be greater than 0 unless @n_messages is 0), 0 if the remote
peer closed the stream, or -1 on error</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">a #NiceAgent</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">the ID of the stream to receive on</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="component_id" transfer-ownership="none">
<doc xml:space="preserve">the ID of the component to receive on</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="messages"
direction="out"
caller-allocates="1"
transfer-ownership="none">
<doc xml:space="preserve">caller-allocated
array of #NiceInputMessages to write the received messages into, of length at
least @n_messages</doc>
<array length="3" zero-terminated="0" c:type="NiceInputMessage*">
<type name="InputMessage" c:type="NiceInputMessage"/>
</array>
</parameter>
<parameter name="n_messages"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">number of entries in @messages</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GCancellable to allow the operation to be
cancelled from another thread, or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
</parameters>
</method>
<method name="recv_messages_nonblocking"
c:identifier="nice_agent_recv_messages_nonblocking"
version="0.1.5"
throws="1">
<doc xml:space="preserve">Try to receive data from the given stream/component combination on @agent,
without blocking. If receiving data would block, -1 is returned and
%G_IO_ERROR_WOULD_BLOCK is set in @error. If any other error occurs, -1 is
returned and @error is set accordingly. Otherwise, 0 is returned if (and only
if) @n_messages is 0. In all other cases, the number of valid messages stored
in @messages is returned, and will be greater than 0.
This function behaves similarly to nice_agent_recv_messages(), except that it
will not block on filling (in reliable mode) or receiving (in non-reliable
mode) exactly @n_messages messages. In reliable mode, it will receive bytes
into @messages until it would block; in non-reliable mode, it will receive
messages until it would block.
Any STUN packets received will not be added to @messages; instead,
they'll be passed for processing to #NiceAgent itself. Since #NiceAgent
does not poll for messages on its own, it's therefore essential to keep
calling this function for ICE connection establishment to work.
As this function is non-blocking, @cancellable is included only for parity
with nice_agent_recv_messages(). If @cancellable is cancelled before this
function is called, a %G_IO_ERROR_CANCELLED error will be returned
immediately.
This must not be used in combination with nice_agent_attach_recv() on the
same stream/component pair.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the number of valid messages written to @messages on success
(guaranteed to be greater than 0 unless @n_messages is 0), 0 if in reliable
mode and the remote peer closed the stream, or -1 on error</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">a #NiceAgent</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">the ID of the stream to receive on</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="component_id" transfer-ownership="none">
<doc xml:space="preserve">the ID of the component to receive on</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="messages"
direction="out"
caller-allocates="1"
transfer-ownership="none">
<doc xml:space="preserve">caller-allocated
array of #NiceInputMessages to write the received messages into, of length at
least @n_messages</doc>
<array length="3" zero-terminated="0" c:type="NiceInputMessage*">
<type name="InputMessage" c:type="NiceInputMessage"/>
</array>
</parameter>
<parameter name="n_messages"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">number of entries in @messages</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GCancellable to allow the operation to be
cancelled from another thread, or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
</parameters>
</method>
<method name="recv_nonblocking"
c:identifier="nice_agent_recv_nonblocking"
version="0.1.5"
throws="1">
<doc xml:space="preserve">A single-message version of nice_agent_recv_messages_nonblocking().</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the number of bytes received into @buf on success (guaranteed to be
greater than 0 unless @buf_len is 0), 0 if in reliable mode and the remote
peer closed the stream, or -1 on error</doc>
<type name="gssize" c:type="gssize"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">a #NiceAgent</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">the ID of the stream to receive on</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="component_id" transfer-ownership="none">
<doc xml:space="preserve">the ID of the component to receive on</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="buf"
direction="out"
caller-allocates="1"
transfer-ownership="none">
<doc xml:space="preserve">caller-allocated buffer
to write the received data into, of length at least @buf_len</doc>
<array length="3" zero-terminated="0" c:type="guint8*">
<type name="guint8" c:type="guint8"/>
</array>
</parameter>
<parameter name="buf_len"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">length of @buf</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 to allow the operation to be
cancelled from another thread, or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
</parameters>
</method>
<method name="remove_stream" c:identifier="nice_agent_remove_stream">
<doc xml:space="preserve">Remove and free a previously created data stream from @agent. If any I/O
streams have been created using nice_agent_get_io_stream(), they should be
closed completely using g_io_stream_close() before this is called, or they
will get broken pipe errors.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the stream to remove</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="restart" c:identifier="nice_agent_restart">
<doc xml:space="preserve">Restarts the session as defined in ICE draft 19. This function
needs to be called both when initiating (ICE spec section 9.1.1.1.
"ICE Restarts"), as well as when reacting (spec section 9.2.1.1.
"Detecting ICE Restart") to a restart.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE on success %FALSE on error</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
</parameters>
</method>
<method name="restart_stream"
c:identifier="nice_agent_restart_stream"
version="0.1.6">
<doc xml:space="preserve">Restarts a single stream as defined in RFC 5245. This function
needs to be called both when initiating (ICE spec section 9.1.1.1.
"ICE Restarts"), as well as when reacting (spec section 9.2.1.1.
"Detecting ICE Restart") to a restart.
Unlike nice_agent_restart(), this applies to a single stream. It also
does not generate a new tie breaker.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE on success %FALSE on error</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the stream</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="send" c:identifier="nice_agent_send">
<doc xml:space="preserve">Sends a data payload over a stream's component.
<note>
<para>
Component state MUST be NICE_COMPONENT_STATE_READY, or as a special case,
in any state if component was in READY state before and was then restarted
</para>
<para>
In reliable mode, the -1 error value means either that you are not yet
connected or that the send buffer is full (equivalent to EWOULDBLOCK).
In both cases, you simply need to wait for the
#NiceAgent::reliable-transport-writable signal to be fired before resending
the data.
</para>
<para>
In non-reliable mode, it will virtually never happen with UDP sockets, but
it might happen if the active candidate is a TURN-TCP connection that got
disconnected.
</para>
<para>
In both reliable and non-reliable mode, a -1 error code could also mean that
the stream_id and/or component_id are invalid.
</para>
</note></doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The number of bytes sent, or negative error code</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the stream to send to</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="component_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the component to send to</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="len" transfer-ownership="none">
<doc xml:space="preserve">The length of the buffer to send</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">The buffer of data to send</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="send_messages_nonblocking"
c:identifier="nice_agent_send_messages_nonblocking"
version="0.1.5"
throws="1">
<doc xml:space="preserve">Sends multiple messages on the socket identified by the given
stream/component pair. Transmission is non-blocking, so a
%G_IO_ERROR_WOULD_BLOCK error may be returned if the send buffer is full.
As with nice_agent_send(), the given component must be in
%NICE_COMPONENT_STATE_READY or, as a special case, in any state if it was
previously ready and was then restarted.
On success, the number of messages written to the socket will be returned,
which may be less than @n_messages if transmission would have blocked
part-way through. Zero will be returned if @n_messages is zero, or if
transmission would have blocked on the first message.
In reliable mode, it is instead recommended to use
nice_agent_send(). The return value can be less than @n_messages
or 0 even if it is still possible to send a partial message. In
this case, "nice-agent-writable" will never be triggered, so the
application would have to use nice_agent_sent() to fill the buffer or have
to retry sending at a later point.
On failure, -1 will be returned and @error will be set. If the #NiceAgent is
reliable and the socket is not yet connected, %G_IO_ERROR_BROKEN_PIPE will be
returned; if the write buffer is full, %G_IO_ERROR_WOULD_BLOCK will be
returned. In both cases, wait for the #NiceAgent::reliable-transport-writable
signal before trying again. If the given @stream_id or @component_id are
invalid or not yet connected, %G_IO_ERROR_BROKEN_PIPE will be returned.
%G_IO_ERROR_FAILED will be returned for other errors.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the number of messages sent (may be zero), or -1 on error</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">a #NiceAgent</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">the ID of the stream to send to</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="component_id" transfer-ownership="none">
<doc xml:space="preserve">the ID of the component to send to</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="messages" transfer-ownership="none">
<doc xml:space="preserve">array of messages to send, of at least
@n_messages entries in length</doc>
<array length="3" zero-terminated="0" c:type="NiceOutputMessage*">
<type name="OutputMessage" c:type="NiceOutputMessage"/>
</array>
</parameter>
<parameter name="n_messages" transfer-ownership="none">
<doc xml:space="preserve">number of entries in @messages</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="cancellable"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">a #GCancellable to cancel the operation from
another thread, or %NULL</doc>
<type name="Gio.Cancellable" c:type="GCancellable*"/>
</parameter>
</parameters>
</method>
<method name="set_local_credentials"
c:identifier="nice_agent_set_local_credentials">
<doc xml:space="preserve">Sets the local credentials for stream @stream_id.
<note>
<para>
This is only effective before ICE negotiation has started.
</para>
</note>
Since 0.1.11</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE on success, %FALSE on error.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the stream</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="ufrag" transfer-ownership="none">
<doc xml:space="preserve">nul-terminated string containing an ICE username fragment
(length must be between 22 and 256 chars)</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="pwd" transfer-ownership="none">
<doc xml:space="preserve">nul-terminated string containing an ICE password
(length must be between 4 and 256 chars)</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_port_range" c:identifier="nice_agent_set_port_range">
<doc xml:space="preserve">Sets a preferred port range for allocating host candidates.
<para>
If a local host candidate cannot be created on that port
range, then the nice_agent_gather_candidates() call will fail.
</para>
<para>
This MUST be called before nice_agent_gather_candidates()
</para></doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the stream</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="component_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the component</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="min_port" transfer-ownership="none">
<doc xml:space="preserve">The minimum port to use</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="max_port" transfer-ownership="none">
<doc xml:space="preserve">The maximum port to use</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="set_relay_info" c:identifier="nice_agent_set_relay_info">
<doc xml:space="preserve">Sets the settings for using a relay server during the candidate discovery.
This may be called multiple times to add multiple relay servers to the
discovery process; one TCP and one UDP, for example.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the TURN settings were accepted.
%FALSE if the address was invalid.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the stream</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="component_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the component</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="server_ip" transfer-ownership="none">
<doc xml:space="preserve">The IP address of the TURN server</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="server_port" transfer-ownership="none">
<doc xml:space="preserve">The port of the TURN server</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="username" transfer-ownership="none">
<doc xml:space="preserve">The TURN username to use for the allocate</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="password" transfer-ownership="none">
<doc xml:space="preserve">The TURN password to use for the allocate</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">The type of relay to use</doc>
<type name="RelayType" c:type="NiceRelayType"/>
</parameter>
</parameters>
</method>
<method name="set_remote_candidates"
c:identifier="nice_agent_set_remote_candidates">
<doc xml:space="preserve">Sets, adds or updates the remote candidates for a component of a stream.
<note>
<para>
NICE_AGENT_MAX_REMOTE_CANDIDATES is the absolute maximum limit
for remote candidates.
</para>
<para>
You must first call nice_agent_gather_candidates() and wait for the
#NiceAgent::candidate-gathering-done signale before
calling nice_agent_set_remote_candidates()
</para>
<para>
Since 0.1.3, there is no need to wait for the candidate-gathering-done signal.
Remote candidates can be set even while gathering local candidates.
Newly discovered local candidates will automatically be paired with
existing remote candidates.
</para>
</note></doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The number of candidates added, negative on errors (memory
allocation error or invalid component)</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the stream the candidates are for</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="component_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the component the candidates are for</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="candidates" transfer-ownership="none">
<doc xml:space="preserve">a #GSList of
#NiceCandidate items describing each candidate to add</doc>
<type name="GLib.SList" c:type="const GSList*">
<type name="Candidate"/>
</type>
</parameter>
</parameters>
</method>
<method name="set_remote_credentials"
c:identifier="nice_agent_set_remote_credentials">
<doc xml:space="preserve">Sets the remote credentials for stream @stream_id.
<note>
<para>
Stream credentials do not override per-candidate credentials if set
</para>
<para>
Due to the native of peer-reflexive candidates, any agent using a per-stream
credentials (RFC5245, WLM2009, OC2007R2 and DRAFT19) instead of
per-candidate credentials (GOOGLE, MSN, OC2007), must
use the nice_agent_set_remote_credentials() API instead of setting the
username and password on the candidates.
</para>
</note></doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE on success, %FALSE on error.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the stream</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="ufrag" transfer-ownership="none">
<doc xml:space="preserve">nul-terminated string containing an ICE username fragment
(length must be between 22 and 256 chars)</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="pwd" transfer-ownership="none">
<doc xml:space="preserve">nul-terminated string containing an ICE password
(length must be between 4 and 256 chars)</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_selected_pair"
c:identifier="nice_agent_set_selected_pair">
<doc xml:space="preserve">Sets the selected candidate pair for media transmission
for a given stream's component. Calling this function will
disable all further ICE processing (connection check,
state machine updates, etc). Note that keepalives will
continue to be sent.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE on success, %FALSE if the candidate pair cannot be found</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the stream</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="component_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the component</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="lfoundation" transfer-ownership="none">
<doc xml:space="preserve">The local foundation of the candidate to use</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="rfoundation" transfer-ownership="none">
<doc xml:space="preserve">The remote foundation of the candidate to use</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_selected_remote_candidate"
c:identifier="nice_agent_set_selected_remote_candidate">
<doc xml:space="preserve">Sets the selected remote candidate for media transmission
for a given stream's component. This is used to force the selection of
a specific remote candidate even when connectivity checks are failing
(e.g. non-ICE compatible candidates).
Calling this function will disable all further ICE processing
(connection check, state machine updates, etc). Note that keepalives will
continue to be sent.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE on success, %FALSE on failure</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the stream</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="component_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the component</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="candidate" transfer-ownership="none">
<doc xml:space="preserve">The #NiceCandidate to select</doc>
<type name="Candidate" c:type="NiceCandidate*"/>
</parameter>
</parameters>
</method>
<method name="set_software"
c:identifier="nice_agent_set_software"
version="0.0.10">
<doc xml:space="preserve">This function will set the value of the SOFTWARE attribute to be added to
STUN requests, responses and error responses sent during connectivity checks.
<para>
The SOFTWARE attribute will only be added in the #NICE_COMPATIBILITY_RFC5245
and #NICE_COMPATIBILITY_WLM2009 compatibility modes.
</para>
<note>
<para>
The @software argument will be appended with the libnice version before
being sent.
</para>
<para>
The @software argument must be in UTF-8 encoding and only the first
128 characters will be sent.
</para>
</note></doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="software" transfer-ownership="none">
<doc xml:space="preserve">The value of the SOFTWARE attribute to add.</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_stream_name"
c:identifier="nice_agent_set_stream_name"
version="0.1.4">
<doc xml:space="preserve">This function will assign a media type to a stream. The only values
that can be used to produce a valid SDP are: "audio", "video",
"text", "application", "image" and "message".
This is only useful when parsing and generating an SDP of the
candidates.
<para>See also: nice_agent_generate_local_sdp()</para>
<para>See also: nice_agent_parse_remote_sdp()</para>
<para>See also: nice_agent_get_stream_name()</para></doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the name has been set. %FALSE in case of error
(invalid stream or duplicate name).</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the stream to change</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">The new name of the stream or %NULL</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_stream_tos"
c:identifier="nice_agent_set_stream_tos"
version="0.0.9">
<doc xml:space="preserve">Sets the IP_TOS and/or IPV6_TCLASS field on the stream's sockets' options</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</instance-parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">The ID of the stream</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="tos" transfer-ownership="none">
<doc xml:space="preserve">The ToS to set</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<property name="bytestream-tcp" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="compatibility"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="guint" c:type="guint"/>
</property>
<property name="controlling-mode" writable="1" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="force-relay" writable="1" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="full-mode"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="ice-tcp" writable="1" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="ice-udp" writable="1" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="keepalive-conncheck"
writable="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="main-context"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</property>
<property name="max-connectivity-checks"
writable="1"
transfer-ownership="none">
<type name="guint" c:type="guint"/>
</property>
<property name="proxy-ip" writable="1" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="proxy-password" writable="1" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="proxy-port" writable="1" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</property>
<property name="proxy-type" writable="1" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</property>
<property name="proxy-username" writable="1" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="reliable"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="stun-pacing-timer"
writable="1"
construct="1"
transfer-ownership="none">
<type name="guint" c:type="guint"/>
</property>
<property name="stun-server" writable="1" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="stun-server-port" writable="1" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</property>
<property name="upnp"
writable="1"
construct="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="upnp-timeout"
writable="1"
construct="1"
transfer-ownership="none">
<type name="guint" c:type="guint"/>
</property>
<glib:signal name="candidate-gathering-done" when="last">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="object" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="component-state-changed" when="last">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="object" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="p0" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="p1" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="initial-binding-request-received" when="last">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="object" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="new-candidate" when="last">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="object" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="p0" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="p1" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="new-candidate-full" when="last">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="object" transfer-ownership="none">
<type name="Candidate"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="new-remote-candidate" when="last">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="object" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="p0" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="p1" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="new-remote-candidate-full" when="last">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="object" transfer-ownership="none">
<type name="Candidate"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="new-selected-pair" when="last">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="object" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="p0" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="p1" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</parameter>
<parameter name="p2" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="new-selected-pair-full" when="last">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="object" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="p0" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="p1" transfer-ownership="none">
<type name="Candidate"/>
</parameter>
<parameter name="p2" transfer-ownership="none">
<type name="Candidate"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="reliable-transport-writable" when="last">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="object" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="p0" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="streams-removed" when="last" introspectable="0">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="object" transfer-ownership="none">
<type/>
</parameter>
</parameters>
</glib:signal>
</class>
<record name="AgentClass"
c:type="NiceAgentClass"
glib:is-gtype-struct-for="Agent">
<field name="parent_class">
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<callback name="AgentRecvFunc" c:type="NiceAgentRecvFunc">
<doc xml:space="preserve">Callback function when data is received on a component</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="agent" transfer-ownership="none">
<doc xml:space="preserve">The #NiceAgent Object</doc>
<type name="Agent" c:type="NiceAgent*"/>
</parameter>
<parameter name="stream_id" transfer-ownership="none">
<doc xml:space="preserve">The id of the stream</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="component_id" transfer-ownership="none">
<doc xml:space="preserve">The id of the component of the stream
which received the data</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="len" transfer-ownership="none">
<doc xml:space="preserve">The length of the data</doc>
<type name="guint" c:type="guint"/>
</parameter>
<parameter name="buf" transfer-ownership="none">
<doc xml:space="preserve">The buffer containing the data received</doc>
<type name="utf8" c:type="gchar*"/>
</parameter>
<parameter name="user_data"
transfer-ownership="none"
nullable="1"
allow-none="1"
closure="5">
<doc xml:space="preserve">The user data set in nice_agent_attach_recv()</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<constant name="CANDIDATE_DIRECTION_MS_PREF_ACTIVE"
value="5"
c:type="NICE_CANDIDATE_DIRECTION_MS_PREF_ACTIVE">
<type name="gint" c:type="gint"/>
</constant>
<constant name="CANDIDATE_DIRECTION_MS_PREF_PASSIVE"
value="2"
c:type="NICE_CANDIDATE_DIRECTION_MS_PREF_PASSIVE">
<type name="gint" c:type="gint"/>
</constant>
<constant name="CANDIDATE_MAX_FOUNDATION"
value="33"
c:type="NICE_CANDIDATE_MAX_FOUNDATION">
<doc xml:space="preserve">The maximum size a candidate foundation can have.</doc>
<type name="gint" c:type="gint"/>
</constant>
<constant name="CANDIDATE_TRANSPORT_MS_PREF_TCP"
value="6"
c:type="NICE_CANDIDATE_TRANSPORT_MS_PREF_TCP">
<type name="gint" c:type="gint"/>
</constant>
<constant name="CANDIDATE_TRANSPORT_MS_PREF_UDP"
value="15"
c:type="NICE_CANDIDATE_TRANSPORT_MS_PREF_UDP">
<type name="gint" c:type="gint"/>
</constant>
<constant name="CANDIDATE_TYPE_PREF_HOST"
value="120"
c:type="NICE_CANDIDATE_TYPE_PREF_HOST">
<type name="gint" c:type="gint"/>
</constant>
<constant name="CANDIDATE_TYPE_PREF_NAT_ASSISTED"
value="105"
c:type="NICE_CANDIDATE_TYPE_PREF_NAT_ASSISTED">
<type name="gint" c:type="gint"/>
</constant>
<constant name="CANDIDATE_TYPE_PREF_PEER_REFLEXIVE"
value="110"
c:type="NICE_CANDIDATE_TYPE_PREF_PEER_REFLEXIVE">
<type name="gint" c:type="gint"/>
</constant>
<constant name="CANDIDATE_TYPE_PREF_RELAYED"
value="20"
c:type="NICE_CANDIDATE_TYPE_PREF_RELAYED">
<type name="gint" c:type="gint"/>
</constant>
<constant name="CANDIDATE_TYPE_PREF_RELAYED_UDP"
value="30"
c:type="NICE_CANDIDATE_TYPE_PREF_RELAYED_UDP">
<type name="gint" c:type="gint"/>
</constant>
<constant name="CANDIDATE_TYPE_PREF_SERVER_REFLEXIVE"
value="100"
c:type="NICE_CANDIDATE_TYPE_PREF_SERVER_REFLEXIVE">
<type name="gint" c:type="gint"/>
</constant>
<record name="Candidate"
c:type="NiceCandidate"
glib:type-name="NiceCandidate"
glib:get-type="nice_candidate_get_type"
c:symbol-prefix="candidate">
<doc xml:space="preserve">A structure to represent an ICE candidate
<note>
<para>
The @priority is an integer as specified in the ICE draft 19. If you are
using the MSN or the GOOGLE compatibility mode (which are based on ICE
draft 6, which uses a floating point qvalue as priority), then the @priority
value will represent the qvalue multiplied by 1000.
</para>
</note></doc>
<field name="type" writable="1">
<doc xml:space="preserve">The type of candidate</doc>
<type name="CandidateType" c:type="NiceCandidateType"/>
</field>
<field name="transport" writable="1">
<doc xml:space="preserve">The transport being used for the candidate</doc>
<type name="CandidateTransport" c:type="NiceCandidateTransport"/>
</field>
<field name="addr" writable="1">
<doc xml:space="preserve">The #NiceAddress of the candidate</doc>
<type name="Address" c:type="NiceAddress"/>
</field>
<field name="base_addr" writable="1">
<doc xml:space="preserve">The #NiceAddress of the base address used by the candidate</doc>
<type name="Address" c:type="NiceAddress"/>
</field>
<field name="priority" writable="1">
<doc xml:space="preserve">The priority of the candidate <emphasis> see note </emphasis></doc>
<type name="guint32" c:type="guint32"/>
</field>
<field name="stream_id" writable="1">
<doc xml:space="preserve">The ID of the stream to which belongs the candidate</doc>
<type name="guint" c:type="guint"/>
</field>
<field name="component_id" writable="1">
<doc xml:space="preserve">The ID of the component to which belongs the candidate</doc>
<type name="guint" c:type="guint"/>
</field>
<field name="foundation" writable="1">
<doc xml:space="preserve">The foundation of the candidate</doc>
<array zero-terminated="0" c:type="gchar" fixed-size="33">
<type name="gchar" c:type="gchar"/>
</array>
</field>
<field name="username" writable="1">
<doc xml:space="preserve">The candidate-specific username to use (overrides the one set
by nice_agent_set_local_credentials() or nice_agent_set_remote_credentials())</doc>
<type name="utf8" c:type="gchar*"/>
</field>
<field name="password" writable="1">
<doc xml:space="preserve">The candidate-specific password to use (overrides the one set
by nice_agent_set_local_credentials() or nice_agent_set_remote_credentials())</doc>
<type name="utf8" c:type="gchar*"/>
</field>
<field name="turn" writable="1">
<doc xml:space="preserve">The #TurnServer settings if the candidate is
of type %NICE_CANDIDATE_TYPE_RELAYED</doc>
<type name="TurnServer" c:type="TurnServer*"/>
</field>
<field name="sockptr" writable="1">
<doc xml:space="preserve">The underlying socket</doc>
<type name="gpointer" c:type="gpointer"/>
</field>
<constructor name="new" c:identifier="nice_candidate_new">
<doc xml:space="preserve">Creates a new candidate. Must be freed with nice_candidate_free()</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A new #NiceCandidate</doc>
<type name="Candidate" c:type="NiceCandidate*"/>
</return-value>
<parameters>
<parameter name="type" transfer-ownership="none">
<doc xml:space="preserve">The #NiceCandidateType of the candidate to create</doc>
<type name="CandidateType" c:type="NiceCandidateType"/>
</parameter>
</parameters>
</constructor>
<method name="copy" c:identifier="nice_candidate_copy">
<doc xml:space="preserve">Makes a copy of a #NiceCandidate</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A new #NiceCandidate, a copy of @candidate</doc>
<type name="Candidate" c:type="NiceCandidate*"/>
</return-value>
<parameters>
<instance-parameter name="candidate" transfer-ownership="none">
<doc xml:space="preserve">The candidate to copy</doc>
<type name="Candidate" c:type="const NiceCandidate*"/>
</instance-parameter>
</parameters>
</method>
<method name="free" c:identifier="nice_candidate_free">
<doc xml:space="preserve">Frees a #NiceCandidate</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="candidate" transfer-ownership="none">
<doc xml:space="preserve">The candidate to free</doc>
<type name="Candidate" c:type="NiceCandidate*"/>
</instance-parameter>
</parameters>
</method>
</record>
<enumeration name="CandidateTransport" c:type="NiceCandidateTransport">
<doc xml:space="preserve">An enum representing the type of transport to use</doc>
<member name="udp" value="0" c:identifier="NICE_CANDIDATE_TRANSPORT_UDP">
<doc xml:space="preserve">UDP transport</doc>
</member>
<member name="tcp_active"
value="1"
c:identifier="NICE_CANDIDATE_TRANSPORT_TCP_ACTIVE">
<doc xml:space="preserve">TCP Active transport</doc>
</member>
<member name="tcp_passive"
value="2"
c:identifier="NICE_CANDIDATE_TRANSPORT_TCP_PASSIVE">
<doc xml:space="preserve">TCP Passive transport</doc>
</member>
<member name="tcp_so"
value="3"
c:identifier="NICE_CANDIDATE_TRANSPORT_TCP_SO">
<doc xml:space="preserve">TCP Simultaneous-Open transport</doc>
</member>
</enumeration>
<enumeration name="CandidateType" c:type="NiceCandidateType">
<doc xml:space="preserve">An enum represneting the type of a candidate</doc>
<member name="host" value="0" c:identifier="NICE_CANDIDATE_TYPE_HOST">
<doc xml:space="preserve">A host candidate</doc>
</member>
<member name="server_reflexive"
value="1"
c:identifier="NICE_CANDIDATE_TYPE_SERVER_REFLEXIVE">
<doc xml:space="preserve">A server reflexive candidate</doc>
</member>
<member name="peer_reflexive"
value="2"
c:identifier="NICE_CANDIDATE_TYPE_PEER_REFLEXIVE">
<doc xml:space="preserve">A peer reflexive candidate</doc>
</member>
<member name="relayed"
value="3"
c:identifier="NICE_CANDIDATE_TYPE_RELAYED">
<doc xml:space="preserve">A relay candidate</doc>
</member>
</enumeration>
<enumeration name="Compatibility" c:type="NiceCompatibility">
<doc xml:space="preserve">An enum to specify which compatible specifications the #NiceAgent should use.
Use with nice_agent_new()
<warning>@NICE_COMPATIBILITY_DRAFT19 is deprecated and should not be used
in newly-written code. It is kept for compatibility reasons and
represents the same compatibility as @NICE_COMPATIBILITY_RFC5245 </warning>
<note>
<para>
If @NICE_COMPATIBILITY_RFC5245 compatibility mode is used for a non-reliable
agent, then ICE-UDP will be used with higher priority and ICE-TCP will also
be used when the UDP connectivity fails. If it is used with a reliable agent,
then ICE-UDP will be used with the TCP-Over-UDP (#PseudoTcpSocket) if ICE-TCP
fails and ICE-UDP succeeds.
</para>
</note></doc>
<member name="rfc5245"
value="0"
c:identifier="NICE_COMPATIBILITY_RFC5245">
<doc xml:space="preserve">Use compatibility with the RFC5245 ICE-UDP specs
and RFC6544 ICE-TCP specs</doc>
</member>
<member name="draft19"
value="0"
c:identifier="NICE_COMPATIBILITY_DRAFT19">
<doc xml:space="preserve">Use compatibility for ICE Draft 19 specs</doc>
</member>
<member name="google" value="1" c:identifier="NICE_COMPATIBILITY_GOOGLE">
<doc xml:space="preserve">Use compatibility for Google Talk specs</doc>
</member>
<member name="msn" value="2" c:identifier="NICE_COMPATIBILITY_MSN">
<doc xml:space="preserve">Use compatibility for MSN Messenger specs</doc>
</member>
<member name="wlm2009"
value="3"
c:identifier="NICE_COMPATIBILITY_WLM2009">
<doc xml:space="preserve">Use compatibility with Windows Live Messenger
2009</doc>
</member>
<member name="oc2007" value="4" c:identifier="NICE_COMPATIBILITY_OC2007">
<doc xml:space="preserve">Use compatibility with Microsoft Office Communicator 2007</doc>
</member>
<member name="oc2007r2"
value="5"
c:identifier="NICE_COMPATIBILITY_OC2007R2">
<doc xml:space="preserve">Use compatibility with Microsoft Office Communicator 2007 R2</doc>
</member>
<member name="last" value="5" c:identifier="NICE_COMPATIBILITY_LAST">
<doc xml:space="preserve">Dummy last compatibility mode</doc>
</member>
</enumeration>
<enumeration name="ComponentState" c:type="NiceComponentState">
<doc xml:space="preserve">An enum representing the state of a component.
<para> See also: #NiceAgent::component-state-changed </para></doc>
<member name="disconnected"
value="0"
c:identifier="NICE_COMPONENT_STATE_DISCONNECTED">
<doc xml:space="preserve">No activity scheduled</doc>
</member>
<member name="gathering"
value="1"
c:identifier="NICE_COMPONENT_STATE_GATHERING">
<doc xml:space="preserve">Gathering local candidates</doc>
</member>
<member name="connecting"
value="2"
c:identifier="NICE_COMPONENT_STATE_CONNECTING">
<doc xml:space="preserve">Establishing connectivity</doc>
</member>
<member name="connected"
value="3"
c:identifier="NICE_COMPONENT_STATE_CONNECTED">
<doc xml:space="preserve">At least one working candidate pair</doc>
</member>
<member name="ready" value="4" c:identifier="NICE_COMPONENT_STATE_READY">
<doc xml:space="preserve">ICE concluded, candidate pair selection
is now final</doc>
</member>
<member name="failed"
value="5"
c:identifier="NICE_COMPONENT_STATE_FAILED">
<doc xml:space="preserve">Connectivity checks have been completed,
but connectivity was not established</doc>
</member>
<member name="last" value="6" c:identifier="NICE_COMPONENT_STATE_LAST">
<doc xml:space="preserve">Dummy state</doc>
</member>
</enumeration>
<enumeration name="ComponentType" c:type="NiceComponentType">
<doc xml:space="preserve">Convenience enum representing the type of a component for use as the
component_id for RTP/RTCP usages.
<example>
<title>Example of use.</title>
<programlisting>
nice_agent_send (agent, stream_id, NICE_COMPONENT_TYPE_RTP, len, buf);
</programlisting>
</example></doc>
<member name="rtp" value="1" c:identifier="NICE_COMPONENT_TYPE_RTP">
<doc xml:space="preserve">RTP Component type</doc>
</member>
<member name="rtcp" value="2" c:identifier="NICE_COMPONENT_TYPE_RTCP">
<doc xml:space="preserve">RTCP Component type</doc>
</member>
</enumeration>
<record name="InputMessage" c:type="NiceInputMessage" version="0.1.5">
<doc xml:space="preserve">Represents a single message received off the network. For reliable
connections, this is essentially just an array of buffers (specifically,
@from can be ignored). for non-reliable connections, it represents a single
packet as received from the OS.
@n_buffers may be -1 to indicate that @buffers is terminated by a
#GInputVector with a %NULL buffer pointer.
By providing arrays of #NiceInputMessages to functions like
nice_agent_recv_messages(), multiple messages may be received with a single
call, which is more efficient than making multiple calls in a loop. In this
manner, nice_agent_recv_messages() is analogous to recvmmsg(); and
#NiceInputMessage to struct mmsghdr.</doc>
<field name="buffers" writable="1">
<doc xml:space="preserve">unowned array of #GInputVector buffers to
store data in for this message</doc>
<array length="1" zero-terminated="0" c:type="GInputVector*">
<type name="Gio.InputVector" c:type="GInputVector"/>
</array>
</field>
<field name="n_buffers" writable="1">
<doc xml:space="preserve">number of #GInputVectors in @buffers, or -1 to indicate @buffers
is %NULL-terminated</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="from" writable="1">
<doc xml:space="preserve">return location to store the address of the peer who
transmitted the message, or %NULL</doc>
<type name="Address" c:type="NiceAddress*"/>
</field>
<field name="length" writable="1">
<doc xml:space="preserve">total number of valid bytes contiguously stored in @buffers</doc>
<type name="gsize" c:type="gsize"/>
</field>
</record>
<record name="OutputMessage" c:type="NiceOutputMessage" version="0.1.5">
<doc xml:space="preserve">Represents a single message to transmit on the network. For
reliable connections, this is essentially just an array of
buffer. for non-reliable connections, it represents a single packet
to send to the OS.
@n_buffers may be -1 to indicate that @buffers is terminated by a
#GOutputVector with a %NULL buffer pointer.
By providing arrays of #NiceOutputMessages to functions like
nice_agent_send_messages_nonblocking(), multiple messages may be transmitted
with a single call, which is more efficient than making multiple calls in a
loop. In this manner, nice_agent_send_messages_nonblocking() is analogous to
sendmmsg(); and #NiceOutputMessage to struct mmsghdr.</doc>
<field name="buffers" writable="1">
<doc xml:space="preserve">unowned array of #GOutputVector buffers
which contain data to transmit for this message</doc>
<array length="1" zero-terminated="0" c:type="GOutputVector*">
<type name="Gio.OutputVector" c:type="GOutputVector"/>
</array>
</field>
<field name="n_buffers" writable="1">
<doc xml:space="preserve">number of #GOutputVectors in @buffers, or -1 to indicate @buffers
is %NULL-terminated</doc>
<type name="gint" c:type="gint"/>
</field>
</record>
<enumeration name="ProxyType" version="0.0.4" c:type="NiceProxyType">
<doc xml:space="preserve">An enum to specify which proxy type to use for relaying.
Note that the proxies will only be used with TCP TURN relaying.
<para> See also: #NiceAgent:proxy-type </para></doc>
<member name="none" value="0" c:identifier="NICE_PROXY_TYPE_NONE">
<doc xml:space="preserve">Do not use a proxy</doc>
</member>
<member name="socks5" value="1" c:identifier="NICE_PROXY_TYPE_SOCKS5">
<doc xml:space="preserve">Use a SOCKS5 proxy</doc>
</member>
<member name="http" value="2" c:identifier="NICE_PROXY_TYPE_HTTP">
<doc xml:space="preserve">Use an HTTP proxy</doc>
</member>
<member name="last" value="2" c:identifier="NICE_PROXY_TYPE_LAST">
<doc xml:space="preserve">Dummy last proxy type</doc>
</member>
</enumeration>
<record name="PseudoTcpCallbacks"
c:type="PseudoTcpCallbacks"
version="0.0.11">
<doc xml:space="preserve">A structure containing callbacks functions that will be called by the
#PseudoTcpSocket when some events happen.
<para> See also: #PseudoTcpWriteResult </para></doc>
<field name="user_data" writable="1">
<doc xml:space="preserve">A user defined pointer to be passed to the callbacks</doc>
<type name="gpointer" c:type="gpointer"/>
</field>
<field name="PseudoTcpOpened">
<callback name="PseudoTcpOpened">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="tcp" transfer-ownership="none">
<type name="PseudoTcpSocket" c:type="PseudoTcpSocket*"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
</field>
<field name="PseudoTcpReadable">
<callback name="PseudoTcpReadable">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="tcp" transfer-ownership="none">
<type name="PseudoTcpSocket" c:type="PseudoTcpSocket*"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
</field>
<field name="PseudoTcpWritable">
<callback name="PseudoTcpWritable">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="tcp" transfer-ownership="none">
<type name="PseudoTcpSocket" c:type="PseudoTcpSocket*"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
</field>
<field name="PseudoTcpClosed">
<callback name="PseudoTcpClosed">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="tcp" transfer-ownership="none">
<type name="PseudoTcpSocket" c:type="PseudoTcpSocket*"/>
</parameter>
<parameter name="error" transfer-ownership="none">
<type name="guint32" c:type="guint32"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
</field>
<field name="WritePacket">
<callback name="WritePacket">
<return-value transfer-ownership="none">
<type name="PseudoTcpWriteResult" c:type="PseudoTcpWriteResult"/>
</return-value>
<parameters>
<parameter name="tcp" transfer-ownership="none">
<type name="PseudoTcpSocket" c:type="PseudoTcpSocket*"/>
</parameter>
<parameter name="buffer" transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="len" transfer-ownership="none">
<type name="guint32" c:type="guint32"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
</field>
</record>
<enumeration name="PseudoTcpDebugLevel"
version="0.0.11"
c:type="PseudoTcpDebugLevel">
<doc xml:space="preserve">Valid values of debug levels to be set.</doc>
<member name="none" value="0" c:identifier="PSEUDO_TCP_DEBUG_NONE">
<doc xml:space="preserve">Disable debug messages</doc>
</member>
<member name="normal" value="1" c:identifier="PSEUDO_TCP_DEBUG_NORMAL">
<doc xml:space="preserve">Enable basic debug messages</doc>
</member>
<member name="verbose" value="2" c:identifier="PSEUDO_TCP_DEBUG_VERBOSE">
<doc xml:space="preserve">Enable verbose debug messages</doc>
</member>
</enumeration>
<enumeration name="PseudoTcpShutdown"
version="0.1.8"
c:type="PseudoTcpShutdown">
<doc xml:space="preserve">Options for which parts of a connection to shut down when calling
pseudo_tcp_socket_shutdown(). These correspond to the values passed to POSIX
shutdown().</doc>
<member name="rd" value="0" c:identifier="PSEUDO_TCP_SHUTDOWN_RD">
<doc xml:space="preserve">Shut down the local reader only</doc>
</member>
<member name="wr" value="1" c:identifier="PSEUDO_TCP_SHUTDOWN_WR">
<doc xml:space="preserve">Shut down the local writer only</doc>
</member>
<member name="rdwr" value="2" c:identifier="PSEUDO_TCP_SHUTDOWN_RDWR">
<doc xml:space="preserve">Shut down both reading and writing</doc>
</member>
</enumeration>
<class name="PseudoTcpSocket"
c:symbol-prefix="pseudo_tcp_socket"
c:type="PseudoTcpSocket"
version="0.0.11"
parent="GObject.Object"
glib:type-name="PseudoTcpSocket"
glib:get-type="pseudo_tcp_socket_get_type"
glib:type-struct="PseudoTcpSocketClass">
<doc xml:space="preserve">The #PseudoTcpSocket is the GObject implementing the Pseudo TCP Socket</doc>
<constructor name="new"
c:identifier="pseudo_tcp_socket_new"
version="0.0.11">
<doc xml:space="preserve">Creates a new #PseudoTcpSocket for the specified conversation
<note>
<para>
The @callbacks must be non-NULL, in order to get notified of packets the
socket needs to send.
</para>
<para>
If the @callbacks structure was dynamicly allocated, it can be freed
after the call @pseudo_tcp_socket_new
</para>
</note></doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">The new #PseudoTcpSocket object, %NULL on error</doc>
<type name="PseudoTcpSocket" c:type="PseudoTcpSocket*"/>
</return-value>
<parameters>
<parameter name="conversation" transfer-ownership="none">
<doc xml:space="preserve">The conversation id for the socket.</doc>
<type name="guint32" c:type="guint32"/>
</parameter>
<parameter name="callbacks" transfer-ownership="none">
<doc xml:space="preserve">A pointer to the #PseudoTcpCallbacks structure for getting
notified of the #PseudoTcpSocket events.</doc>
<type name="PseudoTcpCallbacks" c:type="PseudoTcpCallbacks*"/>
</parameter>
</parameters>
</constructor>
<method name="can_send"
c:identifier="pseudo_tcp_socket_can_send"
version="0.1.5">
<doc xml:space="preserve">Returns if there is space in the send buffer to send any data.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if data can be sent, %FALSE otherwise</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">The #PseudoTcpSocket object.</doc>
<type name="PseudoTcpSocket" c:type="PseudoTcpSocket*"/>
</instance-parameter>
</parameters>
</method>
<method name="close"
c:identifier="pseudo_tcp_socket_close"
version="0.0.11">
<doc xml:space="preserve">Close the socket for sending. If @force is set to %FALSE, the socket will
finish sending pending data before closing. If it is set to %TRUE, the socket
will discard pending data and close the connection immediately (sending a TCP
RST segment).
The socket will be closed in both directions – sending and receiving – and
any pending received data must be read before calling this function, by
calling pseudo_tcp_socket_recv() until it blocks. If any pending data is in
the receive buffer when pseudo_tcp_socket_close() is called, a TCP RST
segment will be sent to the peer to notify it of the data loss.
<note>
<para>
The %PseudoTcpCallbacks:PseudoTcpClosed callback will not be called once
the socket gets closed. It is only used for aborted connection.
Instead, the socket gets closed when the pseudo_tcp_socket_get_next_clock()
function returns FALSE.
</para>
</note>
<para> See also: pseudo_tcp_socket_get_next_clock() </para></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 #PseudoTcpSocket object.</doc>
<type name="PseudoTcpSocket" c:type="PseudoTcpSocket*"/>
</instance-parameter>
<parameter name="force" transfer-ownership="none">
<doc xml:space="preserve">%TRUE to close the socket forcefully, %FALSE to close it gracefully</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="connect"
c:identifier="pseudo_tcp_socket_connect"
version="0.0.11">
<doc xml:space="preserve">Connects the #PseudoTcpSocket to the peer with the same conversation id.
The connection will only be successful after the
%PseudoTcpCallbacks:PseudoTcpOpened callback is called</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE on success, %FALSE on failure (not in %TCP_LISTEN state)
<para> See also: pseudo_tcp_socket_get_error() </para></doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">The #PseudoTcpSocket object.</doc>
<type name="PseudoTcpSocket" c:type="PseudoTcpSocket*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_available_bytes"
c:identifier="pseudo_tcp_socket_get_available_bytes"
version="0.1.5">
<doc xml:space="preserve">Gets the number of bytes of data in the buffer that can be read without
receiving more packets from the network.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The number of bytes or -1 if the connection is not established</doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">The #PseudoTcpSocket object.</doc>
<type name="PseudoTcpSocket" c:type="PseudoTcpSocket*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_available_send_space"
c:identifier="pseudo_tcp_socket_get_available_send_space"
version="0.1.5">
<doc xml:space="preserve">Gets the number of bytes of space available in the transmission buffer.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The number of bytes, or 0 if the connection is not established.</doc>
<type name="gsize" c:type="gsize"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">The #PseudoTcpSocket object.</doc>
<type name="PseudoTcpSocket" c:type="PseudoTcpSocket*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_error"
c:identifier="pseudo_tcp_socket_get_error"
version="0.0.11">
<doc xml:space="preserve">Return the last encountered error.
<note>
<para>
The return value can be :
<para>
EINVAL (for pseudo_tcp_socket_connect()).
</para>
<para>
EWOULDBLOCK or ENOTCONN (for pseudo_tcp_socket_recv() and
pseudo_tcp_socket_send()).
</para>
</para>
</note></doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The error code
<para> See also: pseudo_tcp_socket_connect() </para>
<para> See also: pseudo_tcp_socket_recv() </para>
<para> See also: pseudo_tcp_socket_send() </para></doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">The #PseudoTcpSocket object.</doc>
<type name="PseudoTcpSocket" c:type="PseudoTcpSocket*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_next_clock"
c:identifier="pseudo_tcp_socket_get_next_clock"
version="0.0.11">
<doc xml:space="preserve">Call this to determine the timeout needed before the next time call
to pseudo_tcp_socket_notify_clock() should be made.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if @timeout was filled, %FALSE if the socket is closed and
ready to be destroyed.
<para> See also: pseudo_tcp_socket_notify_clock() </para></doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">The #PseudoTcpSocket object.</doc>
<type name="PseudoTcpSocket" c:type="PseudoTcpSocket*"/>
</instance-parameter>
<parameter name="timeout" transfer-ownership="none">
<doc xml:space="preserve">A pointer to be filled with the new timeout.</doc>
<type name="guint64" c:type="guint64*"/>
</parameter>
</parameters>
</method>
<method name="is_closed"
c:identifier="pseudo_tcp_socket_is_closed"
version="0.1.8">
<doc xml:space="preserve">Gets whether the socket is closed, with the shutdown handshake completed,
and both peers no longer able to read or write data to the connection.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the socket is closed in both directions, %FALSE otherwise</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">The #PseudoTcpSocket object.</doc>
<type name="PseudoTcpSocket" c:type="PseudoTcpSocket*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_closed_remotely"
c:identifier="pseudo_tcp_socket_is_closed_remotely"
version="0.1.8">
<doc xml:space="preserve">Gets whether the socket has been closed on the remote peer’s side of the
connection (i.e. whether pseudo_tcp_socket_close() has been called there).
This is guaranteed to return %TRUE if pseudo_tcp_socket_is_closed() returns
%TRUE. It will not return %TRUE after pseudo_tcp_socket_close() is called
until a FIN segment is received from the remote peer.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the remote peer has closed its side of the connection,
%FALSE otherwise</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">The #PseudoTcpSocket object.</doc>
<type name="PseudoTcpSocket" c:type="PseudoTcpSocket*"/>
</instance-parameter>
</parameters>
</method>
<method name="notify_clock"
c:identifier="pseudo_tcp_socket_notify_clock"
version="0.0.11">
<doc xml:space="preserve">Start the processing of receiving data, pending data or syn/acks.
Call this based on timeout value returned by
pseudo_tcp_socket_get_next_clock().
It's ok to call this too frequently.
<para> See also: pseudo_tcp_socket_get_next_clock() </para></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 #PseudoTcpSocket object.</doc>
<type name="PseudoTcpSocket" c:type="PseudoTcpSocket*"/>
</instance-parameter>
</parameters>
</method>
<method name="notify_message"
c:identifier="pseudo_tcp_socket_notify_message"
version="0.1.5">
<doc xml:space="preserve">Notify the #PseudoTcpSocket that a new message has arrived, and enqueue the
data in its buffers to the #PseudoTcpSocket’s receive buffer.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the packet was processed successfully, %FALSE otherwise</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">The #PseudoTcpSocket object.</doc>
<type name="PseudoTcpSocket" c:type="PseudoTcpSocket*"/>
</instance-parameter>
<parameter name="message" transfer-ownership="none">
<doc xml:space="preserve">A #NiceInputMessage containing the received data.</doc>
<type name="InputMessage" c:type="NiceInputMessage*"/>
</parameter>
</parameters>
</method>
<method name="notify_mtu"
c:identifier="pseudo_tcp_socket_notify_mtu"
version="0.0.11">
<doc xml:space="preserve">Set the MTU of the socket</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 #PseudoTcpSocket object.</doc>
<type name="PseudoTcpSocket" c:type="PseudoTcpSocket*"/>
</instance-parameter>
<parameter name="mtu" transfer-ownership="none">
<doc xml:space="preserve">The new MTU of the socket</doc>
<type name="guint16" c:type="guint16"/>
</parameter>
</parameters>
</method>
<method name="notify_packet"
c:identifier="pseudo_tcp_socket_notify_packet"
version="0.0.11">
<doc xml:space="preserve">Notify the #PseudoTcpSocket when a new packet arrives</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if the packet was processed successfully, %FALSE otherwise</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">The #PseudoTcpSocket object.</doc>
<type name="PseudoTcpSocket" c:type="PseudoTcpSocket*"/>
</instance-parameter>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">The buffer containing the received data</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="len" transfer-ownership="none">
<doc xml:space="preserve">The length of @buffer</doc>
<type name="guint32" c:type="guint32"/>
</parameter>
</parameters>
</method>
<method name="recv"
c:identifier="pseudo_tcp_socket_recv"
version="0.0.11">
<doc xml:space="preserve">Receive data from the socket.
<note>
<para>
Only call this on the %PseudoTcpCallbacks:PseudoTcpReadable callback.
</para>
<para>
This function should be called in a loop. If this function does not
return -1 with EWOULDBLOCK as the error, the
%PseudoTcpCallbacks:PseudoTcpReadable callback will not be called again.
</para>
</note></doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The number of bytes received or -1 in case of error
<para> See also: pseudo_tcp_socket_get_error() </para></doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">The #PseudoTcpSocket object.</doc>
<type name="PseudoTcpSocket" c:type="PseudoTcpSocket*"/>
</instance-parameter>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">The buffer to fill with received data</doc>
<type name="utf8" c:type="char*"/>
</parameter>
<parameter name="len" transfer-ownership="none">
<doc xml:space="preserve">The length of @buffer</doc>
<type name="gsize" c:type="size_t"/>
</parameter>
</parameters>
</method>
<method name="send"
c:identifier="pseudo_tcp_socket_send"
version="0.0.11">
<doc xml:space="preserve">Send data on the socket.
<note>
<para>
If this function return -1 with EWOULDBLOCK as the error, or if the return
value is lower than @len, then the %PseudoTcpCallbacks:PseudoTcpWritable
callback will be called when the socket will become writable.
</para>
</note></doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The number of bytes sent or -1 in case of error
<para> See also: pseudo_tcp_socket_get_error() </para></doc>
<type name="gint" c:type="gint"/>
</return-value>
<parameters>
<instance-parameter name="self" transfer-ownership="none">
<doc xml:space="preserve">The #PseudoTcpSocket object.</doc>
<type name="PseudoTcpSocket" c:type="PseudoTcpSocket*"/>
</instance-parameter>
<parameter name="buffer" transfer-ownership="none">
<doc xml:space="preserve">The buffer with data to send</doc>
<type name="utf8" c:type="const char*"/>
</parameter>
<parameter name="len" transfer-ownership="none">
<doc xml:space="preserve">The length of @buffer</doc>
<type name="guint32" c:type="guint32"/>
</parameter>
</parameters>
</method>
<method name="set_time"
c:identifier="pseudo_tcp_socket_set_time"
version="0.1.8">
<doc xml:space="preserve">Sets the current monotonic time to be used by the TCP socket when calculating
timeouts and expiry times. If this function is not called, or is called with
@current_time as zero, g_get_monotonic_time() will be used. Otherwise, the
specified @current_time will be used until it is updated by calling this
function again.
This function is intended for testing only, and should not be used in
production code.</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 #PseudoTcpSocket object.</doc>
<type name="PseudoTcpSocket" c:type="PseudoTcpSocket*"/>
</instance-parameter>
<parameter name="current_time" transfer-ownership="none">
<doc xml:space="preserve">Current monotonic time, in milliseconds; or zero to use the
system monotonic clock.</doc>
<type name="guint32" c:type="guint32"/>
</parameter>
</parameters>
</method>
<method name="shutdown"
c:identifier="pseudo_tcp_socket_shutdown"
version="0.1.8">
<doc xml:space="preserve">Shut down sending, receiving, or both on the socket, depending on the value
of @how. The behaviour of pseudo_tcp_socket_send() and
pseudo_tcp_socket_recv() will immediately change after this function returns
(depending on the value of @how), though the socket may continue to process
network traffic in the background even if sending or receiving data is
forbidden.
This is equivalent to the POSIX shutdown() function. Setting @how to
%PSEUDO_TCP_SHUTDOWN_RDWR is equivalent to calling pseudo_tcp_socket_close().</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 #PseudoTcpSocket object.</doc>
<type name="PseudoTcpSocket" c:type="PseudoTcpSocket*"/>
</instance-parameter>
<parameter name="how" transfer-ownership="none">
<doc xml:space="preserve">The directions of the connection to shut down.</doc>
<type name="PseudoTcpShutdown" c:type="PseudoTcpShutdown"/>
</parameter>
</parameters>
</method>
<property name="ack-delay" writable="1" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</property>
<property name="callbacks" writable="1" transfer-ownership="none">
<type name="gpointer" c:type="gpointer"/>
</property>
<property name="conversation"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="guint" c:type="guint"/>
</property>
<property name="no-delay" writable="1" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
<property name="rcv-buf" writable="1" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</property>
<property name="snd-buf" writable="1" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</property>
<property name="state" transfer-ownership="none">
<type name="guint" c:type="guint"/>
</property>
<property name="support-fin-ack"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</property>
</class>
<record name="PseudoTcpSocketClass"
c:type="PseudoTcpSocketClass"
disguised="1"
glib:is-gtype-struct-for="PseudoTcpSocket">
</record>
<enumeration name="PseudoTcpState"
version="0.0.11"
c:type="PseudoTcpState">
<doc xml:space="preserve">An enum representing the state of the #PseudoTcpSocket. These states
correspond to the TCP states in RFC 793.
<para> See also: #PseudoTcpSocket:state </para></doc>
<member name="listen" value="0" c:identifier="TCP_LISTEN">
<doc xml:space="preserve">The socket's initial state. The socket isn't connected and is
listening for an incoming connection</doc>
</member>
<member name="syn_sent" value="1" c:identifier="TCP_SYN_SENT">
<doc xml:space="preserve">The socket has sent a connection request (SYN) packet and is
waiting for an answer</doc>
</member>
<member name="syn_received" value="2" c:identifier="TCP_SYN_RECEIVED">
<doc xml:space="preserve">The socket has received a connection request (SYN) packet.</doc>
</member>
<member name="established" value="3" c:identifier="TCP_ESTABLISHED">
<doc xml:space="preserve">The socket is connected</doc>
</member>
<member name="closed" value="4" c:identifier="TCP_CLOSED">
<doc xml:space="preserve">The socket has been closed</doc>
</member>
<member name="fin_wait_1" value="5" c:identifier="TCP_FIN_WAIT_1">
<doc xml:space="preserve">The socket has been closed locally but not remotely
(Since: 0.1.8)</doc>
</member>
<member name="fin_wait_2" value="6" c:identifier="TCP_FIN_WAIT_2">
<doc xml:space="preserve">The socket has been closed locally but not remotely
(Since: 0.1.8)</doc>
</member>
<member name="closing" value="7" c:identifier="TCP_CLOSING">
<doc xml:space="preserve">The socket has been closed locally and remotely
(Since: 0.1.8)</doc>
</member>
<member name="time_wait" value="8" c:identifier="TCP_TIME_WAIT">
<doc xml:space="preserve">The socket has been closed locally and remotely
(Since: 0.1.8)</doc>
</member>
<member name="close_wait" value="9" c:identifier="TCP_CLOSE_WAIT">
<doc xml:space="preserve">The socket has been closed remotely but not locally
(Since: 0.1.8)</doc>
</member>
<member name="last_ack" value="10" c:identifier="TCP_LAST_ACK">
<doc xml:space="preserve">The socket has been closed locally and remotely
(Since: 0.1.8)</doc>
</member>
</enumeration>
<enumeration name="PseudoTcpWriteResult"
version="0.0.11"
c:type="PseudoTcpWriteResult">
<doc xml:space="preserve">An enum representing the result value of the write operation requested by
the #PseudoTcpSocket.
<para> See also: %PseudoTcpCallbacks:WritePacket </para></doc>
<member name="success" value="0" c:identifier="WR_SUCCESS">
<doc xml:space="preserve">The write operation was successful</doc>
</member>
<member name="too_large" value="1" c:identifier="WR_TOO_LARGE">
<doc xml:space="preserve">The socket type requires that message be sent atomically
and the size of the message to be sent made this impossible.</doc>
</member>
<member name="fail" value="2" c:identifier="WR_FAIL">
<doc xml:space="preserve">There was an error sending the message</doc>
</member>
</enumeration>
<enumeration name="RelayType" c:type="NiceRelayType">
<doc xml:space="preserve">An enum representing the type of relay to use</doc>
<member name="udp" value="0" c:identifier="NICE_RELAY_TYPE_TURN_UDP">
<doc xml:space="preserve">A TURN relay using UDP</doc>
</member>
<member name="tcp" value="1" c:identifier="NICE_RELAY_TYPE_TURN_TCP">
<doc xml:space="preserve">A TURN relay using TCP</doc>
</member>
<member name="tls" value="2" c:identifier="NICE_RELAY_TYPE_TURN_TLS">
<doc xml:space="preserve">A TURN relay using TLS over TCP</doc>
</member>
</enumeration>
<record name="TurnServer" c:type="TurnServer">
<doc xml:space="preserve">A structure to store the TURN relay settings</doc>
<field name="ref_count" writable="1">
<doc xml:space="preserve">Reference count for the structure.</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="server" writable="1">
<doc xml:space="preserve">The #NiceAddress of the TURN server</doc>
<type name="Address" c:type="NiceAddress"/>
</field>
<field name="username" writable="1">
<doc xml:space="preserve">The TURN username</doc>
<type name="utf8" c:type="gchar*"/>
</field>
<field name="password" writable="1">
<doc xml:space="preserve">The TURN password</doc>
<type name="utf8" c:type="gchar*"/>
</field>
<field name="type" writable="1">
<doc xml:space="preserve">The #NiceRelayType of the server</doc>
<type name="RelayType" c:type="NiceRelayType"/>
</field>
</record>
<function name="component_state_to_string"
c:identifier="nice_component_state_to_string"
version="0.1.6">
<doc xml:space="preserve">Returns a string representation of the state, generally to use in debug
messages.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">a string representation of @state</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="state" transfer-ownership="none">
<doc xml:space="preserve">a #NiceComponentState</doc>
<type name="ComponentState" c:type="NiceComponentState"/>
</parameter>
</parameters>
</function>
<function name="debug_disable" c:identifier="nice_debug_disable">
<doc xml:space="preserve">Disables libnice debug output to the terminal</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="with_stun" transfer-ownership="none">
<doc xml:space="preserve">Also disable stun debugging messages</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</function>
<function name="debug_enable" c:identifier="nice_debug_enable">
<doc xml:space="preserve">Enables libnice debug output to the terminal. Note that the
`G_MESSAGES_DEBUG` and `NICE_DEBUG` environment variables must be set to the
set of logging domains to print, in order for any output to be printed. Set
them to `all` to print all debugging messages, or any of the following
domains:
- `libnice-stun`
- `libnice-tests`
- `libnice-socket`
- `libnice`
- `libnice-pseudotcp`
- `libnice-pseudotcp-verbose`</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="with_stun" transfer-ownership="none">
<doc xml:space="preserve">Also enable STUN debugging messages</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</function>
<function name="interfaces_get_ip_for_interface"
c:identifier="nice_interfaces_get_ip_for_interface">
<doc xml:space="preserve">Retrieves the IP address of an interface by its name. If this fails, %NULL
is returned.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">a newly-allocated string with the IP
address</doc>
<type name="utf8" c:type="gchar*"/>
</return-value>
<parameters>
<parameter name="interface_name" transfer-ownership="none">
<doc xml:space="preserve">name of local interface</doc>
<type name="utf8" c:type="gchar*"/>
</parameter>
</parameters>
</function>
<function name="interfaces_get_local_interfaces"
c:identifier="nice_interfaces_get_local_interfaces">
<doc xml:space="preserve">Get the list of local interfaces</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a newly-allocated #GList of
strings. The caller must free it.</doc>
<type name="GLib.List" c:type="GList*">
<type name="utf8"/>
</type>
</return-value>
</function>
<function name="interfaces_get_local_ips"
c:identifier="nice_interfaces_get_local_ips">
<doc xml:space="preserve">Get a list of local ipv4 interface addresses</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">a newly-allocated #GList of
strings. The caller must free it.</doc>
<type name="GLib.List" c:type="GList*">
<type name="utf8"/>
</type>
</return-value>
<parameters>
<parameter name="include_loopback" transfer-ownership="none">
<doc xml:space="preserve">Include any loopback devices</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</function>
<function name="pseudo_tcp_set_debug_level"
c:identifier="pseudo_tcp_set_debug_level"
version="0.0.11">
<doc xml:space="preserve">Sets the debug level to enable/disable normal/verbose debug messages.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="level" transfer-ownership="none">
<doc xml:space="preserve">The level of debug to set</doc>
<type name="PseudoTcpDebugLevel" c:type="PseudoTcpDebugLevel"/>
</parameter>
</parameters>
</function>
</namespace>
</repository>
|