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.

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

[20849] New max_message_size property to limit output datagrams size #770

Merged
merged 3 commits into from
May 17, 2024
Merged
Changes from 1 commit
Commits
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
Prev Previous commit
Refs #20849: Apply suggestions
Signed-off-by: elianalf <[email protected]>
elianalf committed May 17, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
commit 8e81d333e623cf16dff82c250bf239eefd7e8e8a
2 changes: 1 addition & 1 deletion code/XMLTester.xml
Original file line number Diff line number Diff line change
@@ -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>
25 changes: 18 additions & 7 deletions docs/fastdds/property_policies/non_consolidated_qos.rst
Original file line number Diff line number Diff line change
@@ -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
@@ -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::
MiguelCompany marked this conversation as resolved.
Show resolved Hide resolved

.. tab:: C++
@@ -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::
MiguelCompany marked this conversation as resolved.
Show resolved Hide resolved

.. tab:: C++