1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252
|
<?xml version="1.0"?>
<doc>
<assembly>
<name>RobotRaconteurNET</name>
</assembly>
<members>
<!-- constants -->
<member name="T:RobotRaconteur.DataTypes">
<summary>
Type codes for types supported by Robot Raconteur
</summary>
<remarks>
<para>
Data type codes are used in messages and service definition parsers.
</para>
<para> Data is always stored as little-endian, except for UUID which are big endian
</para>
</remarks>
</member>
<member name="F:RobotRaconteur.DataTypes.void_t">
<summary>void or null type</summary>
</member>
<member name="F:RobotRaconteur.DataTypes.double_t">
<summary>IEEE-754 64-bit floating point number</summary>
</member>
<member name="F:RobotRaconteur.DataTypes.single_t">
<summary>IEEE-754 32-bit floating point number</summary>
</member>
<member name="F:RobotRaconteur.DataTypes.int8_t">
<summary>8-bit signed integer</summary>
</member>
<member name="F:RobotRaconteur.DataTypes.uint8_t">
<summary>8-bit unsigned integer</summary>
</member>
<member name="F:RobotRaconteur.DataTypes.int16_t">
<summary>16-bit signed integer</summary>
</member>
<member name="F:RobotRaconteur.DataTypes.uint16_t">
<summary>16-bit unsigned integer</summary>
</member>
<member name="F:RobotRaconteur.DataTypes.int32_t">
<summary>32-bit signed integer</summary>
</member>
<member name="F:RobotRaconteur.DataTypes.uint32_t">
<summary>32-bit unsigned integer</summary>
</member>
<member name="F:RobotRaconteur.DataTypes.int64_t">
<summary>64-bit signed integer</summary>
</member>
<member name="F:RobotRaconteur.DataTypes.uint64_t">
<summary>64-bit unsigned integer</summary>
</member>
<member name="F:RobotRaconteur.DataTypes.string_t">
<summary>UTF-8 string</summary>
</member>
<member name="F:RobotRaconteur.DataTypes.cdouble_t">
<summary>128-bit complex double (real,imag)</summary>
</member>
<member name="F:RobotRaconteur.DataTypes.csingle_t">
<summary>64-bit complex float (real,imag)</summary>
</member>
<member name="F:RobotRaconteur.DataTypes.bool_t">
<summary>8-bit boolean</summary>
</member>
<member name="F:RobotRaconteur.DataTypes.structure_t">
<summary>structure (nested message type)</summary>
</member>
<member name="F:RobotRaconteur.DataTypes.vector_t">
<summary>map with int32 key (nested message type)</summary>
</member>
<member name="F:RobotRaconteur.DataTypes.dictionary_t">
<summary>map with string key (nested message type)</summary>
</member>
<member name="F:RobotRaconteur.DataTypes.object_t">
<summary>object type (not serializable)</summary>
</member>
<member name="F:RobotRaconteur.DataTypes.varvalue_t">
<summary>varvalue type (not serializable)</summary>
</member>
<member name="F:RobotRaconteur.DataTypes.varobject_t">
<summary>varobject type (not serializable)</summary>
</member>
<member name="F:RobotRaconteur.DataTypes.list_t">
<summary>list type (nested message type)</summary>
</member>
<member name="F:RobotRaconteur.DataTypes.pod_t">
<summary>pod type (nested message type)</summary>
</member>
<member name="F:RobotRaconteur.DataTypes.pod_array_t">
<summary>pod array type (nested message type)</summary>
</member>
<member name="F:RobotRaconteur.DataTypes.pod_multidimarray_t">
<summary>pod multidimarray type (nested message type)</summary>
</member>
<member name="F:RobotRaconteur.DataTypes.enum_t">
<summary>enum type (not serializable uses int32 for messages)</summary>
</member>
<member name="F:RobotRaconteur.DataTypes.namedtype_t">
<summary>namedtype definition (not serializable)</summary>
</member>
<member name="F:RobotRaconteur.DataTypes.namedarray_t">
<summary>namedarray type (not serializable)</summary>
</member>
<member name="F:RobotRaconteur.DataTypes.namedarray_array_t">
<summary>namedarray array type (nested message type)</summary>
</member>
<member name="F:RobotRaconteur.DataTypes.namedarray_multidimarray_t">
<summary>namedarray multidimarray type (nested message type)</summary>
</member>
<member name="F:RobotRaconteur.DataTypes.multidimarray_t">
<summary>multi-dimensional numeric array (nested message type)</summary>
</member>
<member name="T:RobotRaconteur.DataTypes_ArrayTypes">
<summary>
Array type enum for TypeDefinition parser class
</summary>
</member>
<member name="F:RobotRaconteur.DataTypes_ArrayTypes.ArrayTypes_none">
<summary>type is not an array</summary>
</member>
<member name="F:RobotRaconteur.DataTypes_ArrayTypes.ArrayTypes_array">
<summary>type is a single dimensional array</summary>
</member>
<member name="F:RobotRaconteur.DataTypes_ArrayTypes.ArrayTypes_multidimarray">
<summary>type is a multidimensional array</summary>
</member>
<member name="T:RobotRaconteur.DataTypes_ContainerTypes">
<summary>
Container type enum for TypeDefinition parser class
</summary>
</member>
<member name="F:RobotRaconteur.DataTypes_ContainerTypes.ContainerTypes_none">
<summary>type does not have a container</summary>
</member>
<member name="F:RobotRaconteur.DataTypes_ContainerTypes.ContainerTypes_list">
<summary>type has a list container</summary>
</member>
<member name="F:RobotRaconteur.DataTypes_ContainerTypes.ContainerTypes_map_int32">
<summary>type has a map with int32 keys container</summary>
</member>
<member name="F:RobotRaconteur.DataTypes_ContainerTypes.ContainerTypes_map_string">
<summary>type has a map with string keys container</summary>
</member>
<member name="F:RobotRaconteur.DataTypes_ContainerTypes.ContainerTypes_generator">
<summary>type has a generator container. Only valid for use with function generator members</summary>
</member>
<member name="T:RobotRaconteur.RobotRaconteurNET">
<summary>
Global RobotRaconteurNET functions
</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.MessageFlags_ROUTING_INFO">
<summary>Message contains ROUTING_INFO section</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.MessageFlags_ENDPOINT_INFO">
<summary>Message contains ENDPOINT_INFO section</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.MessageFlags_PRIORITY">
<summary>Message contains PRIORITY section</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.MessageFlags_UNRELIABLE">
<summary>Message is unreliable and may be dropped</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.MessageFlags_META_INFO">
<summary>Message contains META_INFO section</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.MessageFlags_STRING_TABLE">
<summary>Message contains STRING_TABLE section</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.MessageFlags_MULTIPLE_ENTRIES">
<summary>Message contains MULTIPLE_ENTRIES section. If unset, message contains one entry</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.MessageFlags_EXTENDED">
<summary>Message contains EXTENDED section</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.MessageFlags_Version2Compat">
<summary>Message flags for compatibility with Message Format Version 2</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.MessageEntryFlags_SERVICE_PATH_STR">
<summary>MessageEntry contains SERVICE_PATH_STR section</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.MessageEntryFlags_SERVICE_PATH_CODE">
<summary>MessageEntry contains SERVICE_PATH_CODE section</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.MessageEntryFlags_MEMBER_NAME_STR">
<summary>MessageEntry contains MEMBER_NAME_STR section</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.MessageEntryFlags_MEMBER_NAME_CODE">
<summary>MessageEntry contains MEMBER_NAME_CODE section</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.MessageEntryFlags_REQUEST_ID">
<summary>MessageEntry contains REQUEST_ID section</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.MessageEntryFlags_ERROR">
<summary>MessageEntry contains ERROR section</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.MessageEntryFlags_META_INFO">
<summary>MessageEntry contains META_INFO section</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.MessageEntryFlags_EXTENDED">
<summary>MessageEntry contains EXTENDED section</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.MessageEntryFlags_Version2Compat">
<summary>MessageEntry flags for compatibility with Message Format Version 2</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.MessageElementFlags_ELEMENT_NAME_STR">
<summary>MessageElement contains ELEMENT_NAME_STR section</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.MessageElementFlags_ELEMENT_NAME_CODE">
<summary>MessageElement contains ELEMENT_NAME_CODE section</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.MessageElementFlags_ELEMENT_NUMBER">
<summary>MessageElement contains ELEMENT_NUMBER section</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.MessageElementFlags_ELEMENT_TYPE_NAME_STR">
<summary>MessageElement contains ELEMENT_TYPE_NAME_STR section</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.MessageElementFlags_ELEMENT_TYPE_NAME_CODE">
<summary>MessageElement contains ELEMENT_TYPE_NAME_CODE section</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.MessageElementFlags_META_INFO">
<summary>MessageElement contains META_INFO section</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.MessageElementFlags_EXTENDED">
<summary>MessageElement contains EXTENDED section</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.MessageElementFlags_Version2Compat">
<summary>MessageElement flags for compatibility with Message Format Version 2</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNET.RR_VALUE_LIFESPAN_INFINITE">
<summary>Set wire values to have infinite lifespan and will not expire</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.TranspartCapabilityCode_PAGE_MASK">
<summary>Page mask for transport capability code</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.TransportCapabilityCode_MESSAGE2_BASIC_PAGE">
<summary>Message Version 2 transport capability page code</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.TransportCapabilityCode_MESSAGE2_BASIC_ENABLE">
<summary>Enable Message Version 2 transport capability flag</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.TransportCapabilityCode_MESSAGE2_BASIC_CONNECTCOMBINED">
<summary>Enable Message Version 2 connect combined transport capability flag</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.TransportCapabilityCode_MESSAGE4_BASIC_PAGE">
<summary>Message Version 4 transport capability page code</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.TransportCapabilityCode_MESSAGE4_BASIC_ENABLE">
<summary>Enable Message Version 4 transport capability flag</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.TransportCapabilityCode_MESSAGE4_BASIC_CONNECTCOMBINED">
<summary>Enable Message Version 4 connect combine transport capability flag</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.TransportCapabilityCode_MESSAGE4_STRINGTABLE_PAGE">
<summary>Message Version 4 String Table capability page code</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.TransportCapabilityCode_MESSAGE4_STRINGTABLE_ENABLE">
<summary>Enable Message Version 4 String Table transport capability code</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.TransportCapabilityCode_MESSAGE4_STRINGTABLE_MESSAGE_LOCAL2">
<summary>Enable Message Version 4 local String Table capability code</summary>
</member>
<member name="P:RobotRaconteur.RobotRaconteurNET.TransportCapabilityCode_MESSAGE4_STRINGTABLE_STANDARD_TABLE4">
<summary>Enable Message Version 4 standard String Table capability code</summary>
</member>
<member name="T:RobotRaconteur.MessageEntryType">
<summary>
Message entry type codes
</summary>
<remarks>
<para>
Message entries are sent between nodes stored in messages, and represent
requests, responses, or packets. The type of the entry is specified through
the message entry type code. These type codes are similar to op-codes. This
enum contains the defined entry type codes.
</para>
<para>
Odd codes represent requests or packets, even codes
represent responses.
</para>
<para> Entry types less than 500 are considered "special requests" that can be used
before a session is established.
</para>
</remarks>
</member>
<member name="F:RobotRaconteur.MessageEntryType.Null">
<summary>no-op</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.StreamOp">
<summary>Stream operation request (transport only)</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.StreamOpRet">
<summary>Stream operation response (transport only)</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.StreamCheckCapability">
<summary>Stream check capability request (transport only)</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.StreamCheckCapabilityRet">
<summary>Stream check capability response (transport only)</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.GetServiceDesc">
<summary>Get service definition request</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.GetServiceDescRet">
<summary>Get service definition response</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.ObjectTypeName">
<summary>Get object qualified type name request</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.ObjectTypeNameRet">
<summary>Get object qualified type name response</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.ServiceClosed">
<summary>Service closed notification packet</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.ServiceClosedRet">
<summary>(reserved)</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.ConnectClient">
<summary>Connect client request</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.ConnectClientRet">
<summary>Connect client response</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.DisconnectClient">
<summary>Disconnect client request</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.DisconnectClientRet">
<summary>Disconnect client response</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.ConnectionTest">
<summary>Ping request</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.ConnectionTestRet">
<summary>Pong response</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.GetNodeInfo">
<summary>Get node information request (NodeID and NodeName)</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.GetNodeInfoRet">
<summary>Get node information response</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.ReconnectClient">
<summary>(reserved)</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.ReconnectClientRet">
<summary>(reserved)</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.NodeCheckCapability">
<summary>Get node capability request</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.NodeCheckCapabilityRet">
<summary>Get node capability response</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.GetServiceAttributes">
<summary>Get service attributes request</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.GetServiceAttributesRet">
<summary>Get service attributes response</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.ConnectClientCombined">
<summary>Connect client combined operation request</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.ConnectClientCombinedRet">
<summary>Connect client combined operation response</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.EndpointCheckCapability">
<summary>Get endpoint capability request</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.EndpointCheckCapabilityRet">
<summary>Get endpoint capability response</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.ServiceCheckCapabilityReq">
<summary>Get service capability request</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.ServiceCheckCapabilityRet">
<summary>Get service capability response</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.ClientKeepAliveReq">
<summary>Client keep alive request</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.ClientKeepAliveRet">
<summary>Client keep alive response</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.ClientSessionOpReq">
<summary>Client session management operation request</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.ClientSessionOpRet">
<summary>Client session management operation response</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.ServicePathReleasedReq">
<summary>Service path released event notification packet</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.ServicePathReleasedRet">
<summary>(reserved)</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.PropertyGetReq">
<summary>Property member get request</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.PropertyGetRes">
<summary>Property member get response</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.PropertySetReq">
<summary>Property member set request</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.PropertySetRes">
<summary>Property member set response</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.FunctionCallReq">
<summary>Function member call request</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.FunctionCallRes">
<summary>Function member call response</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.GeneratorNextReq">
<summary>Generater next call request</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.GeneratorNextRes">
<summary>Generater next call response</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.EventReq">
<summary>Event member notification</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.EventRes">
<summary>(reserved)</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.PipePacket">
<summary>Pipe member packet</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.PipePacketRet">
<summary>Pipe member packet ack</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.PipeConnectReq">
<summary>Pipe member connect request</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.PipeConnectRet">
<summary>Pipe member connect response</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.PipeDisconnectReq">
<summary>Pipe member close request</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.PipeDisconnectRet">
<summary>Pipe member close response</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.PipeClosed">
<summary>Pipe member closed event notification packet</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.PipeClosedRet">
<summary>(reserved)</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.CallbackCallReq">
<summary>Callback member call request</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.CallbackCallRet">
<summary>Callback member call response</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.WirePacket">
<summary>Wire member value packet</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.WirePacketRet">
<summary>(reserved)</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.WireConnectReq">
<summary>Wire member connect request</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.WireConnectRet">
<summary>Wire member connect response</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.WireDisconnectReq">
<summary>Wire member close request</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.WireDisconnectRet">
<summary>Wire member close response</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.WireClosed">
<summary>Wire member closed event notification packet</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.WireClosedRet">
<summary>(reserved)</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.MemoryRead">
<summary>Memory member read request</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.MemoryReadRet">
<summary>Memory member read response</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.MemoryWrite">
<summary>Memory member write request</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.MemoryWriteRet">
<summary>Memory member write response</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.MemoryGetParam">
<summary>Memory member get param request</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.MemoryGetParamRet">
<summary>Memory member get param response</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.WirePeekInValueReq">
<summary>Wire member peek InValue request</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.WirePeekInValueRet">
<summary>Wire member peek InValue response</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.WirePeekOutValueReq">
<summary>Wire member peek OutValue request</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.WirePeekOutValueRet">
<summary>Wire member peek OutValue response</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.WirePokeOutValueReq">
<summary>Wire member poke OutValue request</summary>
</member>
<member name="F:RobotRaconteur.MessageEntryType.WirePokeOutValueRet">
<summary>Wire member poke OutValue response</summary>
</member>
<member name="T:RobotRaconteur.MessageErrorType">
<summary>
Message error type codes enum
</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.None">
<summary>success</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.ConnectionError">
<summary>connection error</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.ProtocolError">
<summary>protocol error serializing messages</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.ServiceNotFound">
<summary>specified service not found</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.ObjectNotFound">
<summary>specified object not found</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.InvalidEndpoint">
<summary>specified endpoint not found</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.EndpointCommunicationFatalError">
<summary>communication with specified endpoint failed</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.NodeNotFound">
<summary>specified node not found</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.ServiceError">
<summary>service error</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.MemberNotFound">
<summary>specified member not found</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.MemberFormatMismatch">
<summary>message format incompatible with specified member</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.DataTypeMismatch">
<summary>data type did not match expected type</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.DataTypeError">
<summary>data type failure</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.DataSerializationError">
<summary>failure serializing data type</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.MessageEntryNotFound">
<summary>specified message entry not found</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.MessageElementNotFound">
<summary>specified message element not found</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.UnknownError">
<summary>unknown exception occurred check `error name`</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.InvalidOperation">
<summary>invalid operation attempted</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.InvalidArgument">
<summary>argument is invalid</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.OperationFailed">
<summary>the requested operation failed</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.NullValue">
<summary>invalid null value</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.InternalError">
<summary>internal error</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.SystemResourcePermissionDenied">
<summary>permission denied to a system resource</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.OutOfSystemResource">
<summary>system resource has been exhausted</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.SystemResourceError">
<summary>system resource error</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.ResourceNotFound">
<summary>a required resource was not found</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.IOError">
<summary>input/output error</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.BufferLimitViolation">
<summary>a buffer underrun/overrun has occurred</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.ServiceDefinitionError">
<summary>service definition parse or validation error</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.OutOfRange">
<summary>attempt to access an out of range element</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.KeyNotFound">
<summary>key not found</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.InvalidConfiguration">
<summary>invalid configuration specified</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.InvalidState">
<summary>invalid state</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.RemoteError">
<summary>error occurred on remote node</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.RequestTimeout">
<summary>request timed out</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.ReadOnlyMember">
<summary>attempt to write to a read only member</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.WriteOnlyMember">
<summary>attempt to read a write only member</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.NotImplementedError">
<summary>member not implemented</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.MemberBusy">
<summary>member is busy try again</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.ValueNotSet">
<summary>value has not been set</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.AbortOperation">
<summary>abort operation (generator only)</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.OperationAborted">
<summary>the operation has been aborted</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.StopIteration">
<summary>stop generator iteration (generator only)</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.OperationTimeout">
<summary>the operation has timed out</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.OperationCancelled">
<summary>the operation has been cancelled</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.AuthenticationError">
<summary>authentication has failed</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.ObjectLockedError">
<summary>the object is locked by another user or session</summary>
</member>
<member name="F:RobotRaconteur.MessageErrorType.PermissionDenied">
<summary>permission to service object or resource denied</summary>
</member>
<member name="T:RobotRaconteur.ClientServiceListenerEventType">
<summary>
Enum of client listener events
</summary>
</member>
<member name="F:RobotRaconteur.ClientServiceListenerEventType.ClientClosed">
<summary>client has been closed</summary>
</member>
<member name="F:RobotRaconteur.ClientServiceListenerEventType.ClientConnectionTimeout">
<summary>client connection has timed out</summary>
</member>
<member name="F:RobotRaconteur.ClientServiceListenerEventType.TransportConnectionConnected">
<summary>client transport has been connected</summary>
</member>
<member name="F:RobotRaconteur.ClientServiceListenerEventType.TransportConnectionClosed">
<summary>client transport connection has been closed or lost</summary>
</member>
<member name="F:RobotRaconteur.ClientServiceListenerEventType.ServicePathReleased">
<summary>client has received notification that service path was released</summary>
</member>
<member name="T:RobotRaconteur.ServiceServiceListenerEventType">
<summary>
Enum of service listener events
</summary>
</member>
<member name="F:RobotRaconteur.ServerServiceListenerEventType.ServiceClosed">
<summary>service has been closed</summary>
</member>
<member name="F:RobotRaconteur.ServerServiceListenerEventType.ClientConnected">
<summary>client has connected</summary>
</member>
<member name="F:RobotRaconteur.ServerServiceListenerEventType.ClientDisconnected">
<summary>client has disconnected</summary>
</member>
<member name="T:RobotRaconteur.MemberDefinition_Direction">
<summary>
Member direction enum
</summary>
<remarks>
Use member modifiers to declare member direction (readonly,writeonly)
</remarks>
</member>
<member name="F:RobotRaconteur.MemberDefinition_Direction.Direction_both">
<summary>member supports read and write</summary>
</member>
<member name="F:RobotRaconteur.MemberDefinition_Direction.Direction_readonly">
<summary>member is readonly</summary>
</member>
<member name="F:RobotRaconteur.MemberDefinition_Direction.Directionwriteonly">
<summary>member is writeonly</summary>
</member>
<member name="T:RobotRaconteur.MemberDefinition_NoLock">
<summary>
Member locking options enum
</summary>
<remarks>
Use member modifiers to declare lock options
</remarks>
</member>
<member name="F:RobotRaconteur.MemberDefinition_NoLock.NoLock_none">
<summary>member cannot be accessed by other users/sessions when object is locked</summary>
</member>
<member name="F:RobotRaconteur.MemberDefinition_NoLock.NoLock_all">
<summary>member can be accessed by other users/sessions when object is locked</summary>
</member>
<member name="F:RobotRaconteur.MemberDefinition_NoLock.NoLock_read">
<summary>member can be read by other users/sessions when object is locked</summary>
</member>
<member name="T:RobotRaconteur.LogLevel">
<summary>
Log level enum
</summary>
<remarks>
Enum of possible log levels. Set log level using
RobotRaconteurNode::SetLogLevel(),
`ROBOTRACONTEUR_LOG_LEVEL` environmental variable, or
`--robotraconteur-log-level` node setup command line option
</remarks>
</member>
<member name="F:RobotRaconteur.LogLevel.LogLevel_Trace">
<summary>`trace` log level</summary>
</member>
<member name="F:RobotRaconteur.LogLevel.LogLevel_Debug">
<summary>`debug` log level</summary>
</member>
<member name="F:RobotRaconteur.LogLevel.LogLevel_Info">
<summary>`info` log level</summary>
</member>
<member name="F:RobotRaconteur.LogLevel.LogLevel_Warning">
<summary>`warning` log level</summary>
</member>
<member name="F:RobotRaconteur.LogLevel.LogLevel_Error">
<summary>`error` log level</summary>
</member>
<member name="F:RobotRaconteur.LogLevel.LogLevel_Fatal">
<summary>`fatal` log level</summary>
</member>
<member name="F:RobotRaconteur.LogLevel.LogLevel_Disable">
<summary>`disabled` log level</summary>
</member>
<member name="T:RobotRaconteur.LogComponent">
<summary>
Log component enum
</summary>
<remarks>
Log records contain the code of the component where
the log record was generated
</remarks>
</member>
<member name="F:RobotRaconteur.LogComponent.LogComponent_Default">
<summary>default component</summary>
</member>
<member name="F:RobotRaconteur.LogComponent.LogComponent_Node">
<summary>Robot Raconteur Node component</summary>
</member>
<member name="F:RobotRaconteur.LogComponent.LogComponent_Transport">
<summary>tranport component</summary>
</member>
<member name="F:RobotRaconteur.LogComponent.LogComponent_Message">
<summary>message or message serialization component</summary>
</member>
<member name="F:RobotRaconteur.LogComponent.LogComponent_Client">
<summary>client component</summary>
</member>
<member name="F:RobotRaconteur.LogComponent.LogComponent_Service">
<summary>service component</summary>
</member>
<member name="F:RobotRaconteur.LogComponent.LogComponent_Member">
<summary>member component</summary>
</member>
<member name="F:RobotRaconteur.LogComponent.LogComponent_Pack">
<summary>data message packing component</summary>
</member>
<member name="F:RobotRaconteur.LogComponent.LogComponent_Unpack">
<summary>data message unpacking component</summary>
</member>
<member name="F:RobotRaconteur.LogComponent.LogComponent_ServiceDefinition">
<summary>service definition parser component</summary>
</member>
<member name="F:RobotRaconteur.LogComponent.LogComponent_Discovery">
<summary>node/service discovery component</summary>
</member>
<member name="F:RobotRaconteur.LogComponent.LogComponent_Subscription">
<summary>subscription component</summary>
</member>
<member name="F:RobotRaconteur.LogComponent.LogComponent_NodeSetup">
<summary>node setup component</summary>
</member>
<member name="F:RobotRaconteur.LogComponent.LogComponent_Utility">
<summary>utility component</summary>
</member>
<member name="F:RobotRaconteur.LogComponent.LogComponent_RobDefLib">
<summary>service definition standard library component (external)</summary>
</member>
<member name="F:RobotRaconteur.LogComponent.LogComponent_User">
<summary>user component (external)</summary>
</member>
<member name="F:RobotRaconteur.LogComponent.LogComponent_UserClient">
<summary>user client component (external)</summary>
</member>
<member name="F:RobotRaconteur.LogComponent.LogComponent_UserService">
<summary>user service component (external)</summary>
</member>
<member name="F:RobotRaconteur.LogComponent.LogComponent_ThirdParty">
<summary>third party library component (external)</summary>
</member>
<!-- RobotRaconteurNode.h -->
<member name="T:RobotRaconteur.RobotRaconteurObjectLockFlags">
<summary>
The type of object lock
</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurObjectLockFlags.CLIENT_LOCK">
<summary>
Client level lock
</summary>
<remarks>
Only the current client connection will have access
to the locked object
</remarks>
</member>
<member name="F:RobotRaconteur.RobotRaconteurObjectLockFlags.USER_LOCK">
<summary>
User level lock
</summary>
<remarks>
The object will be accesible for all client connections
authenticated by the current user
</remarks>
</member>
<member name="M:RobotRaconteur.RobotRaconteurNode.RegisterTransport(RobotRaconteur.Transport)">
<summary>
Register a transport for use by the node
</summary>
<remarks>None</remarks>
<param name="transport">The transport to register</param>
<returns>The transport internal id</returns>
</member>
<member name="M:RobotRaconteur.RobotRaconteurNode.SelectRemoteNodeURL(RobotRaconteur.vectorstring)">
<summary>
Select the "best" URL from a std::vector of candidates
</summary>
<remarks>
<para>
Service discovery will often return a list of candidate URLs to
use to connect to a node. This function uses heuristics to select
the "best" URL to use. The selection criteria ranks URLs in roughly
the following order, lower number being better:
</para>
<list type="number">
<term>"rr+intra" for IntraTransport</term>
<term>"rr+local" for LocalTransport</term>
<term>"rr+pci" or "rr+usb" for HardwareTransport</term>
<term>"rrs+tcp://127.0.0.1" for secure TcpTransport loopback</term>
<term>"rrs+tcp://[::1]" for secure TcpTransport IPv6 loopback</term>
<term>"rrs+tcp://localhost" for secure TcpTransport loopback</term>
<term>"rrs+tcp://[fe80" for secure TcpTransport link-local IPv6</term>
<term>"rrs+tcp://" for any secure TcpTransport</term>
<term>"rr+tcp://127.0.0.1" for TcpTransport loopback</term>
<term>"rr+tcp://[::1]" for TcpTransport IPv6 loopback</term>
<term>"rr+tcp://localhost" for TcpTransport loopback</term>
<term>"rr+tcp://[fe80" for TcpTransport link-local IPv6</term>
<term>"rr+tcp://" for any TcpTransport</term>
</list>
</remarks>
<param name="urls">The candidate URLs</param>
</member>
<member name="M:RobotRaconteur.RobotRaconteurNode.UnregisterServiceType(System.String)">
<summary>
Unregister a previously registered service type
</summary>
<remarks>
This function is not recommended as the results can be
unpredictable
</remarks>
<param name="type">The type to unregister</param>
</member>
<member name="M:RobotRaconteur.RobotRaconteurNode.IsServiceTypeRegistered(System.String)">
<summary>
Check if a service type has been registered
</summary>
<remarks>None</remarks>
<param name="type">The name of the service type to check</param>
<returns>true if registered, otherwise false</returns>
</member>
<member name="M:RobotRaconteur.RobotRaconteurNode.CloseService(System.String)">
<summary>
Closes a previously registered service
</summary>
<remarks>
Services are automatically closed by Shutdown, so this function
is rarely used.
</remarks>
<param name="sname">The name of the service to close</param>
</member>
<member name="M:RobotRaconteur.RobotRaconteurNode.CheckConnection(System.UInt32)">
<summary>
Check that the TransportConnection associated with an endpoint
is connected
</summary>
<remarks>None</remarks>
<param name="endpoint">The LocalEndpoint identifier to check</param>
</member>
<member name="M:RobotRaconteur.RobotRaconteurNode.Sleep(System.Int32)">
<summary>
Sleeps for a specified duration
</summary>
<remarks>
Normally will sleep based on the system clock, but in certain
circumstances will use simulation time
</remarks>
<param name="duration">Duration to sleep in milliseconds</param>
</member>
<member name="M:RobotRaconteur.RobotRaconteurNode.CreateRate(System.Double)">
<summary>
Create a Rate object
</summary>
<remarks>
<para>
Rate is used to stabilize periodic loops to a specified frequency
</para>
<para> This function will normally return a WallRate instance
</para>
</remarks>
<param name="frequency">Frequency of loop in Hz</param>
<returns>The new Rate object</returns>
</member>
<member name="M:RobotRaconteur.RobotRaconteurNode.CreateAutoResetEvent">
<summary>
Create an AutoResetEvent object
</summary>
<remarks>
Normally the AutoResetEvent will use the system clock for timeouts,
but in certain circumstances will use simulation time
</remarks>
<returns>The new AutoResetEvent object</returns>
</member>
<member name="M:RobotRaconteur.RobotRaconteurNode.CompareLogLevel(RobotRaconteur.LogLevel)">
<summary>
Test if the specified log level would be accepted
</summary>
<remarks>None</remarks>
<param name="log_level">Log level to test</param>
<returns>true if the log would be accepted</returns>
</member>
<member name="M:RobotRaconteur.RobotRaconteurNode.LogMessage(RobotRaconteur.LogLevel,System.String)">
<summary>
Log a simple message using the current node
</summary>
<remarks>
<para>
The record will be sent to the configured log handler,
or sent to std::cerr if none is configured
</para>
<para> If the level of the message is below the current log level
for the node, the record will be ignored
</para>
</remarks>
<param name="level">The level for the log message</param>
<param name="message">The log message</param>
</member>
<member name="M:RobotRaconteur.RobotRaconteurNode.LogRecord(RobotRaconteur.RRLogRecord)">
<summary>
Log a record to the node.
</summary>
<remarks>
<para>
The record will be sent to the configured log handler,
or sent to stderr if none is configured
</para>
<para> If the level of the message is below the current log level
for the node, it will be ignored
</para>
</remarks>
<param name="record">The record to log</param>
</member>
<member name="M:RobotRaconteur.RobotRaconteurNode.GetLogLevel">
<summary>
Get the current log level for the node
</summary>
<remarks>
Default level is "info"
</remarks>
</member>
<member name="M:RobotRaconteur.RobotRaconteurNode.SetLogLevel(RobotRaconteur.LogLevel)">
<summary>
Set the log level for the node
</summary>
<remarks>
Set RobotRaconteur.RobotRaconteur_LogLevel_Disable to disable logging
</remarks>
<param name="level">The desired log level</param>
</member>
<member name="M:RobotRaconteur.RobotRaconteurNode.SetLogLevelFromString(System.String)">
<summary>
Set the log level for the node from a string
</summary>
<remarks>
Must be one of the following values: DISABLE, FATAL, ERROR, WARNING, INFO, DEBUG, TRACE
Defaults to WARNING
</remarks>
<param name="level">The desired log level</param>
</member>
<member name="M:RobotRaconteur.RobotRaconteurNode.SetLogLevelFromEnvVariable">
<summary>
Set the log level for the node from environmental variable `ROBOTRACONTEUR_LOG_LEVEL`
</summary>
<remarks>
<para>
Retrieves the specified environmental variable and sets the log level based
on one of the following values: DISABLE, FATAL, ERROR, WARNING, INFO, DEBUG, TRACE
</para>
<para> If an invalid value or the variable does not exist, the log level is left unchanged.
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.RobotRaconteurNode.SetLogLevelFromEnvVariable(System.String)">
<summary>
Set the log level for the node from specified environmental variable
</summary>
<remarks>
<para>
Retrieves the specified environmental variable and sets the log level based
on one of the following values: DISABLE, FATAL, ERROR, WARNING, INFO, DEBUG, TRACE
</para>
<para> If an invalid value or the variable does not exist, the log level is left unchanged.
</para>
</remarks>
<param name="env_variable_name">The environmental variable to use. Defaults to
`ROBOTRACONTEUR_LOG_LEVEL`</param>
</member>
<member name="M:RobotRaconteur.RobotRaconteurNode.GetLogRecordHandler">
<summary>
Get the currently configured log record handler
</summary>
<remarks>
If null, records are sent to stderr
</remarks>
</member>
<member name="M:RobotRaconteur.RobotRaconteurNode.SetLogRecordHandler">
<summary>
Set the handler for log records
</summary>
<remarks>
If handler is NULL, records are sent to stderr
</remarks>
<param name="handler">The log record handler function</param>
</member>
<member name="M:RobotRaconteur.RobotRaconteurNode.GetRegisteredServiceTypes">
<summary>
Return names of registered service types
</summary>
<remarks>None</remarks>
<returns>The registered service types</returns>
</member>
<member name="T:RobotRaconteur.ConnectionException">
<summary>
Exception thrown when connection to remote node fails
</summary>
<remarks>
This exception is thrown if a connection cannot be created,
the connection fails, or the connection has been closed.
Error code MessageErrorType_ConnectionError (1)
</remarks>
</member>
<member name="M:RobotRaconteur.ConnectionException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a ConnectionException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.ProtocolException">
<summary>
Exception thrown when a protocol failure occurs on
a tranport connection
</summary>
<remarks>
Error code MessageErrorType_ProtocolError (2) </remarks>
</member>
<member name="M:RobotRaconteur.ProtocolException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a ProtocolException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.ServiceNotFoundException">
<summary>
Exception thrown when a service cannot be found
on a remote node
</summary>
<remarks>
Error code MessageErrorType_ServiceNotFound (3)
</remarks>
</member>
<member name="M:RobotRaconteur.ServiceNotFoundException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a ServiceNotFoundException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.ObjectNotFoundException">
<summary>
Exception thrown when a service object cannot
be found
</summary>
<remarks>
<para>
This error is thrown when a specified service path
does not have an associated object. The object may
have been released by the service, or the service
path is invalid
</para>
<para>
Error code MessageErrorType_ObjectNotFound (4)
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.ObjectNotFoundException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a ObjectNotFoundException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.InvalidEndpointException">
<summary>
Exception thrown when an attempt is made
to send a message to an invalid endpoint
</summary>
<remarks>
<para>
Transports between two nodes terminate with a pair
of endpoints, one in each node. If the client, service,
service endpoint, or transport is destroyed, the endpoint
will be deleted. This exception is thrown if the
target endpoint is no longer available.
</para>
<para>
Error code MessageErrorType_InvalidEndpoint (5)
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.InvalidEndpointException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a InvalidEndpointException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.EndpointCommunicationFatalException">
<summary>
Exception thrown when an attempt to send a
message to an endpoint fails
</summary>
<remarks>
<para>
Transports between two nodes terminate with a pair
of endpoints, one in each node. Messages are sent
between endpoint pairs. If for some reason the endpoint
cannot send (or receive) the message, this exception
is thrown.
</para>
<para>
Error code MessageErrorType_EndpointCommunicationFatalError (6)
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.EndpointCommunicationFatalException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a EndpointCommunicationFatalException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.NodeNotFoundException">
<summary>
Exception thrown if the specified node cannot be found
</summary>
<remarks>
<para>
When connecting to a service or sending a message, the NodeID
and/or NodeName are specified. If the specified node
cannot be found, this exception is thrown.
</para>
<para> Error code MessageErrorType_NodeNotFound (7)
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.NodeNotFoundException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a NodeNotFoundException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.ServiceException">
<summary>
Exception thrown when an exception occurs during
an operation on a service
</summary>
<remarks>
<para>
ServiceException is a catch-all error for exceptions on services.
See the message field for an explanation of the error that occurred.
</para>
<para>
Error code MessageErrorType_ServiceError (8)
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.ServiceException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a ServiceException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.MemberNotFoundException">
<summary>
Exception thrown when the specified object member is
not found
</summary>
<remarks>
<para>
Service objects have member that are declared in a service definition.
If an attempt is made to call a member that does not exist, this exception
is thrown.
</para>
<para>
Error code MessageErrorType_MemberNotFound (9)
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.MemberNotFoundException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a MemberNotFoundException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.MemberFormatMismatchException">
<summary>
Exception thrown when a request to a member has an
invalid MessageEntryType or the wrong message elements
</summary>
<remarks>
Error code MessageErrorType_MemberFormatMismatch (10)
</remarks>
</member>
<member name="M:RobotRaconteur.MemberFormatMismatchException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a MemberFormatMismatchException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.DataTypeMismatchException">
<summary>
Exception thrown when incorrect data is received
by a member
</summary>
<remarks>
<para>
Make sure the provided data matches the expected data types
</para> Error <para>
code MessageErrorType_DataTypeMismatch (11)
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.DataTypeMismatchException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a DataTypeMismatchException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.DataTypeException">
<summary>
Exception thrown when unexpected or incompatible
data is provided
</summary>
<remarks>
<para>
DataTypeException is sometimes thrown when there is a
type mismatch instead of DataTypeMismatchException
</para>
<para>
Make sure the provided data matches the expected data types
</para> Error <para>
code MessageErrorType_DataTypeError (12)
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.DataTypeException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a DataTypeException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.DataSerializationException">
<summary>
Exception thrown when data cannot be serialized
</summary>
<remarks>
<para>
This exception is thrown when the provide data cannot be serialized.
This typically occurs inside a transport.
</para>
<para>
Check that the provided data matches the types supported by
the Robot Raconteur C++ library
</para>
<para> Error code MessageErrorType_DataSerializationError (13)
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.DataSerializationException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a DataSerializationException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.MessageEntryNotFoundException">
<summary>
Exception thrown when an expected MessageEntry
is not found
</summary>
<remarks>
Error code MessageErrorType_MessageEntryNotfound (14)
</remarks>
</member>
<member name="M:RobotRaconteur.MessageEntryNotFoundException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a MessageEntryNotFoundException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.MessageElementNotFoundException">
<summary>
Exception thrown wen an expected MessageElement
is not found
</summary>
<remarks>
<para>
This exception is thrown when an expected field or parameter
is not found.
</para>
<para>
Error code MessageErrorType_MessageElementNotfound (15)
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.MessageElementNotFoundException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a MessageElementNotFoundException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.UnknownException">
<summary>
Exception representing an unknown exception type
</summary>
<remarks>
<para>
This exception is used to transmit exceptions that do not have a
MessageErrorType code. Check the Error field for the name
of the exception.
</para>
<para> Error code MessageErrorType_UnknownError (16)
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.UnknownException.#ctor(System.String,System.String,System.String,System.Object)">
<summary>
Construct a UnknownException
</summary>
<remarks>None</remarks>
<param name="error">The name of the exception</param>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.InvalidOperationException">
<summary>
Exception thrown when an invalid operation is attempted
</summary>
<remarks>
Error code MessageErrorType_InvalidOperation (17)
</remarks>
</member>
<member name="M:RobotRaconteur.InvalidOperationException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a InvalidOperationException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.InvalidArgumentException">
<summary>
Exception thrown for an invalid argument
</summary>
<remarks>
Error code MessageErrorType_InvalidArgument (18)
</remarks>
</member>
<member name="M:RobotRaconteur.InvalidArgumentException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a InvalidArgumentException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.OperationFailedException">
<summary>
Exception thrown when an operation fails
</summary>
<remarks>
Error code MessageErrorType_OperationFailed (19)
</remarks>
</member>
<member name="M:RobotRaconteur.OperationFailedException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a OperationFailedException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.NullValueException">
<summary>
Exception thrown for an unexpected null value
</summary>
<remarks>
Error code MessageErrorType_NullValue (20)
</remarks>
</member>
<member name="M:RobotRaconteur.NullValueException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a NullValueException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.InternalErrorException">
<summary>
Exception thrown when an internal error has occurred
</summary>
<remarks>
Error code MessageErrorType_InternalError (21)
</remarks>
</member>
<member name="M:RobotRaconteur.InternalErrorException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a InternalErrorException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.PermissionDeniedException">
<summary>
Exception thrown when permission is denied to a service member
</summary>
<remarks>
Error code MessageErrorType_PermissionDenied (152)
</remarks>
</member>
<member name="M:RobotRaconteur.PermissionDeniedException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a PermissionDeniedException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.SystemResourcePermissionDeniedException">
<summary>
Exception thrown when permission to a system resource is denied
</summary>
<remarks>
Error code MessageErrorType_SystemResourcePermissionDenied (22)
</remarks>
</member>
<member name="M:RobotRaconteur.SystemResourcePermissionDeniedException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a SystemResourcePermissionDeniedException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.OutOfSystemResourceException">
<summary>
Exception thrown when a system resource has been exhausted
</summary>
<remarks>
Error code MessageErrorType_OutOfSystemResource (23)
</remarks>
</member>
<member name="M:RobotRaconteur.OutOfSystemResourceException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a OutOfSystemResourceException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.SystemResourceException">
<summary>
Exception thrown when a system resource error occurs
</summary>
<remarks>
Error code MessageErrorType_SystemResourceException (24)
</remarks>
</member>
<member name="M:RobotRaconteur.SystemResourceException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a SystemResourceException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.ResourceNotFoundException">
<summary>
Exception thrown when a system resource is not found
</summary>
<remarks>
Error code MessageErrorType_ResourceNotFound (25)
</remarks>
</member>
<member name="M:RobotRaconteur.ResourceNotFoundException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a ResourceNotFoundException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.IOException">
<summary>
Exception thrown when an input/output error occurs
</summary>
<remarks>
Error code MessageErrorType_IOError (26)
</remarks>
</member>
<member name="M:RobotRaconteur.IOException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a IOException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.BufferLimitViolationException">
<summary>
Exception thrown when a transport buffer limit is violated
</summary>
<remarks>
<para>
This exception typically occurs if there is a bug in
serialization/deserialization, or the data stream
has been corrupted
</para>
<para> Error code MessageErrorType_BufferLimitViolation (27)
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.BufferLimitViolationException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a BufferLimitViolationException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.ServiceDefinitionException">
<summary>
Exception thrown when a service definition cannot be
parsed or fails verification
</summary>
<remarks>
Error code MessageErrorType_ServiceDefinitionError (28)
</remarks>
</member>
<member name="M:RobotRaconteur.ServiceDefinitionException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a ServiceDefinitionException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.OutOfRangeException">
<summary>
Exception thrown when an attempt to access an array or container
index is out of range
</summary>
<remarks>
Error code MessageErrorType_OutOfRange (29)
</remarks>
</member>
<member name="M:RobotRaconteur.OutOfRangeException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a OutOfRangeException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.KeyNotFoundException">
<summary>
Exception thrown when a key is not found in a map
</summary>
<remarks>
Error code MessageErrorType_KeyNotFound (30)
</remarks>
</member>
<member name="M:RobotRaconteur.KeyNotFoundException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a KeyNotFoundException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.InvalidConfigurationException">
<summary>
Exception thrown when an invalid configuration is specified or encountered
</summary>
<remarks>
Error code MessageErrorType_InvalidConfiguration (31)
</remarks>
</member>
<member name="M:RobotRaconteur.InvalidConfigurationException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a InvalidConfigurationException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.InvalidStateException">
<summary>
Exception thrown when an invalid state is specified or encountered
</summary>
<remarks>
Error code MessageErrorType_InvalidState (32)
</remarks>
</member>
<member name="M:RobotRaconteur.InvalidStateException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a InvalidStateException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.RobotRaconteurRemoteException">
<summary>
Exception thrown when an error occurs on a remote
member request
</summary>
<remarks>
<para>
User defined exceptions declared in service definitions extend
RobotRaconteurRemoteException
</para>
<para>
Error code MessageErrorType_RemoteError (100)
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.RobotRaconteurRemoteException.#ctor(System.String,System.String,System.String,System.Object)">
<summary>
Construct a RobotRaconteurRemoteException
</summary>
<remarks>
error should be the fully qualified type of the exception
for user defined exceptions
</remarks>
<param name="error">The name of the exception</param>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.RequestTimeoutException">
<summary>
The request timed out
</summary>
<remarks>
<para>
See RobotRaconteurNode.SetRequestTimeout(),
or the timeout passed to an asynchronous request
</para>
<para>
Error code MessageErrorType_RequestTimeout (101)
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.RequestTimeoutException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a RequestTimeoutException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.ReadOnlyMemberException">
<summary>
An attempt was made to write/set a read only member
</summary>
<remarks>
Error code MessageErrorType_ReadOnlyMember (102)
</remarks>
</member>
<member name="M:RobotRaconteur.ReadOnlyMemberException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a ReadOnlyMemberException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.WriteOnlyMemberException">
<summary>
An attempt was mode to read/get a write only member
</summary>
<remarks>
Error code MessageErrorType_WriteOnlyMember (103)
</remarks>
</member>
<member name="M:RobotRaconteur.WriteOnlyMemberException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a WriteOnlyMemberException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.NotImplementedException">
<summary>
Exception thrown if a member is not implemented
</summary>
<remarks>
Error code MessageErrorType_NotImplementedError (104)
</remarks>
</member>
<member name="M:RobotRaconteur.NotImplementedException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a NotImplementedException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.MemberBusyException">
<summary>
Thrown is a member is busy. Retry later
</summary>
<remarks>
Error code MessageErrorType_MemberBusy (105)
</remarks>
</member>
<member name="M:RobotRaconteur.MemberBusyException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a MemberBusyException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.ValueNotSetException">
<summary>
Exception thrown if a value has not been set
</summary>
<remarks>
<para>
This exception is most often used by WireConnection.GetInValue()
and WireConnection.GetOutValue() if InValue or OutValue
have not been received or set
</para>
<para> Error code MessageErrorType_ValueNotSet (106)
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.ValueNotSetException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a ValueNotSetException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.AuthenticationException">
<summary>
Exception thrown when authentication is required or attempt
to authenticate fails
</summary>
<remarks>
Error code MessageErrorType_AuthenticationError (150)
</remarks>
</member>
<member name="M:RobotRaconteur.AuthenticationException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a AuthenticationException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.ObjectLockedException">
<summary>
Exception thrown when attempting to access a locked
service object
</summary>
<remarks>
<para>
Service objects can be locked using RobotRaconteurNode::RequestObjectLock().
This exception is thrown if an attempt is made to access a service object
(or sub-object) that has been locked by another user or session.
</para>
<para>
Error code MessageErrorType_ObjectLockedError (151)
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.ObjectLockedException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a ObjectLockedException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.AbortOperationException">
<summary>
Exception passed to generators to trigger an abort
</summary>
<remarks>
<para>
This is typically not thrown or received by the user
</para>
<para> Error code MessageErrorType_AbortOperation (107)
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.AbortOperationException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a AbortOperationException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.OperationAbortedException">
<summary>
Exception thrown when an operation is aborted
</summary>
<remarks>
<para>
This is thrown be generator functions when Abort()
is called
</para>
<para>
Generators are destroyed after throwing
OperationAbortedException during Next()
</para>
<para>
This error is passed to generators to trigger an abort
</para>
<para> Error code MessageErrorType_OperationAborted (108)
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.OperationAbortedException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a OperationAbortedException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.StopIterationException">
<summary>
Exception thrown when a generator has finished sending results
</summary>
<remarks>
<para>
StopIterationException is not an error condition. It signals
that a generator is finished sending results.
</para>
<para>
This error is passed to generators to trigger a close
</para>
<para> Error code MessageErrorType_StopIteration (109)
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.StopIterationException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a StopIterationException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.OperationTimeoutException">
<summary>
Exception thrown when an operation does not complete in the expected time
</summary>
<remarks>
Error code MessageErrorType_OperationTimeout (110)
</remarks>
</member>
<member name="M:RobotRaconteur.OperationTimeoutException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a OperationTimeoutException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.OperationCancelledException">
<summary>
Exception thrown when an operation is cancelled before it is started
</summary>
<remarks>
Error code MessageErrorType_OperationCancelled (111)
</remarks>
</member>
<member name="M:RobotRaconteur.OperationCancelledException.#ctor(System.String,System.String,System.Object)">
<summary>
Construct a OperationCancelledException
</summary>
<remarks>None</remarks>
<param name="message">Message for the user</param>
<param name="sub_name">Optional error sub_name</param>
<param name="param_">Optional error param</param>
</member>
<member name="T:RobotRaconteur.RobotRaconteurNodeSetupFlags">
<summary>
Setup option flags
</summary>
<remarks>
<para>
Setup option flags passed to node setup classes to select options to enable
and disable. Flags are used to configure the following types of options:
</para>
<list type="number">
<term>Enable and disable transport types</term>
<term>Modify transport options including discovery, security requirements,
and connection listening</term>
<term>Configure TLS behavior</term>
<term>Enable local tap for logging</term>
</list>
<para>
Node setup classes also allow options and flags to be "overridden" using
command line options. Use the `*_ALLOW_OVERRIDE` options to configure
when these overrides are allowed.
</para>
<para> The ClientNodeSetup, ServerNodeSetup, and SecureServerNodeSetup
are convenience classes for the most commonly used options.
</para>
</remarks>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNodeSetupFlags.NONE">
<summary>No options enabled</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNodeSetupFlags.ENABLE_NODE_DISCOVERY_LISTENING">
<summary>Enable node discovery listening on all transports</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNodeSetupFlags.ENABLE_NODE_ANNOUNCE">
<summary>Enable node announce on all transports</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNodeSetupFlags.ENABLE_LOCAL_TRANSPORT">
<summary>Enable LocalTransport</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNodeSetupFlags.ENABLE_TCP_TRANSPORT">
<summary>Enable TcpTransport</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNodeSetupFlags.ENABLE_HARDWARE_TRANSPORT">
<summary>Enable HardwareTransport</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNodeSetupFlags.LOCAL_TRANSPORT_START_SERVER">
<summary>Start the LocalTransport server to listen for incoming clients</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNodeSetupFlags.LOCAL_TRANSPORT_START_CLIENT">
<summary>Start the LocalTransport client with specified node name</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNodeSetupFlags.TCP_TRANSPORT_START_SERVER">
<summary>Start the TcpTransport server to listen for incoming clients on the specified port</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNodeSetupFlags.TCP_TRANSPORT_START_SERVER_PORT_SHARER">
<summary>Start the TcpTransport server to incoming for incoming clients using the port sharer</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNodeSetupFlags.DISABLE_MESSAGE4">
<summary>Disable Message Format Version 4 on all transports</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNodeSetupFlags.DISABLE_STRINGTABLE">
<summary>Disable Message Format Version 4 string table on all transports</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNodeSetupFlags.DISABLE_TIMEOUTS">
<summary>Disable all timeouts (useful for debugging)</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNodeSetupFlags.LOAD_TLS_CERT">
<summary>Load the TLS certificate for TcpTransport</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNodeSetupFlags.REQUIRE_TLS">
<summary>Require TLS for all clients on TcpTransport</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNodeSetupFlags.LOCAL_TRANSPORT_SERVER_PUBLIC">
<summary>Make LocalTransport server listen for incoming clients from all users</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNodeSetupFlags.NODENAME_OVERRIDE">
<summary>Allow NodeName to be configured using command line options</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNodeSetupFlags.NODEID_OVERRIDE">
<summary>Allow NodeID to be configured using command line options</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNodeSetupFlags.TCP_PORT_OVERRIDE">
<summary>Allow TCP port to be configured using command line options</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNodeSetupFlags.TCP_WEBSOCKET_ORIGIN_OVERRIDE">
<summary>Allow TCP WebSocket origin control to be configured using command line options</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNodeSetupFlags.ENABLE_INTRA_TRANSPORT">
<summary>Enable IntraTransport</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNodeSetupFlags.INTRA_TRANSPORT_START_SERVER">
<summary>Start the IntraTransport server to listen for incoming clients</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNodeSetupFlags.LOCAL_TAP_ENABLE">
<summary>Enable the LocalTap debug logging system</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNodeSetupFlags.LOCAL_TAP_NAME">
<summary>Allow the user to set the LocalTap name</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNodeSetupFlags.ENABLE_ALL_TRANSPORTS">
<summary>Convenience flag to enable all transports</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNodeSetupFlags.CLIENT_DEFAULT">
<summary>Default configuration for client nodes (See ClientNodeSetup)</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNodeSetupFlags.CLIENT_DEFAULT_ALLOWED_OVERRIDE">
<summary>Default allowed overrides for client nodes (See ClientNodeSetup)</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNodeSetupFlags.SERVER_DEFAULT">
<summary>Default configuration for server nodes</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNodeSetupFlags.SERVER_DEFAULT_ALLOWED_OVERRIDE">
<summary>Default allowed overrides for server nodes</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNodeSetupFlags.SECURE_SERVER_DEFAULT">
<summary>Default configuration for server nodes requiring TLS network transports</summary>
</member>
<member name="F:RobotRaconteur.RobotRaconteurNodeSetupFlags.SECURE_SERVER_DEFAULT_ALLOWED_OVERRIDE">
<summary>Default allowed overrides for server nodes requiring TLS network transports</summary>
</member>
<member name="T:RobotRaconteur.CommandLineConfigParser">
<summary>
Command line parser for node setup classes
</summary>
<remarks>
<para>
The CommandLineConfigParser is used to parse command line options specified
when a program is launched. These options allow for the node configuration to be
changed without recompiling the software. See command_line_options for
a table of the standard command line options.
</para>
<para>
ClientNodeSetup, ServerNodeSetup, and SecureServerNodeSetup use this class to parse
the `sys.argv` parameters. The RobotRaconteurNodeSetup constructors will accept
either `sys.argv`, or will accept an initialize CommandLineConfigParser.
</para>
<para>
The CommandLineConfig() constructor takes the "allowed override" flags, and the option
prefix.
The "allowed override" specifies which options can be overridden using the command line.
The
prefix option allows the command line flag prefix to be changed. By default it expects
all options to begin with `--robotraconteur-` followed by the name of the option. If there
are
multiple nodes, it is necessary to change the prefix to be unique for each node. For
instance,
"robotraconteur1-" for the first node and "RobotRaconteur-" for the second node.
</para>
<para> Users may add additional options to the parser. Use AddStringOption(),
AddBoolOption(), or AddIntOption() to add additional options.
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.CommandLineConfigParser.SetDefaults(System.String,System.UInt16,System.UInt32)">
<summary>
Set the default NodeName, TCP port, and flags
</summary>
<remarks>
The command line options will be allowed to override the options
specified in allowed_overrides passed to CommandLineConfigParser().
</remarks>
<param name="node_name">The default NodeName</param>
<param name="tcp_port">The default TCP port</param>
<param name="default_flags">The default flags</param>
</member>
<member name="M:RobotRaconteur.CommandLineConfigParser.AddStringOption(System.String,System.String)">
<summary>
Add a new string option
</summary>
<remarks>None</remarks>
<param name="name">The name of the option</param>
<param name="descr">Description of the option</param>
</member>
<member name="M:RobotRaconteur.CommandLineConfigParser.AddBoolOption(System.String,System.String)">
<summary>
Add a new bool option
</summary>
<remarks>None</remarks>
<param name="name">The name of the option</param>
<param name="descr">Description of the option</param>
</member>
<member name="M:RobotRaconteur.CommandLineConfigParser.AddIntOption(System.String,System.String)">
<summary>
Add a new int option
</summary>
<remarks>None</remarks>
<param name="name">The name of the option</param>
<param name="descr">Description of the option</param>
</member>
<member name="M:RobotRaconteur.CommandLineConfigParser.ParseCommandLine(System.String[])">
<summary>
Parse a specified string vector containing the options
</summary>
<remarks>
Results are stored in the instance
</remarks>
<param name="args">The options as a string list</param>
</member>
<member name="M:RobotRaconteur.CommandLineConfigParser.GetOptionOrDefaultAsString(System.String)">
<summary>
Get the option value as a string
</summary>
<remarks>
Returns empty string if option not specified on command line
</remarks>
<param name="option">The name of the option</param>
<returns>The option value, or an empty string</returns>
</member>
<member name="M:RobotRaconteur.CommandLineConfigParser.GetOptionOrDefaultAsString(System.String,System.String)">
<summary>
Get the option value as a string
</summary>
<remarks>
Returns default_value if option not specified on command line
</remarks>
<param name="option">The name of the option</param>
<param name="default_value">The default option value</param>
<returns>The option value, or default_value if not specified on command line</returns>
</member>
<member name="M:RobotRaconteur.CommandLineConfigParser.GetOptionOrDefaultAsBool(System.String)">
<summary>
Get the option value as a bool
</summary>
<remarks>
Returns false if option not specified on command line
</remarks>
<param name="option">The name of the option</param>
<returns>The option value, or false</returns>
</member>
<member name="M:RobotRaconteur.CommandLineConfigParser.GetOptionOrDefaultAsBool(System.String,System.Boolean)">
<summary>
Get the option value as a bool
</summary>
<remarks>
Returns default_value if option not specified on command line
</remarks>
<param name="option">The name of the option</param>
<param name="default_value">The default option value</param>
<returns>The option value, or default_value if not specified on command line</returns>
</member>
<member name="M:RobotRaconteur.CommandLineConfigParser.GetOptionOrDefaultAsInt(System.String)">
<summary>
Get the option value as an int
</summary>
<remarks>
Returns -1 if option not specified on command line
</remarks>
<param name="option">The name of the option</param>
<returns>The option value, or -1</returns>
</member>
<member name="M:RobotRaconteur.CommandLineConfigParser.GetOptionOrDefaultAsInt(System.String,System.Int32)">
<summary>
Get the option value as an int
</summary>
<remarks>
Returns default_value if option not specified on command line
</remarks>
<param name="option">The name of the option</param>
<param name="default_value">The default option value</param>
<returns>The option value, or default_value if not specified on command line</returns>
</member>
<member name="M:RobotRaconteur.CommandLineConfigParser.#ctor(System.UInt32)">
<summary>
Construct a new CommandLineConfigParser
</summary>
<remarks>None</remarks>
<param name="allowed_overrides">The allowed overrides flags</param>
</member>
<member name="M:RobotRaconteur.CommandLineConfigParser.#ctor(System.UInt32,System.String)">
<summary>
Construct a new CommandLineConfigParser
</summary>
<remarks>None</remarks>
<param name="allowed_overrides">The allowed overrides flags</param>
<param name="prefix">The prefix to use for the options</param>
</member>
<member name="T:RobotRaconteur.TimeSpec">
<summary>
Represents. a point in time. Used by `wire` members to
timestamp packets
</summary>
<remarks>
<para>
Time is always in UTC
</para>
<para>Time is relative to the UNIX epoch
"1970-01-01T00:00:00Z"</para>
</remarks>
</member>
<member name="P:RobotRaconteur.TimeSpec.seconds">
<summary>
Seconds since epoch
</summary>
<remarks>None</remarks>
</member>
<member name="P:RobotRaconteur.TimeSpec.nanoseconds">
<summary>
Nanoseconds from epoch. Normalized to be between 0 and 1e9-1
</summary>
<remarks>None</remarks>
</member>
<member name="M:RobotRaconteur.TimeSpec.#ctor">
<summary>
Construct empty timespec
</summary>
<remarks>None</remarks>
</member>
<member name="M:RobotRaconteur.TimeSpec.#ctor(System.Int64,System.Int32)">
<summary>
Construct timespec with specified time
</summary>
<remarks>None</remarks>
<param name="seconds">Seconds since epoch</param>
<param name="nanoseconds">Nanoseconds since epoch</param>
</member>
<member name="M:RobotRaconteur.TimeSpec.op_Equality(RobotRaconteur.TimeSpec,RobotRaconteur.TimeSpec)">
<summary>
equality comparison
</summary>
<remarks>None</remarks>
<param name="a"></param>
<param name="b"></param>
<returns></returns>
</member>
<member name="M:RobotRaconteur.TimeSpec.Equals(System.Object)">
<summary>
Object equality operator
</summary>
<remarks>None</remarks>
<param name="o"></param>
<returns></returns>
</member>
<member name="M:RobotRaconteur.TimeSpec.GetHashCode">
<summary>
Hash code
</summary>
<returns></returns>
</member>
<member name="M:RobotRaconteur.TimeSpec.op_Inequality(RobotRaconteur.TimeSpec,RobotRaconteur.TimeSpec)">
<summary>
inequality comparison
</summary>
<remarks>None</remarks>
<param name="a"></param>
<param name="b"></param>
<returns></returns>
</member>
<member name="M:RobotRaconteur.TimeSpec.op_Addition(RobotRaconteur.TimeSpec,RobotRaconteur.TimeSpec)">
<summary>
addition operator
</summary>
<remarks>None</remarks>
<param name="a"></param>
<param name="b"></param>
<returns></returns>
</member>
<member name="M:RobotRaconteur.TimeSpec.op_Subtraction(RobotRaconteur.TimeSpec,RobotRaconteur.TimeSpec)">
<summary>
subtraction operator
</summary>
<remarks>None</remarks>
<param name="a"></param>
<param name="b"></param>
<returns></returns>
</member>
<member name="M:RobotRaconteur.TimeSpec.op_GreaterThan(RobotRaconteur.TimeSpec,RobotRaconteur.TimeSpec)">
<summary>
greater-than comparison
</summary>
<remarks>None</remarks>
<param name="a"></param>
<param name="b"></param>
<returns></returns>
</member>
<member name="M:RobotRaconteur.TimeSpec.op_LessThan(RobotRaconteur.TimeSpec,RobotRaconteur.TimeSpec)">
<summary>
less-then comparison
</summary>
<remarks>None</remarks>
<param name="a"></param>
<param name="b"></param>
<returns></returns>
</member>
<member name="M:RobotRaconteur.TimeSpec.op_GreaterThanOrEqual(RobotRaconteur.TimeSpec,RobotRaconteur.TimeSpec)">
<summary>
greater-than-or-equal comparison
</summary>
<remarks>None</remarks>
<param name="a"></param>
<param name="b"></param>
<returns></returns>
</member>
<member name="M:RobotRaconteur.TimeSpec.op_LessThanOrEqual(RobotRaconteur.TimeSpec,RobotRaconteur.TimeSpec)">
<summary>
less-than-or-equal comparison
</summary>
<remarks>None</remarks>
<param name="a"></param>
<param name="b"></param>
<returns></returns>
</member>
<member name="M:RobotRaconteur.TimeSpec.cleanup_nanosecs">
<summary>
normalize nanoseconds to be within 0 and 1e9-1
</summary>
<remarks>None</remarks>
</member>
<member name="T:RobotRaconteur.ServicePathSegment">
<summary>Service path segment containing a name and an optional index</summary>
<remarks>None</remarks>
</member>
<member name="P:RobotRaconteur.ServicePathSegment.name">
<summary>The name of the segment</summary>
<remarks>None</remarks>
</member>
<member name="P:RobotRaconteur.ServicePathSegment.index">
<summary>The index of the segment</summary>
<remarks>None</remarks>
</member>
<member name="M:RobotRaconteur.ServicePathSegment.#ctor">
<summary>Construct a new ServicePathSegment</summary>
<remarks>None</remarks>
</member>
<member name="M:RobotRaconteur.ServicePathSegment.#ctor(System.String)">
<summary>Construct a new ServicePathSegment with a name</summary>
<remarks>None</remarks>
<param name="name">The name of the segment</param>
</member>
<member name="M:RobotRaconteur.ServicePathSegment.#ctor(System.String,System.String)">
<summary>Construct a new ServicePathSegment with a name and an index</summary>
<remarks>None</remarks>
<param name="name">The name of the segment</param>
<param name="index">The index of the segment</param>
</member>
<member name="M:RobotRaconteur.RobotRaconteurNET.EncodeServicePathIndex(System.String)">
<summary>Encode a service path index for use in a Robot Raconteur service path</summary>
<remarks>None</remarks>
<param name="index">The index to encode</param>
<returns>The encoded index</returns>
</member>
<member name="M:RobotRaconteur.RobotRaconteurNET.DecodeServicePathIndex(System.String)">
<summary>Decode a service path index from a Robot Raconteur service path</summary>
<remarks>None</remarks>
<param name="index">The index to decode</param>
<returns>The decoded index</returns>
</member>
<member name="M:RobotRaconteur.RobotRaconteurNET.ParseServicePath(System.String)">
<summary>Split a service path into segments</summary>
<remarks>None</remarks>
<param name="path">The path to split</param>
<returns>The segments of the path</returns>
</member>
<member name="M:RobotRaconteur.RobotRaconteurNET.BuildServicePath(RobotRaconteur.ServicePathSegments)">
<summary>Join service path segments into a path</summary>
<remarks>None</remarks>
<param name="segments">The segments to join</param>
<returns>The joined path</returns>
</member>
<member name="T:RobotRaconteur.HardwareTransport">
<summary>
Transport for USB, Bluetooth, and PCIe hardware devices
</summary>
<remarks> **WARNING: THE HARDWARE TRANSPORT IS EXPERIMENTAL!** The HardwareTransport is
disabled by default by the node setup classes. Use `--robotraconteur-hardware-enable=true`
option to enable. <para>
It is recommended that ClientNodeSetup, ServerNodeSetup, or SecureServerNodeSetup
be used to construct this class.
</para>
<para>
See robotraconteur_url for more information on URLs.
</para>
<para>
Contact Wason Technology, LLC for more information on the hardware
transport.
</para>
<para>
The use of RobotRaconteurNodeSetup and subclasses is recommended to construct
transports.
</para>
<para>
The transport must be registered with the node using
RobotRaconteurNode.RegisterTransport() after construction if node
setup is not used.
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.HardwareTransport.#ctor">
<summary>
Construct a new HardwareTransport for use with default node. Must be registered with node
using
RobotRaconteurNode.s.RegisterTransport()
</summary>
<remarks>None</remarks>
</member>
<member name="M:RobotRaconteur.HardwareTransport.#ctor(RobotRaconteur.RobotRaconteurNode)">
<summary>
Construct a new HardwareTransport for a non-default node. Must be registered with node using
node.RegisterTransport()
</summary>
<remarks>None</remarks>
<param name="node">The node to use with the transport</param>
</member>
<member name="M:RobotRaconteur.HardwareTransport.Close">
<summary>
Close the transport. Done automatically by node shutdown.
</summary>
<remarks>None</remarks>
</member>
<member name="T:RobotRaconteur.IntraTransport">
<summary>
Transport for intra-process communication
</summary>
<remarks>
<para>
It is recommended that ClientNodeSetup, ServerNodeSetup, or SecureServerNodeSetup
be used to construct this class.
</para>
<para>
See robotraconteur_url for more information on URLs.
</para>
<para>
The IntraTransport implements transport connections between nodes running
within the same process. This is often true for simulation environments, where
there may be multiple simulated devices running within the simulation. The
IntraTransport uses a singleton to keep track of the different nodes running
in the same process, and to form connections. The singleton also implements
discovery updates.
</para>
<para>
The use of RobotRaconteurNodeSetup and subclasses is recommended to construct
transports.
</para>
<para> The transport must be registered with the node using
RobotRaconteurNode.RegisterTransport() after construction if node
setup is not used.
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.IntraTransport.#ctor">
<summary>
Construct a new HardwareTransport for use with default node. Must be registered with node
using RobotRaconteurNode.s.RegisterTransport()
</summary>
<remarks>None</remarks>
</member>
<member name="M:RobotRaconteur.IntraTransport.#ctor(RobotRaconteur.RobotRaconteurNode)">
<summary>
Construct a new IntraTransport for a non-default node. Must be registered with node using
node.RegisterTransport()
</summary>
<remarks>None</remarks>
<param name="node">The node to use with the transport</param>
</member>
<member name="M:RobotRaconteur.IntraTransport.Close">
<summary>
Close the transport. Done automatically by node shutdown.
</summary>
<remarks>None</remarks>
</member>
<member name="M:RobotRaconteur.IntraTransport.StartServer">
<summary>
Start the server to listen for incoming client connections
</summary>
<remarks>None</remarks>
</member>
<member name="T:RobotRaconteur.LocalTransport">
<summary>
Transport for communication between processes using UNIX domain sockets
</summary>
<remarks>
<para>
It is recommended that ClientNodeSetup, ServerNodeSetup, or SecureServerNodeSetup
be used to construct this class.
</para>
<para>
See robotraconteur_url for more information on URLs.
</para>
<para>
The LocalTransport implements transport connections between processes running on the
same host operating system using UNIX domain sockets. UNIX domain sockets are similar
to standard networking sockets, but are used when both peers are on the same machine
instead of connected through a network. This provides faster operation and greater
security, since the kernel simply passes data between the processes. UNIX domain
sockets work using Information Node (inode) files, which are special files on
the standard filesystem. Servers "listen" on a specified inode, and clients
use the inode as the address to connect. The LocalTransport uses UNIX sockets
in `SOCK_STREAM` mode. This provides a reliable stream transport connection similar
to TCP, but with significantly improved performance due the lower overhead.
</para>
<para>
UNIX domain sockets were added to Windows 10 with the 1803 update. Robot Raconteur
switch to UNIX domain sockets for the LocalTransport on Windows in version 0.9.2.
Previous versions used Named Pipes, but these were inferior to UNIX sockets. The
LocalTransport will not function on versions of Windows prior to Windows 10 1803 update
due to the lack of support for UNIX sockets. A warning will be issued to the log if
the transport is not available, and all connection attempts will fail. All other
transports will continue to operate normally.
</para>
<para>
The LocalTransport stores inode and node information files in the filesystem at various
operator system dependent locations. See the Robot Raconteur Standards documents
for details on where these files are stored.
</para>
<para>
Discovery is implemented using file watchers. The file watchens must be activated
using the node setup flags, or by calling EnableNodeDiscoveryListening().
After being initialized the file watchers operate automatically.
</para>
<para>
The LocalTransport can be used to dynamically assign NodeIDs to nodes based on a NodeName.
StartServerAsNodeName() and StartClientAsNodeName() take a NodeName that will identify the
node to clients, and manage a system-local NodeID corresponding to that NodeName. The
generated NodeIDs are stored on the local filesystem. If LocalTransport finds a
corresponding
NodeID on the filesystem, it will load and use that NodeID. If it does not, a new random
NodeID
is automatically generated.
</para>
<para>
The server can be started in "public" or "private" mode. Private servers store their
inode and
information in a location only the account owner can access, while "public" servers are
placed in a location that all users with the appropriate permissions can access. By
default,
public LocalTransport servers are assigned to the "robotraconteur" group. Clients that
belong to the
"robotraconteur" group will be able to connect to these public servers.
</para>
<para>
The use of RobotRaconteurNodeSetup and subclasses is recommended to construct
transports.
</para>
<para> The transport must be registered with the node using
RobotRaconteurNode.RegisterTransport() after construction if node
setup is not used.
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.LocalTransport.#ctor">
<summary>
Construct a new LocalTransport for use with default node. Must be registered with node
using
RobotRaconteurNode.s.RegisterTransport()
</summary>
<remarks>None</remarks>
</member>
<member name="M:RobotRaconteur.LocalTransport.#ctor(RobotRaconteur.RobotRaconteurNode)">
<summary>
Construct a new LocalTransport for a non-default node. Must be registered with node using
node.RegisterTransport()
</summary>
<remarks>None</remarks>
<param name="node">The node to use with the transport</param>
</member>
<member name="M:RobotRaconteur.LocalTransport.Close">
<summary>
Close the transport. Done automatically by node shutdown.
</summary>
<remarks>None</remarks>
</member>
<member name="M:RobotRaconteur.LocalTransport.StartClientAsNodeName(System.String)">
<summary>
Initialize the LocalTransport by assigning a NodeID based on NodeName
</summary>
<remarks>
<para>
Assigns the specified name to be the NodeName of the node, and manages
a corresponding NodeID. See LocalTransport for more information.
</para>
<para> Throws NodeNameAlreadyInUse if another node is using name
</para>
</remarks>
<param name="name">The node name</param>
</member>
<member name="M:RobotRaconteur.LocalTransport.StartServerAsNodeName(System.String)">
<summary>
Start the server using the specified NodeName and assigns a NodeID
</summary>
<remarks>
<para>
The LocalTransport will listen on a UNIX domain socket for incoming clients,
using information files and inodes on the local filesystem. Clients
can locate the node using the NodeID and/or NodeName. The NodeName is assigned
to the node, and the transport manages a corresponding NodeID. See
LocalTransport for more information.
</para>
<para>
Throws NodeNameAlreadyInUse if another node is using name.
</para>
<para> Throws NodeIDAlreadyInUse if another node is using the managed NodeID.
</para>
</remarks>
<param name="name">The NodeName</param>
</member>
<member name="M:RobotRaconteur.LocalTransport.StartServerAsNodeName(System.String,System.Boolean)">
<summary>
Start the server using the specified NodeName and assigns a NodeID
</summary>
<remarks>
<para>
The LocalTransport will listen on a UNIX domain socket for incoming clients,
using information files and inodes on the local filesystem. Clients
can locate the node using the NodeID and/or NodeName. The NodeName is assigned
to the node, and the transport manages a corresponding NodeID. See
LocalTransport for more information.
</para>
<para>
Throws NodeNameAlreadyInUse if another node is using name.
</para>
<para> Throws NodeIDAlreadyInUse if another node is using the managed NodeID.
</para>
</remarks>
<param name="name">The NodeName</param>
<param name="public_">If True, other users can access the server. If False, only
the account owner can access the server.</param>
</member>
<member name="M:RobotRaconteur.LocalTransport.StartServerAsNodeID(RobotRaconteur.NodeID)">
<summary>
The LocalTransport will listen on a UNIX domain socket for incoming clients,
using information files and inodes on the local filesystem. This function
leaves the NodeName blank, so clients must use NodeID to identify the node.
</summary>
<remarks>
Throws NodeIDAlreadyInUse if another node is using nodeid.
</remarks>
<param name="name">The NodeName</param>
</member>
<member name="M:RobotRaconteur.LocalTransport.StartServerAsNodeID(RobotRaconteur.NodeID,System.Boolean)">
<summary>
The LocalTransport will listen on a UNIX domain socket for incoming clients,
using information files and inodes on the local filesystem. This function
leaves the NodeName blank, so clients must use NodeID to identify the node.
</summary>
<remarks>
Throws NodeIDAlreadyInUse if another node is using nodeid
</remarks>
<param name="name">The NodeName</param>
<param name="public_">If True, other users can access the server. If False, only
the account owner can access the server.</param>
</member>
<member name="T:RobotRaconteur.TcpTransport">
<summary>
Transport for Transport Control Protocol Internet Protocol (TCP/IP) networks
</summary>
<remarks>
<para>
It is recommended that ClientNodeSetup, ServerNodeSetup, or SecureServerNodeSetup
be used to construct this class.
</para>
<para>
See robotraconteur_url for more information on URLs.
</para>
<para>
The TcpTransport implements transport connections over TCP/IP networks. TCP/IP is the
most common protocol used for Internet and Local Area Network (LAN) communication,
including
Ethernet and WiFi connections. The Transport Control Protocol (TCP) is a reliable stream
protocol that establishes connections between devices using IP address and port pairs.
Each adapter has an assigned address, and applications create connections on different
ports.
TcpTransport listens to the port specified in StartServer(), and the client uses
a URL containing the IP address and port of the listening transport. The TcpTransport
uses the established connection to pass messages between nodes.
</para>
<para>
The IP protocol is available in two major versions, IPv4 and IPv6. The most common
is IPv4, and its 32 bit address is typically written as four numbers,
ie 172.17.12.174. IPv4 has a number of critical limitations, the greatest being
its 2^32 address limit (approximately 4 billion). This is a problem when there are
tens of billions of internet connected devices already present. IPv6 introduces a 128
bit address space, which allows for approximately 3.4x10^38 possible addresses. The major
advantage for Robot Raconteur is the introduction of "link-local" addresses. These
addresses
begin with "FE80::" and finish with an "EUI-64" address, which is tied to the MAC
address
of the adaptor. IPv4 addresses need to be assigned to devices locally, and have a tendency
to change. IPv6 addresses are permanently assigned to the adapter itself, meaning that
network configuration for LAN communication is essentially automatic. Robot Raconteur
will prefer IPv6 connections when possible for this reason.
</para>
<para>
The TcpTransport is capable of using "raw" streams that implement the Robot Raconteur
message protocols, or to use HTTP WebSockets. HTTP WebSockets allow Robot Raconteur
to communicate seamlessly with browsers and HTTP servers without requiring
additional plugins. WebSockets provide additional security using "origins". See
AddWebSocketAllowedOrigin() for more information.
</para>
<para>
The TcpTransport supports TLS encryption using certificates. See tls_security for
more information on TLS. The TcpTransport supports four modes of TLS encryption:
</para>
<list type="table">
<listheader>
<term>Scheme</term>
<term>Description</term>
<term>Direction</term>
</listheader>
<item>
<term>rrs+tcp</term>
<term>"Raw" protocol with TLS</term>
<term>Both</term>
</item>
<item>
<term>rr+wss</term>
<term>Websocket over HTTPS</term>
<term>Client Only</term>
</item>
<item>
<term>rrs+ws</term>
<term>Websocket with RobotRaconteur TLS over HTTP</term>
<term>Both</term>
</item>
<item>
<term>rrs+wss</term>
<term>Websocket with RobotRaconteur TLS over HTTPS</term>
<term>Client Only</term>
</item>
</list>
<para>
The different combinations of TLS and HTTPS for websockets are used for different
scenarios.
Robot Raconteur Core can initiate HTTPS connections, but cannot accept them. Accepting
HTTPS connections requires a certificate issued by an authority like GoDaddy or Digicert,
and is typically used with an HTTP server running RobotRaconteurWeb.
</para>
<para>
TLS certificates for Robot Raconteur nodes are issued by Wason Technology, LLC using
a root certificate that is "burned in" to Robot Raconteur Core. All devices running
Robot Raconteur will support this certificate chain.
</para>
<para>
Discovery for the TcpTransport is accomplished using User Defined Protocol (UDP) multicast
and/or broadcast packets. Broadcast packets are sent to all connected devices, while
multicast is sent to devices that have registered to receive them. Unlike TCP, the packets
sent to broadcast or multicast are sent to the entire network. This allows for devices
to find each other on the network.
</para>
<para>
For IPv4, the broadcast address 255.255.255.255 on port 48653
is used for discovery. By default, IPv4 is disabled in favor of IPv6. IPv6 uses the
multicast
following multicast addresses:
</para>
<list type="table">
<listheader>
<term>Address</term>
<term>Scope</term>
<term>Port</term>
<term>Default?</term>
</listheader>
<item>
<term>FF01::BA86</term>
<term>Node-Local</term>
<term>48653</term>
<term>Disabled</term>
</item>
<item>
<term>FF02::BA86</term>
<term>Link-Local</term>
<term>48653</term>
<term>Enabled</term>
</item>
<item>
<term>FF05::BA86</term>
<term>Site-Local</term>
<term>48653</term>
<term>Disabled</term>
</item>
</list>
<para>
By default, discovery will only occur on the link-local IPv6 scope. This will
find nodes on the local subnet, but will not attempt to pass through any routers.
</para>
<para>
The use of RobotRaconteurNodeSetup and subclasses is recommended to construct
transports.
</para>
<para> The transport must be registered with the node using
RobotRaconteurNode.RegisterTransport() after construction if node
setup is not used.
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.TcpTransport.#ctor">
<summary>
Construct a new TcpTransport for use with default node. Must be registered with node
using
RobotRaconteurNode.s.RegisterTransport()
</summary>
<remarks>None</remarks>
</member>
<member name="M:RobotRaconteur.TcpTransport.#ctor(RobotRaconteur.RobotRaconteurNode)">
<summary>
Construct a new LocalTransport for a non-default node. Must be registered with node using
node.RegisterTransport()
</summary>
<remarks>None</remarks>
<param name="node">The node to use with the transport</param>
</member>
<member name="M:RobotRaconteur.TcpTransport.Close">
<summary>
Close the transport. Done automatically by node shutdown.
</summary>
<remarks>None</remarks>
</member>
<member name="M:RobotRaconteur.TcpTransport.EnableNodeDiscoveryListening(RobotRaconteur.IPNodeDiscoveryFlags)">
<summary>
Enable node discovery listening
</summary>
<remarks>
<para>
By default enables listining on IPv6 link-local scope
</para>
<para> See IPNodeDiscoveryFlags constants
</para>
</remarks>
<param name="flags">The flags specifying the scope</param>
</member>
<member name="M:RobotRaconteur.TcpTransport.EnableNodeDiscoveryListening">
<summary>
Enable node discovery listening
</summary>
<remarks>
<para>
By default enables listining on IPv6 link-local scope
</para>
<para> See IPNodeDiscoveryFlags constants
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.TcpTransport.DisableNodeDiscoveryListening">
<summary>
Disable node discovery listening
</summary>
<remarks>None</remarks>
</member>
<member name="M:RobotRaconteur.TcpTransport.EnableNodeAnnounce(RobotRaconteur.IPNodeDiscoveryFlags)">
<summary>
Enable node discovery announce
</summary>
<remarks>
<para>
By default enables announce on IPv6 link-local scope
</para>
<para> See IPNodeDiscoveryFlags constants
</para>
</remarks>
<param name="flags">The flags specifying the scope</param>
</member>
<member name="M:RobotRaconteur.TcpTransport.EnableNodeAnnounce">
<summary>
Enable node discovery announce
</summary>
<remarks>
<para>
By default enables announce on IPv6 link-local scope
</para>
<para> See IPNodeDiscoveryFlags constants
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.TcpTransport.DisableNodeAnnounce">
<summary>
Disable node discovery announce
</summary>
<remarks>None</remarks>
</member>
<member name="T:RobotRaconteur.TimerEvent">
<summary>
Timer event structure
</summary>
<remarks>
Contains information about the state of the timer. Passed to the
callback on invocation.
</remarks>
</member>
<member name="P:RobotRaconteur.TimerEvent.stopped">
<summary>
True if timer has been stopped
</summary>
<remarks>None</remarks>
</member>
<member name="P:RobotRaconteur.TimerEvent.last_expected">
<summary>
The last expected callback invocation time
</summary>
<remarks>None</remarks>
</member>
<member name="P:RobotRaconteur.TimerEvent.last_real">
<summary>
The last real callback invocation time
</summary>
<remarks>None</remarks>
</member>
<member name="P:RobotRaconteur.TimerEvent.current_expected">
<summary>
The current expected callback invocation time
</summary>
<remarks>None</remarks>
</member>
<member name="P:RobotRaconteur.TimerEvent.current_real">
<summary>
The current real callback invocation time
</summary>
<remarks>None</remarks>
</member>
<member name="T:RobotRaconteur.Timer">
<summary>
A timer to invoke a callback
</summary>
<remarks>
<para>
Timers invoke a callback at a specified rate. The timer
can either be one-short, or repeating.
</para>
<para> Use RobotRaconteurNode.CreateTimer() to create timers.
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.Timer.Start">
<summary>
Start the timer
</summary>
<remarks>
Must be called after RobotRaconteurNode.CreateTimer()
</remarks>
</member>
<member name="M:RobotRaconteur.Timer.Stop">
<summary>
Stop the timer
</summary>
<remarks>None</remarks>
</member>
<member name="M:RobotRaconteur.Timer.GetPeriod">
<summary>
Get the period of the timer in milliseconds
</summary>
<remarks>None</remarks>
</member>
<member name="M:RobotRaconteur.Timer.SetPeriod(System.Int32)">
<summary>
Set the period of the timer in milliseconds
</summary>
<remarks>None</remarks>
<param name="period">Period in milliseconds</param>
</member>
<member name="M:RobotRaconteur.Timer.IsRunning">
<summary>
Get if the timer is running
</summary>
<remarks>None</remarks>
</member>
<member name="T:RobotRaconteur.Rate">
<summary>
Rate to stabilize a loop
</summary>
<remarks>
Rate is used to stabilize the period of a loop. Use
RobotRaconteur.CreateRate() to create rates.
</remarks>
</member>
<member name="M:RobotRaconteur.Rate.Sleep">
<summary>
Sleep the calling thread until the current loop period expires
</summary>
<remarks>None</remarks>
</member>
<member name="T:RobotRaconteur.AutoResetEvent">
<summary>
Synchronization event for thread synchronization. Resets automatically after
being triggered
</summary>
<remarks>
Construct using RobotRaconteurNode.CreateAutoResetEvent()
</remarks>
</member>
<member name="M:RobotRaconteur.AutoResetEvent.Set">
<summary>
Set the event, releasing waiting threads
</summary>
<remarks>None</remarks>
</member>
<member name="M:RobotRaconteur.AutoResetEvent.Reset">
<summary>
Reset the event
</summary>
<remarks>None</remarks>
</member>
<member name="M:RobotRaconteur.AutoResetEvent.WaitOne">
<summary>
Block the current thread until Set() is called
</summary>
<remarks>None</remarks>
</member>
<member name="M:RobotRaconteur.AutoResetEvent.WaitOne(System.Int32)">
<summary>
Block the current thread until Set() is called, or timeout
expires
</summary>
<remarks>
Timeout is based on the RobotRaconteurNode time provider
</remarks>
<param name="timeout">The timeout in milliseconds</param>
<returns>true if event was set, otherwise false</returns>
</member>
<member name="T:RobotRaconteur.NodeID">
<summary>
NodeID UUID storage and generation
</summary>
<remarks>
<para>
Robot Raconteur uses NodeID and NodeName to uniquely identify a node.
NodeID is a UUID (Universally Unique ID), while NodeName is a string. The
NodeID is expected to be unique, while the NodeName is set by the user
and may not be unique. The NodeID class represents the UUID NodeID.
</para>
<para>
A UUID is a 128-bit randomly generated number that is statistically guaranteed
to be unique to a very high probability. NodeID uses the Boost.UUID library
to generate, manage, and store the UUID.
</para>
<para>
The UUID can be loaded from a string, bytes, or generated randomly at runtime.
It can be converted to a string.
</para>
<para>
The LocalTransport and ServerNodeSetup classes will automatically assign
a NodeID to a node when the local transport is started with a specified node name.
The generated NodeID is stored on the local system, and is associated with the node name.
It will be loaded when a node is started with the same NodeName.
</para>
<para> NodeID with all zeros is considered "any" node.
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.NodeID.#ctor">
<summary>
Construct a new NodeID with "any" node UUID
</summary>
<remarks>None</remarks>
</member>
<member name="M:RobotRaconteur.NodeID.#ctor(System.Byte[])">
<summary>
Construct a new NodeID with the specified UUID bytes
</summary>
<remarks>None</remarks>
<param name="id">The UUID bytes</param>
</member>
<member name="M:RobotRaconteur.NodeID.#ctor(System.String)">
<summary>
Construct a new NodeID parsing a string UUID
</summary>
<remarks>None</remarks>
<param name="id">The UUID as a string</param>
</member>
<member name="M:RobotRaconteur.NodeID.ToString">
<summary> Convert the NodeID UUID to string with "B" format<br /> Convert the UUID string to
8-4-4-4-12 "B" format (with brackets)<br /> {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx} </summary>
<remarks>None</remarks>
</member>
<member name="M:RobotRaconteur.NodeID.IsAnyNode">
<summary>
Is the NodeID UUID all zeros
</summary>
<remarks>
The all zero UUID respresents "any" node, or an unset NodeID
</remarks>
<returns>true The NodeID UUID is all zeros, representing any node, false The NodeID UUID is
not all zeros</returns>
</member>
<member name="M:RobotRaconteur.NodeID.GetAny">
<summary>
Get the "any" NodeId
</summary>
<returns>The "any" NodeID</returns>
</member>
<member name="M:RobotRaconteur.NodeID.ToByteArray">
<summary>
Convert the NodeID UUID to bytes
</summary>
<returns>The UUID as bytes</returns>
</member>
<member name="M:RobotRaconteur.NodeID.NewUniqueID">
<summary>
Generate a new random NodeID UUID
</summary>
<remarks>
Returned UUID is statistically guaranteed to be unique
</remarks>
<returns>The newly generated UUID</returns>
</member>
<member name="T:RobotRaconteur.ServerContext">
<summary>
Context for services registered in a node for use by clients
</summary>
<remarks>
<para>
Services are registered using the RobotRaconteurNode.RegisterService() family of
functions.
The ServerContext manages the services, and dispatches requests and packets to the
appropriate
service object members. Services may expose more than one object. The root object is
specified
when the service is registered. Other objects are specified through ObjRef members. A name
for the service is also specified when the service is registered. This name forms the root
of the service path namespace. Other objects in the service have a unique service path
based on the ObjRef used to access the object.
</para>
<para>
Services may handle multiple connected clients concurrently. Each client is assigned
a ServerEndpoint. The ServerEndpoint is unique to the client connection,
and interacts with ServerContext to complete requests and dispatch packets. When
the service needs to address a specific client, the ServerEndpoint or the
ServerEndpoint.GetCurrentEndpoint() is used. (ServerEndpoint.GetCurrentEndpoint() returns
the
int local client ID.)
</para>
<para>
Service attributes are a varvalue{string} types dictionary that is made available to
clients during service discovery. These attributes are used to help clients determine
which service should be selected for use. Because the attributes are passed to the clients
as part of the discovery process, they should be as concise as possible, and should
not use user defined types. Use ServerContext.SetAttributes() to set the service
attributes
after registering the service.
</para>
<para>
Security for the service is specified using a ServiceSecurityPolicy instance. This policy
is specified by passing as a parameter to RobotRaconteurNode.RegisterService(), or passing
the policy to the constructor.
</para>
<para>
ServerContext implements authentication and object locking.
Server side functions are exposed by ServerContext for authentication, object locking,
and client management.
</para>
<para> Clients using dynamic typing such as Python and MATLAB will only pull service types
explicitly imported by the root object and objref objects that have been requested.
Clients
will not pull service types of user-defined named types if that service type is not
explicitly
imported. This can be problematic if new `struct`, `pod`, and/or `namedarray` types are
introduced
that do not have corresponding objects. Extra imports is used to specify extra service
definitions
the client should pull. Use ServerContext.AddExtraImport(),
ServerContext.RemoveExtraImport(),
and ServerContext.GetExtraImports() to manage the extra imports passed to the client.
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.ServerContext.GetCurrentServicePath">
<summary>
Get the current object service path
</summary>
<remarks>
Returns the service path of the current object during a request or
packet event.
This is a thread-specific value and only
valid during the initial request or packet event invocation.
</remarks>
<returns>The current object service path</returns>
</member>
<member name="P:RobotRaconteur.ServerContext.CurrentServicePath">
<summary>
Get the current object service path
</summary>
<remarks>
Returns the service path of the current object during a request or
packet event.
This is a thread-specific value and only
valid during the initial request or packet event invocation.
</remarks>
</member>
<member name="M:RobotRaconteur.ServerContext.GetCurrentServerContext">
<summary>
Get the current ServerContext
</summary>
<remarks>
Returns the current server context during a request or packet event.
This is a thread-specific value and only
valid during the initial request or packet event invocation.
</remarks>
<return>The current server context</return>
</member>
<member name="P:RobotRaconteur.ServerContext.CurrentServerContext">
<summary>
Get the current ServerContext
</summary>
<remarks>
Returns the current server context during a request or packet event.
This is a thread-specific value and only
valid during the initial request or packet event invocation.
</remarks>
</member>
<member name="M:RobotRaconteur.ServerContext.KickUser(System.String)">
<summary>
Kicks a user with the specified username
</summary>
<remarks>
User must be authenticated.
</remarks>
<param name="username">The username to kick</param>
</member>
<member name="M:RobotRaconteur.ServerContext.RequestObjectLock(System.String,System.String)">
<summary>
Request an object lock on servicepath for user username
</summary>
<remarks>
This function handles incoming client requests, but may also be used
by the service directly
</remarks>
<param name="servicepath">The service path to lock</param>
<param name="username">The name of the user owning the lock</param>
</member>
<member name="M:RobotRaconteur.ServerContext.RequestClientObjectLock(System.String,System.String,System.UInt32)">
<summary>
Request a client lock on servicepath for a specific client connection
</summary>
<remarks>
This function handles incoming client requests, but may also be used
by the service directly. Client object locks lock for a specific client connection,
while client locks lock for a specific user. The specific client connection is
specified using endpoint.
</remarks>
<param name="servicepath">The service path to lock</param>
<param name="username">The name of the user owning the lock</param>
<param name="endpoint">The client endpoint ID of the client owning the lock</param>
</member>
<member name="M:RobotRaconteur.ServerContext.ReleaseObjectLock(System.String,System.String,System.Boolean)">
<summary>
Release a client lock on servicepath
</summary>
<remarks>
<para>
This function handles incoming client requests, but may also be used
by the service directly. Client locks can be released by the user that
created them if override_ is false, or by any user if override_ is true.
</para>
<para> The override_ parameter is set to true for client requests if the client has
the "objectlockoverride" permission.
</para>
</remarks>
<param name="servicepath">The service path to release lock</param>
<param name="username">The username requesting the lock release</param>
<param name="override_">If False, only the creating username can release the lock. If True,
any username can release the lock</param>
</member>
<member name="M:RobotRaconteur.ServerContext.GetObjectLockUsername(System.String)">
<summary>
Get the name of the user that has locked the specified service path
</summary>
<remarks>None</remarks>
<param name="servicepath">The service path</param>
<returns>The user owning the lock, or empty servicepath is not locked</returns>
</member>
<member name="M:RobotRaconteur.ServerContext.GetExtraImports">
<summary>
Get the current list of extra service definition imports
</summary>
<returns>The list of extra imports</returns>
</member>
<member name="M:RobotRaconteur.ServerContext.AddExtraImport(System.String)">
<summary>
Add an extra service definition import
</summary>
<remarks>
<para>
Clients using dynamic typing will not automatically pull service definitions unless
imported by the root object or an objref. If new "struct", "pod", or "namedarray"
types
are introduced in a new service definition type without a corresponding object, an error
will
occur. Use AddExtraImport() to add the name of the new service definition to add it to the
list of service definitions the client will pull.
</para>
<para> Service definition must have been registered using
RobotRaconteurNode.RegisterServiceType()
</para>
</remarks>
<param name="import_">The name of the service definition</param>
</member>
<member name="M:RobotRaconteur.ServerContext.RemoveExtraImport(System.String)">
<summary>
Removes an extra import service definition registered with AddExtraImport()
</summary>
<remarks>
See AddExtraImport()
</remarks>
<param name="import_">The name of the service definition</param>
<returns>true The service definition was removed, false The service definition was not found
in the extra imports vector</returns>
</member>
<member name="M:RobotRaconteur.ServerContext.GetCandidateConnectionURLs">
<summary>
Get the candidate connection URLs for this service.
</summary>
<remarks>
<para>
The candidate connection URLs are the URLs that can be used to connect to the service.
The correct URL to use depends on the transport being used to connect to the service,
and the network configuration of the client and service.
</para>
</remarks>
<returns>The candidate connection URLs</returns>
</member>
<member name="M:RobotRaconteur.ServerContext.PrintCandidateConnectionURLs">
<summary>
Print the candidate connection URLs for this service.
</summary>
<remarks>
<para>
See GetCandidateConnectionURLs() for more information.
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.ServerContext.LogCandidateConnectionURLs(RobotRaconteur.LogLevel)">
<summary>
Log the candidate connection URLs for this service.
</summary>
<remarks>
<para>
See GetCandidateConnectionURLs() for more information.
</para>
</remarks>
<param name="level">The log level to use. Defaults to RobotRaconteur_LogLevel_Info</param>
</member>
<member name="M:RobotRaconteur.ServerContext.SetServiceAttributes(System.Collections.Generic.Dictionary{System.String,System.Object})">
<summary>
Set the service attributes
</summary>
<remarks>
Sets the service attributes. Attributes are made available to clients during
service discovery. Attributes should be concise and not use any user defined
types.
</remarks>
<param name="attributes">The service attributes</param>
</member>
<member name="M:RobotRaconteur.ServerContext.AddServerServiceListener(RobotRaconteur.ServerContext.ServerServiceListenerDelegate)">
<summary>
Add a service listener
</summary>
<remarks>None</remarks>
<param name="listener">Callable listener function</param>
</member>
<member name="M:RobotRaconteur.ServerContext.ReleaseServicePath(System.String)">
<summary> Release the specified service path and all sub objects Services take ownership of
objects returned by objrefs, and will only request the object once. Subsequent requests will
return the cached object. If the objref has changed, the service must call
ReleaseServicePath() to tell the service to request the object again. Release service path
will release the object specified by the service path and all sub objects. This overload
will notify all clients that the objref has been released. If the service path contains a
session key, use ReleaseServicePath(string, uint[]) to only
notify the client that owns the session.
</summary>
<remarks>None</remarks>
<param name="path">The service path to release</param>
</member>
<member name="M:RobotRaconteur.ServerContext.ReleaseServicePath(System.String,System.UInt32[])">
<summary>
Release the specified service path and all sub objects
</summary>
<remarks>
<para>
Services take ownership of objects returned by objrefs, and will only request the object
once. Subsequent requests will return the cached object. If the objref has changed,
the service must call ReleaseServicePath() to tell the service to request the object
again.
Release service path will release the object specified by the service path
and all sub objects.
</para>
<para> This overload will notify the specified that the objref has been released. If the
service
path contains a session key, this overload should be used so the session key is not
leaked.
</para>
</remarks>
<param name="path">The service path to release</param>
<param name="endpoints">The client endpoint IDs to notify of the released service path</param>
</member>
<member name="T:RobotRaconteur.ServerEndpoint">
<summary>
Server endpoint representing a client connection
</summary>
<remarks>
<para>
Robot Raconteur creates endpoint pairs between a client and service. For clients, this
endpoint
is a ClientContext. For services, the endpoint becomes a ServerEndpoint. ServerEndpoints
are used
to address a specific client connected to a service, since services may have multiple
clients
connected concurrently. ServerEndpoints also provide client authentication information.
</para>
<para>Use ServerEndpoint.GetCurrentEndpoint() to retrieve the int32
current endpoint ID. Use ServerEndpoint.GetCurrentAuthenticatedUser() to retrieve
the current user authentication information.
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.ServerEndpoint.GetCurrentEndpoint">
<summary>
Returns the current server endpoint
</summary>
<remarks>
<para>
Returns the current server endpoint during a request or packet event.
This is a thread-specific value and only valid during the initial
request or packet event invocation.
</para>
<para>Throws InvalidOperationException if not during a request or packet event
</para>
</remarks>
<returns>The current server endpoint id</returns>
</member>
<member name="M:RobotRaconteur.ServerEndpoint.GetCurrentAuthenticatedUser">
<summary>
Returns the current authenticated user
</summary>
<remarks>
<para>
Users that have been authenticated have a corresponding
AuthenticatedUser object associated with the ServerEndpoint.
GetCurrentAuthenticatedUser() returns the AuthenticatedUser
associated with the current ServerEndpoint during a request
or packet event. This is a thread-specific value and only valid during
the initial request or packet event invocation.
</para>
<para>Throws PermissionDeniedException or AuthenticationException
if there is no AuthenticatedUser set in the current thread.
</para>
</remarks>
</member>
<member name="T:RobotRaconteur.AuthenticatedUser">
<summary>
Class representing an authenticated user
</summary>
<remarks>
<para>
Use ServerEndpoint.GetCurrentAuthenticatedUser() to retrieve the
authenticated user making a request
</para>
<para>See security for more information.
</para>
</remarks>
</member>
<member name="T:RobotRaconteur.ServiceSecurityPolicy">
<summary>
Security policy for Robot Raconteur service
</summary>
<remarks>
<para>
The security policy sets an authenticator, and a set of policies.
PasswordFileUserAuthenticator is
an example of an authenticator. The valid options for Policies are as follows:
</para>
<list type="table">
<listheader>
<term>Policy name</term>
<term>Possible Values</term>
<term>Default</term>
<term>Description</term>
</listheader>
<item>
<term>requirevaliduser</term>
<term>true,false</term>
<term>false</term>
<term>Set to "true" to require a user be authenticated before accessing
service</term>
</item>
<item>
<term>allowobjectlock</term>
<term>true,false</term>
<term>false</term>
<term>If "true" allow users to request object locks. requirevaliduser must
also be "true"</term>
</item>
</list>
<para>
The security policy is passed as a parameter to RobotRaconteurNode.RegisterService().
</para>
<para>See security for more information.
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.ServiceSecurityPolicy.#ctor(RobotRaconteur.IUserAuthenticator,System.Collections.Generic.Dictionary{System.String,System.String})">
<summary>Construct a new security policy</summary>
<remarks>None</remarks>
<param name="authenticator">The user authenticator</param>
<param name="policies">The security policies</param>
</member>
<member name="T:RobotRaconteur.NativeUserAuthenticator">
<summary>
Base class for user authenticators
</summary>
<remarks>
<para>
Used with ServiceSecurityPolicy to secure services
</para>
<para> Override AuthenticateUser to implement different types
of user authenticators.
</para>
</remarks>
</member>
<member name="T:RobotRaconteur.PasswordFileUserAuthenticator">
<summary>
Simple authenticator using a list of username, password hash, and privileges stored in a
file or string
</summary>
<remarks>
<para>
The password user authenticator expects a string containing a list of users,
one per line. Each line contains the username, password as md5 hash, and privileges,
separated by white spaces.
An example of authentication string contents:
</para>
<code>
user1 79e262a81dd19d40ae008f74eb59edce objectlock
user2 309825a0951b3cf1f25e27b61cee8243 objectlock
superuser1 11e5dfc68422e697563a4253ba360615 objectlock,objectlockoverride
</code>
<para>
The password is md5 hashed. This hash can be generated using the ``--md5passwordhash``
command in the "RobotRaconteurGen" utility.
The privileges are comma separated. Valid privileges are as follows:
</para>
<list type="table">
<listheader>
<term>Policy name</term>
<term>Possible Values</term>
<term>Default</term>
<term>Description</term>
</listheader>
<item>
<term>requirevaliduser</term>
<term>true,false</term>
<term>false</term>
<term>Set to "true" to require a user be authenticated before accessing
service</term>
</item>
<item>
<term>allowobjectlock</term>
<term>true,false</term>
<term>false</term>
<term>If "true" allow users to request object locks. requirevaliduser must
also be "true"</term>
</item>
</list>
</remarks>
</member>
<member name="M:RobotRaconteur.PasswordFileUserAuthenticator.#ctor(System.String)">
<summary>
Construct a new PasswordFileUserAuthenticator
</summary>
<summary name="data">The file text</summary>
<remarks>None</remarks>
</member>
<member name="M:RobotRaconteur.PasswordFileUserAuthenticator.#ctor(System.String,System.Boolean)">
<summary>
Construct a new PasswordFileUserAuthenticator
</summary>
<remarks>None</remarks>
<param name="data">The file text</param>
<param name="require_verified_client">Require clients to be verified</param>
</member>
<member name="T:RobotRaconteur.RRLogRecord">
<summary>
Robot Raconteur log record
</summary>
<remarks>
<para>
Records information about a logging event
</para>
<para> See logging for more information.
</para>
</remarks>
</member>
<member name="P:RobotRaconteur.RRLogRecord.Level">
<summary>
The log level
</summary>
<remarks>None</remarks>
</member>
<member name="P:RobotRaconteur.RRLogRecord.Component">
<summary>
The source component
</summary>
<remarks>None</remarks>
</member>
<member name="P:RobotRaconteur.RRLogRecord.ComponentName">
<summary>
The source component name
</summary>
<remarks>None</remarks>
</member>
<member name="P:RobotRaconteur.RRLogRecord.ComponentObjectID">
<summary>
The source component object ID
</summary>
<remarks>None</remarks>
</member>
<member name="P:RobotRaconteur.RRLogRecord.Endpoint">
<summary>
The source endpoint
</summary>
<remarks>None</remarks>
</member>
<member name="P:RobotRaconteur.RRLogRecord.ServicePath">
<summary>
The service path of the source object
</summary>
<remarks>None</remarks>
</member>
<member name="P:RobotRaconteur.RRLogRecord.Member">
<summary>
The source member
</summary>
<remarks>None</remarks>
</member>
<member name="P:RobotRaconteur.RRLogRecord.Message">
<summary>
Human readable log message
</summary>
<remarks>None</remarks>
</member>
<member name="P:RobotRaconteur.RRLogRecord.Time">
<summary>
Time of logging event
</summary>
<remarks>None</remarks>
</member>
<member name="P:RobotRaconteur.RRLogRecord.SourceFile">
<summary>
The sourcecode filename
</summary>
<remarks>None</remarks>
</member>
<member name="P:RobotRaconteur.RRLogRecord.SourceLine">
<summary>
The line within the sourcecode file
</summary>
<remarks>None</remarks>
</member>
<member name="P:RobotRaconteur.RRLogRecord.ThreadID">
<summary>
The source thread
</summary>
<remarks>None</remarks>
</member>
<member name="P:RobotRaconteur.RRLogRecord.FiberID">
<summary>
The source coroutine fiber
</summary>
<remarks>None</remarks>
</member>
<member name="P:RobotRaconteur.RRLogRecord.Node">
<summary>
The source node
</summary>
<remarks>None</remarks>
</member>
<member name="T:RobotRaconteur.LogRecordHandler">
<summary>
Base class of log record handler
</summary>
<remarks>
<para>
By default, RobotRaconteurNode will print log records to ``stderr``. Use
RobotRaconteur.RobotRaconteurNode.SetLogRecordHandler() to specify a LogRecordHandler
to accept log records instead of printing them to the terminal.
</para>
<para>See logging for more information.
</para>
</remarks>
</member>
<member name="T:RobotRaconteur.FileLogRecordHandler">
<summary>
Log record handler that saves to a file
</summary>
<remarks>
See logging for more information.
</remarks>
</member>
<member name="M:RobotRaconteur.FileLogRecordHandler.#ctor">
<summary>
Construct a FileLogRecordHandler. Use OpenFile() to open a file.
</summary>
<remarks>None</remarks>
</member>
<member name="M:RobotRaconteur.FileLogRecordHandler.OpenFile(System.String)">
<summary>
Open a file to store log records
</summary>
<remarks>None</remarks>
<param name="filename">The filename</param>
</member>
<member name="M:RobotRaconteur.FileLogRecordHandler.OpenFile(System.String,System.Boolean)">
<summary>
Open a file to store log records
</summary>
<remarks>None</remarks>
<param name="filename">The filename</param>
<param name="append">If true, log messages are appended. If false, the file is truncated when
opened</param>
</member>
<member name="T:RobotRaconteur.BroadcastDownsampler">
<summary>
Downsampler to manage rate of packets sent to client
</summary>
<remarks>
<para>
PipeBroadcaster and WireBroadcaster by default sends packets to all clients when
a pipe packet is sent or the wire value is changed. The updates typically happen
within a sensor or control loop, with the rate set by the specific device producing
the updates. Some clients may require less frequent data, and may run in to bandwidth
or processing issues if the data is sent at the full update rate. The BroadcastDownsampler
is used to implement broadcaster predicates that will drop packets.
Clients specify how many packets they want dropped between each packet sent. For instance,
a downsample of 0 means that no packets are dropped. A downsample of 1 will drop every
other
packet. A downsample of two will drop 2 packets between sending 1 packet, etc. The
downsample level for each client is set using SetClientDownsample(). This should be
made available to the client using a property member.
</para>
<para>
PipeBroadcaster and WireBroadcaster must be added to the downsampler
using AddPipeBroadcaster() and AddWireBroadcaster(), respectively.
It is recommended that these functions be called within
the RRServiceObjectInit(context,servicepath) function that is called
by the node when a service object is initialized.
</para>
<para>
BeginStep() and EndStep() must be called for each iteration of the
broadcasting loop. Use BroadcastDownsamplerStep for automatic
management in the loop.
</para>
<para>See com.robotraconteur.isoch.IsochDevice for the standard use
of downsampling.
</para>
</remarks>
</member>
<member name="M:RobotRaconteur.BroadcastDownsampler.#ctor(RobotRaconteur.ServerContext,System.UInt32)">
<summary>
Construct a new BroadcastDownsampler
</summary>
<remarks>None</remarks>
<param name="context">The service context</param>
<param name="default_downsample">The default downsample. Usually set to 0</param>
</member>
<member name="M:RobotRaconteur.BroadcastDownsampler.GetClientDownsample(System.UInt32)">
<summary>
Get the downsample for the specified client
</summary>
<remarks>None</remarks>
<param name="ep">The endpoint ID of the client</param>
<returns>The downsample</returns>
</member>
<member name="M:RobotRaconteur.BroadcastDownsampler.SetClientDownsample(System.UInt32,System.UInt32)">
<summary>
Set the downsample for the specified client
</summary>
<remarks>None</remarks>
<param name="ep">The endpoint ID of the client</param>
<param name="downsample">The desired downsample</param>
</member>
<member name="M:RobotRaconteur.BroadcastDownsampler.BeginStep">
<summary>
Begin the update loop step
</summary>
<remarks>
Use BroadcastDownsamplerStep for automatic stepping
</remarks>
</member>
<member name="M:RobotRaconteur.BroadcastDownsampler.EndStep">
<summary>
End the update loop step
</summary>
<remarks>
Use BroadcastDownsamplerStep for automatic stepping
</remarks>
</member>
<member name="T:RobotRaconteur.ServiceSubscriptionFilterAttribute">
<summary>Subscription filter attribute for use with ServiceSubscriptionFilter</summary>
<remarks>None</remarks>
</member>
<member name="M:RobotRaconteur.ServiceSubscriptionFilterAttribute.#ctor">
<summary>Construct a new ServiceSubscriptionFilterAttribute</summary>
<remarks>None</remarks>
</member>
<member name="P:RobotRaconteur.ServiceSubscriptionFilterAttribute.Name">
<summary>The attribute name. Empty for no name</summary>
<remarks>None</remarks>
</member>
<member name="P:RobotRaconteur.ServiceSubscriptionFilterAttribute.Value">
<summary>The string value of the attribute</summary>
<remarks>None</remarks>
</member>
<member name="T:RobotRaconteur.ServiceSubscriptionFilterAttributeGroupOperation">
<summary>Subscription filter attribute group for use with ServiceSubscriptionFilter</summary>
<remarks>None</remarks>
</member>
<member name="F:RobotRaconteur.ServiceSubscriptionFilterAttributeGroupOperation.OR">
<summary>OR Operation</summary>
<remarks>None</remarks>
</member>
<member name="F:RobotRaconteur.ServiceSubscriptionFilterAttributeGroupOperation.AND">
<summary>AND Operation</summary>
<remarks>None</remarks>
</member>
<member name="F:RobotRaconteur.ServiceSubscriptionFilterAttributeGroupOperation.NOR">
<summary>NOR Operation</summary>
<remarks>None</remarks>
</member>
<member name="F:RobotRaconteur.ServiceSubscriptionFilterAttributeGroupOperation.NAND">
<summary>NAND Operation</summary>
<remarks>None</remarks>
</member>
<member name="T:RobotRaconteur.ServiceSubscriptionFilterAttributeGroup">
<summary>Subscription filter for use with ServiceSubscription</summary>
<remarks>None</remarks>
</member>
<member name="M:RobotRaconteur.ServiceSubscriptionFilterAttributeGroup.#ctor">
<summary>Construct a new ServiceSubscriptionFilterAttributeGroup</summary>
<remarks>None</remarks>
</member>
<member name="P:RobotRaconteur.ServiceSubscriptionFilterAttributeGroup.Attributes">
<summary>The attributes in the group</summary>
<remarks>None</remarks>
</member>
<member name="P:RobotRaconteur.ServiceSubscriptionFilterAttributeGroup.Groups">
<summary>The nested groups in the group</summary>
<remarks>None</remarks>
</member>
<member name="P:RobotRaconteur.ServiceSubscriptionFilterAttributeGroup.Operation">
<summary>The operation to use for matching the attributes and groups</summary>
<remarks>None</remarks>
</member>
<member name="P:RobotRaconteur.ServiceSubscriptionFilterAttributeGroup.SplitStringAttribute">
<summary>True if string attributes will be split into a list with delimiter (default ",")</summary>
<remarks>None</remarks>
</member>
<member name="P:RobotRaconteur.ServiceSubscriptionFilterAttributeGroup.SplitStringDelimiter">
<summary>Delimiter to use to split string attributes (default ",")</summary>
<remarks>None</remarks>
</member>
<!-- BEGIN GENERATED_MEMBERS -->
<!-- GENERATED_MEMBERS -->
<!-- END GENERATED_MEMBERS -->
</members>
</doc>
|