From 40ef047f4f19264147bf23d0a0617428e1583141 Mon Sep 17 00:00:00 2001 From: cferreiragonz Date: Tue, 11 Jun 2024 09:08:19 +0200 Subject: [PATCH] Refs #20291: Revision - Use RLContainerConfig Signed-off-by: cferreiragonz --- code/XMLTester.xml | 7 ++-- code/XMLTesterExample.xml | 7 ++-- docs/03-exports/aliases-api.include | 3 +- .../core/policy/eprosimaExtensions.rst | 34 ++++++++----------- .../xml_configuration/domainparticipant.rst | 25 +++++--------- 5 files changed, 34 insertions(+), 42 deletions(-) diff --git a/code/XMLTester.xml b/code/XMLTester.xml index f82d4dc2e..6a4b26f74 100644 --- a/code/XMLTester.xml +++ b/code/XMLTester.xml @@ -1555,8 +1555,11 @@ 127 true - 16 - 16 + + 16 + 0 + 16 + diff --git a/code/XMLTesterExample.xml b/code/XMLTesterExample.xml index 708fd28d3..7b204ad61 100644 --- a/code/XMLTesterExample.xml +++ b/code/XMLTesterExample.xml @@ -449,8 +449,11 @@ 127 true - 16 - 16 + + 16 + 0 + 16 + diff --git a/docs/03-exports/aliases-api.include b/docs/03-exports/aliases-api.include index 569546e6c..b7304470e 100644 --- a/docs/03-exports/aliases-api.include +++ b/docs/03-exports/aliases-api.include @@ -527,8 +527,7 @@ .. |SendBuffersAllocationAttributes-api| replace:: :cpp:struct:`SendBuffersAllocationAttributes` .. |SendBuffersAllocationAttributes::preallocated_number-api| replace:: :cpp:member:`preallocated_number` .. |SendBuffersAllocationAttributes::dynamic-api| replace:: :cpp:member:`dynamic` -.. |SendBuffersAllocationAttributes::preallocated_network_buffers-api| replace:: :cpp:member:`preallocated_network_buffers` -.. |SendBuffersAllocationAttributes::allocation_inc_network_buffers-api| replace:: :cpp:member:`allocation_inc_network_buffers` +.. |SendBuffersAllocationAttributes::network_buffers_config-api| replace:: :cpp:member:`network_buffers_config` .. |ReaderTimes-api| replace:: :cpp:class:`ReaderTimes` .. |ReaderTimes::initial_acknack_delay-api| replace:: :cpp:member:`initial_acknack_delay` diff --git a/docs/fastdds/dds_layer/core/policy/eprosimaExtensions.rst b/docs/fastdds/dds_layer/core/policy/eprosimaExtensions.rst index 9763d574b..c805dbcc3 100644 --- a/docs/fastdds/dds_layer/core/policy/eprosimaExtensions.rst +++ b/docs/fastdds/dds_layer/core/policy/eprosimaExtensions.rst @@ -384,17 +384,15 @@ See |SendBuffersAllocationAttributes-api|. List of structure members: -+------------------------------------------------------------------------+-------------------------+-------------------+ -| Member Name | Type | Default Value | -+========================================================================+=========================+===================+ -| |SendBuffersAllocationAttributes::preallocated_number-api| | ``size_t`` | 0 | -+------------------------------------------------------------------------+-------------------------+-------------------+ -| |SendBuffersAllocationAttributes::dynamic-api| | ``bool`` | ``false`` | -+------------------------------------------------------------------------+-------------------------+-------------------+ -| |SendBuffersAllocationAttributes::preallocated_network_buffers-api| | ``size_t`` | ``0`` | -+------------------------------------------------------------------------+-------------------------+-------------------+ -| |SendBuffersAllocationAttributes::allocation_inc_network_buffers-api| | ``size_t`` | ``0`` | -+------------------------------------------------------------------------+-------------------------+-------------------+ ++----------------------------------------------------------------+---------------------------------------+----------------+ +| Member Name | Type | Default Value | ++================================================================+=======================================+================+ +| |SendBuffersAllocationAttributes::preallocated_number-api| | ``size_t`` | 0 | ++----------------------------------------------------------------+---------------------------------------+----------------+ +| |SendBuffersAllocationAttributes::dynamic-api| | ``bool`` | ``false`` | ++----------------------------------------------------------------+---------------------------------------+----------------+ +| |SendBuffersAllocationAttributes::network_buffers_config-api| | :ref:`resourcelimitedcontainerconfig` | (16, inf, 16) | ++------------------------------------------------------------------------+-------------------------------+----------------+ * |SendBuffersAllocationAttributes::preallocated_number-api|: This member controls the initial number of send buffers to be allocated. @@ -403,17 +401,13 @@ List of structure members: * |SendBuffersAllocationAttributes::dynamic-api|: This member controls how the buffer manager behaves when a send buffer is not available. When true, a new buffer will be created. Otherwise, it will wait for a buffer to be returned. -* |SendBuffersAllocationAttributes::preallocated_network_buffers-api|: - This attribute controls the initial number of network buffers to be allocated for each send buffer. - The default value will preallocate 16 network buffers. -* |SendBuffersAllocationAttributes::allocation_inc_network_buffers-api|: - This attribute controls the initial number of network buffers to be allocated when growing the vector of the send - buffer if it runs out of capacity. - The default value will dynamically allocate 16 network buffers every time is needed. +* |SendBuffersAllocationAttributes::network_buffers_config-api|: + This attribute defines the allocation behavior and limits of the network buffers contained in each send buffer. + The default value will preallocate 16 network buffers and dynamically allocate 16 network buffers every time + that growing the vector is needed. .. note:: - |SendBuffersAllocationAttributes::preallocated_network_buffers-api| and - |SendBuffersAllocationAttributes::allocation_inc_network_buffers-api| will also be used to instantiate a vector of + |SendBuffersAllocationAttributes::network_buffers_config-api| will also be used to instantiate a vector of |SerializedPayload_t-api| that contains the metadata necessary to avoid payload copies during the creation of the RTPS message. diff --git a/docs/fastdds/xml_configuration/domainparticipant.rst b/docs/fastdds/xml_configuration/domainparticipant.rst index 84f598361..61de6ce27 100644 --- a/docs/fastdds/xml_configuration/domainparticipant.rst +++ b/docs/fastdds/xml_configuration/domainparticipant.rst @@ -676,24 +676,17 @@ Send buffers See :ref:`sendbuffersallocationattributes`. - ``bool`` - false - * - ```` - - Initial number initial number of network buffers |br| - to be allocated for each send buffer. See |br| - :ref:`sendbuffersallocationattributes`. - - ``uint32_t`` - - 0 - * - ```` - - Number of network buffers to be dynamically |br| - allocated when growing the vector of the send buffer |br| - if it runs out of capacity. See |br| - :ref:`sendbuffersallocationattributes`. - - ``uint32_t`` - - 0 + * - ```` + - Network buffer :ref:`CommonAlloc` to specify the |br| + number of network buffers to be allocated for each |br| + send buffer. See :ref:`ResourceLimitedContainerConfig`. + - :ref:`CommonAlloc` + - (16, inf, 16) .. note:: The default value ``0`` of ```` will perform an initial guess of the number of buffers required, based on the number of threads from which a send operation could be started. So it does not mean there are no buffers, instead it would use the maximum amount of buffers available. - Similarly, the default value ``0`` of ```` and ```` - will use a fixed amount of 16 network buffers per send buffer as the preallocated and the increment number, - respectively. + On the contrary, ```` will default to an initial number of 16 buffers, with an infinite + maximum and an increment of 16 buffers per send buffer. Setting a value of ``0`` will prevent the creation of + network buffers. In case of doubt, leave it unset.