From e78729c6b64508bcc4c76b68770e316ae8d3540b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jes=C3=BAs=20Poderoso?= <120394830+JesusPoderoso@users.noreply.github.com> Date: Thu, 4 Apr 2024 12:58:50 +0200 Subject: [PATCH] Update docs to force unlimited ResourceLimits if lower or equal to zero (#738) Signed-off-by: JesusPoderoso (cherry picked from commit 495f5a21b2808b5d9d33bb771eff8a62ec81678f) # Conflicts: # docs/fastdds/dds_layer/core/policy/standardQosPolicies.rst --- .../dds_layer/core/policy/standardQosPolicies.rst | 11 +++++++++++ docs/fastdds/xml_configuration/common.rst | 10 +++++----- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/docs/fastdds/dds_layer/core/policy/standardQosPolicies.rst b/docs/fastdds/dds_layer/core/policy/standardQosPolicies.rst index a243990d2..ed72fe3c4 100644 --- a/docs/fastdds/dds_layer/core/policy/standardQosPolicies.rst +++ b/docs/fastdds/dds_layer/core/policy/standardQosPolicies.rst @@ -1157,11 +1157,22 @@ List of QoS Policy data members: can manage across all the instances associated with it. In other words, it represents the maximum samples that the middleware can store for a DataReader or DataWriter. +<<<<<<< HEAD * |ResourceLimitsQosPolicy::max_instances-api|: Controls the maximum number of instances that a DataWriter or DataReader can manage. * |ResourceLimitsQosPolicy::max_samples_per_instance-api|: Controls the maximum number of samples within an instance that the DataWriter or DataReader can manage. +======= + **Value less or equal to 0 means infinite resources.** +* |ResourceLimitsQosPolicy::max_instances-api|: Controls the maximum number of instances that a DataWriter or + DataReader can manage. + **Value less or equal to 0 means infinite resources.** +* |ResourceLimitsQosPolicy::max_samples_per_instance-api|: Controls the maximum number of samples within an instance + that the DataWriter or + DataReader can manage. + **Value less or equal to 0 means infinite resources.** +>>>>>>> 495f5a2 (Update docs to force unlimited ResourceLimits if lower or equal to zero (#738)) * |ResourceLimitsQosPolicy::allocated_samples-api|: States the number of samples that will be allocated on initialization. * |ResourceLimitsQosPolicy::extra_samples-api|: States the number of extra samples that will be allocated on diff --git a/docs/fastdds/xml_configuration/common.rst b/docs/fastdds/xml_configuration/common.rst index ef94fb39b..7e6dcca6e 100644 --- a/docs/fastdds/xml_configuration/common.rst +++ b/docs/fastdds/xml_configuration/common.rst @@ -211,17 +211,17 @@ Please refer to :ref:`ResourceLimitsQosPolicy` for further information on Resour +--------------------------------+-----------------------------------------------------------+---------------+---------+ | Name | Description | Values | Default | +================================+===========================================================+===============+=========+ -| ```` | It must verify that: | ``uint32_t`` | 5000 | +| ```` | It must verify that: | ``int32_t`` | 5000 | | | ```` `>=` ````. | | | +--------------------------------+-----------------------------------------------------------+---------------+---------+ -| ```` | It defines the maximum number of instances. | ``uint32_t`` | 10 | +| ```` | It defines the maximum number of instances. | ``int32_t`` | 10 | +--------------------------------+-----------------------------------------------------------+---------------+---------+ -| ```` | It must verify that: :ref:`HistoryQos ` | ``uint32_t`` | 400 | +| ```` | It must verify that: :ref:`HistoryQos ` | ``int32_t`` | 400 | | | ```` `<=` ````. | | | +--------------------------------+-----------------------------------------------------------+---------------+---------+ -| ```` | It controls the maximum number of samples to be stored. | ``uint32_t`` | 100 | +| ```` | It controls the maximum number of samples to be stored. | ``int32_t`` | 100 | +--------------------------------+-----------------------------------------------------------+---------------+---------+ -| ```` | The number of extra samples to allocate on the pool. | ``uint32_t`` | 1 | +| ```` | The number of extra samples to allocate on the pool. | ``int32_t`` | 1 | +--------------------------------+-----------------------------------------------------------+---------------+---------+ .. _CommonQOS: