2. Introduction to Publish/Subscribe¶
Prerequisites |
|
Time to complete | 30 minutes |
Concepts covered in this module |
|
The most basic communication pattern supported by RTI® Connext® DDS is the publish/subscribe model. Publish/Subscribe is a communications model where data producers “publish” data and data consumers “subscribe” to data. These publishers and subscribers don’t need to know about each other ahead of time; they discover each other dynamically at runtime. The data they share is described by a “topic,” and publishers and subscribers send and receive data only for the topics they are interested in. In this pattern, many publishers may publish the same topic, and many subscribers may subscribe to the same topic. Subscribers receive data from all of the publishers that they share a topic with. Publishers send data directly to subscribers, with no need for a broker or centralized application to mediate communications.
2.1. Introduction to DataWriters, DataReaders, and Topics¶
In DDS, the objects that actually publish data are called DataWriters, and the objects that subscribe to data are DataReaders. DataWriters and DataReaders are associated with a single Topic object that describes that data. (DDS also has Publisher and Subscriber objects, but we will talk about them later.) An application typically has a combination of DataWriters and DataReaders.
In a chocolate factory, for example, there might be a sensor that measures and publishes the current temperature of the tempering machine. Other applications monitor the temperature by subscribing to it. In this example, your Topic might be “ChocolateTemperature.” The sensor’s DataWriter will be associated with the “ChocolateTemperature” Topic. In a similar way, other DataWriters and DataReaders share different types of data using additional Topics.
Connext DDS is responsible for discovering DataWriters and DataReaders in a system, checking if they have a matching Topic (and compatible quality of service, which we will discuss later) and then providing the communication between those DataWriters and DataReaders. Logically, this means you can visualize your applications as having DataWriters and DataReaders that connect to a “databus,” because your applications are not specifying exactly which other applications they communicate with – they only specify which Topics they read from and write to the databus, and Connext DDS sets up the communication. Note that there is no “databus” object in your system – it is a logical way to visualize systems in which you don’t have to configure each communication path.
2.2. Hands-On 1: Your First DataWriter and DataReader¶
We are going to start with a simple “Hello World” application to show how to use the code generator, and how to create a DataWriter and a DataReader.
Tip
By the end of this exercise, a publishing application will send data,
and a subscribing application will receive and print it to the console
using std::cout
.
2.2.1. Clone Repository¶
Get the files you need to perform the hands-on exercises. Either download the repository as a Zip file from the repository webpage here, or clone the repository from GitHub with the following command:
$ git clone https://github.com/rticommunity/rticonnextdds-getting-started.git
$ git clone https://github.com/rticommunity/rticonnextdds-getting-started.git
> git clone https://github.com/rticommunity/rticonnextdds-getting-started.git
2.2.2. Set Up Environment Variables (rtisetenv)¶
Set up the environment variables for running the code generator and compiling your application:
Open a command prompt window, if you haven’t already.
Run this script:
$ source <installdir>/resource/scripts/rtisetenv_<architecture>.bash$ source <installdir>/resource/scripts/rtisetenv_<architecture>.bashIf the script doesn’t work, you may be using the zsh shell. If you are, run
/bin/bash
before running the script to get into the bash shell.> <installdir>\resource\scripts\rtisetenv_<architecture>.batWhen a directory name has a space, enclose the path in quotation marks. For example:
"C:\Program Files\rti_connext_dds-6.0.1\resource\scripts\rtisetenv_x64Win64VS2017.bat"
.
<installdir>
refers to the installation directory for Connext DDS.The
rtisetenv
script adds the location of the SDK libraries (<installdir>/lib/<architecture>
) to your library path, sets the <NDDSHOME> environment variable (see Paths Mentioned in Documentation), and puts the RTI Code Generator tool in your path. You’ll need this tool in the next step.Your architecture (such as
x64Win64VS2017
orx64Linux3gcc5.4.0
) is the combination of a processor, OS, and compiler version that you will use to build your application. The architecture you choose should match the target libraries you installed (see Installing Connext DDS). See also Checking What is Installed. To see the full list of available architectures, runrtiddsgen -help
or see the “RTI Architecture Abbreviation” columns in the RTI Connext DDS Core Libraries Platform Notes.If this script does not exist in your installation, it means that you need to install a target. See Installing Connext DDS.
2.2.3. Run Code Generator¶
Inside the repository you have cloned, there is a directory named
2_hello_world
, which contains the HelloWorld type definition in a file
named hello_world.idl
.
Open
hello_world.idl
to see the definition for our HelloWorld type:// Hello world! struct HelloWorld { // String with maximum length of 256 characters string<256> msg; };This language-independent interface is written in IDL, the Interface Definition Language. IDL allows you to declare data types used for communication (we’ll cover this more in Introduction to Data Types). Connext DDS includes a code generator that translates from this language-independent data type into code specific for your language. The generated code serializes and deserializes your data into and out of a network format.
From a terminal or command prompt, run rtiddsgen, which runs the code generator on
hello_world.idl
:$ cd 2_hello_world $ rtiddsgen -language c++11 -platform <architecture> -create makefiles -create typefiles -d c++11 hello_world.idl$ cd 2_hello_world $ rtiddsgen -language c++11 -platform <architecture> -create makefiles -create typefiles -d c++11 hello_world.idl> cd 2_hello_world > rtiddsgen -language c++11 -platform <architecture> -create makefiles -create typefiles -d c++11 -ppDisable hello_world.idl
-ppDisable
disables the preprocessor. It is necessary for running rtiddsgen on a Windows system if the preprocessor is not in your path. You can only use-ppDisable
if your IDL is simple, as it is here—otherwise you must add the preprocessor to your path. See Command-Line Arguments for rtiddsgen, in the RTI Connext DDS Code Generator User’s Manual if you want more information.You don’t have to type the full path (
<install dir>/bin/rtiddsgen
) because you ranrtisetenv_<architecture>
earlier, as described in Set Up Environment Variables (rtisetenv).Your
architecture
is the combination of a processor, OS, and compiler version that you will use to build your application. (See Set Up Environment Variables (rtisetenv).)
-d c++11
specifies the directory where the code will be generated.Note
If you are using Visual Studio 2019, use “VS2017” in your
architecture
name.Open the
c++11
directory to review the code.
2.2.3.1. Overview of Generated and Example Code¶
The code you just generated includes the files in Table 2.1,
in the c++11
directory. Some of the files are generated by rtiddsgen, some
came from the GitHub repository you cloned.
Files | Description | Generated by rtiddsgen? |
---|---|---|
|
The C++11 definition of your data type, and the code used to serialize
and deserialize it (convert it to a format for the network). This is the
type-specific code that will be used in your real application. These
files were generated when you specified -create typefiles when running
rtiddsgen. |
Yes |
|
Example code from the repository you cloned. It includes code for two applications you can read and modify. These will compile into separate applications, hello_world_publisher and hello_world_subscriber. | No [1] |
|
Used to build your application. These files were generated because you specified
-platform <architecture> -create makefiles when running rtiddsgen. For more
information on how to build, see the README_<architecture>.txt file generated with
the code. [2] |
Yes |
|
Configuration file for Quality of Service (to be discussed more later). This file came from the repository you cloned. | No |
|
Instructions for how to open and modify the files, compile, and run the example for your specific IDE and operating system. This file was generated when you ran rtiddsgen. | Yes |
[1] | rtiddsgen can also generate simple example code, but we are using our own code examples for this Getting Started Guide. |
[2] | These files are generated by rtiddsgen. If you want to create your own project files or makefiles, see the RTI Connext DDS Core Libraries Platform Notes to know what compilation and linker settings to use in them. |
2.2.4. Open/Modify Publishing Application¶
In the
2_hello_world/c++11
directory, openhello_world_publisher.cxx
in your IDE of choice. (See theREADME_<architecture>.txt
file generated with the code for information on how to modify this file in your IDE and operating system.)This snippet shows how to create a Topic (with a name and data type) and create a DataWriter for that Topic:
// A Topic has a name and a datatype. Create a Topic named // "HelloWorld Topic" with type HelloWorld dds::topic::Topic<HelloWorld> topic(participant, "Example HelloWorld"); // A Publisher allows an application to create one or more DataWriters // Publisher QoS is configured in USER_QOS_PROFILES.xml dds::pub::Publisher publisher(participant); // This DataWriter will write data on Topic "HelloWorld Topic" // DataWriter QoS is configured in USER_QOS_PROFILES.xml dds::pub::DataWriter<HelloWorld> writer(publisher, topic);Tip
In this example, Topic, Publisher, and DataWriter look like ordinary objects being created on the stack. However, these types are actually reference types that behave like shared pointers. Copying a reference does not copy the entity it is referring to, and creating additional references from the existing reference(s) is a relatively inexpensive operation.
You can find more information about reference type semantics in the Modern C++ API reference, along with documentation conventions for distinguishing between reference types and value types.
Change the Topic name from “Example HelloWorld” to “HelloWorld Topic”:
// A Topic has a name and a datatype. Create a Topic named // "HelloWorld Topic" with type HelloWorld dds::topic::Topic<HelloWorld> topic(participant, "HelloWorld Topic");Modify the code to send the message “Hello world!” with a count.
The following snippet shows how to write a HelloWorld update using the DataWriter’s write method.
In the for loop in the snippet, add the highlighted line, just after the comment
// Modify the data to be written here
. This will set sample.msg to “Hello world!” with a count:// Create data sample for writing HelloWorld sample; for (int count = 0; running && (count < sample_count || sample_count == 0); count++) { // Modify the data to be written here sample.msg("Hello world! " + std::to_string(count)); std::cout << "Writing HelloWorld, count " << count << std::endl; writer.write(sample); rti::util::sleep(dds::core::Duration(4)); }Recall that your “HelloWorld Topic” describes your data. This Topic is associated with the data type HelloWorld, which is defined in the IDL file (see Run Code Generator). The data type HelloWorld contains a string field named msg. In this step, you have just added code to set a value for the msg field. Now, when the DataWriter writes data, the msg field in the data will contain the string “Hello world! 1”, “Hello world! 2”, etc.
Definition
A sample is a single update to a Topic, such as “Hello world! 1”. Every time an application calls
write()
, it is “writing a sample.” Every time an application receives data, it is “receiving a sample.”Note that samples don’t necessarily overwrite each other. For example, if you set up a RELIABLE Quality of Service (QoS) with a History kind of KEEP_ALL, all samples will be saved and accumulate. You can find more details in Basic QoS.
2.2.5. Open/Modify Subscribing Application¶
The subscriber application also creates a Topic, in hello_world_subscriber.cxx
.
Open
hello_world_subscriber.cxx
.This snippet shows how to create a Topic (with a name and data type) and create a DataReader for that Topic:
// A Topic has a name and a datatype. Create a Topic named // "HelloWorld Topic" with type HelloWorld dds::topic::Topic<HelloWorld> topic(participant, "Example HelloWorld"); // A Subscriber allows an application to create one or more DataReaders // Subscriber QoS is configured in USER_QOS_PROFILES.xml dds::sub::Subscriber subscriber(participant); // This DataReader will read data of type HelloWorld on Topic // "HelloWorld Topic". DataReader QoS is configured in // USER_QOS_PROFILES.xml dds::sub::DataReader<HelloWorld> reader(subscriber, topic);Change the Topic name from “Example HelloWorld” to “HelloWorld Topic”, just as you did in the publishing application.
Note
The Topic names must match between the publishing and subscribing applications for the DataWriter and DataReader to communicate.
// Create a Topic -- and automatically register the type dds::topic::Topic<HelloWorld> topic(participant, "HelloWorld Topic");
2.2.5.1. Details of Receiving Data¶
You don’t need to make any changes here, but look at the
hello_world_subscriber.cxx
code to see how it receives data. The
DataReader is being notified of new data using an object called a WaitSet:
// Create a WaitSet and attach the StatusCondition
dds::core::cond::WaitSet waitset;
waitset += status_condition;
while (running && (samples_read < sample_count || sample_count == 0)) {
// Dispatch will call the handlers associated to the WaitSet conditions
// when they activate
std::cout << "HelloWorld subscriber sleeping for 4 sec..."
<< std::endl;
waitset.dispatch(dds::core::Duration(4)); // Wait up to 4s each time
}
This WaitSet object is a way for the application to sleep until some
“condition” becomes true. When the application calls
waitset.dispatch(dds::core::Duration(4))
, it will sleep for up to the
duration time (4 seconds in this example), unless it is woken up due to
a condition becoming true.
There are multiple types of conditions that you can attach to a WaitSet, but this example shows a StatusCondition. Here is the code for the StatusCondition:
// Obtain the DataReader's Status Condition
dds::core::cond::StatusCondition status_condition(reader);
// Enable the 'data available' status.
status_condition.enabled_statuses(
dds::core::status::StatusMask::data_available());
// Associate a handler with the status condition. This will run when the
// condition is triggered.
unsigned int samples_read = 0;
status_condition.extensions().handler([&reader, &samples_read]() {
samples_read += process_data(reader);
});
In this example, we are saying that we are interested in waking up when the “data available” status becomes true. This means that when data arrives:
- The reader’s
data_available
status becomes true - The application is woken up from the dispatch call
- The lambda function is called
A closer look at process_data
, called by the lambda function:
unsigned int process_data(dds::sub::DataReader<HelloWorld>& reader)
{
// Take all samples. Samples are loaned to application, loan is
// returned when LoanedSamples destructor called.
unsigned int samples_read = 0;
dds::sub::LoanedSamples<HelloWorld> samples = reader.take();
for (const auto& sample : samples) {
if (sample.info().valid()) {
samples_read++;
std::cout << sample.data() << std::endl;
}
}
return samples_read;
} // The LoanedSamples destructor returns the loan
This code calls reader.take()
, which removes any available samples out
of the DataReader queue, and returns them in a collection. If data is
arriving quickly, it is likely this collection will contain multiple
samples. In this example, the sample’s data is being printed to the
screen with std::cout
.
2.2.6. Compile Your Changes¶
Now that you have made changes to both the publisher and subscriber code, compile
the code with your modifications. (For general instructions on how to compile on
each operating system, see the README_<architecture>.txt
file included with your
generated code.)
Note
If you see linker errors, you may not have a complete installation. See Installing Connext DDS.
You should see two applications in the objs/<architecture>
directory:
- hello_world_publisher
- hello_world_subscriber
2.2.7. Run the Applications¶
Make sure you have run
rtisetenv_<architecture>
in any new command prompt window, to avoid issues with paths and licensing. See Set Up Environment Variables (rtisetenv).
From within the
2_hello_world/c++11
directory, enter the following full path:$ objs/<architecture>/hello_world_publisher
$ objs/<architecture>/hello_world_publisher
> objs\<architecture>\hello_world_publisher.exeNote
You must be in the
2_hello_world/<language>
directory and type the full path above. Do not run the publisher or subscriber application from withinobjs/<architecture>
. You should run from the2_hello_world/<language>
directory because the examples use Quality of Service (QoS) information from the fileUSER_QOS_PROFILES.xml
in the2_hello_world/<language>
directory. We’ll talk more about QoS in a later module.You should see this in the window for the publisher:
Writing HelloWorld, count 1 Writing HelloWorld, count 2 Writing HelloWorld, count 3 Writing HelloWorld, count 4 ...Open another command prompt window, run
rtisetenv_<architecture>
if you haven’t already in that window, and from within the2_hello_world/c++11
directory, enter the following full path:$ objs/<architecture>/hello_world_subscriber
$ objs/<architecture>/hello_world_subscriber
> objs\<architecture>\hello_world_subscriber.exeYou should see this in the window for the subscriber:
HelloWorld subscriber sleeping for 4 sec... [msg: Hello world! 1] HelloWorld subscriber sleeping for 4 sec... [msg: Hello world! 2] HelloWorld subscriber sleeping for 4 sec... [msg: Hello world! 3] ...(Since both the publisher and subscriber sleep for up to 4 seconds, you may get the
HelloWorld subscriber sleeping for 4 sec...
line twice in a row, depending on the timing between the two applications.)The
[msg: Hello world! <count>]
line is the data being sent by the DataWriter. If the DataWriter weren’t communicating with the DataReader, you would just see theHelloWorld subscriber sleeping for 4 sec
lines and not the “msg” lines. (The subscribing application prints the “sleeping” lines before the WaitSet starts waiting for data, then it prints the “msg:” lines when it receives data from the DataWriter.)Note
If you don’t get the results described here, see Troubleshooting.
2.2.8. Taking It Further¶
Under the hood, the publishing and subscribing applications are doing a lot of work:
Before communication starts, the DataWriter and DataReader discover each other and check that they have the same Topic name, compatible data types, and compatible QoS. (We will talk more about discovery in a later module). After discovery, the DataWriter sends data directly to the DataReader, with no message broker required.
When you run the applications on the same machine, by default they communicate over shared memory. If you run one on another machine, they communicate over the network using UDP.
2.2.8.1. Start up Multiple Publishing or Subscribing Applications¶
Try starting up multiple publishing or subscribing applications, and you
will see that they will also send or receive data. (Remember to run from the
2_hello_world/<language>
directory.)
2.2.8.2. Publish/Subscribe across Multiple Machines¶
To publish/subscribe between two machines:
Clone the repository on both machines. See Clone Repository.
In the
2_hello_world
directory on one machine, modify and run the publishing application as described in Open/Modify Publishing Application. See also Compile Your Changes and Run the Applications.
In the
2_hello_world
directory on the other machine, modify and run the subscribing application as described in Open/Modify Subscribing Application. See also Compile Your Changes and Run the Applications.Note
If you are running both applications and they aren’t communicating (you don’t see the “msg:” lines shown at the end of Run the Applications), see Troubleshooting.
2.2.8.3. Create Multiple DataWriters, DataReaders, and Topics in a Single Application¶
So far, you have created two applications: one that uses a DataReader to subscribe to “HelloWorld Topic” and one that uses a DataWriter to publish “HelloWorld Topic.” You have seen that these applications automatically discover each other and communicate, and that you can run multiple copies of them.
In Introduction to Data Types, you’ll add a second DataWriter to an application, and in Introduction to Keys and Instances, you’ll create an application that contains multiple DataWriters, DataReaders, and Topics.
Tip
Even though these initial example applications each do only one thing, typical real-world applications contain a combination of DataWriters and DataReaders for multiple Topics in a single application. We will illustrate this in later modules.
2.3. Troubleshooting¶
2.3.1. Why aren’t my applications communicating?¶
If you are running both applications and they aren’t communicating (you don’t see the
msg: Hello world
lines shown at the end of Run the Applications), here
are some things to check:
- Did you change the Topic name in both applications before compiling? They should match.
Are you running both applications from the
2_hello_world/<language>
directory, so they load the sameUSER_QOS_PROFILES.xml
file?Note
You must be in the
2_hello_world/<language>
directory when you typeobjs/<architecture>/hello_world_<publisher or subscriber>[.exe]
. Do not run the application from withinobjs/<architecture>
. (When rtiddsgen generates a project for your IDE (e.g., for Eclipse™ or Visual Studio) and you run the application from that IDE, it will run from the correct directory.)If you are running on multiple machines, does your network support multicast? If it does not, see How do I set my discovery peers? below, for how to specify the addresses of the remote machines your application plans to communicate with.
- Check to see if one or both machines use a firewall. You may need to disable your firewall or configure it to allow multicast traffic for communication to be established.
For more information, see the article on RTI Community, How to Do Basic Debugging for System-Level DDS.
2.3.2. How do I set my discovery peers?¶
If you are running Connext DDS on multiple machines and your network does not support multicast, specify the address(es) of the remote machine(s) you want to communicate with:
In the
2_hello_world\<language>
directory, find USER_QOS_PROFILES.xml.
Identify the following lines in USER_QOS_PROFILES.xml:
<participant_qos> <!-- The participant name, if it is set, will be displayed in the RTI tools, making it easier for you to tell one application from another when you're debugging. --> <participant_name> <name>HelloWorldParticipant</name> </participant_name> </participant_qos>
Add the
<discovery>
section as follows, and replace the IP address with the IP address or hostname of the other machine you want to communicate with:<participant_qos> <!-- The participant name, if it is set, will be displayed in the RTI tools, making it easier for you to tell one application from another when you're debugging. --> <participant_name> <name>HelloWorldParticipant</name> </participant_name> <discovery> <initial_peers> <!-- Add an element for each machine you want to communicate with --> <element>192.168.1.14</element> </initial_peers> </discovery> </participant_qos>
If you want more information about discovery peers, see Configuring the Peers List Used in Discovery, in the RTI Connext DDS Core Libraries User’s Manual.
2.3.3. Why does the DataReader miss the first samples?¶
Discovery is not an instantaneous event. It takes some time for the discovery process between applications to complete. The DataWriter and DataReader must discover each other before they can start communicating. Therefore, if you send data immediately after creating the Connext DDS entities, DataReaders will not receive the first few samples because they are still in-process of discovering the DataWriters and vice versa. This is true even when the DataWriters and DataReaders are reliable, because the Reliability QoS on its own does not guarantee delivery to DataReaders that have not been discovered yet.
You can overcome this behavior with the Durability QoS Policy, which can be set to deliver historical samples (that DataWriters already sent) to late-joining DataReaders. The DataReaders will then receive the first samples they originally missed. We’ll talk about this more in Basic QoS.
2.3.4. Why do I get a “No source for License information” error?¶
If you get the following error, run rtisetenv_<architecture>
in your command prompt window:
RTI Connext DDS No source for License information
Please contact support@rti.com with any questions or comments.
Exception in subscriber_main(): Failed to create DomainParticipant
(You may need to run rtisetenv_<architecture>
for each new command prompt window you open, especially
if you installed an evaluation version.) See Set Up Environment Variables (rtisetenv).
See also Setting Up a License.
2.4. Hands-On 2: Viewing Your Data¶
Now that you’ve created applications that are publishing data, you can visualize that data using the Admin Console tool.
Note
The applications from Hands-On 1 above should be running while you perform the Admin Console steps below. See Run the Applications.
2.4.1. Open Admin Console¶
Start by opening Admin Console from RTI Launcher:
The following sections guide you through Admin Console for the purposes of this exercise, but you can find more information in Admin Console’s online Help:
2.4.2. Choose Automatically Join¶
You may be prompted to automatically or manually join domains when you first open Admin Console. For the purposes of this exercise, choose to automatically join (the default). We’ll discuss domains in a later module.
2.4.3. Switch to Data Visualization Perspective¶
Select the Data Visualization Perspective entry under the Visualization menu. (You may need to close a Welcome tab first.) If you can’t select the Data Visualization Perspective menu item, you may already be in that mode.
2.4.4. Open Topic Data Tab¶
From the DDS Logical View, click on the “HelloWorld Topic” to open the Topic View.
After switching to the Data Visualization Perspective, the main window will show the Topic Data tab, as seen below:
2.4.5. Subscribe to “HelloWorld Topic”¶
The Admin Console tool itself is a DDS application, so it must also create DataReaders to subscribe to the “HelloWorld Topic.” (See the Admin Console online Help for more information about this.) When you subscribe to the “HelloWorld Topic” in Admin Console, Admin Console will create a DataReader for this Topic.
Click on the Subscribe… button or right-click on the Topic in the DDS Logical View and select Subscribe. This will open the Create Subscription dialog seen below. Click OK to subscribe to the Topic.
2.4.6. Use Topic Data Tab¶
After the Topic is subscribed to, you will see your “Hello world” message.
In the Admin Console tool, you’re also able to inspect DataWriters and DataReaders, and even chart your live data, which we will look at later.
2.4.7. Use Admin Console across Machines¶
Admin Console is like any other Connext DDS application. It discovers what DataWriters and DataReaders are on the network, whether they’re on the same machine as Admin Console or on different machines.
If you have trouble viewing data in Admin Console across machines, the same troubleshooting tips apply to Admin Console as apply to DataWriters and DataReaders in How do I set my discovery peers?. If your network supports multicast, you’ll see data on the other machines in Admin Console; otherwise, specify the IP addresses of the remote machines you want Admin Console to communicate with.
2.5. Next Steps¶
Congratulations! You’ve written your first DDS application, which publishes HelloWorld data. In this exercise, you’ve experienced a quick overview of the development process from defining a data type and using the code generator, to building an example application and using Connext DDS Professional tools to see that data is being published. We’ll continue to build on these skills and to use these tools in more depth in subsequent exercises.
2.5.1. Additional information¶
See the full RTI Connext DDS Core Libraries Getting Started Guide for more details, including common design patterns such as subscribing only to relevant data and accessing historical data when joining the network. The content in this hands-on exercise (Introduction to Publish/Subscribe) replaces section 4.1 Building and Running “Hello, World” in the full guide.
2.5.2. Next Step¶
The next module takes a deeper dive into data types, including a little more information about how to define common types. We will be starting to work with an example that’s more complex than a “hello world”—we’re going to be using a chocolate factory example to showcase DDS concepts.
See next: Introduction to Data Types.