Skip to content

Commit

Permalink
Rearrange use cases list (#700)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
3 people committed Mar 1, 2024
1 parent 557efa3 commit 63940f4
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 3 deletions.
4 changes: 4 additions & 0 deletions docs/fastdds/use_cases/tcp/tcp_use_case.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ networks. When configured, UDP transport will exclusively be used during the :re
taking advantage of the more reliable TCP/SHM for the remainder of the communication process. Fast DDS offers
an extremely straightforward implementation for this mode through an environment variable, XML profiles or via code.

For a video demonstration showcasing a practical example of this configuration, please refer to:
`Large Data communication with ROS 2
<https://docs.vulcanexus.org/en/latest/rst/use_cases/large_data/large_data.html>`_.

Also, it is possible to enable TCP communication while using
:ref:`discovery-server-use-case` to manage :ref:`discovery`.

Expand Down
4 changes: 2 additions & 2 deletions docs/fastdds/use_cases/tcp/tcp_with_multicast_discovery.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@

.. _use-case-tcp-multicast:

LARGE_DATA: TCP / SHM Communication with Multicast Discovery
=============================================================
Large Data Mode
===============

The following snippets show how to configure *Fast DDS* |DomainParticipants| to run the
:ref:`PDP discovery<disc_phases>` phase over UDP multicast and communicate application data over a
Expand Down
3 changes: 2 additions & 1 deletion docs/fastdds/use_cases/use_cases.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,15 +100,16 @@ with distributed systems:

.. toctree::
:maxdepth: 2
:hidden:

/fastdds/use_cases/tcp/tcp_use_case.rst
/fastdds/use_cases/wifi/wifi.rst
/fastdds/use_cases/well_known_deployments/well_known_deployments.rst
/fastdds/use_cases/large_data/large_data.rst
/fastdds/use_cases/many_subscribers/many_subscribers.rst
/fastdds/use_cases/realtime/realtime.rst
/fastdds/use_cases/reduce_memory/reduce_memory.rst
/fastdds/use_cases/zero_copy/zero_copy.rst
/fastdds/use_cases/tcp/tcp_use_case.rst
/fastdds/use_cases/unique_network_flows/unique_network_flows.rst
/fastdds/use_cases/statistics_module/statistics_module.rst
/fastdds/use_cases/dynamic_network_interfaces/dynamic_network_interfaces.rst
Expand Down

0 comments on commit 63940f4

Please sign in to comment.