Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[20501] Rearrange use cases list (backport #700) #713

Merged
merged 1 commit into from
Mar 4, 2024
+9 −4
Merged

[20501] Rearrange use cases list (backport #700) #713

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/fastdds/use_cases/tcp/tcp_use_case.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
.. _use-case-tcp:

Large Data mode and Fast DDS over TCP
======================================
=====================================

As explained in :ref:`transport_tcp_tcp`, Fast DDS offers the possibility to communicate nodes within distributed
applications with DDS over a TCP transport layer.
Expand All @@ -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
View file
Open in desktop
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
View file
Open in desktop
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