cyclonedds/examples/helloworld
ChenYing Kuo af3604dea7
Fix some typos. (#399)
* Fix some typos.

Signed-off-by: ChenYing Kuo <evshary@gmail.com>

* Also update q_config.c, cyclonedds.rnc, cyclonedds.xsd for correct
build.

Signed-off-by: ChenYing Kuo <evshary@gmail.com>

* Remove cdds.md.

Signed-off-by: ChenYing Kuo <evshary@gmail.com>
2020-02-19 12:33:39 +01:00
..
CMakeLists.export Fix install dir of CycloneDDSConfig.cmake (#321) 2019-11-18 14:21:10 +01:00
CMakeLists.txt Generate documentation using the FindSphinx.cmake module 2019-07-31 20:12:11 +02:00
HelloWorldData.idl Reorganize repository 2019-07-30 10:52:44 +02:00
publisher.c Fix some typos. (#399) 2020-02-19 12:33:39 +01:00
readme.rst Reorganize repository 2019-07-30 10:52:44 +02:00
subscriber.c Reorganize repository 2019-07-30 10:52:44 +02:00

..
   Copyright(c) 2006 to 2018 ADLINK Technology Limited and others

   This program and the accompanying materials are made available under the
   terms of the Eclipse Public License v. 2.0 which is available at
   http://www.eclipse.org/legal/epl-2.0, or the Eclipse Distribution License
   v. 1.0 which is available at
   http://www.eclipse.org/org/documents/edl-v10.php.

   SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause

HelloWorld
==========

Description
***********

The basic HelloWorld example is used to illustrate the necessary steps to setup DCPS entities.
Note it is also used in the Getting Started Guide to explain the usage of Eclipse Cyclone DDS.

Design
******

It consists of 2 units:

- HelloworldPublisher: implements the publisher's main
- HelloworldSubscriber: implements the subscriber's main

Scenario
********

The publisher sends a single HelloWorld sample. The sample contains two fields:

- a userID field (long type)
- a message field (string type)

When it receives the sample, the subscriber displays the userID and the message field.

Running the example
*******************

It is recommended that you run the subscriber and publisher in separate terminals to avoid mixing the output.

- Open 2 terminals.
- In the first terminal start the subscriber by running HelloWorldSubscriber
- In the second terminal start the publisher by running HelloWorldPublisher