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
|
###############
Getting Started
###############
.. image:: /_static/gettingstarted-figures/Cyclone_DDS-Logo.png
:width: 50%
:align: center
Installing Eclipse Cyclone DDS
==============================
Eclipse Cyclone DDS is a very performant and robust OMG compliant Data
Distribution Service (DDS) implementation. Cyclone DDS core is
implemented in C and provides C-APIs to applications. Through its
Cyclonedds-cxx package, the ISO/IEC C++ 2003 language binding is
supported.
The first chapters detail the installation and build process of Cyclone
Core, including the C-APIs. The remaining chapters details how to
install the C++ support packages. Short tutorials in C and C++ are
detailed to give the reader examples of how the DDS technology is used
with Cyclone to share data.
System requirements
~~~~~~~~~~~~~~~~~~~
At the time of writing this document, Eclipse Cyclone DDS supports
Linux, macOS, and Windows and is known to work on FreeRTOS, QNX and the
solaris-like Openindiana OS.
To build the Cyclone DDS implementation, the following software should
be installed on your machine:
* A C compiler (most commonly GCC or clang on Linux, Visual Studio on Windows, XCode on macOS);
* `Git <https://git-scm.com/>`__ version control system;
* `CMake <https://cmake.org/download/>`__, version 3.10 or later;
* Optionally `OpenSSL <https://www.openssl.org/>`__, preferably version 1.1 or
later to use TLS over TCP. If you need to reduce the footprint or if
you have issues with the FindOpenSSL CMake script, you can explicitly
disable this by setting ENABLE\_SSL=NO
On Linux, install these dependencies with a package manager of your choice:
.. code-block:: bash
yum install git cmake gcc
apt-get install git cmake gcc
aptitude install git cmake gcc
# or others
On Windows, to install dependencies using chocolatey, use ``choco install git cmake``.
On macOS, installing XCode from the App Store should be enough.
Native Installation for Linux and macOS
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To obtain the Eclipse Cyclone DDS:
.. code-block:: bash
git clone https://github.com/eclipse-cyclonedds/cyclonedds.git
cd cyclonedds
mkdir build
Then, depending on whether you like to develop applications using
Cyclone DDS or contribute to it, you may follow different procedures.
For Application Developers
''''''''''''''''''''''''''
You can build and install the required libraries needed to develop your
own applications using Cyclone DDS in a few simple steps.
.. code-block:: bash
cd build
cmake -DCMAKE_INSTALL_PREFIX=<install-location> ..
cmake --build .
To install it after a successful build:
Depending on the installation location, you may need administrator
privileges.
.. code-block:: bash
cmake --build . --target install
This install step copies everything to:
- ``<install-location>/lib``
- ``<install-location>/bin``
- ``<install-location>/include/ddsc``
- ``<install-location>/share/CycloneDDS``
At this point, you are ready to use Eclipse Cyclone DDS in your own
projects.
**Note:** The default build type is a release build with debug
information included (RelWithDebInfo). This is a convenient type of
build to use from applications because of a good mix between performance
and still being able to debug things. If you'd rather have a Debug or
pure Release build, set ``CMAKE_BUILD_TYPE`` accordingly.
If you want to contribute to Cyclone DDS, please refer to `Appendix I
Contributing to Eclipse Cyclone
DDS <#appendix-i-contributing-to-eclipse-cyclone-dds>`__.
Installation with product installer for Linux and macOS
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
TBD.
Native Installation for Windows
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To obtain the Eclipse Cyclone DDS:
.. code-block:: bash
git clone https://github.com/eclipse-cyclonedds/cyclonedds.git
cd cyclonedds
mkdir build
Then, depending on whether you like to develop applications using
Cyclone DDS or contribute to it, you may follow different procedures.
For Application Developers
''''''''''''''''''''''''''
You can build and install the required libraries needed to develop your
own applications using Cyclone DDS in a few simple steps.
.. code-block:: bash
cd build
cmake -G "<generator-name>" -DCMAKE_INSTALL_PREFIX=<install-location> ..
cmake --build .
**Note:** Replace ``<install-location>`` with the directory where you
would like to install Cyclone DDS. Replace ``<generator-name>`` with one
of the methods CMake
`generators <https://cmake.org/cmake/help/latest/manual/cmake-generators.7.html>`__
offer for generating build files.
For example, "Visual Studio 15 2017 Win64" targets a 64-bit build using
Visual Studio 2017, and the ``<install-location>`` can be in the
``build\install`` directory. With both the ``<generator-name>`` and
``<install-location>`` specified as the example, the command looks like
this:
.. code-block:: bash
cmake -G "Visual Studio 15 2017 Win64" -DCMAKE_INSTALL_PREFIX=install ..
To install it after a successful build:
Depending on the installation location you may need administrator
privileges.
.. code-block:: bash
cmake --build . --target install
This step will copies everything to:
- ``<install-location>/lib``
- ``<install-location>/bin``
- ``<install-location>/include/ddsc``
- ``<install-location>/share/CycloneDDS``
At this point, you are ready to use Eclipse Cyclone DDS in your
projects.
**Note:** The default build type is a release build with debug
information included (RelWithDebInfo). This is a convenient type of
build to use from applications because of a good mix between performance
and still being able to debug things. If you'd rather have a Debug or
pure Release build, set ``CMAKE_BUILD_TYPE`` accordingly.
If you want to contribute to Cyclone DDS, please refer to `Appendix I
Contributing to Eclipse Cyclone DDS for
Windows. <#appendix-i-contributing-to-eclipse-cyclone-dds>`__
Installation with product installer for Windows
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The Cyclone DDS also provides a product installer, this may be easier
than installing it from GitHub.
To install the Cyclone DDS from the installer:
1. Start the installer, and click 'Next'.
.. image:: /_static/gettingstarted-figures/1.5-1.png
:align: center
2. Accept the terms, and click'Next'.
.. image:: /_static/gettingstarted-figures/1.5-2.png
:align: center
3. Choose whether you want to add Cyclone DDS to the system PATH. We
recommend to add it to the system PATH so that your application can
use the related libraries directly. Select whether to add it for the
current user or all users and click 'Next'.
.. image:: /_static/gettingstarted-figures/1.5-3.png
:align: center
4. Set up the directory to install Cyclone DDS. We recommend that you DO
NOT install it in the ``Program Files`` directory, as it needs
administrators' permission to write to the folder. Click 'Next'.
.. image:: /_static/gettingstarted-figures/1.5-4.png
:align: center
5. You are now ready to install the Cyclone DDS, click 'Install'.
.. image:: /_static/gettingstarted-figures/1.5-5.png
:align: center
6. Click 'Finish'.
.. image:: /_static/gettingstarted-figures/1.5-6.png
:align: center
The installation of Cyclone DDS core, C-APIs and pre-compiler are
complete. The next section describes how to test it.
.. _test_your_installation:
Test your Installation
~~~~~~~~~~~~~~~~~~~~~~
To test if your installation and configuration are working correctly,
you can use the Cyclone DDS *ddsperf* tool (``ddsperf sanity``) or you
can use the Hello World example. To use the ddsperf tool, refer to
`testing your network
configuration. <#testing-your-network-configuration>`__ The test
using the Hello World example is explained in this section.
Environnement variable updates
''''''''''''''''''''''''''''''
On Windows, to run Eclipse Cyclone DDS executables, the required libraries
(like ``ddsc.dll``) need to be available to the executables. Normally,
these libraries are installed in system default locations and it works
out-of-the-box. However, if they are not installed in those locations,
the library search path must be changed. This can be achieved by
executing the command:
.. code-block:: PowerShell
set PATH=<install-location>\bin;%PATH%
**Note:** An alternative to make the required libraries available to the
executables, is to simply copy the required libraries to the
executables' directory.
Running the pre-built example
''''''''''''''''''''''''''''''
Eclipse Cyclone DDS includes a simple *Hello World!* application that
can be executed to test your installation. The *Hello World!*
application consists of two executables:
- ``HelloworldPublisher``
- ``HelloworldSubscriber``
The *Hello World!* application is located in
``<cyclonedds-directory>\build\bin\Debug`` in Windows, and
``<cyclonedds-directory>/build/bin`` in Linux.
To run the example application, open two console windows and navigate to
the appropriate directory in both console windows. Run
``HelloworldSubscriber`` in one of the console windows using:
**Windows** ``HelloworldSubscriber.exe``
**Linux** ``./HelloworldSubscriber``
Run ``HelloworldPublisher`` in the other console window using:
**Windows** ``HelloworldPublisher.exe``
**Linux** ``./HelloworldPublisher``
``HelloworldPublisher`` appears as follows:
.. image:: /_static/gettingstarted-figures/1.6.2-1.png
:align: center
``HelloworldSubscriber`` appears as follows:
.. image:: /_static/gettingstarted-figures/1.6.2-2.png
:align: center
**Note:** Cyclone's default behavior is to automatically detect the
first network interface card available on your machine and uses it to
exchange the hello world message. Ensure that your publisher and
subscriber applications are on the same network, selecting the right
interface card. This is one of the most common issues on machine
configurations with multiple network interface cards.
This default behavior can be overridden by updating the property
``//CycloneDDS/Domain/General/``
``NetworkInterfaceAddress`` in a deployment file (e.g.
``cyclonedds.xml``) that you created to point to it through an OS
environment variable named CYCLONEDDS\_URI. More information on this
topic can be found in the `github
repository <https://github.com/eclipse-cyclonedds/cyclonedds/blob/master/docs/manual/options.md>`__
and the configuration section on
https://github.com/eclipse-cyclonedds/cyclonedds.
Want to know more about DDS?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The primary source of information is the OMG website at
`http://www.omg.org <http://www.omg.org/>`__, specifically the `DDS
Getting <http://www.omg.org/gettingstarted/omg_idl.htm>`__\ Startedpage
and the `DDS specification <http://www.omg.org/spec/DDS/>`__.
In the future we will provide the following:
1. Tutorial document
2. Deployment Guide, for now, you can refer to https://github.com/eclipse-cyclonedds/cyclonedds/blob/master/docs/manual/options.md
You can find the API reference in the sidebar.
Uninstalling Cyclone DDS
~~~~~~~~~~~~~~~~~~~~~~~~
Uninstallation for Native Installation
''''''''''''''''''''''''''''''''''''''
You can manually remove the install and build directory. In Linux and
macOS in the install or build directory:
.. code-block:: bash
rm -rf *
Uninstallation for the product installer
''''''''''''''''''''''''''''''''''''''''
Windows
^^^^^^^
On Windows, to uninstall the Cyclone DDS you can either do it from the
Windows application control panel (Programs and Features in Control
Panel) or by using the product installer; in this case, start-up the
Cyclone DDS product installer, and select 'Remove'.
.. image:: /_static/gettingstarted-figures/1.8.2.1.png
:align: center
Linux and macOS
^^^^^^^^^^^^^^^
TBD.
Building Cyclone DDS applications
=================================
Building Your First Example
~~~~~~~~~~~~~~~~~~~~~~~~~~~
To test the complete workflow of building a DDS based application, you
can use a simple *Hello World!*. Although this application does not
reveal all the power of building a data-centric application, it has the
merit to introduce you to the basic steps to build a DDS application.
This chapter focuses on building this example, without analyzing the
source code, which is the subject of the next chapter.
The procedure used to build the *Hello World!* example can also be used
for building your own applications.
On Linux, if you have not specified an installation directory, it is
advised to copy the Cyclone DDS examples to your preferred directory.
You can find them in your ``<install-location>`` directory.
Six files are available under the *Hello* *World!* root directory to
support building the example. For this chapter, we mainly describe:
- ``CMakeLists.txt``
- ``HelloWorldData.idl``
- ``publisher.c``
- ``subscriber.c``
Building the *HelloWorld!* application with CMake
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In the previous sections, building the *Hello* *World!* example is done
by default during the Cyclone build process. However, the *Hello*
*World!* example can also be built using the `CMake
tool <http://cmake.org/>`__, although you can obviously build with your
native compilers and preferred toolchains.
`CMake <http://cmake.org/>`__ is an open-source, cross-platform family
of tools designed to build, test, and package software. It is used to
control the software compilation process using simple platform and
compiler independent configuration files. It also generates native
makefiles, projects, and workspaces of your development environment.
CMake's main strength is build portability. The same CMake input files
build with GNU make, Visual studio 6,7,8 IDEs, Borland make, nmake, and
XCode, etc...
Another advantage of CMake is building out-of-source. It simply works
out-of-the-box. There are two important reasons to choose this means:
- Easy cleanup (no cluttering the source tree). Simply remove the build
directory to start from scratch.
- Multiple build targets. It's possible to have up-to-date Debug and
Release targets, without having to recompile the entire tree. For
systems that do cross-platform compilation, it is easy to have
up-to-date builds for the host and target platform.
In order to use CMake you need to provide a ``CMakeLists.txt``. A sample
CMakeList file can be found within
``<install-location>/share/CycloneDDS/examples/helloworld/``
The content of the ``CMakeLists.txt`` is:
.. code-block:: cmake
cmake_minimum_required(VERSION 3.5)
if (NOT TARGET CycloneDDS::ddsc)
# Find the Cyclone DDS package. If it is not in a default location, try
# finding it relative to the example where it most likely resides.
find_package(CycloneDDS REQUIRED PATHS
"${CMAKE_SOURCE_DIR}/../../")
endif()
# This is a convenience function, provided by the CycloneDDS package,
# that will supply a library target related the the given idl file.
# In short, it takes the idl file, generates the source files with
# the proper data types and compiles them into a library.
idlc_generate(HelloWorldData_lib "HelloWorldData.idl")
# Both executables have only one related source file.
add_executable(HelloworldPublisher publisher.c)
add_executable(HelloworldSubscriber subscriber.c)
# Both executables need to be linked to the idl data type library and
# the ddsc API library.
target_link_libraries(HelloworldPublisher HelloWorldData_lib CycloneDDS::ddsc)
target_link_libraries(HelloworldSubscriber HelloWorldData_lib CycloneDDS::ddsc)
To build a Cyclone based application you need to link your business code
with:
- The ``ddsc`` library that contains the DDS API the application needs.
- The helper functions and structures that represent your datatypes.
These helpers are generated by the Cyclone pre-compiler IDL and can
be accessed through the CMake (``idlc_generate``) call that takes the
idl file (e.g ``HelloWorld.idl``) as input and packages the datatyped
helpers in a library (e.g. ``HelloWorldData_lib``).
The ``idlc_generate`` call makes use of how the DDS IDLC-compiler
generates the helpers' functions and structures.
This process is depicted as follows:
.. image:: /_static/gettingstarted-figures/2.2-1.png
:align: center
The cyclone-based application executable (e.g. ``HelloworldPublisher``)
is built with the CMake ``target_link_libraries()`` call. This call
combines the ``ddsc`` lib, the datatype helper lib, and the application
code lib.
**Note:** CMake attempts to find the ``CycloneDDS`` CMake package in the
default location, two levels above the current source directory. Every
path and dependencies is automatically set. CMake uses the default
locations to locate the code CycloneDDS package.
Building the Hello World! Example
'''''''''''''''''''''''''''''''''
Now that CMakeLists.txt file is completed the build process can start
On Linux
^^^^^^^^
It's good practice to build examples or applications out-of-source by
creating a ``build`` directory in the
``cyclonedds/build/install/share/CycloneDDS/examples/helloworld``
directory.
Configure the build environment:
.. code-block:: bash
mkdir build
cd build
cmake ../
CMake uses the CMakeLists.txt in the helloworld directory to create
makefiles that fit the native platform.
The real build process of the applications (``HelloworldPublisher`` and
``HelloworldSubscriber`` in this case) can start:
.. code-block:: bash
cmake --build .
The resulting Publisher and Subscriber applications can be found in
``examples/helloworld/build``.
The *Hello World!* example can now be executed, as described in `Test
your installation <#test-your-installation>`__ in the previous
chapter
on Windows
^^^^^^^^^^
CMake usually knows which generator to use, but with Windows you must
supply a specific generator.
For example, only 64-bit libraries are shipped for Windows, by default
CMake generates a 32-bit project, resulting in linker errors. When
generating a Visual Studio project, if you want to generate a b4-bit
build, append **Win64** to the generator description.
The following example shows how to generate a Visual Studio 2015 project
with a 64-bit build:
.. code-block:: PowerShell
cmake -G "Visual Studio 14 2015 Win64" ..
**Note:** CMake generators can also create IDE environments. For
instance, the "Visual Studio 14 2015 Win64" generates a Visual Studio
solution file. Other IDE's are also possible, such as Eclipse IDE.
CMake uses the ``CMakeLists.txt`` in the helloworld directory to create
makefiles that fit the native platform.
The real build process of the applications can start:
.. code-block:: PowerShell
cmake --build .
To generate a Release build:
.. code-block:: PowerShell
cmake --build . --config "Release"
The resulting Publisher and Subscriber applications can be found in ``examples\helloworld\build\Release``.
The *Hello World!* example can now be executed, as described in `Test
your installation <#test-your-installation>`__, using the binaries
built.
Hello World!, Code anatomy
==========================
The previous chapter described the installation process that built
implicitly or explicitly the C *Hello World!* Example. This chapter
introduces the key concept of DDS and details the structural code of a
simple system made by an application that publishes keyed messages and
another one that subscribes and reads such data. Each message represents
a data object that is uniquely identified with a unique key and a
payload.
Data-Centric Architecture
~~~~~~~~~~~~~~~~~~~~~~~~~
In a service-centric architecture, to interact, applications need to
know each other's interfaces to share data, share events, share
commands, or replies. These interfaces are modeled as sets of operations
and functions that are managed in centralized repositories. This kind of
architecture creates unnecessary dependencies that end-up creating a
tightly coupled system. The centralized interface repositories are
usually seen as a single point of failure.
In a data-centric architecture, your design focuses on the data each
application produces and decides to share rather than on the Interfaces'
operations and the internal processing that produced them.
A data-centric architecture creates a decoupled system that focuses on
the data and applications states' that need to be shared rather than the
applications' details. In a data-centric system, data and their
associated quality of services are the only contract that bounds the
applications together. With DDS, the system decoupling is
bi-dimensional, in Space and in Time.
Space-decoupling derives from the fact that applications do not need to,
either know the identity of the data produced (or consumers) nor their
logical or their physical location in the network. Under the hood, DDS
runs a zero-configuration, interoperable discovery protocol that
searches matching data readers and data writes that are interested by
the same data topic.
Time-decoupling derives from the fact that, fundamentally, the nature of
the communication is asynchronous. Data producers and data consumers,
known respectively, as Data Writers, and data readers are not forced to
be active and connected at the same time to share data. In this
scenario, the DDS middleware can handle and manage data on behalf of the
late joining data readers applications and delivered to it when they
join the system.
Time and space decoupling gives applications the freedom to be plugged
or unplugged in the system at any time, from anywhere, in any order.
This keeps the complexity and administration of a data-centric
architecture relatively low when adding more and more data readers and
data writers applications.
.. _key_steps:
Keys steps to build the Hello World! application
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The *Hello World!* example has a very simple 'data layer' with a data
model made of one data type ``Msg`` that represents keyed messages (c,f
next subsection).
To exchange data with Cyclone DDS, applications' business logic needs
to:
1. Declare its participation and involvement in a *DDS domain*. A DDS
domain is an administrative boundary that defines, scopes, and
gathers all the DDS applications, data, and infrastructure that needs
to interconnect together by sharing the same data space. Each DDS
domain has a unique identifier. Applications declare their
participation within a DDS domain by creating a **Domain Participant
entity**.
2. Create a **Data topic** that has the data type described in a data
model. The data types define the structure of the Topic. The Topic is
therefore an association between the topic's name and a datatype.
QoSs can be optionally added to this association. The concept Topic
therefore discriminates and categorizes the data in logical classes
and streams.
3. Create the **Data Readers** and **Writers** entities that are
specific to the topic. Applications may want to change the default
QoSs. In the Hello world! example, the ``ReliabilityQoS`` is changed
from its default value (``Best-effort``) to ``Reliable``.
4. Once the previous DDS computational entities are in place, the
application logic can start writing or reading the data.
At the application level, readers and writers do not need to be aware of
each other. The reading application, hereby called Subscriber polls the
data reader periodically, until a publishing application, hereby called
Publisher writes the required data into the shared topic, namely
``HelloWorldData_Msg``.
The data type is described using the OMG `IDL
Language <http://www.omg.org/gettingstarted/omg_idl.htm>`__ located in
``HelloWorldData.idl`` file. Such IDL file is seen as the data model of
our example.
This data model is preprocessed and compiled by Cyclone-DDS IDL-Compiler
to generate a C representation of the data as described in Chapter 2.
These generated source and header files are used by the
``HelloworldSubscriber.c`` and ``HelloworldPublishe.c`` programs to
share the *Hello* *World!* Message instance and sample.
Hello World! IDL
''''''''''''''''
The HelloWorld data type is described in a language independent way and
stored in the HelloWorldData.idl file:
.. code-block:: omg-idl
module HelloWorldData
{
struct Msg
{
@key long userID;
string message;
};
};
A subset of the OMG Interface Definition Language (IDL) is used as DDS
data definition language. In our simple example, the HelloWorld data
model is made of one module ``HelloWorldData``. A module can be seen as
a namespace where data with interrelated semantic is represented
together in the same logical set.
The ``structMsg`` is the actual data type that shapes the data used to
build topics. As already mentioned, a topic is an association between a
data type and a string name. The topic name is not defined in the IDL
file, but it is defined by the application business logic, at runtime.
In our simplistic case, the data type Msg contains two fields:
``userID`` and ``message`` payload. The ``userID`` is used as a unique
identification of each message instance. This is done using the
``@key`` annotation.
The Cyclone DDS IDL compiler translates the IDL datatype in a C struct
with a name made of the\ ``<ModuleName>_<DataTypeName>`` .
.. code-block:: C
typedef struct HelloWorldData_Msg
{
int32_t userID;
char * message;
} HelloWorldData_Msg;
**Note:** When translated into a different programming language, the
data has a different representation that is specific to the target
language. For instance, as shown in chapter 7, in C++ the Helloworld
data type is represented by a C++ class. This is the advantage of using
a neutral language like IDL to describe the data model.It can be
translated into different languages that can be shared between different
applications written in different programming languages.
Generated files with the IDL compiler
'''''''''''''''''''''''''''''''''''''
In Cyclone DDS the IDL compiler is a C program that processes .idl files.
.. code-block:: bash
idlc HelloWorldData.idl
This results in new ``HelloWorldData.c`` and ``HelloWorldData.h`` files
that need to be compiled and their associated object file must be linked
with the *Hello World!* publisher and subscriber application business
logic. When using the Cyclone provided CMake project, this step is done
automatically.
As described earlier, the IDL compiler generates one source and one
header files. The header file (``HelloWorldData.h``) contains the data
type of the messages that are shared. While the source file has no
direct use from the application developer's perspective.
``HelloWorldData.h``\ \* needs to be included by the application code as
it contains the actual message type and contains helper macros to
allocate and free memory space for the ``HelloWorldData_Msg`` type.
.. code-block:: C
typedef struct HelloWorldData_Msg
{
int32_t userID;
char * message;
} HelloWorldData_Msg;
HelloWorldData_Msg_alloc()
HelloWorldData_Msg_free(d,o)
The header file also contains an extra variable that describes the data
type to the DDS middleware. This variable needs to be used by the
application when creating the topic.
.. code-block:: C
HelloWorldData_Msg_desc
The Hello World! Business Logic
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
As well as the ``HelloWorldData.h/c`` generated files, the *Hello
World!* example also contains two application-level source files
(``subscriber.c`` and ``publisher.c``), containing the business logic.
*Hello* *World!* Subscriber Source Code
'''''''''''''''''''''''''''''''''''''''
The ``Subscriber.c`` mainly contains the statements to wait for a *Hello
World!* message and reads it when it receives it.
**Note:** The Cyclone DDS ``read`` semantics keeps the data sample
in the data reader cache. It is important to remember to use ``take`` where
appropriate to prevent resource-exhaustion.
The subscriber application implements the steps defined in :ref:`the Key Steps <key_steps>`.
.. code-block:: C
:linenos:
#include "ddsc/dds.h"
#include "HelloWorldData.h"
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
/* An array of one message (aka sample in dds terms) will be used. */
#define MAX_SAMPLES 1
int main (int argc, char ** argv) {
dds_entity_t participant;
dds_entity_t topic;
dds_entity_t reader;
HelloWorldData_Msg *msg;
void *samples[MAX_SAMPLES];
dds_sample_info_t infos[MAX_SAMPLES];
dds_return_t ret;
dds_qos_t *qos;
(void)argc;
(void)argv;
/* Create a Participant. */
participant = dds_create_participant (DDS_DOMAIN_DEFAULT, NULL, NULL);
DDS_ERR_CHECK (participant, DDS_CHECK_REPORT | DDS_CHECK_EXIT);
/* Create a Topic. */
topic = dds_create_topic (participant, &HelloWorldData_Msg_desc,
"HelloWorldData_Msg", NULL, NULL);
DDS_ERR_CHECK (topic, DDS_CHECK_REPORT | DDS_CHECK_EXIT);
/* Create a reliable Reader. */
qos = dds_create_qos ();
dds_qset_reliability (qos, DDS_RELIABILITY_RELIABLE, DDS_SECS (10));
reader = dds_create_reader (participant, topic, qos, NULL);
DDS_ERR_CHECK (reader, DDS_CHECK_REPORT | DDS_CHECK_EXIT);
dds_delete_qos(qos);
printf ("\n=== [Subscriber] Waiting for a sample ...\n");
/* Initialize sample buffer, by pointing the void pointer within
* the buffer array to a valid sample memory location. */
samples[0] = HelloWorldData_Msg alloc ();
/* Poll until data has been read. */
while (true)
{
/* Do the actual read.
* The return value contains the number of read samples. */
ret = dds_read (reader, samples, infos, MAX_SAMPLES, MAX_SAMPLES);
DDS_ERR_CHECK (ret, DDS_CHECK_REPORT | DDS_CHECK_EXIT);
/* Check if we read some data and it is valid. */
if ((ret > 0) && (infos[0].valid_data))
{
/* Print Message. */
msg = (HelloWorldData_Msg*) samples[0];
printf ("=== [Subscriber] Received : ");
printf ("Message (%d, %s)\n", msg->userID, msg->message);
break;
}
else
{
/* Polling sleep. */
dds_sleepfor (DDS_MSECS (20));
}
}
/* Free the data location. */
HelloWorldData_Msg_free (samples[0], DDS_FREE_ALL);
/* Deleting the participant will delete all its children recursively as well. */
ret = dds_delete (participant);
DDS_ERR_CHECK (ret, DDS_CHECK_REPORT | DDS_CHECK_EXIT);
return EXIT_SUCCESS;
}
Within the subscriber code, we mainly use the DDS API and the
``HelloWorldData_Msg`` type. The following header files must be included:
* The ``dds.h`` file to give access to the DDS APIs
* The ``HelloWorldData.h`` is specific to the data type defined in the IDL
.. code-block:: C
#include "ddsc/dds.h"
#include "HelloWorldData.h"
With Cyclone DDS, at least three DDS entities are needed to build a
minimalistic application, the domain participant, the topic, and the
reader. A DDS Subscriber entity is implicitly created by Cyclone DDS. If
required, this behavior can be overridden.
.. code-block:: C
dds_entity_t participant;
dds_entity_t topic;
dds_entity_t reader;
To handle the data, some buffers are declared and created:
.. code-block:: C
HelloWorldData_Msg *msg;
void *samples[MAX_SAMPLES];
dds_sample_info_t info[MAX_SAMPLES];
As the ``read()`` operation may return more than one data sample (in the
event that several publishing applications are started simultaneously to
write different message instances), an array of samples is therefore
needed.
In Cyclone DDS data and metadata are propagated together. The
``dds_sample_info`` array needs to be declared to handle the metadata.
The DDS participant is always attached to a specific DDS domain. In the
*Hello World!* example, it is part of the ``Default_Domain``, the one
specified in the xml deployment file (see :ref:`test your installation <test_your_installation>` for more details).
.. code-block:: C
participant = dds_create_participant (DDS_DOMAIN_DEFAULT, NULL, NULL);
The next step is to create the topic with a given name. Topics with the
same data type description and with different names are considered
different topics. This means that readers or writers created for a given
topic do not interfere with readers or writers created with another
topic even if they have the same data type. Topics with the same name but
incompatible datatype is considered an error and should be avoided.
.. code-block:: C
topic = dds_create_topic (participant, &HelloWorldData_Msg_desc, "HelloWorldData_Msg", NULL, NULL);
Once the topic is created, we can create a data reader and attach to it.
.. code-block:: C
dds_qos_t *qos = dds_create_qos ();
dds_qset_reliability (qos, DDS_RELIABILITY_RELIABLE, DDS_SECS (10));
reader = dds_create_reader (participant, topic, qos, NULL);
dds_delete_qos(qos);
The read operation expects an array of pointers to a valid memory
location. This means the samples array needs initialization by pointing
the void pointer within the buffer array to a valid sample memory
location.
In our example, we have an array of one element
(``#define MAX_SAMPLES 1``.) we only need to allocate memory for one
``HelloWorldData_Msg``.
.. code-block:: C
samples[0] = HelloWorldData_Msg_alloc ();
At this stage, we can attempt to read data by going into a polling loop
that regularly scrutinizes and examines the arrival of a message.
.. code-block:: C
ret = dds_read (reader, samples, info, MAX_SAMPLES, MAX_SAMPLES);
The ``dds_read`` operation returns the number of samples equal to the
parameter ``MAX_SAMPLE``. If that number exceeds 0 that means data
arrived in the reader's cache.
The Sample\_info (``info``) structure tells us whether the data we are
reading is *Valid* or *Invalid*. Valid data means that it contains the
payload provided by the publishing application. Invalid data means, that
we are rather reading the DDS state of data Instance. The state of a
data instance can be for instance *DISPOSED* by the writer or it is
*NOT\_ALIVE* anymore, which could happen if the publisher application
terminates while the subscriber is still active. In this case, the
sample is not considered as Valid, and its sample ``info[].Valid_data``
field is be ``False``.
.. code-block:: C
if ((ret > 0) && (info[0].valid_data))
If data is read, then we can cast the void pointer to the actual message
data type and display the contents.
.. code-block:: C
msg = (HelloWorldData_Msg*) samples[0];
printf ("=== [Subscriber] Received : ");
printf ("Message (%d, %s)\n", msg->userID, msg->message);
break;
When data is received and the polling loop is stopped, we release the
allocated memory and delete the domain participant.
.. code-block:: C
HelloWorldData_Msg_free (samples[0], DDS_FREE_ALL);
dds_delete (participant);
All the entities that are created under the participant, such as the
data reader and topic, are recursively deleted.
*Hello* *World!* Publisher Source Code
''''''''''''''''''''''''''''''''''''''
The ``Publisher.c`` contains the source that writes a *Hello World!*
Message.
From the DDS perspective, the publisher application code is almost
symmetric to the subscriber one, except that you need to create a data
writer instead of a data reader. To ensure data is written only when
Cyclone DDS discovers at least a matching reader, a synchronization
statement is added to the main thread. Synchronizing the main thread
until a reader is discovered ensures we can start the publisher or
subscriber program in any order.
.. code-block:: C
:linenos:
#include "ddsc/dds.h"
#include "HelloWorldData.h"
#include <stdio.h>
#include <stdlib.h>
int main (int argc, char ** argv)
{
dds_entity_t participant;
dds_entity_t topic;
dds_entity_t writer;
dds_return_t ret;
HelloWorldData_Msg msg;
(void)argc;
(void)argv;
/* Create a Participant. */
participant = dds_create_participant (DDS_DOMAIN_DEFAULT, NULL, NULL);
DDS_ERR_CHECK (participant, DDS_CHECK_REPORT | DDS_CHECK_EXIT);
/* Create a Topic. */
topic = dds_create_topic (participant, &HelloWorldData_Msg_desc, "HelloWorldData_Msg", NULL, NULL);
DDS_ERR_CHECK (topic, DDS_CHECK_REPORT | DDS_CHECK_EXIT);
/* Create a Writer. */
writer = dds_create_writer (participant, topic, NULL, NULL);
printf("=== [Publisher] Waiting for a reader to be discovered ...\n");
ret = dds_set_status_mask(writer, DDS_PUBLICATION_MATCHED_STATUS);
DDS_ERR_CHECK (ret, DDS_CHECK_REPORT | DDS_CHECK_EXIT);
while(true)
{
uint32_t status;
ret = dds_get_status_changes (writer, &status);
DDS_ERR_CHECK (ret, DDS_CHECK_REPORT | DDS_CHECK_EXIT);
if (status == DDS_PUBLICATION_MATCHED_STATUS) {
break;
}
/* Polling sleep. */
dds_sleepfor (DDS_MSECS (20));
}
/* Create a message to write. */
msg.userID = 1;
msg.message = "Hello World";
printf ("=== [Publisher] Writing : ");
printf ("Message (%d, %s)\n", msg.userID, msg.message);
ret = dds_write (writer, &msg);
DDS_ERR_CHECK (ret, DDS_CHECK_REPORT | DDS_CHECK_EXIT);
/* Deleting the participant will delete all its children recursively as well. */
ret = dds_delete (participant);
DDS_ERR_CHECK (ret, DDS_CHECK_REPORT | DDS_CHECK_EXIT);
return EXIT_SUCCESS;
}
We are using the DDS API and the ``HelloWorldData_Msg`` type to send
data, therefore, we need to include the appropriate header files as we
did in the subscriber code.
.. code-block:: C
#include "ddsc/dds.h"
#include "HelloWorldData.h"
Like with the reader in ``subscriber.c``, we need a participant and a
topic to create a writer. We also need to use the same topic name as the
one specified in ``subscriber.c``.
.. code-block:: C
dds_entity_t participant;
dds_entity_t topic;
dds_entity_t writer;
participant = dds_create_participant (DDS_DOMAIN_DEFAULT, NULL, NULL);
topic = dds_create_topic (participant, &HelloWorldData_Msg_desc,
"HelloWorldData_Msg", NULL, NULL);
writer = dds_create_writer (participant, topic, NULL, NULL);
When Cyclone DDS discovers readers and writers sharing the same data
type and topic name, it connects them without the application
involvement. In order to write data only when a data readers appears, a
rendez-vous pattern is required. Such pattern can be implemented by
either:
* Waiting for the publication/subscription matched events, where the
Publisher waits and blocks the writing-thread until the appropriate
publication matched event is raised, or
* Regularly, polls the publication matching status. This is the
preferred option we implement in this example. The following line of
code instructs Cyclone DDS to listen on the
DDS\_PUBLICATION\_MATCHED\_STATUS:
.. code-block:: C
dds_set_status_mask(writer, DDS_PUBLICATION_MATCHED_STATUS);
At regular intervals we get the status change and a matching
publication. In between, the writing thread sleeps for a time period
equal ``DDS\_MSECS`` (in milliseconds).
.. code-block:: C
while(true)
{
uint32_t status;
ret = dds_get_status_changes (writer, &status);
DDS_ERR_CHECK(ret, DDS_CHECK_REPORT | DDS_CHECK_EXIT);
if (status == DDS_PUBLICATION_MATCHED_STATUS) {
break;
}
/* Polling sleep. */
dds_sleepfor (DDS_MSECS (20));
}
After this loop, we are sure that a matching reader has been discovered.
Now, we commence the writing of the data instance. First, the data must
be created and initialized
.. code-block:: C
HelloWorldData_Msg msg;
msg.userID = 1;
msg.message = "Hello World";
Then we can send the data instance of the keyed message.
.. code-block:: C
ret = dds_write (writer, &msg);
When terminating the program, we free the DDS allocated resources by
deleting the root entity of all the others: the domain participant.
.. code-block:: C
ret = dds_delete (participant);
All the underlying entities such as topic, writer … etc are deleted.
Benchmarking Tools for Cyclone
==============================
Introduction
~~~~~~~~~~~~
Cyclone DDS provides a tool that measures primarily data *throughput*
and *latency* of the cyclone-based applications within the network or
within the same board, namely *ddsperf*. This tool also help to do
sanity checks to ensure your configuration is correctly set up and
running. This chapter describes how to use the *ddsperf* tool and how to
read and interpret its outputs and results. Using the Cyclone DDS Python
package you can also run *ddsperf* as a graphical application, by running
*cyclonedds performance*.
As well as *ddsperf*, you can also find dedicated examples in the
product distribution that measures the DDS system throughput and the
latency with their associated codebase. You can start from the provided
code and customize it to fit your scenario and exact data types. Both
*ddsperf*\ tool and the provided examples perform the benchmarking using
sequences of octets with different parameterized sizes.
Testing your network configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Once your Cyclone DDS installation is successfully completed, you may
want to test if your network environment is correctly set up. This can
be done either by running the *HelloWorld* example or by using the
*ddsperf* tool. The Helloworld example sends a message in one shot,
whereas the ddsperf tool can send a continuous stream of data at a low
frequency rate for sanity checks and can therefore bypass sporadic
network issues.
If you have installed Cyclone DDS using the product installer, the
*ddsperf* tool is pre-installed within ``<cyclonedds_dir>/bin``. If you
have installed Cyclone DDS through the native installation process,
(from GitHub), you can locate the tool within
``<cyclonedds_dir>/build/bin``.
Complete the sanity checks of your DDS based system using the *ddsperf*
tool as follows:
.. code-block:: bash
ddsperf sanity
With the sanity option, only one data sample is sent each second (1Hz).
In another terminal, start the *ddsperf* with the **Pong** mode to echo
the data to the first instance of the *ddsperf* started with the
*Sanity* option.
.. code-block:: bash
ddsperf pong
.. image:: /_static/gettingstarted-figures/4.2-1.png
:align: center
If the data is not exchanged on the network between the two ddsperf
instances, it is likely that Cyclone DDS has not selected the
appropriate network card on both machines or a firewall in-between is
preventing the communication.
Cyclone DDS automatically selects the most available network interface.
This behavior can be overridden by changing the configuration file. (see
section :ref:`test your installation <test_your_installation>` for more details) .
When running the previous scenario on a local machine, this test ensures
the loop-back option is enabled.
Measuring Latency
~~~~~~~~~~~~~~~~~
To measure latency between two different applications, you need to run
two instances of the *ddsperf* tool and instruct one of them to endorse
the role of a *sender* that sends a given amount of data (a sequence of
octets) at a given rate and the other instance takes the role of
*receiver* that sends back the same amount of data to the sender in a
Ping-Pong scenario. The sending action is triggered by the **Ping**
option. The receiving behavior is triggered by the **Pong** action. The
sender measures the roundtrip time and computes the latency as half of
the roundtrip time.
The Ping-Pong scenario avoids clock desynchronization issues that might
occur between two machines that do not share accurately the same
perception of the time in the network.
.. image:: /_static/gettingstarted-figures/4.3-1.png
:align: center
To differential the two operational modes, the *ddsperf* tool can
operate either in a **Ping mode** or in a **Pong mode**.
To run this scenario, open 2 terminals (e.g on Linux like OSs) and run
the following commands in either of the terminals. The graphical
*python-based* alternative is also noted.
.. code-block:: bash
ddsperf ping
cyclonedds performance ping
Input this command in another terminal:
.. code-block:: bash
ddsperf pong
cyclonedds performance pong
This basic scenario performs a simple latency test with all the default
values. You may customize your test scenario by changing the following
options.
* In **Ping mode** you can specify:
* The **Rate** and frequency at which data is written. This is
specified through the [R[Hz]] option. The default rate is "as fast as
possible". In **ping** mode, it always sends a new ping as soon as it
gets a pong
* The **Size** of the data that is exchanged. This is specified
through the [Size S] option. Using the default built-in topic, 12
bytes (an integer key, an integer sequence number, and an empty
sequence of bytes). are sent every time. The size is "as small as
possible" by default, depending on the size of the topic it defaults
to
* The **Listening** mode, which can either be ``waitset`` based or
``Listener`` Callbacks modes. In the waitset mode the *ddsperf*
application creates a dedicated thread to wait for the data to return
back from the receiving instance of *ddsperf* tool (i.e the instance
started with the Pong mode). In the Listener Callback mode, the
thread is created by the Cyclone DDS middleware. The Listener mode is
the default.
* In **Pong mode** you can only specify one option:
* The **Listening** mode (with two possible values, ``waitset`` or
``Listener``)
For instance, if you want to measure local latency between to processes
exchanging 2KB at the frequency of 50Hz, you can run the following
commands in 2 different terminals:
.. code-block:: bash
ddsperf ping 50Hz 2048 waitset
cyclonedds performance ping --rate 50Hz --size 2048 --triggering-mode waitset
.. code-block:: bash
ddsperf pong waitset
cyclonedds performance pong --triggering-mode waitset
The output of the *ddsperf* tool is as shown below:
1. The output for the **Ping** application indicates mainly:
- The **size of the data** involved in the test (e.g. 12 bytes)
- The **minimum latency** (e.g. 78.89 us)
- The **maximum latency** (e.g. 544,85 us)
- The **mean latency** (e.g. 118.434 us)
- As well as the latency at 50%, 90% or 99% of the time.
.. image:: /_static/gettingstarted-figures/4.3-2.png
:align: center
2. The output for the **Pong** application:
- **RSS** is the Resident Set Size; it indicates the amount of memory
used by the process (e.g. 3.5MB used by the process id 2680);
- **VCSW** is the number of voluntary switches, it indicates the
times when the process waits for input or an event (e.g. 2097 times);
- **IVCSW** is the number of involuntary switches, it indicates the
times when the process is pre-empted or blocked by a mutex (e.g. 6
times);
- The percentage of time spent executing user code and the percentage
of time spent executing kernel code in a specific thread (e.g. spent
almost 0% of the time executing the user code and 5% executing kernel
code in thread "ping").
.. image:: /_static/gettingstarted-figures/4.3-3.png
:align: center
Measuring Throughput
~~~~~~~~~~~~~~~~~~~~
To measure throughput between two different applications, you need to
run at least two instances of the *ddsperf*\ tool and instruct one of
them to endorse the role of a Publisher that sends a given amount of
data (a sequence of octets) at a given rate. The other instances take
the role of Subscriber applications. Please note that when your scenario
involves only one subscriber, the UDP unicast mode is used. If several
subscriber instances are running, the multicast is automatically used.
.. image:: /_static/gettingstarted-figures/4.4-1.png
:align: center
Two additional modes are therefore supported:
The **Pub** mode and the **Sub** mode.
In the Sub mode the subscriber operates either:
- Using the **Listener** notification mechanism,
- The **WaitSet** notification mechanism, or
- The **Pooling** mode. The pooling mode allows the subscriber to
cyclically fetch the data from its local cache instead of being
notified each time a new set of data is added to the subscriber's
cache as is the case with the other modes.
You can publish data in two ways by publishing each data sample
individually or by sending them in a *Burst* mode.
- The **Rate** and frequency at which data is written. This is
specified through the [R[Hz]] option. The default rate is "as fast as
possible". Which means, in **pub** mode, instead of trying to reach a
certain rate, it just pushes data as hard as it can.
- The **Size** of the data that is exchanged. This is specified through
the [Size S] option. The size is "as small as possible" by default,
depending on the size of the topic it defaults to.
- The **Burst Size** , defines the number of data samples that are
issued together in as a batch. This parameter is defined by the
[Burst N] option. The default size for burst is 1. It doesn't make
much difference when going "as fast as possible", and it only applies
to the **pub** mode.
- The triggering mode by default is *listener* for the **ping** ,
**pong** and **sub** mode.
To run a simple throughput test, you can simply run a **pub** mode and a
**sub** mode in 2 different terminals without specifying any other
options or you can customize it as shown below:
Open two terminals, navigate to the directory where *ddsperf* is located
and write the following command:
.. code-block:: bash
ddsperf pub size 1k
cyclonedds performance publish --size 1k
And in the other terminal, type in:
.. code-block:: bash
ddsperf -Qrss:1 sub
cyclonedds performance -Qrss:1 subscribe
This measures the throughput of data samples with 1Kbytes written as
fast as possible.
The ``-Qrss:1`` option in **sub** mode sets the maximum allowed increase
in RSS as 1MB. When running the test, if the memory occupieds by the
process increases by less than 1MB, the test can successfully run.
Otherwise, an error message is printed out at the end of the test.
As the ``pub`` in this example only has a size of 1k, the sub does not
print out an RSS error message at the end of the test.
The output of the *ddsperf* tool when measuring throughput is as shown
below:
1. The output for the **Pub** application indicates mainly:
- **RSS** is the Resident Set Size; it indicates the amount of memory
is used by the process (e.g. 6.3MB used by the process id "4026");
- **VCSW** is the number of voluntary switches, it indicates the
times when the process waits for input or an event (e.g. 1054 times);
- **IVCSW** is the number of involuntary switches, it indicates the
times when the process is pre-empted or blocked by a mutex (e.g. 24
times);
- The percentage of time spent executing user code and the percentage
of time spent executing kernel code in a specific thread (e.g. spent
34% of the time executing the user code and 11% executing kernel code
in thread "pub").
.. image:: /_static/gettingstarted-figures/4.4-2.png
:align: center
2. The output for the **Sub** application indicates mainly:
- The **size of the data** involved in this test (e.g. 1024 bytes,
which is the "size 1k" defined in the pub command)
- The **total packets received** (e.g. 614598);
- The **total packets lost** t (e.g. 0);
- The **packets received in a 1 second reporting period** (e.g.
212648);
- The **packets lost in a 1 second report period** (e.g. 0);
- The **number of samples processed by the Sub application** in 1s
(e.g. 21260 KS/s, with the unit KS/s is 1000 samples per second).
.. image:: /_static/gettingstarted-figures/4.4-3.png
:align: center
Measuring Throughput and Latency in a mixed scenario
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In some scenarios, it might be useful to measure the throughput and
latency at the same time.
The *ddsperf* tool allows you to mix these two scenarios. To address
such cases the Ping mode can be combined with the Pub mode.
The [Ping x%] switch combined with the Pub mode allows you to send a
fraction of samples x% as if they were used in the Ping mode.
The different modes of the *ddsperf* tool are summarized in the figure
below.
.. image:: /_static/gettingstarted-figures/4.5-1.png
:align: center
You can get more information for the *ddsperf* tool by using the [help]
option:
.. code-block:: bash
ddsperf help
cyclonedds performance --help
Additional options
~~~~~~~~~~~~~~~~~~
As well as selecting the ``mode``, you can also select the ``options``
to specify how to send and receive the data (such as modifying the
reliable QoS from Reliable to Best-Effort with the ``-u`` option), or
how to evaluate or view the data in the *ddsperf*\ tool.
The ``options`` you can select are listed in the *ddsperf* ``help``
menu, as shown below.
.. image:: /_static/gettingstarted-figures/4.6-1.png
:align: center
Installing Eclipse Cyclone DDS CXX
==================================
Cyclone DDS CXX is an implementation of the DDS ISO/IEC C++ PSM API,
or simply put, a C++ binding for Eclipse Cyclone DDS. It is made of an
IDL compiler that uses an IDL data model to generate their C++
representation and artifacts, a software layer that maps some DDS APIs
on the Cyclone DDS C APIs and direct access to the cyclone kernel APIs
when managing data to lower overhead.
.. image:: /_static/gettingstarted-figures/5-1.png
:align: center
System requirements
~~~~~~~~~~~~~~~~~~~
At the time of writing this document, Eclipse Cyclone DDS CXX supports
Linux, macOS, and Windows. Cyclone DDS CXX is known to work on FreeRTOS
and the solaris-like Openindiana OS.
To build the Cyclone DDS C++ binding, the following software should be
installed on your machine.
- C and C++ compilers (most commonly GCC on Linux, Visual Studio on
Windows, Xcode on macOS);
- `Git <https://git-scm.com/>`__ version control system,
`CMake <https://cmake.org/download/>`__\ (version 3.7 or later);
- Eclipse Cyclone DDS
The installation of `Eclipse Cyclone
DDS <#installing-eclipse-cyclone-dds>`__ with the C language support
is described in Chapter 1. This chapter describes the CXX IDL compiler.
Native Installation for Linux and macOS
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Install Eclipse Cyclone DDS CXX
'''''''''''''''''''''''''''''''
To obtain the C++ binding for Cyclone DDS:
.. code-block:: bash
git clone https://github.com/eclipse-cyclonedds/cyclonedds-cxx.git
Building
^^^^^^^^
To build Cyclone DDS CXX, browse to the folder directory and create
a "build" folder to retain the build files.
.. code-block:: bash
cd cyclonedds-cxx
mkdir build
Depending on whether you want to develop applications using Cyclone DDS
CXX or contribute to it, you may follow different procedures.
For Application Developers
^^^^^^^^^^^^^^^^^^^^^^^^^^
To build and install the required libraries needed to develop your
applications using the C++ binding for Cyclone DDS:
.. code-block:: bash
cd build
cmake -DCMAKE_INSTALL_PREFIX=<cyclonedds-cxx-install-location> -DCMAKE_PREFIX_PATH="<cyclonedds-install-location>" -DBUILD_EXAMPLES=ON ..
cmake --build .
The ``<cyclonedds-cxx-install-location>`` is where the C++ binding for
Cyclone DDS is installed to.
To install the package after a successful build:
Depending on the installation location you may need administrator
privileges.
.. code-block:: bash
cmake --build . --target install
This copies everything to:
- ``<cyclonedds-cxx-install-location>/lib``
- ``<cyclonedds-cxx-install-location>/bin``
- ``<cyclonedds-cxx-install-location>/include/ddsc``
- ``<cyclonedds-cxx-install-location>/share/CycloneDDS CXX``
At this point, you are ready to use Eclipse Cyclone DDS CXX in your
projects.
**Note:** The default build type is a release build with debug
information included (``RelWithDebInfo``). This is a convenient type of
build to use for applications as it provides a good mix between
performance and the ability to debug things. If you'd rather have a
Debug or pure Release build, set ``CMAKE_BUILD_TYPE`` accordingly.
If you want to contribute to Cyclone DDS CXX, please refer to `Appendix
II Contributing to Eclipse Cyclone DDS
CXX <#appendix-ii-contributing-to-eclipse-cyclone-dds-cxx>`__.
Installation with product installer for Linux and macOS
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
TBD.
Native Installation for Windows
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Install Eclipse Cyclone DDS CXX
'''''''''''''''''''''''''''''''
To obtain the C++ binding for Cyclone DDS:
.. code-block:: bash
git clone https://github.com/eclipse-cyclonedds/cyclonedds-cxx.git
Building
^^^^^^^^
To build the Cyclone DDS CXX, browse to the folder directory and create
a "build" folder to retain all the build files.
.. code-block:: bash
cd cyclonedds-cxx
mkdir build
Depending on whether you want to develop applications using Cyclone
DDS CXX or contribute to it, you may follow different procedures.
For Application Developers
^^^^^^^^^^^^^^^^^^^^^^^^^^
To build and install the required libraries needed to develop your
applications using the C++ binding for Cyclone DDS:
.. code-block:: bash
cd build
cmake -G "<generator-name>" -DCMAKE_INSTALL_PREFIX=<cyclonedds-cxx-install-location> -DCMAKE_PREFIX_PATH="<cyclonedds-install-location>" -DBUILD_EXAMPLES=ON ..
cmake --build .
**Note:** Replace ``<generator-name>`` with one of the methods CMake
generators offer for generating build files. For example, for
"``Visual Studio 16 2019``\ " target a 64-bit build using Visual Studio
2019. And the command should be:
.. code-block:: bash
cmake -G "Visual Studio 16 2019" -DCMAKE_INSTALL_PREFIX=<cyclonedds-cxx-install-location> -DCMAKE_PREFIX_PATH="<cyclonedds-install-location>" -DBUILD_EXAMPLES=ON ..
To install after a successful build:
Depending on the installation location you may need administrator
privileges.
.. code-block:: bash
cmake --build . --target install
This copies everything to:
- ``<cyclonedds-cxx-install-location>/lib``
- ``<cyclonedds-cxx-install-location>/bin``
- ``<cyclonedds-cxx-install-location>/include/ddsc``
- ``<cyclonedds-cxx-install-location>/share/CycloneDDS CXX``
At this point, you are ready to use Eclipse Cyclone DDS CXX in your
projects.
**Note:** The default build type is a release build with debug
information included (``RelWithDebInfo``). This is a convenient type of
build to use for applications as it provides a good mix between
performance and the ability to debug things. If you prefer have a Debug
or pure Release build, set ``CMAKE_BUILD_TYPE`` accordingly.
If you want to contribute to Cyclone DDS CXX, refer to `Contributing to
Eclipse Cyclone DDS CXX for Windows in Appendix
II. <#appendix-ii-contributing-to-eclipse-cyclone-dds-cxx>`__
Installation with product installer for Windows
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Cyclone DDS CXX also provides a product installer, this may be easier
than installing it from GitHub.
To install the Cyclone DDS CXX from the installer, use the following
steps.
1. Start up the installer and click 'Next'.
.. image:: /_static/gettingstarted-figures/5.5-1.png
:align: center
2. Agree to the terms, and click 'Next'.
.. image:: /_static/gettingstarted-figures/5.5-2.png
:align: center
3. Choose whether you would like to add Cyclone DDS CXX to the system
PATH. We recommend to add it to the system PATH, so that your
application can use the related libraies directly. Select whether you
would like to add it for the current user or for all users and click
'Next'.
.. image:: /_static/gettingstarted-figures/5.5-3.png
:align: center
4. Select the directory where you would like to install Cyclone DDS CXX.
Avoid installing it within the ``Program Files`` directory, as it
requires administrator privileges. Click 'Next'.
.. image:: /_static/gettingstarted-figures/5.5-4.png
:align: center
5. You are now ready to install the Cyclone DDS CXX, click 'Install'.
.. image:: /_static/gettingstarted-figures/5.5-5.png
:align: center
6. Click 'Finish'.
.. image:: /_static/gettingstarted-figures/5.5-6.png
:align: center
The installation for Cyclone DDS CXX is complete, to build an
application using Cyclone DDS CXX, refer to `how to build your first
Cyclone DDS CXX
example <#building-your-first-cyclonedds-cxx-example>`__.
Test your CXX Installation for Native Installation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Environnement variable updates
''''''''''''''''''''''''''''''
To run an Eclipse Cyclone DDSCXX application, the required libraries
(such as ddsc.dll and ddscxx.dll) must be available in the executable
path. These libraries should be installed in the system default
location. However, if they are not installed there, the library search
path must be updated accordingly. On Linux use the command:
.. code-block:: PowerShell
Set PATH=<cyclonedds-installation-location>\bin;<cyclonedds-cxx-installation-location>\bin
**Note:** Alternatively, copy the required libraries to the executables'
directory.
Running the pre-built example
'''''''''''''''''''''''''''''
A simple *Hello World* application is included in the Eclipse Cyclone
DDSCXX, it can be used to test the installation. The *Hello World*
application is located in:
- **Windows:** ``<cyclonedds-cxx-directory>\build\bin\Debug``
- **Linux:** ``<cyclone-cxx-directory>/build/bin``
To run the example application, open two console windows, and navigate
to the appropriate directory. Run the ``ddscxxHelloworldPublisher`` in
one of the console windows by using the following command:
- **Windows:** ``ddscxxHelloworldPublisher.exe``
- **Linux:** ``./ddscxxHelloworldPublisher``
Run the ``ddscxxHelloworldSubscriber`` in the other console window
using:
- **Windows:** ``ddscxxHelloworldSubscriber.exe``
- **Linux:** ``./ddscxxHelloworldSubscriber.exe``
The output for the ``ddscxxHelloworldPublisher`` is as follows:
.. image:: /_static/gettingstarted-figures/5.6.2-1.png
:align: center
The output for the ``ddscxxHelloworldSubscriber`` is as follows:
.. image:: /_static/gettingstarted-figures/5.6.2-2.png
:align: center
For more information on how to build this application and the code which
has been used, refer to `Hello
World. <#building-your-first-cyclonedds-cxx-example>`__
Uninstalling Cyclone DDS CXX
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Uninstallation for Native Installation
''''''''''''''''''''''''''''''''''''''
At this stage, you can manually remove the install and build directory.
Alternatively, in Linux and macOS, in the install or build directory,
use the following command:
.. code-block:: bash
rm -rf *
Uninstallation for product installer
''''''''''''''''''''''''''''''''''''
Windows
^^^^^^^
To uninstall the Cyclone DDS CXX either remove it from Programs and
Features in the Control Panel or use the Cyclone DDS CXX installer. In
the latest case start Cyclone DDS CXX package, and choose 'Remove'.
.. image:: /_static/gettingstarted-figures/5.7.2.1-1.png
:align: center
Linux and macOS
^^^^^^^^^^^^^^^
TBD.
Building Eclipse Cyclone DDS CXX applications
=============================================
Building Your First Cyclone DDS CXX example
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To test your installation, the *Hello World* example can be used. The
code of this application is detailed in the next chapter.
The *DDS CXX Hello World* example can be found in the
``<cyclonedds-cxx-install-location>/share/CycloneDDS CXX/helloworld``
directory for both Linux and Windows. This chapter describes the example
build process using the CMake.
Building a Cyclone DDS CXX application with CMake
'''''''''''''''''''''''''''''''''''''''''''''''''
The CMake build file for the *DDS CXX Hello World* example is located
under the ``helloworld`` directory (``CMakeLists.txt``).
The content of the ``CMakeLists.txt`` is as follows:
.. code-block:: cmake
project(helloworld LANGUAGES C CXX)
cmake_minimum_required(VERSION 3.5)
if (NOT TARGET CycloneDDS CXX::ddscxx)
find_package(CycloneDDS CXX REQUIRED)
endif()
# Convenience function, provided by the idlc backend for CXX that generates a CMake
# target for the given IDL file. The function calls idlc to generate
# source files and compiles them into a library.
idlcxx_generate(TARGET ddscxxHelloWorldData_lib FILES HelloWorldData.idl WARNINGS no-implicit-extensibility)
add_executable(ddscxxHelloworldPublisher publisher.cpp)
add_executable(ddscxxHelloworldSubscriber subscriber.cpp)
# Link both executables to idl data type library and ddscxx.
target_link_libraries(ddscxxHelloworldPublisher ddscxxHelloWorldData_lib CycloneDDS CXX::ddscxx)
target_link_libraries(ddscxxHelloworldSubscriber ddscxxHelloWorldData_lib CycloneDDS CXX::ddscxx)
set_property(TARGET ddscxxHelloworldPublisher PROPERTY CXX_STANDARD 11)
set_property(TARGET ddscxxHelloworldSubscriber PROPERTY CXX_STANDARD 11)
To build a Cyclone DDS CXX based application with CMake, you must link
your application business code with:
- ``Cyclone DDS CXX`` libraries that contain the DDS CXX API your
application needs.
- The wrapper classes and structures that represent your datatypes and
the customized-data writers and readers that can handle these data
types. These classes are generated by the CMake statement
``idlcxx_generate()`` that incepts the IDL file, invokes the
IDL compiler and packages the datatype wrapper classes in a library
(e.g. ``ddscxxHelloWorldData_lib``).
This process is depicted as follows:
.. image:: /_static/gettingstarted-figures/6.1.1-1.png
:align: center
Setting the property for the applications in the CMake
``set_property()`` statement, compiles the application against the
``C++ 11`` standard.
The application executable (``ddscxxHellowordPublisher``) is built with
the CMake ``target_link_libraries()`` statement which links the ddscxx
lib, the datatype wrapper classes lib (e.g ``ddscxxHelloWorldData_lib``)
and the application code lib.
The CMake tries to find the ``CycloneDDS`` and ``CycloneDDSCXX``
CMake packages, the details regarding how to locate those packages are
described in the next section. When the packages are found, every path
and dependencies are automatically set.
Build the DDS CXX Hello World Example
'''''''''''''''''''''''''''''''''''''
To build the example, navigate to the example's directory and create a
build folder.
.. code-block:: bash
mkdir build
cd build
Building the DDS CXX Hello World example on Linux and macOS
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To build the *DDS CXX Hello World* example, the ``PREFIX_PATH`` must be
specified, the command is:
.. code-block:: bash
mkdir build
cd build
cmake -DCMAKE_PREFIX_PATH="<cyclone-install-location>;<cyclonedds-cxx-install-location>" ..
cmake --build .
The *DDS CXX Hello World* example application can now be found in the
``helloworld/build`` directory, use the method in `Test your CXX
installation <#test-your-cxx-installation-for-native-installation>`__
to check if the application runs successfully.
Building the DDS CXX Hello World example on Windows
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To build the *DDS CXX Hello World* example in Windows, it's likely that
you have to specify the generator for CMake. For example, to generate a
Visual Studio 2017 project, use the following command:
.. code-block:: bash
mkdir build
cd build
cmake -G “Visual Studio 15 2017 Win64” -DCMAKE_PREFIX_PATH=”<cyclone-install-location>;<cyclonedds-cxx-install-location>” ..
CMake uses the CMakeLists.txt in the helloworld directory to create
makefiles that fit the native platform.
Subsequently, build the example. We recommend you provide the config of
Visual Studio:
.. code-block:: bash
cmake --build . --config "Release"
The *DDS CXX Hello World* example application can now be found in the
``helloworld\build\Release`` directory, use the method in `Test your CXX
installation <#test-your-cxx-installation-for-native-installation>`__
to check if the application runs successfully.
**Note:** If the *DDS CXX Hello World* application fails, please check
the `environment variable <#test-your-cxx-installation-for-native-installation>`__ is set up correctly.
DDS CXX Hello World Code anatomy
================================
The previous chapter described the installation process that built
implicitly or explicitly the C++ *Hello World!* Example. The key concept
of DDS was introduced in Chapter 3. This chapter introduces the
structural code of a simple system made by an application that publishes
keyed messages and another one that subscribes and reads such data. Each
message represents a data object that is uniquely identified with a key
and a payload.
.. _key_steps_helloworld_cpp:
Keys steps to build the Hello World! application in CXX
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The *Hello World!* example has a very simple 'data layer' with a data
model made of one data type ``Msg`` who represents keyed messages (c,f
next subsection).
To exchange data, applications' business logic with Cyclone DDS must:
1. Declare its subscription and involvement into a **DDS domain**. A
DDS domain is an administrative boundary that defines, scopes and
gathers all the DDS applications, data, and infrastructure that needs
to interconnect and share the same data space. Each DDS domain has a
unique identifier. Applications declare their participation within a
DDS domain by creating a **Domain Participant entity**.
2. Create a **Data topic** that has the data type described in the data
model. The data types define the structure of the Topic. The Topic is
therefore an association between the topic name and datatype. QoSs
can be optionally added to this association. A Topic therefore
categories the data in logical classes and streams.
3. Create at least a **Publisher** , a **Subscriber**, and **Data
Readers** and **Writers** objects that are specific to the topic
created earlier. Applications may want to change the default QoSs at
this stage. In the Hello world! example, the ``ReliabilityQoS`` is
changed from its default value (Best-effort) to Reliable.
4. Once the previous DDS computational object s are in place, the
application logic can start writing or reading the data.
At the application level, readers and writers do not need to be aware of
each other. The reading application, hereby designated as application
Subscriber polls the data reader periodically, until a writing
application, hereby called application Publisher, provides the required
data into the shared topic, namely ``HelloWorldData_Msg``.
The data type is described using the OMG `IDL
Language <http://www.omg.org/gettingstarted/omg_idl.htm>`__ located in
``HelloWorldData.idl`` file. This IDL file is considered the Data Model
of our example.
This data model is preprocessed and compiled by Cyclone-DDS CXX
IDL-Compiler to generate a CXX representation of the data as described
in Chapter 6. These generated source and header files are used by the
``HelloworldSubscriber.cpp`` and ``HelloworldPublisher.cpp``
applicationprograms to share the *Hello World!* Message instance and
sample.
HelloWorld IDL
''''''''''''''
As explained in chapter 3, the benefits of using IDL language to define
data is to have a data model that is independent from the programming
languages. The ``HelloWorld.idl`` IDL file used in chapter 3 can
therefore be reused, it is compiled to be used within C++ DDS based
applications.
The HelloWorld data type is described in a language independent way and
stored in the HelloWorldData.idl file (same as in chapter 3).
.. code-block:: omg-idl
module HelloWorldData
{
struct Msg
{
@key long userID;
string message;
};
};
A subset of the OMG Interface Definition Language (IDL) is used as DDS
data definition language. In our simple example, the HelloWorld data
model is made of one module ``HelloWorldData``. A module can be seen as
namespace where data with interrelated semantic is represented together
in the same logical set.
The struct Msg is the actual data structure that shapes the data used to
build the Topics. As already mentioned, a topic is basically an
association between a data type and a string name. The topic name is not
defined in the IDL file, but it is defined by the application business
logic, at runtime.
In our case, the data type ``Msg`` contains two fields: ``userID`` and
``message`` payload. The ``userID`` is used as a unique identification
of each message instance. This is done using the
``@key`` annotation.
The Cyclone DDS CXX IDL compiler translates the module name into
namespaces and structure name into classes.
It also generates code for public accessor functions for all fields
mentioned in the IDL struct, separate public constructors, and a
destructor:
- A default (empty) constructor that recursively invokes the
constructors of all fields
- A copy-constructor that performs a deep-copy from the existing class
- A move-constructor that moves all arguments to its members
The destructor recursively releases all fields. It also generates code
for assignment operators that recursively construct all fields based on
the parameter class (copy and move versions). The following code snippet is
provided without warrenty: the internal format can change, but it API it provides
to your application code is stable.
.. code-block:: C++
namespace HelloWorldData
{
class Msg OSPL_DDS_FINAL
{
public:
int32_t userID_;
std::string message_;
public:
Msg() :
userID_(0) {}
explicit Msg(
int32_t userID,
const std::string& message) :
userID_(userID),
message_(message) {}
Msg(const Msg &_other) :
userID_(_other.userID_),
message_(_other.message_) {}
#ifdef OSPL_DDS_CXX11
Msg(Msg &&_other) :
userID_(::std::move(_other.userID_)),
message_(::std::move(_other.message_)) {}
Msg& operator=(Msg &&_other)
{
if (this != &_other) {
userID_ = ::std::move(_other.userID_);
message_ = ::std::move(_other.message_);
}
return *this;
}
#endif
Msg& operator=(const Msg &_other)
{
if (this != &_other) {
userID_ = _other.userID_;
message_ = _other.message_;
}
return *this;
}
bool operator==(const Msg& _other) const
{
return userID_ == _other.userID_ &&
message_ == _other.message_;
}
bool operator!=(const Msg& _other) const
{
return !(*this == _other);
}
int32_t userID() const { return this->userID_; }
int32_t& userID() { return this->userID_; }
void userID(int32_t _val_) { this->userID_ = _val_; }
const std::string& message() const { return this->message_; }
std::string& message() { return this->message_; }
void message(const std::string& _val_) { this->message_ = _val_; }
#ifdef OSPL_DDS_CXX11
void message(std::string&& _val_) { this->message_ = _val_; }
#endif
};
}
**Note:** When translated into a different programming language, the
data has a different representation that is specific to the target
language. For instance, as shown in chapter 3, in C the Helloworld data
type is represented by a C structure. This is the advantage of using a
neutral language like IDL to describe the data model. It can be
translated into different languages that can be shared between different
applications written in different programming languages.
The IDL compiler generated files
''''''''''''''''''''''''''''''''
The IDL compiler is a bison-based parser written in pure C and should be
fast and portable. It loads dynamic libraries to support different output
languages, but this is almost never relevant to you as a user. You can use
``CMake`` recipes as described above or invoke directly:
.. code-block:: bash
idlc -l cxx HelloWorldData.idl
This results in the following new files that need to be compiled and
their associated object file linked with the Hello *World!* publisher
and subscriber application business logic:
- ``HelloWorldData.hpp``
- ``HelloWorldData.cpp``
When using CMake to build the application, this step is hidden, and is
done automatically. For building with CMake, refer to `building the
Hello World example. <#build-the-dds-cxx-hello-world-example>`__
``HelloWorldData.hpp`` and ``HelloWorldData.cpp`` files contain the data
type of the messages that are shared.
DDS CXX Hello World Business Logic
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
As well as from the ``HelloWorldData`` data type files that the *DDS CXX
Hello World* example uses to send messages, the *DDS CXX Hello World!*
example also contains two application-level source files
(``subscriber.cpp`` and ``publisher.cpp``), containing the business
logic.
DDS CXX *Hello World* Subscriber Source Code
''''''''''''''''''''''''''''''''''''''''''''
The ``Subscriber.cpp`` file mainly contains the statements to wait for a
*Hello World* message and reads it when it receives it.
**Note:** The read sematic keeps the data sample in the Data Reader
cache. The Subscriber application implements the steps defined in
:ref:`Key Steps to build helloworld for C++ <key_steps_helloworld_cpp>`.
.. code-block:: C++
:linenos:
#include <cstdlib>
#include <iostream>
#include <chrono>
#include <thread>
/* Include the C++ DDS API. */
#include "dds/dds.hpp"
/* Include data type and specific traits to be used with the C++ DDS API. */
#include "HelloWorldData.hpp"
using namespace org::eclipse::cyclonedds;
int main() {
try {
std::cout << "=== [Subscriber] Create reader." << std::endl;
/* First, a domain participant is needed.
* Create one on the default domain. */
dds::domain::DomainParticipant participant(domain::default_id());
/* To subscribe to something, a topic is needed. */
dds::topic::Topic<HelloWorldData::Msg> topic(participant, "ddscxx_helloworld_example");
/* A reader also needs a subscriber. */
dds::sub::Subscriber subscriber(participant);
/* Now, the reader can be created to subscribe to a HelloWorld message. */
dds::sub::DataReader<HelloWorldData::Msg> reader(subscriber, topic);
/* Poll until a message has been read.
* It isn't really recommended to do this kind wait in a polling loop.
* It's done here just to illustrate the easiest way to get data.
* Please take a look at Listeners and WaitSets for much better
* solutions, albeit somewhat more elaborate ones. */
std::cout << "=== [Subscriber] Wait for message." << std::endl;
bool poll = true;
while (poll) {
/* For this example, the reader will return a set of messages (aka
* Samples). There are other ways of getting samples from reader.
* See the various read() and take() functions that are present. */
dds::sub::LoanedSamples<HelloWorldData::Msg> samples;
/* Try taking samples from the reader. */
samples = reader.take();
/* Are samples read? */
if (samples.length() > 0) {
/* Use an iterator to run over the set of samples. */
dds::sub::LoanedSamples<HelloWorldData::Msg>::const_iterator sample_iter;
for (sample_iter = samples.begin();
sample_iter < samples.end();
++sample_iter) {
/* Get the message and sample information. */
const HelloWorldData::Msg& msg = sample_iter->data();
const dds::sub::SampleInfo& info = sample_iter->info();
/* Sometimes a sample is read, only to indicate a data
* state change (which can be found in the info). If
* that's the case, only the key value of the sample
* is set. The other data parts are not.
* Check if this sample has valid data. */
if (info.valid()) {
std::cout << "=== [Subscriber] Message received:" << std::endl;
std::cout << " userID : " << msg.userID() << std::endl;
std::cout << " Message : \"" << msg.message() << "\"" << std::endl;
/* Only 1 message is expected in this example. */
poll = false;
}
}
} else {
std::this_thread::sleep_for(std::chrono::milliseconds(20));
}
}
}
catch (const dds::core::Exception& e) {
std::cerr << "=== [Subscriber] Exception: " << e.what() << std::endl;
return EXIT_FAILURE;
}
std::cout << "=== [Subscriber] Done." << std::endl;
return EXIT_SUCCESS;
}
Within the subscriber code, we mainly use the DDS ISOCPP API and the
``HelloWorldData::Msg`` type. Therefore, the following header files must
be included:
- The ``dds.hpp`` file give access to the DDS APIs,
- The ``HelloWorldData.hpp`` is specific to the data type defined
in the IDL.
.. code-block:: C++
#include "dds/dds.hpp"
#include "HelloWorldData.hpp"
At least four DDS entities are needed, the domain participant, the topic
, the subscriber and the reader.
.. code-block:: C++
dds::domain::DomainParticipant participant(domain::default_id());
dds::topic::Topic<HelloWorldData::Msg> topic(participant,"ddscxx_helloworld_example");
dds::sub::Subscriber subscriber(participant);
dds::sub::DataReader<HelloWorldData::Msg> reader(subscriber,topic);
The Cyclone DDS CXX API simplifies and extends how data can be read or
taken. To handle the data some ``LoanedSamples`` are declared and
created which loans samples from the Service pool. Return of the loan is
implicit and managed by scoping:
.. code-block:: C++
dds::sub::LoanedSamples<HelloWorldData::Msg> samples;
dds::sub::LoanedSamples<HelloWorldData::Msg>::const_iterator sample_iter;
As the ``read( )/take()`` operation may return more the one data sample
(in the event that several publishing applications are started
simultaneously to write different message instances), an iterator is
used.
.. code-block:: C++
const::HelloWorldData::Msg& msg;
const dds::sub::SampleInfo& info;
In DDS data and metadata are propagated together. The samples are a set
of the data-samples ( i.e user defined data) and metadata describing the
sample state, validity etc ,,, (``info``). To get the data and its
metadata from each of the samples, we can use iterators.
.. code-block:: C++
try {
// ...
}
catch (const dds::core::Exception& e) {
std::cerr << "=== [Subscriber] Exception: " << e.what() << std::endl;
return EXIT_FAILURE;
}
It is good practice to surround every key verbs of the DDS APIs with
``try/catch`` block to precisely locate issues when they occur. In this
example one block is used to facilitate the programming model of the
applications and improve their source code readability.
.. code-block:: C++
dds::domain::DomainParticipant participant(domain::default_id());
The DDS participant is always attached to a specific DDS domain. In the
Hello World! example, it is part of the Default\_Domain, the one
specified in the xml deployment file that you potentially be created
(i.e. the one pointing to ``$CYCLONEDDS_URI``), please refer to
:ref:`testing your installation <test_your_installation>` for further details.
Subsequently, create a subscriber attached to your participant.
.. code-block:: C++
dds::sub::Subscriber subscriber(participant);
The next step is to create the topic with a given
name(\ ``ddscxx_helloworld_example``)and the predefined data
type(\ ``HelloWorldData::Msg``). Topics with the same data type
description and with different names are considered different topics.
This means that readers or writers created for a given topic do not
interfere with readers or writers created with another topic even if
they are the same data type.
.. code-block:: C++
dds::topic::Topic<HelloWorldData::Msg> topic(participant,"ddscxx_helloworld_example");
Once the topic is created, we can create and associate to it a data
reader.
.. code-block:: C++
dds::sub::DataReader<HelloWorldData::Msg> reader(subscriber, topic);
To modify the Data Reader Default Reliability Qos to Reliable:
.. code-block:: C++
dds::sub::qos::DataReaderQos drqos = topic.qos() << dds::core::policy::Reliability::Reliable();
dds::sub::DataReader<HelloWorldData::Msg> dr(subscriber, topic, drqos);
To retrieve data in your application code from the data reader's cache
you can either use pre-allocated a buffer to store the data or loaned it
from the middleware.
If you decide to use a pre-allocated buffer, you create an array/vector
like container. If you use the loaned buffer option, you need to be
aware that these buffers are actually 'owned' by the middleware,
precisely by the DataReader. The Cyclone DDS CXX API allows you to
return the loans implicitly through scoping.
In our example we are using the loan samples mode (``LoanedSamples``).
``Samples`` are an unbounded sequence of samples; the length of the
sequence depends on the amount of data available in the data reader's
cache.
.. code-block:: C++
dds::sub::LoanedSamples<HelloWorldData::Msg> samples;
At this stage, we can attempt to read data by going into a polling loop
that regularly scrutinizes and examines the arrival of a message.
Samples are removed from the reader's cache when taken with the
``take()``.
.. code-block:: C++
samples = reader.take();
If you choose to read the samples with ``read()``, data remains in the
data reader cache. A length() of samples greater than zero indicates
that the data reader cache was not empty.
.. code-block:: C++
if (samples.length() > 0)
As sequences are NOT pre-allocated by the user, buffers are 'loaned' to
him by the DataReader.
.. code-block:: C++
dds::sub::LoanedSamples<HelloWorldData::Msg>::const_iterator sample_iter;
for (sample_iter = samples.begin();
sample_iter < samples.end();
++sample_iter)
For each individual sample, cast and extract its user defined data
(``Msg``) and metadate (``info``).
.. code-block:: C++
const HelloWorldData::Msg& msg = sample_iter->data();
const dds::sub::SampleInfo& info = sample_iter->info();
The SampleInfo (``info``) tells us whether the data we are taking is
*Valid* or *Invalid*. Valid data means that it contains the payload
provided by the publishing application. Invalid data means, that we are
reading the DDS state of data Instance. The state of a data instance can
be ``DISPOSED`` by the writer or it is ``NOT_ALIVE`` anymore, which
could happen if the publisher application terminates while the
subscriber is still active. In this case the sample is not considered
Valid, and its sample ``info.valid()`` field is False.
.. code-block:: C++
if (info.valid())
As the sample contains valid data, we can safely display its content.
.. code-block:: C++
std::cout << "=== [Subscriber] Message received:" << std::endl;
std::cout << " userID : " << msg.userID() << std::endl;
std::cout << " Message : \"" << msg.message() << "\"" << std::endl;
As we are using the Poll data reading mode, we repeat the above steps
every 20 milliseconds.
.. code-block:: C++
else {
std::this_thread::sleep_for(std::chrono::milliseconds(20));
}
This example uses the polling mode to read or take data. Cyclone DDS
offers *waitSet* and *Listener* mechanism to notify the application that
data is available in their cache, which avoids polling the cache at a
regular intervals. The discretion of these mechanisms is beyond the
scope of this document.
All the entities that are created under the participant, such as the
Data Reader Subscriber and Topic, are automatically deleted by
middleware through the scoping mechanism.
DDS CXX *Hello World* Publisher Source Code
'''''''''''''''''''''''''''''''''''''''''''
The ``Publisher.cpp`` contains the source that writes a *Hello World*
message. From the DDS perspective, the publisher application code is
almost symmetrical to the subscriber one, except that you need to create
a Publisher and Data Writer respectively, instead of a Subscriber and
Data Reader. To ensure data is only written when Cyclone DDS discovers
at least a matching reader, a synchronization statement is added to the
main thread. Synchronizing the main thread until a reader is discovered
assures we can start the publisher or subscriber program in any order.
.. code-block:: C++
:linenos:
#include <cstdlib>
#include <iostream>
#include <chrono>
#include <thread>
/* Include the C++ DDS API. */
#include "dds/dds.hpp"
/* Include data type and specific traits to be used with the C++ DDS API. */
#include "HelloWorldData.hpp"
using namespace org::eclipse::cyclonedds;
int main() {
try {
std::cout << "=== [Publisher] Create writer." << std::endl;
/* First, a domain participant is needed.
* Create one on the default domain. */
dds::domain::DomainParticipant participant(domain::default_id());
/* To publish something, a topic is needed. */
dds::topic::Topic<HelloWorldData::Msg> topic(participant, "ddscxx_helloworld_example");
/* A writer also needs a publisher. */
dds::pub::Publisher publisher(participant);
/* Now, the writer can be created to publish a HelloWorld message. */
dds::pub::DataWriter<HelloWorldData::Msg> writer(publisher, topic);
/* For this example, we'd like to have a subscriber to actually read
* our message. This is not always necessary. Also, the way it is
* done here is just to illustrate the easiest way to do so. It isn't
* really recommended to do a wait in a polling loop, however.
* Please take a look at Listeners and WaitSets for much better
* solutions, albeit somewhat more elaborate ones. */
std::cout << "=== [Publisher] Waiting for subscriber." << std::endl;
while (writer.publication_matched_status().current_count() == 0) {
std::this_thread::sleep_for(std::chrono::milliseconds(20));
}
/* Create a message to write. */
HelloWorldData::Msg msg(1, "Hello World");
/* Write the message. */
std::cout << "=== [Publisher] Write sample." << std::endl;
writer.write(msg);
/* With a normal configuration (see dds::pub::qos::DataWriterQos
* for various different writer configurations), deleting a writer will
* dispose all its related message.
* Wait for the subscriber to have stopped to be sure it received the
* message. Again, not normally necessary and not recommended to do
* this in a polling loop. */
std::cout << "=== [Publisher] Waiting for sample to be accepted." << std::endl;
while (writer.publication_matched_status().current_count() > 0) {
std::this_thread::sleep_for(std::chrono::milliseconds(50));
}
}
catch (const dds::core::Exception& e) {
std::cerr << "=== [Publisher] Exception: " << e.what() << std::endl;
return EXIT_FAILURE;
}
std::cout << "=== [Publisher] Done." << std::endl;
return EXIT_SUCCESS;
}
We are using the ISOCPP DDS API and the HelloWorldData to receive data.
For that, we need to include the appropriate header files.
.. code-block:: C++
#include "dds/dds.hpp"
#include "HelloWorldData.hpp"
An exception handling mechanism ``try/catch`` block is used.
.. code-block:: C++
try {
// …
}
catch (const dds::core::Exception& e) {
std::cerr << "=== [Subscriber] Exception: " << e.what() << std::endl;
return EXIT_FAILURE;
}
AS with the reader in ``subscriber.cpp``, we need a participant, a
topic, and a publisher to be able to create a writer. We also need to
use the same topic name as the one specified in the ``subscriber.cpp``.
.. code-block:: C++
dds::domain::DomainParticipant participant(domain::default_id());
dds::topic::Topic<HelloWorldData::Msg> topic(participant, "ddscxx_helloworld_example");
dds::pub::Publisher publisher(participant);
With these entities ready, the writer can now be created. The writer is
created for a specific topic ``“ddscxx_helloworld_example”`` in the
default DDS domain.
.. code-block:: C++
dds::pub::DataWriter<HelloWorldData::Msg> writer(publisher, topic);
To modify the Data Writer Default Reliability Qos to Reliable:
.. code-block:: C++
dds::pub::qos::DataReaderQos dwqos = topic.qos() << dds::core::policy::Reliability::Reliable();
dds::sub::DataWriter<HelloWorldData::Msg> dr(publisher, topic, dwqos);
When Cyclone DDS discovers readers and writers sharing the same data
type and topic name, it connects them without the application
involvement. In order to write data only when a data reader appears, a
rendez-vous pattern is required. Such pattern can be implemented by
either:
1. Wait for the publication/subscription matched events, where the
Publisher waits and blocks the writing-thread until the appropriate
publication matched event is raised, or
2. Regularly, poll the publication matching status. This is the
preferred option used in this example.The following line of code
instructs Cyclone DDS to listen on the
``writer.publication_matched_status()``
.. code-block:: C++
dds::pub::DataWriter<HelloWorldData::Msg> writer(publisher, topic);
At regular intervals, we get the status change and for a matching
publication. In between, the writing thread sleeps for 20 milliseconds.
.. code-block:: C++
while (writer.publication_matched_status().current_count() == 0) {
std::this_thread::sleep_for(std::chrono::milliseconds(20));
}
After this loop, we are certain that a matching reader has been
discovered. Now, we can commence the writing of the data instance.
First, the data must be created and initialized
.. code-block:: C++
HelloWorldData::Msg msg(1, "Hello World");
Send the data instance of the keyed message.
.. code-block:: C++
writer.write(msg);
After writing the data to the writer, the *DDS CXX Hello World* example
checks if there is still a matching subscriber(s) available. If there is
a matching subscriber(s), the example waits for 50ms and start
publishing the data again. If no matching subscriber is found, then the
publisher program is ended.
.. code-block:: C++
return EXIT_SUCCESS;
Through scoping, all the entities such as topic, writer … etc are
deleted automatically.
Contributing to Eclipse Cyclone DDS
===================================
We welcome all contributions to the project, including questions,
examples, bug fixes, enhancements or improvements to the documentation,
etc.
If you want to contribute code, it is useful to know that build
configurations for Azure DevOps Pipelines are present in the repositories
and there is a test suite using CTest and CUnit that can be built
locally. The following sections explain how to do this for the different
operating systems.
Linux and macOS
~~~~~~~~~~~~~~~
Set the CMake variable ``BUILD_TESTING`` to ``ON`` when configuring, e.g.:
.. code-block:: bash
cd build
cmake -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTING=ON ..
cmake --build .
ctest
**Note:** To install the Cyclone DDS package:
.. code-block:: bash
cmake -DCMAKE_INSTALL_PREFIX=<install-location> ..
cmake --build . --target install
This build requires `CUnit <http://cunit.sourceforge.net/>`__. You can
install this yourself, or you can choose to instead rely on the
`Conan <https://conan.io/>`__ packaging system that the CI build
infrastructure also uses. In that case, install Conan in the build
directory prior to running CMake:
.. code-block:: bash
conan install .. --build missing
Windows
~~~~~~~
Set the CMake variable ``BUILD_TESTING`` to ``ON`` when configuring, e.g.:
.. code-block:: bash
cd build
cmake -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTING=ON ..
cmake --build .
ctest
**Note:** To install the Cyclone DDS package:
.. code-block:: bash
cmake -DCMAKE_INSTALL_PREFIX=<install-location> ..
cmake --build . --target install
This build requires `CUnit <http://cunit.sourceforge.net/>`__. You can
install this yourself, or you can choose to instead rely on the
`Conan <https://conan.io/>`__ packaging system that the CI build
infrastructure also uses. In that case, install Conan in the build
directory prior to running CMake:
.. code-block:: bash
conan install .. --build missing
**Note:** depending on the generator, you may also need to add switches
to select the architecture and build type, e.g.:
.. code-block:: bash
conan install -s arch=x86_64 -s build_type=Debug ..
This automatically downloads and/or builds CUnit
(and currently OpenSSL for transport security).
Contributing to Eclipse Cyclone DDS CXX
=======================================
Linux and macOS
~~~~~~~~~~~~~~~
Set the CMake variable ``BUILD_TESTING`` to ``ON`` when configuring.
.. code-block:: bash
cd build
cmake -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTING=ON ..
cmake --build .
ctest
**Note:** If CMake can not locate the Cyclone DDS:
.. code-block:: bash
cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_INSTALL_PREFIX=<install-location> -DCMAKE_PREFIX_PATH="<cyclonedds-install-location>" -DBUILD_TESTING=ON ..
To install the package:
.. code-block:: bash
cmake --build . --target install
This build requires `Google
Test <https://github.com/google/googletest>`__. You can install this
yourself, or you can choose to instead rely on the
`Conan <https://conan.io/>`__ package manager that the CI build
infrastructure also uses. In that case, install Conan in the build
directory prior to running CMake:
.. code-block:: bash
conan install .. --build missing
This automatically downloads and/or builds Google Test.
Windows
~~~~~~~
Set the CMake variable ``BUILD_TESTING`` to on when configuring.
.. code-block:: bash
cd build
cmake -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTING=ON ..
cmake --build .
ctest
**Note:** If CMake can not locate the Cyclone DDS or IDL package:
.. code-block:: bash
cmake -DCMAKE_BUILD_TYPE=Debug -DCMAKE_INSTALL_PREFIX=<install-location> -DCMAKE_PREFIX_PATH="<cyclonedds-install-location>" -DBUILD_TESTING=ON ..
To install the package:
.. code-block:: bash
cmake --build . --target install
This build requires `Google
Test <https://github.com/google/googletest>`__. You can install this
yourself, or you can choose to instead rely on the
`Conan <https://conan.io/>`__ package manager that the CI build
infrastructure also uses. In that case, install Conan in the build
directory prior to running CMake:
.. code-block:: bash
conan install .. --build missing
This automatically downloads and/or builds Google Test.
**Note:** Depending on the generator, you may also need to add switches
to select the architecture and build type, e.g.:
.. code-block:: bash
conan install -s arch=x86_64 -s build_type=Debug ..
|