Improve large data docs (#698)

* Refs #20501: Add new entry to typical case of use & extend description Signed-off-by: cferreiragonz <[email protected]> * Refs #20501: Change title and remove TODO Signed-off-by: cferreiragonz <[email protected]> --------- Signed-off-by: cferreiragonz <[email protected]> Co-authored-by: cferreiragonz <[email protected]>
eProsima · Feb 29, 2024 · 0e4aadb · 0e4aadb
1 parent 1a9c83b
commit 0e4aadb
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 7 deletions.
diff --git a/docs/fastdds/use_cases/tcp/tcp_use_case.rst b/docs/fastdds/use_cases/tcp/tcp_use_case.rst
@@ -2,8 +2,8 @@
 
 .. _use-case-tcp:
 
-Fast DDS over 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.
@@ -16,10 +16,16 @@ links.
 The configuration of the TCP transport typically involves an *a priori* knowledge of the deployment in order
 to set :ref:`Simple Initial Peers` for :ref:`discovery`, which may not always be possible and creates difficulties when
 reallocating nodes of the distributed applications, as the entire discovery configuration needs to be changed.
-To overcome this problem, these use cases present an approach for leveraging the Fast DDS' TCP transport capabilities
-while at the same time not requiring configuration modifications when the deployment changes over time.
-One option is to configure the participant discovery phase (see :ref:`disc_phases`) to occur over UDP multicast, while
-the application data delivery occurs over TCP. Also, it is possible to enable TCP communication while using
+To overcome this problem, Fast DDS presents the ``LARGE_DATA`` builtin transports configuration as an approach for
+leveraging the Fast DDS' TCP transport capabilities while at the same time not requiring configuration modifications
+when the deployment changes over time.
+
+``LARGE_DATA`` has been specifically designed to improve communication performance of large data samples over lossy
+networks. When configured, UDP transport will exclusively be used during the :ref:`PDP discovery<disc_phases>` phase,
+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.
+
+Also, it is possible to enable TCP communication while using
 :ref:`discovery-server-use-case` to manage :ref:`discovery`.
 
 .. toctree::

diff --git a/docs/fastdds/use_cases/tcp/tcp_with_multicast_discovery.rst b/docs/fastdds/use_cases/tcp/tcp_with_multicast_discovery.rst
@@ -3,7 +3,7 @@
 
 .. _use-case-tcp-multicast:
 
-TCP / SHM Communication with Multicast Discovery (LARGE_DATA)
+LARGE_DATA: TCP / SHM Communication with Multicast Discovery
 =============================================================
 
 The following snippets show how to configure *Fast DDS* |DomainParticipants| to run the

diff --git a/docs/fastdds/use_cases/use_cases.rst b/docs/fastdds/use_cases/use_cases.rst
@@ -10,6 +10,12 @@ Typical Use-Cases
 This section provides configuration examples for the following typical use cases when dealing
 with distributed systems:
 
++ :ref:`use-case-tcp`.
+  Describes how to configure *Fast DDS* to use the ``LARGE_DATA`` builtin transports mode. This mode enables
+  efficient utilization of TCP transport without the need for constant reconfiguration during deployment changes. It
+  optimizes communication performance for large data samples over lossy networks by employing a combination of UDP and
+  TCP/SHM transports.
+
 + :ref:`use-case-fast-rtps-over-wifi`.
   Presents a case where :ref:`discovery` through multicast communication is a challenge.
   This example shows how to: