/usr/include/upnp/upnp.h is in libupnp3-dev 1:1.6.6-5.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 | /*******************************************************************************
*
* Copyright (c) 2000-2003 Intel Corporation
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* * Neither name of Intel Corporation nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTEL OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
******************************************************************************/
#ifndef UPNP_H
#define UPNP_H
/** @name The API */
/*! @{ */
#if defined MYLIB_LARGEFILE_SENSITIVE && _FILE_OFFSET_BITS+0 != 64
#if defined __GNUC__
#warning libupnp requires largefile mode - use AC_SYS_LARGEFILE
#else
#error libupnp requires largefile mode - use AC_SYS_LARGEFILE
#endif
#endif
#include <stdio.h>
#ifndef WIN32
#include <sys/param.h>
#endif
#if (defined(BSD) && BSD >= 199306)
#include <time.h>
#endif
#include "ixml.h"
#include "upnpconfig.h"
#ifdef WIN32
#ifndef UPNP_STATIC_LIB
#ifdef LIBUPNP_EXPORTS
/* set up declspec for dll export to make functions visible to library users */
#define EXPORT_SPEC __declspec(dllexport)
#else
#define EXPORT_SPEC __declspec(dllimport)
#endif
#else
#define EXPORT_SPEC
#endif
#ifdef UPNP_USE_MSVCPP
/* define some things the M$ VC++ doesn't know */
#define UPNP_INLINE
typedef __int64 int64_t;
#define PRId64 "I64d"
#define PRIzu "lu"
#endif
#ifdef UPNP_USE_BCBPP
/* define some things Borland Builder doesn't know */
#define UPNP_INLINE inline
typedef __int64 int64_t;
#warning The Borland C compiler is probably broken on PRId64, please someone provide a proper fix here
#define PRId64 "I64d"
#define PRIzu "zu"
#endif
#else
#define EXPORT_SPEC
#define UPNP_INLINE inline
/* Invented this macro so that we can live a little longer with MSVC lack of C99. */
#define PRIzu "zu"
#endif
/*
* Defining this macro here gives some interesting information about unused
* functions in the code. Of course, this should never go uncommented on a
* release.
*/
/*#define inline*/
#ifndef WIN32
#define UpnpCloseSocket close
#else
#define UpnpCloseSocket closesocket
#define fseeko fseek
#endif
#ifndef WIN32
#define SOCKET int
#endif
#ifndef WIN32
#include <netinet/in.h>
#else
#include <winsock2.h>
#include <time.h>
#endif
#include <sys/types.h>
#define NUM_HANDLE 200
#define LINE_SIZE 180
#define NAME_SIZE 256
#define MNFT_NAME_SIZE 64
#define MODL_NAME_SIZE 32
#define SERL_NUMR_SIZE 64
#define MODL_DESC_SIZE 64
#define UPNP_INFINITE -1
#define UPNP_USING_CHUNKED -3
#define UPNP_UNTIL_CLOSE -4
/** @name Error codes
* The functions in the SDK API can return a variety of error
* codes to describe problems encountered during execution. This section
* lists the error codes and provides a brief description of what each error
* code means. Refer to the documentation for each function for a
* description of what an error code means in that context.
*/
/*! @{ */
/** @name UPNP_E_SUCCESS [0]
* {\tt UPNP_E_SUCCESS} signifies that the operation completed successfully.
* For asynchronous functions, this only means that the packet generated by
* the operation was successfully transmitted on the network. The result of
* the entire operation comes as part of the callback for that operation.
*/
/*! @{ */
#define UPNP_E_SUCCESS 0
/*! @} */
/** @name UPNP_E_INVALID_HANDLE [-100]
* {\tt UPNP_E_INVALID_HANDLE} signifies that the handle passed to a
* function is not a recognized as a valid handle.
*/
/*! @{ */
#define UPNP_E_INVALID_HANDLE -100
/*! @} */
/** @name UPNP_E_INVALID_PARAM [-101]
* {\tt UPNP_E_INVALID_PARAM} signifies that one or more of the parameters
* passed to the function is not valid. Refer to the documentation for each
* function for more information on the valid ranges of the parameters.
*/
/*! @{ */
#define UPNP_E_INVALID_PARAM -101
/*! @} */
/** @name UPNP_E_OUTOF_HANDLE [-102]
* {\tt UPNP_E_OUTOF_HANDLE} signifies that the SDK does not have any
* more space for additional handles. The SDK allocates space for only
* a few handles in order to conserve memory.
*/
/*! @{ */
#define UPNP_E_OUTOF_HANDLE -102
/*! @} */
#define UPNP_E_OUTOF_CONTEXT -103
/** @name UPNP_E_OUTOF_MEMORY [-104]
* {\tt UPNP_E_OUTOF_MEMORY} signifies that not enough resources are
* currently available to complete the operation. Most operations require
* some free memory in order to complete their work.
*/
/*! @{ */
#define UPNP_E_OUTOF_MEMORY -104
/*! @} */
/** @name UPNP_E_INIT [-105]
* {\tt UPNP_E_INIT} signifies that the SDK has already been
* initialized. The SDK needs to be initialied only once per process.
* Any additional initialization attempts simply return this error with
* no other ill effects.
*/
/*! @{ */
#define UPNP_E_INIT -105
/*! @} */
#define UPNP_E_BUFFER_TOO_SMALL -106
/** @name UPNP_E_INVALID_DESC [-107]
* {\tt UPNP_E_INVALID_DESC} signifies that the description document passed
* to {\bf UpnpRegisterRootDevice} or {\bf UpnpRegisterRootDevice2} is an
* invalid description document.
*/
/*! @{ */
#define UPNP_E_INVALID_DESC -107
/*! @} */
/** @name UPNP_E_INVALID_URL [-108]
* {\tt UPNP_E_INVALID_URL} signifies that a URL passed into the function
* is invalid. The actual cause is function specific, but in general, the
* URL itself might be malformed (e.g. have invalid characters in it) or
* the host might be unreachable.
*/
/*! @{ */
#define UPNP_E_INVALID_URL -108
/*! @} */
#define UPNP_E_INVALID_SID -109
#define UPNP_E_INVALID_DEVICE -110
/** @name UPNP_E_INVALID_SERVICE [-111]
* {\tt UPNP_E_INVALID_SERVICE} is returned only by {\bf UpnpNotify},
* {\bf UpnpNotifyExt}, {\bf UpnpAcceptSubscription}, and
* {\bf UpnpAcceptSubscriptionExt} to signify that the device ID/service
* ID pair does not refer to a valid service.
*/
/*! @{ */
#define UPNP_E_INVALID_SERVICE -111
/*! @} */
/** @name UPNP_E_BAD_RESPONSE [-113]
* {\tt UPNP_E_BAD_RESPONSE} signifies that the response received from the
* remote side of a connection is not correct for the protocol. This applies
* to the GENA, SOAP, and HTTP protocols.
*/
/*! @{ */
#define UPNP_E_BAD_RESPONSE -113
/*! @} */
#define UPNP_E_BAD_REQUEST -114
/** @name UPNP_E_INVALID_ACTION [-115]
* {\tt UPNP_E_INVALID_ACTION} signifies that the SOAP action message is
* invalid. This can be because the DOM document passed to the function was
* malformed or the action message is not correct for the given action.
*/
/*! @{ */
#define UPNP_E_INVALID_ACTION -115
/*! @} */
/** @name UPNP_E_FINISH [-116]
* {\tt UPNP_E_FINISH} signifies that {\bf UpnpInit} has not been called, or
* that {\bf UpnpFinish} has already been called. None of the API functions
* operate until {\bf UpnpInit} successfully completes.
*/
/*! @{ */
#define UPNP_E_FINISH -116
/*! @} */
/** @name UPNP_E_INIT_FAILED [-117]
* {\tt UPNP_E_INIT_FAILED} signifies that {\bf UpnpInit} cannot complete.
* The typical reason is failure to allocate sufficient resources.
*/
/*! @{ */
#define UPNP_E_INIT_FAILED -117
/*! @} */
/** @name UPNP_E_URL_TOO_BIG [-118]
* {\tt UPNP_E_URL_TOO_BIG} signifies that the URL passed into a function
* is too long. The SDK limits URLs to 180 characters in length.
*/
#define UPNP_E_URL_TOO_BIG -118
/** @name UPNP_E_BAD_HTTPMSG [-119]
* {\tt UPNP_E_BAD_HTTPMSG} signifies that the HTTP message contains invalid
* message headers. The error always refers to the HTTP message header
* received from the remote host. The main areas where this occurs are in
* SOAP control messages (e.g. {\bf UpnpSendAction}), GENA subscription
* message (e.g. {\bf UpnpSubscribe}), GENA event notifications (e.g. {\bf
* UpnpNotify}), and HTTP transfers (e.g. {\bf UpnpDownloadXmlDoc}).
*/
/*! @{ */
#define UPNP_E_BAD_HTTPMSG -119
/*! @} */
/** @name UPNP_E_ALREADY_REGISTERED [-120]
* {\tt UPNP_E_ALREADY_REGISTERED} signifies that a client or a device is
* already registered. The SDK currently has a limit of one registered
* client and one registered device per process.
*/
/*! @{ */
#define UPNP_E_ALREADY_REGISTERED -120
/*! @} */
/** @name UPNP_E_NETWORK_ERROR [-200]
* {\tt UPNP_E_NETWORK_ERROR} signifies that a network error occurred. It
* is the generic error code for network problems that are not covered under
* one of the more specific error codes. The typical meaning is the SDK
* failed to read the local IP address or had problems configuring one of
* the sockets.
*/
/*! @{ */
#define UPNP_E_NETWORK_ERROR -200
/*! @} */
/** @name UPNP_E_SOCKET_WRITE [-201]
* {\tt UPNP_E_SOCKET_WRITE} signifies an error writing to a socket. This
* occurs in any function that makes network connections, such
* as discovery (e.g. {\bf UpnpSearchAsync} or {\bf UpnpSendAdvertisement}),
* control (e.g. {\bf UpnpSendAction}), eventing (e.g. {\bf UpnpNotify}),
* and HTTP functions (e.g. {\bf UpnpDownloadXmlDoc}).
*/
/*! @{ */
#define UPNP_E_SOCKET_WRITE -201
/*! @} */
/** @name UPNP_E_SOCKET_READ [-202]
* {\tt UPNP_E_SOCKET_READ} signifies an error reading from a socket. This
* occurs in any function that makes network connections, such
* as discovery (e.g. {\bf UpnpSearchAsync} or {\bf UpnpSendAdvertisement}),
* control (e.g. {\bf UpnpSendAction}), eventing (e.g. {\bf UpnpNotify}),
* and HTTP functions (e.g. {\bf UpnpDownloadXmlDoc}).
*/
/*! @{ */
#define UPNP_E_SOCKET_READ -202
/*! @} */
/** @name UPNP_E_SOCKET_BIND [-203]
* {\tt UPNP_E_SOCKET_BIND} signifies that the SDK had a problem binding
* a socket to a network interface. This occurs in any function that makes
* network connections, such as discovery (e.g. {\bf UpnpSearchAsync} or
* {\bf UpnpSendAdvertisement}), control (e.g. {\bf UpnpSendAction}), eventing
* (e.g. {\bf UpnpNotify}), and HTTP functions (e.g.
* {\bf UpnpDownloadXmlDoc}).
*/
/*! @{ */
#define UPNP_E_SOCKET_BIND -203
/*! @} */
/** @name UPNP_E_SOCKET_CONNECT [-204]
* {\tt UPNP_E_SOCKET_CONNECT} signifies that the SDK had a problem
* connecting to a remote host. This occurs in any function that makes
* network connections, such as discovery (e.g. {\bf UpnpSearchAsync} or
* {\bf UpnpSendAdvertisement}), control (e.g. {\bf UpnpSendAction}), eventing
* (e.g. {\bf UpnpNotify}), and HTTP functions (e.g.
* {\bf UpnpDownloadXmlDoc}).
*/
/*! @{ */
#define UPNP_E_SOCKET_CONNECT -204
/*! @} */
/** @name UPNP_E_OUTOF_SOCKET [-205]
* {\tt UPNP_E_OUTOF_SOCKET} signifies that the SDK cannot create any
* more sockets. This occurs in any function that makes
* network connections, such as discovery (e.g. {\bf UpnpSearchAsync} or
* {\bf UpnpSendAdvertisement}), control (e.g. {\bf UpnpSendAction}), eventing
* (e.g. {\bf UpnpNotify}), and HTTP functions (e.g.
* {\bf UpnpDownloadXmlDoc}).
*/
/*! @{ */
#define UPNP_E_OUTOF_SOCKET -205
/*! @} */
/** @name UPNP_E_LISTEN [-206]
* {\tt UPNP_E_LISTEN} signifies that the SDK had a problem setting the
* socket to listen for incoming connections. This error only happens during
* initialization (i.e. {\bf UpnpInit}).
*/
/*! @{ */
#define UPNP_E_LISTEN -206
/*! @} */
/** @name UPNP_E_TIMEDOUT [-207]
* {\tt UPNP_E_TIMEDOUT} signifies that too much time elapsed before the
* required number of bytes were sent or received over a socket. This error
* can be returned by any function that performs network operations.
*/
/*! @{ */
#define UPNP_E_TIMEDOUT -207
/*! @} */
/** @name UPNP_E_SOCKET_ERROR [-208]
* {\tt UPNP_E_SOCKET_ERROR} is the generic socket error code for
* conditions not covered by other error codes. This error can be returned
* by any function that performs network operations.
*/
/*! @{ */
#define UPNP_E_SOCKET_ERROR -208
/*! @} */
#define UPNP_E_FILE_WRITE_ERROR -209
/** @name UPNP_E_CANCELED [-210]
* {\tt UPNP_E_CANCELED} signifies that the operation was canceled. This
* error can be returned by any function that allows for external
* cancelation.
*/
/*! @{ */
#define UPNP_E_CANCELED -210
/*! @} */
#define UPNP_E_EVENT_PROTOCOL -300
/** @name UPNP_E_SUBSCRIBE_UNACCEPTED [-301]
* {\tt UPNP_E_SUBSCRIBE_UNACCEPTED} signifies that a subscription
* request was rejected from the remote side.
*/
/*! @{ */
#define UPNP_E_SUBSCRIBE_UNACCEPTED -301
/*! @} */
/** @name UPNP_E_UNSUBSCRIBE_UNACCEPTED [-302]
* {\tt UPNP_E_UNSUBSCRIBE_UNACCEPTED} signifies that an unsubscribe
* request was rejected from the remote side.
*/
/*! @{ */
#define UPNP_E_UNSUBSCRIBE_UNACCEPTED -302
/*! @} */
/** @name UPNP_E_NOTIFY_UNACCEPTED [-303]
* {\tt UPNP_E_NOTIFY_UNACCEPTED} signifies that the remote host did not
* accept the notify sent from the local device.
*/
/*! @{ */
#define UPNP_E_NOTIFY_UNACCEPTED -303
/*! @} */
/** @name UPNP_E_INVALID_ARGUMENT [-501]
* {\tt UPNP_E_INVALID_ARGUMENT} signifies that one or more of the parameters
* passed to a function is invalid. Refer to the individual function
* descriptions for the acceptable ranges for parameters.
*/
/*! @{ */
#define UPNP_E_INVALID_ARGUMENT -501
/*! @} */
/** @name UPNP_E_FILE_NOT_FOUND [-502]
* {\tt UPNP_E_FILE_NOT_FOUND} signifies that the filename passed
* to one of the device registration functions was not found or was not
* accessible.
*/
/*! @{ */
#define UPNP_E_FILE_NOT_FOUND -502
/*! @} */
/** @name UPNP_E_FILE_READ_ERROR [-503]
* {\tt UPNP_E_FILE_READ_ERROR} signifies an error when reading a file.
*/
/*! @{ */
#define UPNP_E_FILE_READ_ERROR -503
/*! @} */
/** @name UPNP_E_EXT_NOT_XML [-504]
* {\tt UPNP_E_EXT_NOT_XML} signifies that the file name of the description
* document passed to {\bf UpnpRegisterRootDevice2} does not end in ".xml".
*/
/*! @{ */
#define UPNP_E_EXT_NOT_XML -504
/*! @} */
#define UPNP_E_NO_WEB_SERVER -505
#define UPNP_E_OUTOF_BOUNDS -506
/** @name UPNP_E_NOT_FOUND [-507]
* {\tt UPNP_E_NOT_FOUND} signifies that the response to a SOAP request
* did not contain the required XML constructs.
*/
/*! @{ */
#define UPNP_E_NOT_FOUND -507
/*! @} */
/** @name UPNP_E_INTERNAL_ERROR [-911]
* {\tt UPNP_E_INTERNAL_ERROR} is the generic error code for internal
* conditions not covered by other error codes.
*/
/*! @{ */
#define UPNP_E_INTERNAL_ERROR -911
/*! @} */
/* SOAP-related error codes */
#define UPNP_SOAP_E_INVALID_ACTION 401
#define UPNP_SOAP_E_INVALID_ARGS 402
#define UPNP_SOAP_E_OUT_OF_SYNC 403
#define UPNP_SOAP_E_INVALID_VAR 404
#define UPNP_SOAP_E_ACTION_FAILED 501
/*! @} */
#ifndef OUT
#define OUT
#endif
#ifndef IN
#define IN
#endif
#ifndef INOUT
#define INOUT
#endif
#include "upnpdebug.h"
enum UpnpOpenFileMode{UPNP_READ, UPNP_WRITE};
/*! @name Constants, Structures, and Types */
/*! @{ */
/** Returned when a control point application registers with {\bf
* UpnpRegisterClient}. Client handles can only be used with
* functions that operate with a client handle. */
typedef int UpnpClient_Handle;
/** Returned when a device application registers with {\bf
* UpnpRegisterRootDevice} or {\bf UpnpRegisterRootDevice2}. Device handles
* can only be used with functions that operate with a device handle. */
typedef int UpnpDevice_Handle;
/** @name UPnP_EventType
@memo The reason code for an event callback.
@doc The {\bf Event} parameter will be different depending on the
reason for the callback. The descriptions for each event
type describe the contents of the {\bf Event} parameter.
*/
enum Upnp_EventType_e {
/*
* Control callbacks
*/
/** Received by a device when a control point issues a control
* request. The {\bf Event} parameter contains a pointer to a {\bf
* Upnp_Action_Request} structure containing the action. The application
* stores the results of the action in this structure. */
UPNP_CONTROL_ACTION_REQUEST,
/** A {\bf UpnpSendActionAsync} call completed. The {\bf Event}
* parameter contains a pointer to a {\bf Upnp_Action_Complete} structure
* with the results of the action. */
UPNP_CONTROL_ACTION_COMPLETE,
/** Received by a device when a query for a single service variable
* arrives. The {\bf Event} parameter contains a pointer to a {\bf
* Upnp_State_Var_Request} structure containing the name of the variable
* and value. */
UPNP_CONTROL_GET_VAR_REQUEST,
/** A {\bf UpnpGetServiceVarStatus} call completed. The {\bf Event}
* parameter contains a pointer to a {\bf Upnp_State_Var_Complete} structure
* containing the value for the variable. */
UPNP_CONTROL_GET_VAR_COMPLETE,
/*
* Discovery callbacks
*/
/** Received by a control point when a new device or service is available.
* The {\bf Event} parameter contains a pointer to a {\bf
* Upnp_Discovery} structure with the information about the device
* or service. */
UPNP_DISCOVERY_ADVERTISEMENT_ALIVE,
/** Received by a control point when a device or service shuts down. The {\bf
* Event} parameter contains a pointer to a {\bf Upnp_Discovery}
* structure containing the information about the device or
* service. */
UPNP_DISCOVERY_ADVERTISEMENT_BYEBYE,
/** Received by a control point when a matching device or service responds.
* The {\bf Event} parameter contains a pointer to a {\bf
* Upnp_Discovery} structure containing the information about
* the reply to the search request. */
UPNP_DISCOVERY_SEARCH_RESULT,
/** Received by a control point when the search timeout expires. The
* SDK generates no more callbacks for this search after this
* event. The {\bf Event} parameter is {\tt NULL}. */
UPNP_DISCOVERY_SEARCH_TIMEOUT,
/*
* Eventing callbacks
*/
/** Received by a device when a subscription arrives.
* The {\bf Event} parameter contains a pointer to a {\bf
* Upnp_Subscription_Request} structure. At this point, the
* subscription has already been accepted. {\bf UpnpAcceptSubscription}
* needs to be called to confirm the subscription and transmit the
* initial state table. This can be done during this callback. The SDK
* generates no events for a subscription unless the device
* application calls {\bf UpnpAcceptSubscription}.
*/
UPNP_EVENT_SUBSCRIPTION_REQUEST,
/** Received by a control point when an event arrives. The {\bf
* Event} parameter contains a {\bf Upnp_Event} structure
* with the information about the event. */
UPNP_EVENT_RECEIVED,
/** A {\bf UpnpRenewSubscriptionAsync} call completed. The status of
* the renewal is in the {\bf Event} parameter as a {\bf
* Upnp_Event_Subscription} structure. */
UPNP_EVENT_RENEWAL_COMPLETE,
/** A {\bf UpnpSubscribeAsync} call completed. The status of the
* subscription is in the {\bf Event} parameter as a {\bf
* Upnp_Event_Subscription} structure. */
UPNP_EVENT_SUBSCRIBE_COMPLETE,
/** A {\bf UpnpUnSubscribeAsync} call completed. The status of the
* subscription is in the {\bf Event} parameter as a {\bf
* Upnp_Event_Subscribe} structure. */
UPNP_EVENT_UNSUBSCRIBE_COMPLETE,
/** The auto-renewal of a client subscription failed.
* The {\bf Event} parameter is a {\bf Upnp_Event_Subscribe} structure
* with the error code set appropriately. The subscription is no longer
* valid. */
UPNP_EVENT_AUTORENEWAL_FAILED,
/** A client subscription has expired. This will only occur
* if auto-renewal of subscriptions is disabled.
* The {\bf Event} parameter is a {\bf Upnp_Event_Subscribe}
* structure. The subscription is no longer valid. */
UPNP_EVENT_SUBSCRIPTION_EXPIRED
};
typedef enum Upnp_EventType_e Upnp_EventType;
/** The {\bf Upnp_SID} holds the subscription identifier for a subscription
between a client and a device. The SID is a string representation of
a globally unique id (GUID) and should not be modified.
*/
typedef char Upnp_SID[44];
/** @name Upnp_SType
@memo Represents the different types of searches that
can be performed using the SDK for UPnP Devices API.
@doc By specifying these different values to
{\bf UpnpSearchAsync}, the control point application
can control the scope of the search from all devices
to specific devices or services.
*/
enum Upnp_SType_e {
/** Search for all devices and services on the network. */
UPNP_S_ALL,
/** Search for all root devices on the network. */
UPNP_S_ROOT,
/** Search for a particular device type or a particular device
instance. */
UPNP_S_DEVICE,
/** Search for a particular service type, possibly on a particular
* device type or device instance. */
UPNP_S_SERVICE
};
typedef enum Upnp_SType_e Upnp_SType;
/** @name Upnp_DescType
@memo Specifies the type of description in
{\bf UpnpRegisterRootDevice2}.
@doc These values control how {\bf UpnpRegisterRootDevice2}
interprets the {\bf description} parameter.
*/
enum Upnp_DescType_e {
/** The description is the URL to the description document. */
UPNPREG_URL_DESC,
/** The description is a file name on the local file system
containing the description of the device. */
UPNPREG_FILENAME_DESC,
/** The description is a pointer to a character array containing
the XML description document. */
UPNPREG_BUF_DESC
};
typedef enum Upnp_DescType_e Upnp_DescType;
/** Returned as part of a {\bf UPNP_CONTROL_ACTION_COMPLETE} callback. */
struct Upnp_Action_Request
{
/** The result of the operation. */
int ErrCode;
/** The socket number of the connection to the requestor. */
int Socket;
/** The error string in case of error. */
char ErrStr[LINE_SIZE];
/** The Action Name. */
char ActionName[NAME_SIZE];
/** The unique device ID. */
char DevUDN[NAME_SIZE];
/** The service ID. */
char ServiceID[NAME_SIZE];
/** The DOM document describing the action. */
IXML_Document *ActionRequest;
/** The DOM document describing the result of the action. */
IXML_Document *ActionResult;
/** IP address of the control point requesting this action. */
struct in_addr CtrlPtIPAddr;
/** The DOM document containing the information from the
the SOAP header. */
IXML_Document *SoapHeader;
};
struct Upnp_Action_Complete
{
/** The result of the operation. */
int ErrCode;
/** The control URL for service. */
char CtrlUrl[NAME_SIZE];
/** The DOM document describing the action. */
IXML_Document *ActionRequest;
/** The DOM document describing the result of the action. */
IXML_Document *ActionResult;
};
/** Represents the request for current value of a state variable in a service
* state table. */
struct Upnp_State_Var_Request
{
/** The result of the operation. */
int ErrCode;
/** The socket number of the connection to the requestor. */
int Socket;
/** The error string in case of error. */
char ErrStr[LINE_SIZE];
/** The unique device ID. */
char DevUDN[NAME_SIZE];
/** The service ID. */
char ServiceID[NAME_SIZE];
/** The name of the variable. */
char StateVarName[NAME_SIZE];
/** IP address of sender requesting the state variable. */
struct in_addr CtrlPtIPAddr;
/** The current value of the variable. This needs to be allocated by
* the caller. When finished with it, the SDK frees this {\bf DOMString}. */
DOMString CurrentVal;
};
/** Represents the reply for the current value of a state variable in an
asynchronous call. */
struct Upnp_State_Var_Complete
{
/** The result of the operation. */
int ErrCode;
/** The control URL for the service. */
char CtrlUrl[NAME_SIZE];
/** The name of the variable. */
char StateVarName[NAME_SIZE];
/** The current value of the variable or error string in case of error. */
DOMString CurrentVal;
};
/** Returned along with a {\bf UPNP_EVENT_RECEIVED} callback. */
struct Upnp_Event
{
/** The subscription ID for this subscription. */
Upnp_SID Sid;
/** The event sequence number. */
int EventKey;
/** The DOM tree representing the changes generating the event. */
IXML_Document *ChangedVariables;
};
/*
* This typedef is required by Doc++ to parse the last entry of the
* Upnp_Discovery structure correctly.
*/
/** Returned in a {\bf UPNP_DISCOVERY_RESULT} callback. */
struct Upnp_Discovery
{
/** The result code of the {\bf UpnpSearchAsync} call. */
int ErrCode;
/** The expiration time of the advertisement. */
int Expires;
/** The unique device identifier. */
char DeviceId[LINE_SIZE];
/** The device type. */
char DeviceType[LINE_SIZE];
/** The service type. */
char ServiceType[LINE_SIZE];
/** The service version. */
char ServiceVer[LINE_SIZE];
/** The URL to the UPnP description document for the device. */
char Location[LINE_SIZE];
/** The operating system the device is running. */
char Os[LINE_SIZE];
/** Date when the response was generated. */
char Date[LINE_SIZE];
/** Confirmation that the MAN header was understood by the device. */
char Ext[LINE_SIZE];
/** The host address of the device responding to the search. */
struct sockaddr_in DestAddr;
};
/** Returned along with a {\bf UPNP_EVENT_SUBSCRIBE_COMPLETE} or {\bf
* UPNP_EVENT_UNSUBSCRIBE_COMPLETE} callback. */
struct Upnp_Event_Subscribe {
/** The SID for this subscription. For subscriptions, this only
* contains a valid SID if the {\bf Upnp_EventSubscribe.result} field
* contains a {\tt UPNP_E_SUCCESS} result code. For unsubscriptions,
* this contains the SID from which the subscription is being
* unsubscribed. */
Upnp_SID Sid;
/** The result of the operation. */
int ErrCode;
/** The event URL being subscribed to or removed from. */
char PublisherUrl[NAME_SIZE];
/** The actual subscription time (for subscriptions only). */
int TimeOut;
};
/** Returned along with a {\bf UPNP_EVENT_SUBSCRIPTION_REQUEST}
* callback. */
struct Upnp_Subscription_Request
{
/** The identifier for the service being subscribed to. */
char *ServiceId;
/** Universal device name. */
char *UDN;
/** The assigned subscription ID for this subscription. */
Upnp_SID Sid;
};
struct File_Info
{
/** The length of the file. A length less than 0 indicates the size
* is unknown, and data will be sent until 0 bytes are returned from
* a read call. */
off_t file_length;
/** The time at which the contents of the file was modified;
* The time system is always local (not GMT). */
time_t last_modified;
/** If the file is a directory, {\bf is_directory} contains
* a non-zero value. For a regular file, it should be 0. */
int is_directory;
/** If the file or directory is readable, this contains
* a non-zero value. If unreadable, it should be set to 0. */
int is_readable;
/** The content type of the file. This string needs to be allocated
* by the caller using {\bf ixmlCloneDOMString}. When finished
* with it, the SDK frees the {\bf DOMString}. */
DOMString content_type;
};
/* The type of handle returned by the web server for open requests. */
typedef void *UpnpWebFileHandle;
/** The {\bf UpnpVirtualDirCallbacks} structure contains the pointers to
* file-related callback functions a device application can register to
* virtualize URLs.
*/
struct UpnpVirtualDirCallbacks
{
/** Called by the web server to query information on a file. The callback
* should return 0 on success or -1 on an error. */
int (*get_info) (
IN const char *filename, /** The name of the file to query. */
OUT struct File_Info *info /** Pointer to a structure to store the
information on the file. */
);
/** Called by the web server to open a file. The callback should return
* a valid handle if the file can be opened. Otherwise, it should return
* {\tt NULL} to signify an error. */
UpnpWebFileHandle (*open)(
IN const char *filename, /** The name of the file to open. */
IN enum UpnpOpenFileMode Mode /** The mode in which to open the file.
Valid values are {\tt UPNP_READ} or
{\tt UPNP_WRITE}. */
);
/** Called by the web server to perform a sequential read from an open
* file. The callback should copy {\bf buflen} bytes from the file into
* the buffer.
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt 0}: The file contains no more data (EOF).
* \item {\tt >0}: A successful read of the number of bytes in the
* return code.
* \item {\tt <0}: An error occurred reading the file.
* \end{itemzie}
*/
int (*read) (
IN UpnpWebFileHandle fileHnd, /** The handle of the file to read. */
OUT char *buf, /** The buffer in which to place the
data. */
IN size_t buflen /** The size of the buffer (i.e. the
number of bytes to read). */
);
/** Called by the web server to perform a sequential write to an open
* file. The callback should write {\bf buflen} bytes into the file from
* the buffer. It should return the actual number of bytes written,
* which might be less than {\bf buflen} in the case of a write error.
*/
int (*write) (
IN UpnpWebFileHandle fileHnd, /** The handle of the file to write. */
IN char *buf, /** The buffer with the bytes to write. */
IN size_t buflen /** The number of bytes to write. */
);
/** Called by the web server to move the file pointer, or offset, into
* an open file. The {\bf origin} parameter determines where to start
* moving the file pointer. A value of {\tt SEEK_CUR} moves the
* file pointer relative to where it is. The {\bf offset} parameter can
* be either positive (move forward) or negative (move backward).
* {\tt SEEK_END} moves relative to the end of the file. A positive
* {\bf offset} extends the file. A negative {\bf offset} moves backward
* in the file. Finally, {\tt SEEK_SET} moves to an absolute position in
* the file. In this case, {\bf offset} must be positive. The callback
* should return 0 on a successful seek or a non-zero value on an error.
*/
int (*seek) (
IN UpnpWebFileHandle fileHnd, /** The handle of the file to move the
file pointer. */
IN off_t offset, /** The number of bytes to move in the
file. Positive values move foward and
negative values move backward. Note
that this must be positive if the
{\bf origin} is {\tt SEEK_SET}. */
IN int origin /** The position to move relative to. It
can be {\tt SEEK_CUR} to move relative
to the current position,
{\tt SEEK_END} to move relative to
the end of the file, or {\tt
SEEK_SET} to specify an absolute
offset. */
);
/** Called by the web server to close a file opened via the {\bf open}
* callback. It should return 0 on success, or a non-zero value on an
* error.
*/
int (*close) (
IN UpnpWebFileHandle fileHnd /** The handle of the file to close. */
);
};
typedef struct virtual_Dir_List
{
struct virtual_Dir_List *next;
char dirName[NAME_SIZE];
} virtualDirList;
/** All callback functions share the same prototype, documented below.
* Note that any memory passed to the callback function
* is valid only during the callback and should be copied if it
* needs to persist. This callback function needs to be thread
* safe. The context of the callback is always on a valid thread
* context and standard synchronization methods can be used. Note,
* however, because of this the callback cannot call SDK functions
* unless explicitly noted.
*
* \begin{verbatim}
int CallbackFxn( Upnp_EventType EventType, void* Event, void* Cookie );
\end{verbatim}
*
* where {\bf EventType} is the event that triggered the callback,
* {\bf Event} is a structure that denotes event-specific information for that
* event, and {\bf Cookie} is the user data passed when the callback was
* registered.
*
* See {\bf Upnp_EventType} for more information on the callback values and
* the associated {\bf Event} parameter.
*
* The return value of the callback is currently ignored. It may be used
* in the future to communicate results back to the SDK.
*/
typedef int (*Upnp_FunPtr) (
IN Upnp_EventType EventType,
IN void *Event,
IN void *Cookie
);
/*! @} */ /* Constants, Structures, and Types */
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
/*! @name Initialization and Registration */
/*! @{ */
/** Initializes the Linux SDK for UPnP Devices. This function must be called
* before any other API function can be called. It should be called
* only once. Subsequent calls to this API return a {\tt UPNP_E_INIT}
* error code.
*
* Optionally, the application can specify a host IP address (in the
* case of a multi-homed configuration) and a port number to use for
* all UPnP operations. Since a port number can be used only by one
* process, multiple processes using the SDK must specify
* different port numbers.
*
* If unspecified, the SDK will use the first adapter's IP address
* and an arbitrary port.
*
* This call is synchronous.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_OUTOF_MEMORY}: Insufficient resources exist
* to initialize the SDK.
* \item {\tt UPNP_E_INIT}: The SDK is already initialized.
* \item {\tt UPNP_E_INIT_FAILED}: The SDK initialization
* failed for an unknown reason.
* \item {\tt UPNP_E_SOCKET_BIND}: An error occurred binding a socket.
* \item {\tt UPNP_E_LISTEN}: An error occurred listening to a socket.
* \item {\tt UPNP_E_OUTOF_SOCKET}: An error ocurred creating a socket.
* \item {\tt UPNP_E_INTERNAL_ERROR}: An internal error ocurred.
* \end{itemize} */
EXPORT_SPEC int UpnpInit(
IN const char *HostIP, /** The host IP address to use, in
string format, for example "192.168.0.1",
or {\tt NULL} to use the first adapter's
IP address. */
IN unsigned short DestPort /** The destination port number to use. 0
will pick an arbitrary free port. */
);
/** Terminates the Linux SDK for UPnP Devices. This function must be the last
* API function called. It should be called only once. Subsequent calls to
* this API return a {\tt UPNP_E_FINISH} error code.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_FINISH}: The SDK is already terminated or
* it is not initialized.
* \end{itemize} */
EXPORT_SPEC int UpnpFinish();
/** If '0' is used as the port number in {\bf UpnpInit}, then this
* function can be used to retrieve the actual port allocated to
* the SDK. If {\bf UpnpInit} has not succeeded then 0 is
* returned.
*
* @return [unsigned short] The port on which an internal server is
* listening for UPnP related requests.
*/
EXPORT_SPEC unsigned short UpnpGetServerPort(void);
/** If {\tt NULL} is used as the IP address in {\bf UpnpInit}, then this
* function can be used to retrieve the actual interface address
* on which device is running. If {\bf UpnpInit} has not succeeded
* then {\tt NULL} is returned.
*
* @return [char*] The IP address on which an internal server is listening
* for UPnP related requests.
*/
EXPORT_SPEC char * UpnpGetServerIpAddress(void);
/** {\bf UpnpRegisterClient} registers a control point application with the
* SDK. A control point application cannot make any other API calls
* until it registers using this function.
*
* {\bf UpnpRegisterClient} is a synchronous call and generates no callbacks.
* Callbacks can occur as soon as this function returns.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_FINISH}: The SDK is already terminated or
* is not initialized.
* \item {\tt UPNP_E_INVALID_PARAM}: Either {\bf Callback} or {\bf Hnd}
* is not a valid pointer.
* \item {\tt UPNP_E_OUTOF_MEMORY}: Insufficient resources exist to
* register this control point.
* \end{itemize}
*/
EXPORT_SPEC int UpnpRegisterClient(
IN Upnp_FunPtr Callback, /** Pointer to a function for receiving
asynchronous events. */
IN const void *Cookie, /** Pointer to user data returned with the
callback function when invoked. */
OUT UpnpClient_Handle *Hnd /** Pointer to a variable to store the
new control point handle. */
);
/** {\bf UpnpRegisterRootDevice} registers a device application with
* the SDK. A device application cannot make any other API
* calls until it registers using this function. Device applications
* can also register as control points (see {\bf UpnpRegisterClient}
* to get a control point handle to perform control point
* functionality).
*
* {\bf UpnpRegisterRootDevice} is synchronous and does not generate
* any callbacks. Callbacks can occur as soon as this function returns.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_FINISH}: The SDK is already terminated or
* is not initialized.
* \item {\tt UPNP_E_INVALID_DESC}: The description document was not
* a valid device description.
* \item {\tt UPNP_E_INVALID_URL}: The URL for the description document
* is not valid.
* \item {\tt UPNP_E_INVALID_PARAM}: Either {\bf Callback} or {\bf Hnd}
* is not a valid pointer or {\bf DescURL} is {\tt NULL}.
* \item {\tt UPNP_E_NETWORK_ERROR}: A network error occurred.
* \item {\tt UPNP_E_SOCKET_WRITE}: An error or timeout occurred writing
* to a socket.
* \item {\tt UPNP_E_SOCKET_READ}: An error or timeout occurred reading
* from a socket.
* \item {\tt UPNP_E_SOCKET_BIND}: An error occurred binding a socket.
* \item {\tt UPNP_E_SOCKET_CONNECT}: An error occurred connecting the
* socket.
* \item {\tt UPNP_E_OUTOF_SOCKET}: Too many sockets are currently
* allocated.
* \item {\tt UPNP_E_OUTOF_MEMORY}: There are insufficient resources to
* register this root device.
* \end{itemize} */
EXPORT_SPEC int UpnpRegisterRootDevice(
IN const char *DescUrl, /** Pointer to a string containing the
description URL for this root device
instance. */
IN Upnp_FunPtr Callback, /** Pointer to the callback function for
receiving asynchronous events. */
IN const void *Cookie, /** Pointer to user data returned with the
callback function when invoked. */
OUT UpnpDevice_Handle *Hnd /** Pointer to a variable to store the
new device handle. */
);
/** {\bf UpnpRegisterRootDevice2} is similar to {\bf UpnpRegisterRootDevice},
* except that it also allows the description document to be specified as a
* file or a memory buffer. The description can also be configured to have the
* correct IP and port address.
*
* NOTE: For the configuration to be functional, the internal web server
* MUST be present. In addition, the web server MUST be activated
* (using {\bf UpnpSetWebServerRootDir}) before calling this function.
* The only condition where the web server can be absent is if the
* description document is specified as a URL and no configuration is
* required (i.e. {\tt config_baseURL = 0}.)
*
* {\bf UpnpRegisterRootDevice2} is synchronous and does not generate
* any callbacks. Callbacks can occur as soon as this function returns.
*
* Examples of using different types of description documents:
* \begin{verbatim}
1) Description specified as a URL:
descriptionType == UPNPREG_URL_DESC
description is the URL
bufferLen = 0 (ignored)
2) Description specified as a file:
descriptionType == UPNPREG_FILENAME_DESC
description is a filename
bufferLen = 0 (ignored)
3) Description specified as a memory buffer:
descriptionType == UPNPREG_BUF_DESC
description is pointer to a memory buffer
bufferLen == length of memory buffer
\end{verbatim}
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_FINISH}: The SDK is already terminated or
* is not initialized.
* \item {\tt UPNP_E_INVALID_DESC}: The description document is not
* a valid device description.
* \item {\tt UPNP_E_INVALID_PARAM}: Either {\bf Callback} or {\bf Hnd}
* is not a valid pointer or {\bf DescURL} is {\tt NULL}.
* \item {\tt UPNP_E_NETWORK_ERROR}: A network error occurred.
* \item {\tt UPNP_E_SOCKET_WRITE}: An error or timeout occurred writing
* to a socket.
* \item {\tt UPNP_E_SOCKET_READ}: An error or timeout occurred reading
* from a socket.
* \item {\tt UPNP_E_SOCKET_BIND}: An error occurred binding a socket.
* \item {\tt UPNP_E_SOCKET_CONNECT}: An error occurred connecting the
* socket.
* \item {\tt UPNP_E_OUTOF_SOCKET}: Too many sockets are currently
* allocated.
* \item {\tt UPNP_E_OUTOF_MEMORY}: There are insufficient resources to
* register this root device.
* \item {\tt UPNP_E_URL_TOO_BIG}: Length of the URL is bigger than the
* internal buffer.
* \item {\tt UPNP_E_FILE_NOT_FOUND}: The description file could not
* be found.
* \item {\tt UPNP_E_FILE_READ_ERROR}: An error occurred reading the
* description file.
* \item {\tt UPNP_E_INVALID_URL}: The URL to the description document
* is invalid.
* \item {\tt UPNP_E_EXT_NOT_XML}: The URL to the description document
* or file should have a {\tt .xml} extension.
* \item {\tt UPNP_E_NO_WEB_SERVER}: The internal web server has been
* compiled out; the SDK cannot configure itself from the
* description document.
* \end{itemize} */
EXPORT_SPEC int UpnpRegisterRootDevice2(
IN Upnp_DescType descriptionType,/** The type of the description
document. */
IN const char* description, /** Treated as a URL, file name or
memory buffer depending on
description type. */
IN size_t bufferLen, /** The length of memory buffer if
passing a description in a buffer,
otherwise it is ignored. */
IN int config_baseURL, /** If nonzero, {\tt URLBase} of
description document is
configured and the description
is served using the internal
web server. */
IN Upnp_FunPtr Fun, /** Pointer to the callback function
for receiving asynchronous
events. */
IN const void* Cookie, /** Pointer to user data returned
with the callback function when
invoked. */
OUT UpnpDevice_Handle* Hnd /** Pointer to a variable to store
the new device handle. */
);
/** {\bf UpnpUnRegisterClient} unregisters a control point application,
* unsubscribing all active subscriptions. After this call, the
* {\bf UpnpClient_Handle} is no longer valid.
*
* {\bf UpnpUnRegisterClient} is a synchronous call and generates no
* callbacks. The SDK generates no more callbacks after this
* function returns.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_HANDLE}: The handle is not a valid control
* point handle.
* \end{itemize} */
EXPORT_SPEC int UpnpUnRegisterClient(
IN UpnpClient_Handle Hnd /** The handle of the control point instance
to unregister. */
);
/** Unregisters a root device registered with {\bf UpnpRegisterRootDevice} or
* {\bf UpnpRegisterRootDevice2}. After this call, the
* {\bf UpnpDevice_Handle} is no longer valid. For all advertisements that
* have not yet expired, the SDK sends a device unavailable message
* automatically.
*
* {\bf UpnpUnRegisterRootDevice} is a synchronous call and generates no
* callbacks. Once this call returns, the SDK will no longer
* generate callbacks to the application.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_HANDLE}: The handle is not a valid
* device handle.
* \end{itemize}
*/
EXPORT_SPEC int UpnpUnRegisterRootDevice(
IN UpnpDevice_Handle /** The handle of the root device instance to
unregister. */
);
/** OBSOLETE METHOD : use {\bf UpnpSetMaxContentLength} instead.
* Warning: the Handle argument provided here is not used, so the effect
* of this function is global to the SDK (= same as
* {\bf UpnpSetMaxContentLength} ).
*/
EXPORT_SPEC int UpnpSetContentLength(
IN UpnpClient_Handle Hnd,
IN int contentLength
);
/** Sets the maximum content-length that the SDK will process on an incoming
* SOAP requests or responses. This API allows devices that have memory
* constraints to exhibit consistent behaviour if the size of the
* incoming SOAP message exceeds the memory that device can allocate.
* The default maximum content-length is {\tt DEFAULT_SOAP_CONTENT_LENGTH}
* = 16K bytes.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \end{itemize}
*/
EXPORT_SPEC int UpnpSetMaxContentLength(
IN size_t contentLength /** The maximum permissible content length
for incoming SOAP actions, in bytes. */
);
/*! @} */ /* Initialization and Registration */
/******************************************************************************
******************************************************************************
* *
* D I S C O V E R Y *
* *
******************************************************************************
******************************************************************************/
/*! @name Discovery */
/*! @{ */
/** {\bf UpnpSearchAsync} searches for devices matching the given
* search target. The function returns immediately and the SDK
* calls the default callback function, registered during the
* {\bf UpnpRegisterClient} call, for each matching root device,
* device, or service. The application specifies the search type by the
* {\bf Target} parameter.
*
* Note that there is no way for the SDK to distinguish which client
* instance issued a particular search. Therefore, the client can get
* search callbacks that do not match the original criteria of the search.
* Also, the application will receive multiple callbacks for each search.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_HANDLE}: The handle is not a valid control
* point handle.
* \item {\tt UPNP_E_INVALID_PARAM}: {\bf Target} is {\tt NULL}.
* \end{itemize} */
EXPORT_SPEC int UpnpSearchAsync(
IN UpnpClient_Handle Hnd, /** The handle of the client performing
the search. */
IN int Mx, /** The time, in seconds, to wait for
responses. If the time is greater
than {\tt MAX_SEARCH_TIME} then the time is
set to {\tt MAX_SEARCH_TIME}. If the time is
less than {\tt MIN_SEARCH_TIME} then the
time is set to {\tt MIN_SEARCH_TIME}. */
IN const char *Target, /** The search target as defined in the UPnP
Device Architecture v1.0 specification. */
IN const void *Cookie /** The user data to pass when the callback
function is invoked. */
);
/** {\bf UpnpSendAdvertisement} sends out the discovery announcements for
* all devices and services for a device. Each announcement is made with
* the same expiration time.
*
* {\bf UpnpSendAdvertisement} is a synchronous call.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_HANDLE}: The handle is not a valid
* device handle.
* \item {\tt UPNP_E_OUTOF_MEMORY}: There are insufficient resources to
* send future advertisements.
* \end{itemize}
*/
EXPORT_SPEC int UpnpSendAdvertisement(
IN UpnpDevice_Handle Hnd, /** The device handle for which to send out the
announcements. */
IN int Exp /** The expiration age, in seconds, of
the announcements. */
);
/*! @} */ /* Discovery */
/******************************************************************************
******************************************************************************
* *
* C O N T R O L *
* *
******************************************************************************
******************************************************************************/
/*! @name Control */
/*! @{ */
/** {\bf UpnpGetServiceVarStatus} queries the state of a state
* variable of a service on another device. This is a synchronous call.
* A positive return value indicates a SOAP error code, whereas a negative
* return code indicates an SDK error code. {\bf Note that the use of this
* function is deprecated by the UPnP Forum}.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_HANDLE}: The handle is not a valid control
* point handle.
* \item {\tt UPNP_E_INVALID_URL}: {\bf ActionUrl} is not a valid URL.
* \item {\tt UPNP_E_INVALID_DESC}: The XML document was not
* found or it does not contain a valid XML description.
* \item {\tt UPNP_E_INVALID_PARAM}: {\bf StVarVal} is not a valid
* pointer or {\bf VarName} or {\bf ActionUrl} is {\tt NULL}.
* \item {\tt UPNP_E_OUTOF_MEMORY}: Insufficient resources exist to
* complete this operation.
* \item {\tt UPNP_SOAP_E_INVALID_VAR}: The given variable is invalid
* according to the device.
* \end{itemize}
*/
EXPORT_SPEC int UpnpGetServiceVarStatus(
IN UpnpClient_Handle Hnd, /** The handle of the control point. */
IN const char *ActionURL, /** The URL of the service. */
IN const char *VarName, /** The name of the variable to query. */
OUT DOMString *StVarVal /** The pointer to store the value
for {\bf VarName}. The SDK
allocates this string and the caller
needs to free it using
{\bf ixmlFreeDOMString}. */
);
/** {\bf UpnpGetServiceVarStatusAsync} queries the state of a variable of a
* service, generating a callback when the operation is complete. {\bf Note
* that the use of this function is deprecated by the UPnP Forum}.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_HANDLE}: The handle is not a valid control
* point handle.
* \item {\tt UPNP_E_INVALID_URL}: The {\bf ActionUrl} is not a valid URL.
* \item {\tt UPNP_E_INVALID_PARAM}: {\bf VarName}, {\bf Fun} or
* {\bf ActionUrl} is not a valid pointer.
* \item {\tt UPNP_E_OUTOF_MEMORY}: Insufficient resources exist to
* complete this operation.
* \end{itemize}
*/
EXPORT_SPEC int UpnpGetServiceVarStatusAsync(
IN UpnpClient_Handle Hnd, /** The handle of the control point. */
IN const char *ActionURL, /** The URL of the service. */
IN const char *VarName, /** The name of the variable to query. */
IN Upnp_FunPtr Fun, /** Pointer to a callback function to
be invoked when the operation is complete. */
IN const void *Cookie /** Pointer to user data to pass to the
callback function when invoked. */
);
/** {\bf UpnpSendAction} sends a message to change a state variable
* in a service. This is a synchronous call that does not return until the
* action is complete.
*
* Note that a positive return value indicates a SOAP-protocol error code.
* In this case, the error description can be retrieved from {\bf RespNode}.
* A negative return value indicates an SDK error.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_HANDLE}: The handle is not a valid control
* point handle.
* \item {\tt UPNP_E_INVALID_URL}: {\bf ActionUrl} is not a valid URL.
* \item {\tt UPNP_E_INVALID_ACTION}: This action is not valid.
* \item {\tt UPNP_E_INVALID_DEVICE}: {\bf DevUDN} is not a
* valid device.
* \item {\tt UPNP_E_INVALID_PARAM}: {\bf ServiceType}, {\bf Action},
* {\bf ActionUrl}, or
* {\bf RespNode} is not a valid pointer.
* \item {\tt UPNP_E_OUTOF_MEMORY}: Insufficient resources exist to
* complete this operation.
* \end{itemize}
*/
EXPORT_SPEC int UpnpSendAction(
IN UpnpClient_Handle Hnd, /** The handle of the control point
sending the action. */
IN const char *ActionURL, /** The action URL of the service. */
IN const char *ServiceType, /** The type of the service. */
IN const char *DevUDN, /** This parameter is ignored and must be
{\tt NULL}. */
IN IXML_Document *Action, /** The DOM document for the action. */
OUT IXML_Document **RespNode /** The DOM document for the response
to the action. The SDK allocates
this document and the caller needs to free
it. */
);
/** {\bf UpnpSendActionEx} sends a message to change a state variable
* in a service. This is a synchronous call that does not return until the
* action is complete.
*
* Note that a positive return value indicates a SOAP-protocol error code.
* In this case, the error description can be retrieved from {\bf RespNode}.
* A negative return value indicates an SDK error.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_HANDLE}: The handle is not a valid control
* point handle.
* \item {\tt UPNP_E_INVALID_URL}: {\bf ActionUrl} is not a valid URL.
* \item {\tt UPNP_E_INVALID_ACTION}: This action is not valid.
* \item {\tt UPNP_E_INVALID_DEVICE}: {\bf DevUDN} is not a
* valid device.
* \item {\tt UPNP_E_INVALID_PARAM}: {\bf ServiceType}, {\bf Action},
* {\bf ActionUrl}, or
* {\bf RespNode} is not a valid pointer.
* \item {\tt UPNP_E_OUTOF_MEMORY}: Insufficient resources exist to
* complete this operation.
* \end{itemize}
*/
EXPORT_SPEC int UpnpSendActionEx(
IN UpnpClient_Handle Hnd, /** The handle of the control point
sending the action. */
IN const char *ActionURL, /** The action URL of the service. */
IN const char *ServiceType, /** The type of the service. */
IN const char *DevUDN, /** This parameter is ignored and must be
{\tt NULL}. */
IN IXML_Document *Header, /** The DOM document for the SOAP header.
This may be {\tt NULL} if the header is
not required. */
IN IXML_Document *Action, /** The DOM document for the action. */
OUT IXML_Document **RespNode /** The DOM document for the response
to the action. The SDK allocates
this document and the caller needs to free
it. */
);
/** {\bf UpnpSendActionAsync} sends a message to change a state variable
* in a service, generating a callback when the operation is complete.
* See {\bf UpnpSendAction} for comments on positive return values. These
* positive return values are sent in the event struct associated with the
* {\tt UPNP_CONTROL_ACTION_COMPLETE} event.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_HANDLE}: The handle is not a valid control
* point handle.
* \item {\tt UPNP_E_INVALID_URL}: {\bf ActionUrl} is an invalid URL.
* \item {\tt UPNP_E_INVALID_DEVICE}: {\bf DevUDN} is an invalid device.
* \item {\tt UPNP_E_INVALID_PARAM}: Either {\bf Fun} is not a valid
* callback function or {\bf ServiceType}, {\bf Act}, or
* {\bf ActionUrl} is {\tt NULL}.
* \item {\tt UPNP_E_INVALID_ACTION}: This action is not valid.
* \item {\tt UPNP_E_OUTOF_MEMORY}: Insufficient resources exist to
* complete this operation.
* \end{itemize}
*/
EXPORT_SPEC int UpnpSendActionAsync(
IN UpnpClient_Handle Hnd, /** The handle of the control point
sending the action. */
IN const char *ActionURL, /** The action URL of the service. */
IN const char *ServiceType, /** The type of the service. */
IN const char *DevUDN, /** This parameter is ignored and must be
{\tt NULL}. */
IN IXML_Document *Action, /** The DOM document for the action to
perform on this device. */
IN Upnp_FunPtr Fun, /** Pointer to a callback function to
be invoked when the operation
completes. */
IN const void *Cookie /** Pointer to user data that to be
passed to the callback when invoked. */
);
/** {\bf UpnpSendActionExAsync} sends a message to change a state variable
* in a service, generating a callback when the operation is complete.
* See {\bf UpnpSendAction} for comments on positive return values. These
* positive return values are sent in the event struct associated with the
* {\tt UPNP_CONTROL_ACTION_COMPLETE} event.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_HANDLE}: The handle is not a valid control
* point handle.
* \item {\tt UPNP_E_INVALID_URL}: {\bf ActionUrl} is an invalid URL.
* \item {\tt UPNP_E_INVALID_DEVICE}: {\bf DevUDN} is an invalid device.
* \item {\tt UPNP_E_INVALID_PARAM}: Either {\bf Fun} is not a valid
* callback function or {\bf ServiceType}, {\bf Act}, or
* {\bf ActionUrl} is {\tt NULL}.
* \item {\tt UPNP_E_INVALID_ACTION}: This action is not valid.
* \item {\tt UPNP_E_OUTOF_MEMORY}: Insufficient resources exist to
* complete this operation.
* \end{itemize}
*/
EXPORT_SPEC int UpnpSendActionExAsync(
IN UpnpClient_Handle Hnd, /** The handle of the control point
sending the action. */
IN const char *ActionURL, /** The action URL of the service. */
IN const char *ServiceType, /** The type of the service. */
IN const char *DevUDN, /** This parameter is ignored and must be
{\tt NULL}. */
IN IXML_Document *Header, /** The DOM document for the SOAP header.
This may be {\tt NULL} if the header is
not required. */
IN IXML_Document *Action, /** The DOM document for the action to
perform on this device. */
IN Upnp_FunPtr Fun, /** Pointer to a callback function to
be invoked when the operation
completes. */
IN const void *Cookie /** Pointer to user data that to be
passed to the callback when invoked. */
);
/*! @} */ /* Control */
/******************************************************************************
******************************************************************************
* *
* E V E N T I N G *
* *
******************************************************************************
******************************************************************************/
/*! @name Eventing */
/*! @{ */
/** {\bf UpnpAcceptSubscription} accepts a subscription request and sends
* out the current state of the eventable variables for a service.
* The device application should call this function when it receives a
* {\tt UPNP_EVENT_SUBSCRIPTION_REQUEST} callback. This function is
* synchronous and generates no callbacks.
*
* {\bf UpnpAcceptSubscription} can be called during the execution of
* a callback function.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_HANDLE}: The handle is not a valid device
* handle.
* \item {\tt UPNP_E_INVALID_SERVICE}: The {\bf DevId}/{\bf ServId}
* pair refers to an invalid service.
* \item {\tt UPNP_E_INVALID_SID}: The specified subscription ID is not
* valid.
* \item {\tt UPNP_E_INVALID_PARAM}: Either {\bf VarName},
* {\bf NewVal}, {\bf DevID}, or {\bf ServID} is not a valid
* pointer or {\bf cVariables} is less than zero.
* \item {\tt UPNP_E_OUTOF_MEMORY}: Insufficient resources exist to
* complete this operation.
* \end{itemize}
*/
EXPORT_SPEC int UpnpAcceptSubscription(
IN UpnpDevice_Handle Hnd, /** The handle of the device. */
IN const char *DevID, /** The device ID of the subdevice of the
service generating the event. */
IN const char *ServID, /** The unique service identifier of the service
generating the event. */
IN const char **VarName, /** Pointer to an array of event variables. */
IN const char **NewVal, /** Pointer to an array of values for
the event variables. */
IN int cVariables, /** The number of event variables in
{\bf VarName}. */
IN Upnp_SID SubsId /** The subscription ID of the newly
registered control point. */
);
/** {\bf UpnpAcceptSubscriptionExt} is similar to {\bf UpnpAcceptSubscription}
* except that it takes a DOM document for the variables to event rather
* than an array of strings. This function is sychronous
* and generates no callbacks.
*
* {\bf UpnpAcceptSubscriptionExt} can be called during the execution of
* a callback function.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_HANDLE}: The handle is not a valid device
* handle.
* \item {\tt UPNP_E_INVALID_SERVICE}: The {\bf DevId}/{\bf ServId}
* pair refers to an invalid service.
* \item {\tt UPNP_E_INVALID_SID}: The specified subscription ID is not
* valid.
* \item {\tt UPNP_E_INVALID_PARAM}: Either {\bf VarName},
* {\bf NewVal}, {\bf DevID}, {\bf ServID}, or {\bf PropSet}
* is not a valid pointer.
* \item {\tt UPNP_E_OUTOF_MEMORY}: Insufficient resources exist to
* complete this operation.
* \end{itemize}
*/
EXPORT_SPEC int UpnpAcceptSubscriptionExt(
IN UpnpDevice_Handle Hnd, /** The handle of the device. */
IN const char *DevID, /** The device ID of the subdevice of the
service generating the event. */
IN const char *ServID, /** The unique service identifier of the service
generating the event. */
IN IXML_Document *PropSet, /** The DOM document for the property set.
Property set documents must conform to
the XML schema defined in section 4.3 of the
Universal Plug and Play Device Architecture
specification. */
IN Upnp_SID SubsId /** The subscription ID of the newly
registered control point. */
);
/** {\bf UpnpNotify} sends out an event change notification to all
* control points subscribed to a particular service. This function is
* synchronous and generates no callbacks.
*
* {\bf UpnpNotify} may be called during a callback function to send out
* a notification.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_HANDLE}: The handle is not a valid device
* handle.
* \item {\tt UPNP_E_INVALID_SERVICE}: The {\bf DevId}/{\bf ServId}
* pair refers to an invalid service.
* \item {\tt UPNP_E_INVALID_PARAM}: Either {\bf VarName}, {\bf NewVal},
* {\bf DevID}, or {\bf ServID} is not a valid pointer or
* {\bf cVariables} is less than zero.
* \item {\tt UPNP_E_OUTOF_MEMORY}: Insufficient resources exist to
* complete this operation.
* \end{itemize}
*/
EXPORT_SPEC int UpnpNotify(
IN UpnpDevice_Handle, /** The handle to the device sending the event. */
IN const char *DevID, /** The device ID of the subdevice of the service
generating the event. */
IN const char *ServID, /** The unique identifier of the service
generating the event. */
IN const char **VarName,/** Pointer to an array of variables that
have changed. */
IN const char **NewVal, /** Pointer to an array of new values for
those variables. */
IN int cVariables /** The count of variables included in this
notification. */
);
/** {\bf UpnpNotifyExt} is similar to {\bf UpnpNotify} except that it takes
* a DOM document for the event rather than an array of strings. This
* function is synchronous and generates no callbacks.
*
* {\bf UpnpNotifyExt} may be called during a callback function to send out
* a notification.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_HANDLE}: The handle is not a valid device
* handle.
* \item {\tt UPNP_E_INVALID_SERVICE}: The {\bf DevId}/{\bf ServId}
* pair refers to an invalid service.
* \item {\tt UPNP_E_INVALID_PARAM}: Either {\bf VarName}, {\bf NewVal},
* {\bf DevID}, {\bf ServID}, or {\bf PropSet}
* is not a valid pointer or {\bf cVariables} is less than zero.
* \item {\tt UPNP_E_OUTOF_MEMORY}: Insufficient resources exist to
* complete this operation.
* \end{itemize}
*/
EXPORT_SPEC int UpnpNotifyExt(
IN UpnpDevice_Handle, /** The handle to the device sending the
event. */
IN const char *DevID, /** The device ID of the subdevice of the
service generating the event. */
IN const char *ServID, /** The unique identifier of the service
generating the event. */
IN IXML_Document *PropSet /** The DOM document for the property set.
Property set documents must conform to
the XML schema defined in section 4.3 of
the Universal Plug and Play Device
Architecture specification. */
);
/** {\bf UpnpRenewSubscription} renews a subscription that is about to
* expire. This function is synchronous.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_HANDLE}: The handle is not a valid control
* point handle.
* \item {\tt UPNP_E_INVALID_PARAM}: {\bf Timeout} is not a valid pointer.
* \item {\tt UPNP_E_INVALID_SID}: The SID being passed to this function
* is not a valid subscription ID.
* \item {\tt UPNP_E_NETWORK_ERROR}: A network error occured.
* \item {\tt UPNP_E_SOCKET_WRITE}: An error or timeout occurred writing
* to a socket.
* \item {\tt UPNP_E_SOCKET_READ}: An error or timeout occurred reading
* from a socket.
* \item {\tt UPNP_E_SOCKET_BIND}: An error occurred binding a socket.
* \item {\tt UPNP_E_SOCKET_CONNECT}: An error occurred connecting to
* {\bf PublisherUrl}.
* \item {\tt UPNP_E_OUTOF_SOCKET}: An error occurred creating a socket.
* \item {\tt UPNP_E_BAD_RESPONSE}: An error occurred in response from
* the publisher.
* \item {\tt UPNP_E_SUBSCRIBE_UNACCEPTED}: The publisher refused
* the subscription renew.
* \item {\tt UPNP_E_OUTOF_MEMORY}: Insufficient resources exist to
* complete this operation.
* \end{itemize}
*/
EXPORT_SPEC int UpnpRenewSubscription(
IN UpnpClient_Handle Hnd, /** The handle of the control point that
is renewing the subscription. */
INOUT int *TimeOut, /** Pointer to a variable containing the
requested subscription time. Upon return,
it contains the actual renewal time. */
IN Upnp_SID SubsId /** The ID for the subscription to renew. */
);
/** {\bf UpnpRenewSubscriptionAsync} renews a subscription that is about
* to expire, generating a callback when the operation is complete.
*
* Note that many of the error codes for this function are returned in
* the {\bf Upnp_Event_Subscribe} structure. In those cases, the function
* returns {\tt UPNP_E_SUCCESS} and the appropriate error code will
* be in the {\bf Upnp_Event_Subscribe.ErrCode} field in the {\bf Event}
* structure passed to the callback.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_HANDLE}: The handle is not a valid control
* point handle.
* \item {\tt UPNP_E_INVALID_SID}: The {\bf SubsId} is not a valid
* subscription ID.
* \item {\tt UPNP_E_INVALID_PARAM}: Either {\bf Fun} is not a valid
* callback function pointer or {\bf Timeout} is less than zero
* but is not {\tt UPNP_INFINITE}.
* \item {\tt UPNP_E_OUTOF_MEMORY}: Insufficient resources exist to
* complete this operation.
* \item {\tt UPNP_E_NETWORK_ERROR}: A network error occured (returned in
* the {\bf Upnp_Event_Subscribe.ErrCode} field as part of the
* callback).
* \item {\tt UPNP_E_SOCKET_WRITE}: An error or timeout occurred writing
* to a socket (returned in the {\bf Upnp_Event_Subscribe.ErrCode}
* field as part of the callback).
* \item {\tt UPNP_E_SOCKET_READ}: An error or timeout occurred reading
* from a socket (returned in the
* {\bf Upnp_Event_Subscribe.ErrCode} field as part of the
* callback).
* \item {\tt UPNP_E_SOCKET_BIND}: An error occurred binding the socket
* (returned in the {\bf Upnp_Event_Subscribe.ErrCode} field as
* part of the callback).
* \item {\tt UPNP_E_SOCKET_CONNECT}: An error occurred connecting to
* {\bf PublisherUrl} (returned in the {\bf
* Upnp_Event_Subscribe.ErrCode} field as part of the callback).
* \item {\tt UPNP_E_OUTOF_SOCKET}: An error occurred creating socket (
* returned in the {\bf Upnp_Event_Subscribe.ErrCode} field as
* part of the callback).
* \item {\tt UPNP_E_BAD_RESPONSE}: An error occurred in response from
* the publisher (returned in the {\bf
* Upnp_Event_Subscribe.ErrCode} field as part of the callback).
* \item {\tt UPNP_E_SUBSCRIBE_UNACCEPTED}: The publisher refused
* the subscription request (returned in the {\bf
* Upnp_Event_Subscribe.ErrCode} field as part of the callback).
* \end{itemize}
*/
EXPORT_SPEC int UpnpRenewSubscriptionAsync(
IN UpnpClient_Handle Hnd, /** The handle of the control point that
is renewing the subscription. */
IN int TimeOut, /** The requested subscription time. The
actual timeout value is returned when
the callback function is called. */
IN Upnp_SID SubsId, /** The ID for the subscription to renew. */
IN Upnp_FunPtr Fun, /** Pointer to a callback function to be
invoked when the renewal is complete. */
IN const void *Cookie /** Pointer to user data passed
to the callback function when invoked. */
);
/** {\bf UpnpSetMaxSubscriptions} sets the maximum number of subscriptions
* accepted per service. The default value accepts as many as system
* resources allow. If the number of current subscriptions for a service is
* greater than the requested value, the SDK accepts no new
* subscriptions or renewals, however, the SDK does not remove
* any current subscriptions.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_HANDLE}: The handle is not a valid device
* handle.
* \end{itemize}
*/
EXPORT_SPEC int UpnpSetMaxSubscriptions(
IN UpnpDevice_Handle Hnd, /** The handle of the device for which
the maximum number of subscriptions is
being set. */
IN int MaxSubscriptions /** The maximum number of subscriptions to be
allowed per service. */
);
/** {\bf UpnpSetMaxSubscriptionTimeOut} sets the maximum time-out accepted
* for a subscription request or renewal. The default value accepts the
* time-out set by the control point. If a control point requests a
* subscription time-out less than or equal to the maximum, the SDK
* grants the value requested by the control point. If the time-out
* is greater, the SDK returns the maximum value.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_HANDLE}: The handle is not a valid device
* handle.
* \end{itemize}
*/
EXPORT_SPEC int UpnpSetMaxSubscriptionTimeOut(
IN UpnpDevice_Handle Hnd, /** The handle of the device for which
the maximum subscription time-out is
being set. */
IN int MaxSubscriptionTimeOut /** The maximum subscription time-out to
be accepted. */
);
/** {\bf UpnpSubscribe} registers a control point to receive event
* notifications from another device. This operation is synchronous.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_HANDLE}: The handle is not a valid control
* point handle.
* \item {\tt UPNP_E_INVALID_URL}: {\bf PublisherUrl} is not a valid URL.
* \item {\tt UPNP_E_INVALID_PARAM}: {\bf Timeout} is not a valid pointer
* or {\bf SubsId} or {\bf PublisherUrl} is {\tt NULL}.
* \item {\tt UPNP_E_NETWORK_ERROR}: A network error occured.
* \item {\tt UPNP_E_SOCKET_WRITE}: An error or timeout occurred writing
* to a socket.
* \item {\tt UPNP_E_SOCKET_READ}: An error or timeout occurred reading
* from a socket.
* \item {\tt UPNP_E_SOCKET_BIND}: An error occurred binding a socket.
* \item {\tt UPNP_E_SOCKET_CONNECT}: An error occurred connecting to
* {\bf PublisherUrl}.
* \item {\tt UPNP_E_OUTOF_SOCKET}: An error occurred creating a socket.
* \item {\tt UPNP_E_BAD_RESPONSE}: An error occurred in response from
* the publisher.
* \item {\tt UPNP_E_SUBSCRIBE_UNACCEPTED}: The publisher refused
* the subscription request.
* \item {\tt UPNP_E_OUTOF_MEMORY}: Insufficient resources exist to
* complete this operation.
* \end{itemize}
*/
EXPORT_SPEC int UpnpSubscribe(
IN UpnpClient_Handle Hnd, /** The handle of the control point. */
IN const char *PublisherUrl, /** The URL of the service to subscribe to. */
INOUT int *TimeOut, /** Pointer to a variable containing
the requested subscription time. Upon
return, it contains the actual
subscription time returned from the
service. */
OUT Upnp_SID SubsId /** Pointer to a variable to receive the
subscription ID (SID). */
);
/** {\bf UpnpSubscribeAsync} performs the same operation as
* {\bf UpnpSubscribe}, but returns immediately and calls the registered
* callback function when the operation is complete.
*
* Note that many of the error codes for this function are returned in
* the {\bf Upnp_Event_Subscribe} structure. In those cases, the function
* returns {\tt UPNP_E_SUCCESS} and the appropriate error code will
* be in the {\bf Upnp_Event_Subscribe.ErrCode} field in the {\bf Event}
* structure passed to the callback.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_HANDLE}: The handle is not a valid control
* point handle.
* \item {\tt UPNP_E_INVALID_URL}: The {\bf PublisherUrl} is not a valid
* URL.
* \item {\tt UPNP_E_INVALID_PARAM}: Either {\bf TimeOut} or {\bf Fun} or
* {\bf PublisherUrl} is not a valid pointer.
* \item {\tt UPNP_E_OUTOF_MEMORY}: Insufficient resources exist to
* complete this operation.
* \item {\tt UPNP_E_NETWORK_ERROR}: A network error occured (returned in
* the {\bf Upnp_Event_Subscribe.ErrCode} field as part of the
* callback).
* \item {\tt UPNP_E_SOCKET_WRITE}: An error or timeout occurred writing
* to a socket (returned in the
* {\bf Upnp_Event_Subscribe.ErrCode} field as part of the
* callback).
* \item {\tt UPNP_E_SOCKET_READ}: An error or timeout occurred reading
* from a socket (returned in the
* {\bf Upnp_Event_Subscribe.ErrCode} field as part of the
* callback).
* \item {\tt UPNP_E_SOCKET_BIND}: An error occurred binding the socket
* (returned in the {\bf Upnp_Event_Subscribe.ErrCode} field as
* part of the callback).
* \item {\tt UPNP_E_SOCKET_CONNECT}: An error occurred connecting to
* {\bf PublisherUrl} (returned in the {\bf
* Upnp_Event_Subscribe.ErrCode} field as part of the callback).
* \item {\tt UPNP_E_OUTOF_SOCKET}: An error occurred creating the
* socket (returned in the {\bf Upnp_Event_Subscribe.ErrCode}
* field as part of the callback).
* \item {\tt UPNP_E_BAD_RESPONSE}: An error occurred in response from
* the publisher (returned in the {\bf
* Upnp_Event_Subscribe.ErrCode} field as part of the callback).
* \item {\tt UPNP_E_SUBSCRIBE_UNACCEPTED}: The publisher refused
* the subscription request (returned in the {\bf
* Upnp_Event_Subscribe.ErrCode} field as part of the callback).
* \end{itemize}
*/
EXPORT_SPEC int UpnpSubscribeAsync(
IN UpnpClient_Handle Hnd, /** The handle of the control point that
is subscribing. */
IN const char *PublisherUrl, /** The URL of the service to subscribe
to. */
IN int TimeOut, /** The requested subscription time. Upon
return, it contains the actual
subscription time returned from the
service. */
IN Upnp_FunPtr Fun, /** Pointer to the callback function for
this subscribe request. */
IN const void *Cookie /** A user data value passed to the
callback function when invoked. */
);
/** {\bf UpnpUnSubscribe} removes the subscription of a control point from a
* service previously subscribed to using {\bf UpnpSubscribe} or
* {\bf UpnpSubscribeAsync}. This is a synchronous call.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_HANDLE}: The handle is not a valid control
* point handle.
* \item {\tt UPNP_E_INVALID_SID}: The {\bf SubsId} is not a valid
* subscription ID.
* \item {\tt UPNP_E_NETWORK_ERROR}: A network error occured.
* \item {\tt UPNP_E_SOCKET_WRITE}: An error or timeout occurred writing
* to a socket.
* \item {\tt UPNP_E_SOCKET_READ}: An error or timeout occurred reading
* from a socket.
* \item {\tt UPNP_E_SOCKET_BIND}: An error occurred binding a socket.
* \item {\tt UPNP_E_SOCKET_CONNECT}: An error occurred connecting to
* {\bf PublisherUrl}.
* \item {\tt UPNP_E_OUTOF_SOCKET}: An error ocurred creating a socket.
* \item {\tt UPNP_E_BAD_RESPONSE}: An error occurred in response from
* the publisher.
* \item {\tt UPNP_E_UNSUBSCRIBE_UNACCEPTED}: The publisher refused
* the unsubscribe request (the client is still unsubscribed and
* no longer receives events).
* \item {\tt UPNP_E_OUTOF_MEMORY}: Insufficient resources exist to
* complete this operation.
* \end{itemize}
*/
EXPORT_SPEC int UpnpUnSubscribe(
IN UpnpClient_Handle Hnd, /** The handle of the subscribed control
point. */
IN Upnp_SID SubsId /** The ID returned when the control point
subscribed to the service. */
);
/** {\bf UpnpUnSubscribeAsync} removes a subscription of a control
* point from a service previously subscribed to using {\bf
* UpnpSubscribe} or {\bf UpnpSubscribeAsync}, generating a callback
* when the operation is complete.
*
* Note that many of the error codes for this function are returned in
* the {\bf Upnp_Event_Subscribe} structure. In those cases, the function
* returns {\tt UPNP_E_SUCCESS} and the appropriate error code will
* be in the {\bf Upnp_Event_Subscribe.ErrCode} field in the {\bf Event}
* structure passed to the callback.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_HANDLE}: The handle is not a valid control
* point handle.
* \item {\tt UPNP_E_INVALID_SID}: The {\bf SubsId} is not a valid SID.
* \item {\tt UPNP_E_INVALID_PARAM}: {\bf Fun} is not a valid callback
* function pointer.
* \item {\tt UPNP_E_OUTOF_MEMORY}: Insufficient resources exist to
* complete this operation.
* \item {\tt UPNP_E_NETWORK_ERROR}: A network error occured (returned in
* the {\bf Upnp_Event_Subscribe.ErrCode} field as part of the
* callback).
* \item {\tt UPNP_E_SOCKET_WRITE}: An error or timeout occurred writing
* to a socket (returned in the {\bf
* Upnp_Event_Subscribe.ErrCode} field as part of the callback).
* \item {\tt UPNP_E_SOCKET_READ}: An error or timeout occurred reading
* from a socket (returned in the
* {\bf Upnp_Event_Subscribe.ErrCode} field as part of the
* callback).
* \item {\tt UPNP_E_SOCKET_BIND}: An error occurred binding the socket
* (returned in the {\bf Upnp_Event_Subscribe.ErrCode} field as
* part of the callback).
* \item {\tt UPNP_E_SOCKET_CONNECT}: An error occurred connecting to
* {\bf PublisherUrl} (returned in the {\bf
* Upnp_Event_Subscribe.ErrCode} field as part of the callback).
* \item {\tt UPNP_E_OUTOF_SOCKET}: An error occurred creating a socket (
* returned in the {\bf Upnp_Event_Subscribe.ErrCode} field as
* part of the callback).
* \item {\tt UPNP_E_BAD_RESPONSE}: An error occurred in response from
* the publisher (returned in the {\bf
* Upnp_Event_Subscribe.ErrCode} field as part of the callback).
* \item {\tt UPNP_E_UNSUBSCRIBE_UNACCEPTED}: The publisher refused
* the subscription request (returned in the {\bf
* Upnp_Event_Subscribe.ErrCode} field as part of the callback).
* \end{itemize} */
EXPORT_SPEC int UpnpUnSubscribeAsync(
IN UpnpClient_Handle Hnd, /** The handle of the subscribed control
point. */
IN Upnp_SID SubsId, /** The ID returned when the
control point subscribed to the service. */
IN Upnp_FunPtr Fun, /** Pointer to a callback function to be
called when the operation is complete. */
IN const void *Cookie /** Pointer to user data to pass to the
callback function when invoked. */
);
/*! @} */ /* Eventing */
/******************************************************************************
******************************************************************************
* *
* C L I E N T - A P I *
* *
******************************************************************************
******************************************************************************/
/*! @name Control Point HTTP API */
/*! @{ */
/** {\bf UpnpDownloadUrlItem} downloads a file specified in a URL.
* The SDK allocates the memory for {\bf outBuf} and the
* application is responsible for freeing this memory. Note that
* the item is passed as a single buffer. Large items should not
* be transferred using this function.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_PARAM}: Either {\bf url}, {\bf outBuf}
* or {\bf contentType} is not a valid pointer.
* \item {\tt UPNP_E_INVALID_URL}: The {\bf url} is not a valid
* URL.
* \item {\tt UPNP_E_OUTOF_MEMORY}: Insufficient resources exist to
* download this file.
* \item {\tt UPNP_E_NETWORK_ERROR}: A network error occurred.
* \item {\tt UPNP_E_SOCKET_WRITE}: An error or timeout occurred writing
* to a socket.
* \item {\tt UPNP_E_SOCKET_READ}: An error or timeout occurred reading
* from a socket.
* \item {\tt UPNP_E_SOCKET_BIND}: An error occurred binding a socket.
* \item {\tt UPNP_E_SOCKET_CONNECT}: An error occurred connecting a
* socket.
* \item {\tt UPNP_E_OUTOF_SOCKET}: Too many sockets are currently
* allocated.
* \end{itemize}
*/
EXPORT_SPEC int UpnpDownloadUrlItem(
IN const char *url, /** URL of an item to download. */
OUT char **outBuf, /** Buffer to store the downloaded item. */
OUT char *contentType /** HTTP header value content type if
present. It should be at least
{\tt LINE_SIZE} bytes in size. */
);
/** {\bf UpnpOpenHttpGet} gets a file specified in a URL.
* The SDK allocates the memory for {\bf handle} and
* {\bf contentType}, the application is responsible for freeing this memory.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_PARAM}: Either {\bf url}, {\bf handle},
* {\bf contentType}, {\bf contentLength} or {\bf httpStatus}
* is not a valid pointer.
* \item {\tt UPNP_E_INVALID_URL}: The {\bf url} is not a valid
* URL.
* \item {\tt UPNP_E_OUTOF_MEMORY}: Insufficient resources exist to
* download this file.
* \item {\tt UPNP_E_NETWORK_ERROR}: A network error occurred.
* \item {\tt UPNP_E_SOCKET_WRITE}: An error or timeout occurred writing
* to a socket.
* \item {\tt UPNP_E_SOCKET_READ}: An error or timeout occurred reading
* from a socket.
* \item {\tt UPNP_E_SOCKET_BIND}: An error occurred binding a socket.
* \item {\tt UPNP_E_SOCKET_CONNECT}: An error occurred connecting a
* socket.
* \item {\tt UPNP_E_OUTOF_SOCKET}: Too many sockets are currently
* allocated.
* \item {\tt UPNP_E_BAD_RESPONSE}: A bad response was received from the
* remote server.
* \end{itemize}
*/
EXPORT_SPEC int UpnpOpenHttpGet(
IN const char *url, /** The URL of an item to get. */
IN OUT void **handle, /** A pointer to store the handle for
this connection. */
IN OUT char **contentType, /** A buffer to store the media type of
the item. */
IN OUT int *contentLength, /** A pointer to store the length of the
item. */
IN OUT int *httpStatus, /** The status returned on receiving a
response message. */
IN int timeout /** The time out value sent with the
request during which a response is
expected from the server, failing
which, an error is reported back to
the user. */
);
/** {\bf UpnpOpenHttpGetProxy} gets a file specified in a URL through the
* specified proxy.
* The SDK allocates the memory for {\bf handle} and
* {\bf contentType}, the application is responsible for freeing this memory.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_PARAM}: Either {\bf url}, {\bf handle},
* {\bf contentType}, {\bf contentLength} or {\bf httpStatus}
* is not a valid pointer.
* \item {\tt UPNP_E_INVALID_URL}: The {\bf url} is not a valid
* URL.
* \item {\tt UPNP_E_OUTOF_MEMORY}: Insufficient resources exist to
* download this file.
* \item {\tt UPNP_E_NETWORK_ERROR}: A network error occurred.
* \item {\tt UPNP_E_SOCKET_WRITE}: An error or timeout occurred writing
* to a socket.
* \item {\tt UPNP_E_SOCKET_READ}: An error or timeout occurred reading
* from a socket.
* \item {\tt UPNP_E_SOCKET_BIND}: An error occurred binding a socket.
* \item {\tt UPNP_E_SOCKET_CONNECT}: An error occurred connecting a
* socket.
* \item {\tt UPNP_E_OUTOF_SOCKET}: Too many sockets are currently
* allocated.
* \item {\tt UPNP_E_BAD_RESPONSE}: A bad response was received from the
* remote server.
* \end{itemize}
*/
EXPORT_SPEC int UpnpOpenHttpGetProxy(
IN const char *url, /** The URL of an item to get. */
IN const char *proxy_str, /** The URL of the proxy. */
IN OUT void **handle, /** A pointer to store the handle for
this connection. */
IN OUT char **contentType, /** A buffer to store the media type of
the item. */
IN OUT int *contentLength, /** A pointer to store the length of the
item. */
IN OUT int *httpStatus, /** The status returned on receiving a
response message. */
IN int timeout /** The time out value sent with the
request during which a response is
expected from the server, failing
which, an error is reported back to
the user. */
);
/** {\bf UpnpOpenHttpGetEx} gets specified number of bytes from a file
* specified in the URL. The number of bytes is specified through a low
* count and a high count which are passed as a range of bytes for the
* request. The SDK allocates the memory for {\bf handle} and
* {\bf contentType}, the application is responsible for freeing this memory.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_PARAM}: Either {\bf url}, {\bf handle},
* {\bf contentType}, {\bf contentLength} or {\bf httpStatus}
* is not a valid pointer.
* \item {\tt UPNP_E_INVALID_URL}: The {\bf url} is not a valid
* URL.
* \item {\tt UPNP_E_OUTOF_MEMORY}: Insufficient resources exist to
* download this file.
* \item {\tt UPNP_E_NETWORK_ERROR}: A network error occurred.
* \item {\tt UPNP_E_SOCKET_WRITE}: An error or timeout occurred writing
* to a socket.
* \item {\tt UPNP_E_SOCKET_READ}: An error or timeout occurred reading
* from a socket.
* \item {\tt UPNP_E_SOCKET_BIND}: An error occurred binding a socket.
* \item {\tt UPNP_E_SOCKET_CONNECT}: An error occurred connecting a
* socket.
* \item {\tt UPNP_E_OUTOF_SOCKET}: Too many sockets are currently
* allocated.
* \item {\tt UPNP_E_BAD_RESPONSE}: A bad response was received from the
* remote server.
* \end{itemize}
*/
EXPORT_SPEC int UpnpOpenHttpGetEx(
IN const char *url, /** The URL of the item to get. */
IN OUT void **handle, /** A pointer to store the handle for
this connection. */
IN OUT char **contentType, /** A buffer to store the media type of the
item. */
IN OUT int *contentLength, /** A buffer to store the length of the
item. */
IN OUT int *httpStatus, /** The status returned on receiving a
response message from the remote
server. */
IN int lowRange, /** An integer value representing the low
end of a range to retrieve. */
IN int highRange, /** An integer value representing the high
end of a range to retrieve. */
IN int timeout /** A time out value sent with the request
during which a response is expected
from the server, failing which, an
error is reported back to the user. */
);
/** {\bf UpnpReadHttpGet} gets specified number of bytes from a file
* specified in a URL.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_PARAM}: Either {\bf handle}, {\bf buf}
* or {\bf size} is not a valid pointer.
* \item {\tt UPNP_E_BAD_RESPONSE}: A bad response was received from the
* remote server.
* \item {\tt UPNP_E_BAD_HTTPMSG}: Either the request or response was in
* the incorrect format.
* \item {\tt UPNP_E_CANCELED}: another thread called UpnpCancelHttpGet.
* \end{itemize}
*
* Note: In case of return values, the status code parameter of the passed
* in handle value may provide additional information on the return
* value.
*/
EXPORT_SPEC int UpnpReadHttpGet(
IN void *handle, /** The token created by the call to
{\bf UpnpOpenHttpGet}. */
IN OUT char *buf, /** The buffer to store the read item. */
IN OUT unsigned int *size, /** The size of the buffer to be read. */
IN int timeout /** The time out value sent with the
request during which a response is
expected from the server, failing
which, an error is reported back to
the user. */
);
/** {\bf UpnpHttpGetProgress} rettrieve progress information of a http-get
* transfer.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_PARAM}: Either {\bf handle}, {\bf length}
* or {\bf total} is not a valid pointer.
* \end{itemize}
*
*/
EXPORT_SPEC int UpnpHttpGetProgress(
IN void *handle, /** The token created by the call to
{\bf UpnpOpenHttpGet}. */
OUT unsigned int *length, /** The number of bytes received. */
OUT unsigned int *total /** The content length. */
);
/** {\bf UpnpCancelHttpGet} set the cancel flag of the {\bf handle}
* parameter.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_PARAM}: {\bf handle} is not a valid pointer.
* \end{itemize}
*/
EXPORT_SPEC int UpnpCancelHttpGet(IN void *handle);
/** {\bf UpnpCloseHttpGet} closes the connection and frees memory that was
* allocated for the {\bf handle} parameter.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_PARAM}: {\bf handle} is not a valid pointer.
* \end{itemize}
*/
EXPORT_SPEC int UpnpCloseHttpGet(IN void *handle);
/** {\bf UpnpOpenHttpPost} makes an HTTP POST request message, opens a
* connection to the server and sends the POST request to the server if
* the connection to the server succeeds.
* The SDK allocates the memory for {\bf handle} and
* {\bf contentType}, the application is responsible for freeing this memory.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_PARAM}: Either {\bf url}, {\bf handle}
* or {\bf contentType} is not a valid pointer.
* \item {\tt UPNP_E_INVALID_URL}: The {\bf url} is not a valid
* URL.
* \item {\tt UPNP_E_OUTOF_MEMORY}: Insufficient resources exist to
* download this file.
* \item {\tt UPNP_E_SOCKET_ERROR}: Error occured allocating a socket and
* resources or an error occurred binding a socket.
* \item {\tt UPNP_E_SOCKET_WRITE}: An error or timeout occurred writing
* to a socket.
* \item {\tt UPNP_E_SOCKET_CONNECT}: An error occurred connecting a
* socket.
* \item {\tt UPNP_E_OUTOF_SOCKET}: Too many sockets are currently
* allocated.
* \end{itemize}
*/
EXPORT_SPEC int UpnpOpenHttpPost(
IN const char *url, /** The URL in which to send the POST
request. */
IN OUT void **handle, /** A pointer in which to store the
handle for this connection. This
handle is required for futher
operations over this connection. */
IN const char *contentType, /** A buffer to store the media type of
content being sent. */
IN int contentLength, /** The length of the content, in bytes,
being posted. */
IN int timeout /** The time out value sent with the
request during which a response is
expected from the receiver, failing
which, an error is reported. */
);
/** {\bf UpnpWriteHttpPost} sends a request to a server to copy the contents of
* a buffer to the URI specified in the {\bf UpnpOpenHttpPost} call.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_PARAM}: Either {\bf handle}, {\bf buf}
* or {\bf size} is not a valid pointer.
* \item {\tt UPNP_E_SOCKET_WRITE}: An error or timeout occurred writing
* to a socket.
* \item {\tt UPNP_E_OUTOF_SOCKET}: Too many sockets are currently
* allocated.
* \end{itemize}
*/
EXPORT_SPEC int UpnpWriteHttpPost(
IN void *handle, /** The handle of the connection created
by the call to {\bf UpnpOpenHttpPost}. */
IN char *buf, /** The buffer to be posted. */
IN unsigned int *size, /** The size, in bytes of {\bf buf}. */
IN int timeout /** A timeout value sent with the request
during which a response is expected
from the server, failing which, an
error is reported. */
);
/** {\bf UpnpCloseHttpPost} sends and receives any pending data, closes the
* connection with the server, and frees memory allocated during the
* {\bfUpnpOpenHttpPost} call.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_PARAM}: Either {\bf handle}, or
* {\bf httpStatus} is not a valid pointer.
* \item {\tt UPNP_E_SOCKET_READ}: An error or timeout occurred reading
* from a socket.
* \item {\tt UPNP_E_OUTOF_SOCKET}: Too many sockets are currently
* allocated.
* \end{itemize}
*/
EXPORT_SPEC int UpnpCloseHttpPost(
IN void *handle, /** The handle of the connection to close,
created by the call to
{\bf UpnpOpenHttpPost}. */
IN OUT int *httpStatus, /** A pointer to a buffer to store the
final status of the connection. */
IN int timeout /** A time out value sent with the request
during which a response is expected from
the server, failing which, an error is
reported. */
);
/** {\bf UpnpDownloadXmlDoc} downloads an XML document specified in a URL.
* The SDK parses the document and returns it in the form of a
* DOM document. The application is responsible for freeing the DOM document.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPNP_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_PARAM}: Either {\bf url} or {\bf xmlDoc}
* is not a valid pointer.
* \item {\tt UPNP_E_INVALID_DESC}: The XML document was not
* found or it does not contain a valid XML description.
* \item {\tt UPNP_E_INVALID_URL}: The {\bf url} is not a valid
* URL.
* \item {\tt UPNP_E_OUTOF_MEMORY}: There are insufficient resources to
* download the XML document.
* \item {\tt UPNP_E_NETWORK_ERROR}: A network error occurred.
* \item {\tt UPNP_E_SOCKET_WRITE}: An error or timeout occurred writing
* to a socket.
* \item {\tt UPNP_E_SOCKET_READ}: An error or timeout occurred reading
* from a socket.
* \item {\tt UPNP_E_SOCKET_BIND}: An error occurred binding a socket.
* \item {\tt UPNP_E_SOCKET_CONNECT}: An error occurred connecting the
* socket.
* \item {\tt UPNP_E_OUTOF_SOCKET}: Too many sockets are currently
* allocated.
* \end{itemize}
*/
EXPORT_SPEC int UpnpDownloadXmlDoc(
IN const char *url, /** URL of the XML document. */
OUT IXML_Document **xmlDoc /** A pointer in which to store the
XML document. */
);
/*! @} */ /* Control Point HTTP API */
/******************************************************************************
******************************************************************************
* *
* W E B S E R V E R A P I *
* *
******************************************************************************
******************************************************************************/
/*! @name Web Server API */
/*! @{ */
/** {\bf UpnpSetWebServerRootDir} sets the document root directory for
* the internal web server. This directory is considered the
* root directory (i.e. "/") of the web server.
*
* This function also activates or deactivates the web server.
* To disable the web server, pass {\tt NULL} for {\bf rootDir}; to
* activate, pass a valid directory string.
*
* Note that this function is not available when the web server is not
* compiled into the SDK.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPPN_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_ARGUMENT}: {\bf rootDir} is an invalid
* directory.
* \end{itemize}
*/
EXPORT_SPEC int UpnpSetWebServerRootDir(
IN const char* rootDir /** Path of the root directory of the web
server. */
);
/** {\bf UpnpSetVirtualDirCallbacks} sets the callback function to be used to
* access a virtual directory. Refer to the description of
* {\bf UpnpVirtualDirCallbacks} for a description of the functions.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPPN_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_ARGUMENT}: {\bf callbacks} is not a valid
* pointer.
* \end{itemize}
*/
EXPORT_SPEC int UpnpSetVirtualDirCallbacks(
IN struct UpnpVirtualDirCallbacks *callbacks /** Pointer to a structure
containing points to the
virtual interface
functions. */
);
/** {\bf UpnpEnableWebServer} enables or disables the webserver. A value of
* {\tt TRUE} enables the webserver, {\tt FALSE} disables it.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPPN_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_ARGUMENT}: {\bf enable} is not valid.
* \end{itemize}
*/
EXPORT_SPEC int UpnpEnableWebserver(
IN int enable /** {\tt TRUE} to enable, {\tt FALSE} to disable. */
);
/** {\bf UpnpIsWebServerEnabled} returns {\tt TRUE} if the webserver is
* enabled, or {\tt FALSE} if it is not.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt TRUE}: The webserver is enabled.
* \item {\tt FALSE}: The webserver is not enabled
* \end{itemize}
*/
EXPORT_SPEC int UpnpIsWebserverEnabled();
/** {\bf UpnpAddVirtualDir} adds a virtual directory mapping.
*
* All webserver requests containing the given directory are read using
* functions contained in a {\bf UpnpVirtualDirCallbacks} structure registered
* via {\bf UpnpSetVirtualDirCallbacks}.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPPN_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_ARGUMENT}: {\bf dirName} is not valid.
* \end{itemize}
*/
EXPORT_SPEC int UpnpAddVirtualDir(
IN const char *dirName /** The name of the new directory mapping to add.
*/
);
/** {\bf UpnpRemoveVirtualDir} removes a virtual directory mapping made with
* {\bf UpnpAddVirtualDir}.
*
* @return [int] An integer representing one of the following:
* \begin{itemize}
* \item {\tt UPPN_E_SUCCESS}: The operation completed successfully.
* \item {\tt UPNP_E_INVALID_ARGUMENT}: {\bf dirName} is not valid.
* \end{itemize}
*/
EXPORT_SPEC int UpnpRemoveVirtualDir(
IN const char *dirName /** The name of the virtual directory mapping to
remove. */
);
/** {\bf UpnpRemoveAllVirtualDirs} removes all virtual directory mappings.
*
* @return [void] This function does not return a value.
*
*/
EXPORT_SPEC void UpnpRemoveAllVirtualDirs( );
EXPORT_SPEC void UpnpFree(
IN void *item /* The item to free. */
);
/*! @} */ /* Web Server API */
#ifdef __cplusplus
}
#endif /* __cplusplus */
/*! @} */ /* The API */
#endif
|