Skip to content

Commit cf5a2a8

Browse files
Rearrange use cases list (#700) (#713)
* Rearrange use cases list Signed-off-by: Raul Sanchez-Mateos <raul@eprosima.com> * Refs #20501: Rename title & Add video link Signed-off-by: cferreiragonz <carlosferreira@eprosima.com> * Apply suggestion Co-authored-by: Jesús Poderoso <120394830+JesusPoderoso@users.noreply.github.com> --------- Signed-off-by: Raul Sanchez-Mateos <raul@eprosima.com> Signed-off-by: cferreiragonz <carlosferreira@eprosima.com> Co-authored-by: cferreiragonz <carlosferreira@eprosima.com> Co-authored-by: Jesús Poderoso <120394830+JesusPoderoso@users.noreply.github.com> (cherry picked from commit 63940f4) Co-authored-by: Raul Sanchez-Mateos Lizano <raul@eprosima.com>
1 parent 44179ea commit cf5a2a8

3 files changed

Lines changed: 9 additions & 4 deletions

File tree

docs/fastdds/use_cases/tcp/tcp_use_case.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
.. _use-case-tcp:
44

55
Large Data mode and Fast DDS over TCP
6-
======================================
6+
=====================================
77

88
As explained in :ref:`transport_tcp_tcp`, Fast DDS offers the possibility to communicate nodes within distributed
99
applications with DDS over a TCP transport layer.
@@ -25,6 +25,10 @@ networks. When configured, UDP transport will exclusively be used during the :re
2525
taking advantage of the more reliable TCP/SHM for the remainder of the communication process. Fast DDS offers
2626
an extremely straightforward implementation for this mode through an environment variable, XML profiles or via code.
2727

28+
For a video demonstration showcasing a practical example of this configuration, please refer to:
29+
`Large Data communication with ROS 2
30+
<https://docs.vulcanexus.org/en/latest/rst/use_cases/large_data/large_data.html>`_.
31+
2832
Also, it is possible to enable TCP communication while using
2933
:ref:`discovery-server-use-case` to manage :ref:`discovery`.
3034

docs/fastdds/use_cases/tcp/tcp_with_multicast_discovery.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33

44
.. _use-case-tcp-multicast:
55

6-
LARGE_DATA: TCP / SHM Communication with Multicast Discovery
7-
=============================================================
6+
Large Data Mode
7+
===============
88

99
The following snippets show how to configure *Fast DDS* |DomainParticipants| to run the
1010
:ref:`PDP discovery<disc_phases>` phase over UDP multicast and communicate application data over a

docs/fastdds/use_cases/use_cases.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,15 +100,16 @@ with distributed systems:
100100

101101
.. toctree::
102102
:maxdepth: 2
103+
:hidden:
103104

105+
/fastdds/use_cases/tcp/tcp_use_case.rst
104106
/fastdds/use_cases/wifi/wifi.rst
105107
/fastdds/use_cases/well_known_deployments/well_known_deployments.rst
106108
/fastdds/use_cases/large_data/large_data.rst
107109
/fastdds/use_cases/many_subscribers/many_subscribers.rst
108110
/fastdds/use_cases/realtime/realtime.rst
109111
/fastdds/use_cases/reduce_memory/reduce_memory.rst
110112
/fastdds/use_cases/zero_copy/zero_copy.rst
111-
/fastdds/use_cases/tcp/tcp_use_case.rst
112113
/fastdds/use_cases/unique_network_flows/unique_network_flows.rst
113114
/fastdds/use_cases/statistics_module/statistics_module.rst
114115
/fastdds/use_cases/dynamic_network_interfaces/dynamic_network_interfaces.rst

0 commit comments

Comments
 (0)