Skip to content

Commit e8f7b5f

Browse files
Improve large data docs (#712)
* Refs #20501: Add new entry to typical case of use & extend description Signed-off-by: cferreiragonz <carlosferreira@eprosima.com> * Refs #20501: Change title and remove TODO Signed-off-by: cferreiragonz <carlosferreira@eprosima.com> --------- Signed-off-by: cferreiragonz <carlosferreira@eprosima.com> Co-authored-by: cferreiragonz <carlosferreira@eprosima.com> (cherry picked from commit 0e4aadb) Co-authored-by: Raul Sanchez-Mateos Lizano <raul@eprosima.com>
1 parent 791aab4 commit e8f7b5f

3 files changed

Lines changed: 20 additions & 8 deletions

File tree

docs/fastdds/use_cases/tcp/tcp_use_case.rst

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
.. _use-case-tcp:
44

5-
Fast DDS over TCP
6-
=================
5+
Large Data mode and Fast DDS over TCP
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.
@@ -16,10 +16,16 @@ links.
1616
The configuration of the TCP transport typically involves an *a priori* knowledge of the deployment in order
1717
to set :ref:`Simple Initial Peers` for :ref:`discovery`, which may not always be possible and creates difficulties when
1818
reallocating nodes of the distributed applications, as the entire discovery configuration needs to be changed.
19-
To overcome this problem, these use cases present an approach for leveraging the Fast DDS' TCP transport capabilities
20-
while at the same time not requiring configuration modifications when the deployment changes over time.
21-
One option is to configure the participant discovery phase (see :ref:`disc_phases`) to occur over UDP multicast, while
22-
the application data delivery occurs over TCP. Also, it is possible to enable TCP communication while using
19+
To overcome this problem, Fast DDS presents the ``LARGE_DATA`` builtin transports configuration as an approach for
20+
leveraging the Fast DDS' TCP transport capabilities while at the same time not requiring configuration modifications
21+
when the deployment changes over time.
22+
23+
``LARGE_DATA`` has been specifically designed to improve communication performance of large data samples over lossy
24+
networks. When configured, UDP transport will exclusively be used during the :ref:`PDP discovery<disc_phases>` phase,
25+
taking advantage of the more reliable TCP/SHM for the remainder of the communication process. Fast DDS offers
26+
an extremely straightforward implementation for this mode through an environment variable, XML profiles or via code.
27+
28+
Also, it is possible to enable TCP communication while using
2329
:ref:`discovery-server-use-case` to manage :ref:`discovery`.
2430

2531
.. toctree::

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-
TCP / SHM Communication with Multicast Discovery (LARGE_DATA)
7-
=============================================================
6+
LARGE_DATA: TCP / SHM Communication with Multicast Discovery
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: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ Typical Use-Cases
1010
This section provides configuration examples for the following typical use cases when dealing
1111
with distributed systems:
1212

13+
+ :ref:`use-case-tcp`.
14+
Describes how to configure *Fast DDS* to use the ``LARGE_DATA`` builtin transports mode. This mode enables
15+
efficient utilization of TCP transport without the need for constant reconfiguration during deployment changes. It
16+
optimizes communication performance for large data samples over lossy networks by employing a combination of UDP and
17+
TCP/SHM transports.
18+
1319
+ :ref:`use-case-fast-rtps-over-wifi`.
1420
Presents a case where :ref:`discovery` through multicast communication is a challenge.
1521
This example shows how to:

0 commit comments

Comments
 (0)