Skip to content

Commit 02b5cc5

Browse files
author
Fran Porcel
committed
Fixed README and scripts from PR feedback
1 parent f49cf5e commit 02b5cc5

File tree

3 files changed

+38
-33
lines changed

3 files changed

+38
-33
lines changed

examples/routing_service/shmem_udp_gateway/README.md

+36-31
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,23 @@ a second configuration option using RTI Cloud Discovery Service to use Unicast.
1111

1212
For your convenience, there are 2 scripts to set up environment variables:
1313

14-
- Linux: _variables.sh_
15-
- Windows: _variables.bat_
14+
- Linux: *variables.sh*
15+
- Windows: *variables.bat*
1616

1717
These are the variables they contain, which you should modify according to your
1818
system:
1919

2020
- **NDDSHOME**: path to the installation of RTI Connext Professional.
21-
- **NDDS_QOS_PROFILES**: path to the _qos.xml_ file containing QoS profiles.
21+
- **NDDS_QOS_PROFILES**: path to the *qos.xml* file containing QoS profiles.
2222
- **SHMEM_DOMAIN**: the domain for the applications using SHMEM.
23-
- **UDP_DOMAIN**: the domain for the applications using UDP (mainly the DomainParticipant of RTI Routing Service).
24-
- **APPS**: total number of DomainParticipants on the localhost. By default, Connext will try to reach out to the first 5 created applications on SHMEM, therefore, we need to increase that number if there are more than 5 applications.
25-
- **CDS_IP_ADDRESS**: the IP address of the host that contains RTI Cloud Discovery Service.
23+
- **UDP_DOMAIN**: the domain for the applications using UDP (mainly the
24+
DomainParticipant of RTI Routing Service).
25+
- **APPS**: total number of DomainParticipants on the localhost. By default,
26+
Connext will try to reach out to the first 5 created applications on SHMEM,
27+
therefore, we need to increase that number if there are more than 5
28+
applications.
29+
- **CDS_IP_ADDRESS**: the IP address of the host that contains RTI Cloud
30+
Discovery Service.
2631
- **CDS_PORT**: the UDP port that CDS will use.
2732

2833
On Linux, you can use the environment variables by sourcing the file:
@@ -44,23 +49,23 @@ instead of the Windows variable signs (%%).
4449

4550
You will need 3 terminals to run this example.
4651

47-
1. On terminal 1, source the variables script and run an RTI DDS Ping publisher
48-
on SHMEM acting as a local publisher:
52+
1. On terminal 1, source the variables script and run an RTI DDS Ping
53+
publisher on SHMEM acting as a local publisher:
4954

5055
```bash
5156
source variables.sh
5257
$NDDSHOME/bin/rtiddsping -pub -domain $SHMEM_DOMAIN -qosProfile "example_library::shmem_profile"
5358
```
5459

55-
2. On terminal 2, source the variables script and run an RTI DDS Ping
60+
2. On terminal 2, source the variables script and run an RTI DDS Ping
5661
subscriber on UDP acting as a remote subscriber:
5762

5863
```bash
5964
source variables.sh
6065
$NDDSHOME/bin/rtiddsping -sub -domain $UDP_DOMAIN -qosProfile "example_library::multicast"
6166
```
6267

63-
3. At this point, there should be no communication between both applications.
68+
3. At this point, there should be no communication between both applications.
6469
They are on different domains and they're using different transports.
6570
On terminal 3, on the same host as the SHMEM application,
6671
source the variables script and start Routing Service:
@@ -69,7 +74,8 @@ source the variables script and start Routing Service:
6974
source variables.sh
7075
$NDDSHOME/bin/rtiroutingservice -cfgFile RS_config_multicast.xml -cfgName gateway_SHMEM_and_UDP
7176
```
72-
4. The subscriber should now be receiving data. For instance:
77+
78+
4. The subscriber should now be receiving data. For instance:
7379

7480
```bash
7581
...
@@ -81,52 +87,52 @@ source the variables script and start Routing Service:
8187
...
8288
```
8389

84-
5. (Optional) Feel free to explore the QoS and RS config files. The relevant
85-
QoS profiles for this example are _shmem_profile_ and _multicast_. The RS file
86-
contains a _domain_route_ with 2 DPs. 1 for UDP and another one for SHMEM
87-
(configured through the DP QoS). It also contains 2 _auto_topic_route_ tags
90+
5. (Optional) Feel free to explore the QoS and RS config files. The relevant
91+
QoS profiles for this example are *shmem_profile* and *multicast*. The RS file
92+
contains a *domain_route* with 2 DPs. 1 for UDP and another one for SHMEM
93+
(configured through the DP QoS). It also contains 2 *auto_topic_route* tags
8894
that allow the traffic to flow in the SHMEM --> UDP and SHMEM <-- UDP
8995
directions. In a real scenario, there would most likely be more topic routes,
9096
because different topics will require different DW / DR QoS policies.
9197

92-
6. (Optional) You can run Wireshark and capture data to verify that the
98+
6. (Optional) You can run Wireshark and capture data to verify that the
9399
traffic only goes to the 3 different ports that Routing Service opens:
94100
Multicast discovery, Unicast discovery and Unicast user-data. Which ports are
95101
actually in use will depend on the domain ID you use for UDP and whether you
96102
started the RTI DDS Ping application on the same machine as Routing Service or
97103
not. Remember you can check the ports in use on this [spreadsheet](https://d2vkrkwbbxbylk.cloudfront.net/sites/default/files/knowledge_base/Port%20Assign4.2e.xls).
98104

99-
6. You can now shutdown the 3 applications with Ctrl+C.
105+
6. You can now shutdown the 3 applications with Ctrl+C.
100106

101107
## Multicast-less example (CDS)
102108

103109
You will need 3 terminals to run this example.
104110

105-
1. On terminal 1, source the variables script and run an RTI DDS Ping publisher
106-
on SHMEM acting as a local publisher:
111+
1. On terminal 1, source the variables script and run an RTI DDS Ping
112+
publisher on SHMEM acting as a local publisher:
107113

108114
```bash
109115
source variables.sh
110116
$NDDSHOME/bin/rtiddsping -pub -domain $SHMEM_DOMAIN -qosProfile "example_library::shmem_profile"
111117
```
112118

113-
2. Install the CDS package. For instance: _rti_cloud_discovery_service-7.2.0-host-x64Linux.rtipkg_
119+
2. Install the CDS package. For instance: *rti_cloud_discovery_service-7.2.0-host-x64Linux.rtipkg*
114120

115-
3. On terminal 2, source the variables script and start CDS:
121+
3. On terminal 2, source the variables script and start CDS:
116122

117123
```bash
118124
$NDDSHOME/bin/rticlouddiscoveryservice -cfgFile CDS_config.xml -cfgName cds_all_domains_udpv4
119125
```
120126

121-
4. On terminal 3, source the variables script and run an RTI DDS Ping
127+
4. On terminal 3, source the variables script and run an RTI DDS Ping
122128
subscriber on UDP acting as a remote subscriber:
123129

124130
```bash
125131
source variables.sh
126132
$NDDSHOME/bin/rtiddsping -sub -domain $UDP_DOMAIN -qosProfile "example_library::no_multicast"
127133
```
128134

129-
5. At this point, there should be no communication between both applications.
135+
5. At this point, there should be no communication between both applications.
130136
They are on different domains and they're using different transports. On
131137
terminal 4, on the same host as the SHMEM application, source the variables
132138
script and start Routing Service:
@@ -136,7 +142,7 @@ script and start Routing Service:
136142
$NDDSHOME/bin/rtiroutingservice -cfgFile RS_config_with_CDS.xml -cfgName gateway_SHMEM_and_UDP
137143
```
138144
139-
6. The subscriber should now be receiving data. For instance:
145+
6. The subscriber should now be receiving data. For instance:
140146
141147
```bash
142148
...
@@ -148,20 +154,19 @@ script and start Routing Service:
148154
...
149155
```
150156
151-
152-
7. (Optional) Feel free to explore the QoS and RS config files. The relevant
153-
QoS profiles for this example are _shmem_profile_ and _no_multicast_. The RS
154-
file contains a _domain_route_ with 2 DPs. 1 for UDP and another one for SHMEM
155-
(configured through the DP QoS). It also contains 2 _auto_topic_route_ tags
157+
7. (Optional) Feel free to explore the QoS and RS config files. The relevant
158+
QoS profiles for this example are *shmem_profile* and *no_multicast*. The RS
159+
file contains a *domain_route* with 2 DPs. 1 for UDP and another one for SHMEM
160+
(configured through the DP QoS). It also contains 2 *auto_topic_route* tags
156161
that allow the traffic to flow in the SHMEM --> UDP and SHMEM <-- UDP
157162
directions. In a real scenario, there would most likely be more topic routes,
158163
because different topics will require different DW / DR QoS policies.
159164
160-
8. (Optional) You can run Wireshark and capture data to verify that the
165+
8. (Optional) You can run Wireshark and capture data to verify that the
161166
traffic only goes to the 2 different ports that Routing Service opens: Unicast
162167
discovery and Unicast user-data. Which ports are actually in use will depend
163168
on the domain ID you use for UDP and whether you started the RTI DDS Ping
164169
application on the same machine as Routing Service or not. Remember you can
165170
check the ports in use on this [spreadsheet](https://d2vkrkwbbxbylk.cloudfront.net/sites/default/files/knowledge_base/Port%20Assign4.2e.xls).
166171
167-
8. You can now shutdown the 4 applications with Ctrl+C.
172+
8. You can now shutdown the 4 applications with Ctrl+C.

examples/routing_service/shmem_udp_gateway/variables.bat

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ set SHMEM_DOMAIN=0
1414
set UDP_DOMAIN=1
1515
set APPS=20
1616
set CDS_IP_ADDRESS=127.0.0.1
17-
set CDS_PORT=8000
17+
set CDS_PORT=8000

examples/routing_service/shmem_udp_gateway/variables.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ export SHMEM_DOMAIN=0
1414
export UDP_DOMAIN=1
1515
export APPS=20
1616
export CDS_IP_ADDRESS=127.0.0.1
17-
export CDS_PORT=8000
17+
export CDS_PORT=8000

0 commit comments

Comments
 (0)