Skip to content

Commit

Permalink
Refs #20849: Apply suggestions
Browse files Browse the repository at this point in the history
Signed-off-by: elianalf <62831776+elianalf@users.noreply.github.com>
  • Loading branch information
elianalf committed May 17, 2024
1 parent fd0303c commit 8e81d33
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 8 deletions.
2 changes: 1 addition & 1 deletion code/XMLTester.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3258,7 +3258,7 @@
<data_writer profile_name="max_msg_size_datawriter_xml_profile">
<propertiesPolicy>
<properties>
<!-- Set the maximum size in bytes for all RTPS datagrams sent by the participant -->
<!-- Set the maximum size in bytes for all RTPS datagrams sent by the writer -->
<property>
<name>fastdds.max_message_size</name>
<value>1200</value>
Expand Down
25 changes: 18 additions & 7 deletions docs/fastdds/property_policies/non_consolidated_qos.rst
Original file line number Diff line number Diff line change
Expand Up @@ -360,14 +360,15 @@ Maximum Message Size
One common requirement is the differentiation between the maximum size of received and sent datagrams.
This capability is especially important in scenarios where a system might need to handle large incoming
data sizes but should restrict the size of the data it sends to prevent overwhelming network resources
or complying with network traffic policies. The primary attribute for controlling datagram size is
`maxMessageSize`, which sets the upper limit for both the size of datagrams that can be received and
those that can be sent. For applications that need to restrict the size of outgoing datagrams without
changing the size of incoming ones, it's possible to set the new property ``fastdds.max_message_size``.
or complying with network traffic policies.
The primary attribute for controlling datagram size is `maxMessageSize`, which sets the upper limit
for both the size of datagrams that can be received and those that can be sent.
Property ``fastdds.max_message_size`` allows restricting the size of outgoing datagrams without
changing the size of incoming ones.
This property allows for the specific configuration of the maximum number of bytes for datagrams that
are sent. By configuring this property to a value lower than the smallest `maxMessageSize` across all
transports, applications can achieve a lower sending limit while maintaining the ability to receive
larger datagrams.
are sent.
By configuring this property to a value lower than the smallest `maxMessageSize` across all transports,
applications can achieve a lower sending limit while maintaining the ability to receive larger datagrams.

.. list-table::
:header-rows: 1
Expand All @@ -384,6 +385,11 @@ larger datagrams.
An invalid value of ``fastdds.max_message_size`` would log an error,
and the default value will be used.

.. _setting_max_message_size_participant:

Setting ``fastdds.max_message_size`` At Participant Level
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""

.. tabs::

.. tab:: C++
Expand All @@ -402,6 +408,11 @@ larger datagrams.
:end-before: <!--><-->
:lines: 2,4-16

.. _setting_max_message_size_writer:

Setting ``fastdds.max_message_size`` At Writer Level
""""""""""""""""""""""""""""""""""""""""""""""""""""

.. tabs::

.. tab:: C++
Expand Down

0 comments on commit 8e81d33

Please sign in to comment.