5. Repeater Example¶

A DDS Router could work as a TURN Repeater to forward messages by the same Participant. If you are interested in understanding the use case of a Repeater please refer to the following section Repeater DDS Router.

5.1. Configuration¶

5.1.1. Version¶

The version attribute is required, as the repeater tag is only supported from v4.0 configuration version.

version: v5.0                                                     # 0

5.1.2. Allowed Topics¶

This section lists the Topics that the DDS Router will route from one Participant to the other. Topic HelloWorldTopic with datatype HelloWorld, and ROS 2 topic rt/chatter with datatype std_msgs::msg::dds_::String_ will be forwarded from one domain to the other, allowing different DDS domains to interact with each other.

allowlist:
  - name: HelloWorldTopic                                         # 1
    type: HelloWorld                                              # 1
  - name: rt/chatter                                              # 2
    type: std_msgs::msg::dds_::String_

5.1.3. Repeater Participant¶

The Repeater Participant is the one that will be used to forward messages by the same Participant. It must be a WAN Participant and be configured as so with WAN configuration.

  - name: RepeaterParticipant                                     # 3
    kind: wan                                                     # 4
    repeater: true                                                # 5
    listening-addresses:
      - domain: "server.domain.com"
        port: 11666
        transport: tcp

5.1.4. Client Participants¶

Every Client can connect to a Repeater Participant as if it was a normal WAN Participant. The Repeater admits as many edge DDS Router connections as desired, so several DDS Router can use the same or similar configuration to communicate across it.

  - name: Client                                                  # 5
    kind: wan                                                     # 6
    connection-addresses:
      - domain: "server.domain.com"
        port: 11666
        transport: tcp

5.2. Execute example¶

Please refer to this section for a detailed explanation on how to execute the DDS Router.

5.2.1. Execute with ROS 2 demo nodes¶

In order to run this example, there must be three different hosts located in different local networks:

host H_A with private IP 192.168.1.2 connected to network router R_A with public IP 1.1.1.1.
host H_B with private IP 192.168.2.2 connected to network router R_B with public IP 2.2.2.2.
host H_C with private IP 192.168.2.3 connected to network router R_C with public IP 3.3.3.3.

This example could be run in localhost or with two hosts in the same LAN, but it will not use the WAN communication features of the DDS Router.

5.2.2. Host H_A¶

This host runs the DDS Router Repeater Server, which will receive data from both edges and redirect the messages between them. Execute DDS Router using file <path/to/ddsrouter_tool>/share/resources/configurations/examples/repeater.yaml. Remember to change the IP and port on the configuration file to the actual public IP of R_A, and be sure that the port forwarding rules are configured in R_A so H_A is accessible from the outside.

5.2.3. Hosts H_B and H_C¶

These hosts run the DDS Router WAN Clients, which will connect to the previously launched Repeater Server. Execute DDS Router using file <path/to/ddsrouter_tool>/share/resources/configurations/examples/wan_client.yaml. Remember to change the IPs and ports on the configuration file to the actual public IPs of R_A and R_B. In this example the port forwarding is not required, as the Repeater will allow the communication through it, and TCP protocol is being used..

Both clients can execute ROS 2 demo nodes, which will publish and subscribe in topic rt/chatter. Execute a talker in one of them and a listener in the other. It is recommended to use different ROS_DOMAIN_ID in each node, so in case both nodes are accessible (under same network) no loop is created. In order to do so, change the YAML configuration files to use different domains, and use the following ROS2 commands:

# Hb
ROS_DOMAIN_ID=0 ros2 run demo_nodes_cpp talker

# Hc
ROS_DOMAIN_ID=1 ros2 run demo_nodes_cpp listener

5.2.4. Result¶

After executing the three DDS Router applications in hosts, and talker and listener applications, the listener in H_C will start receiving and printing data from the talker in H_B. You are communicating DDS via WAN.

Note

If H_B can access H_C due to port forwarding or because both are under the same network, the listener will receive duplicated messages, as one of them will arrive from H_B and the other from H_A.