Skip to content

Commit 8b9830f

Browse files
Update docs to force unlimited ResourceLimits if lower or equal to zero (#738) (#740)
Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> (cherry picked from commit 495f5a2) Co-authored-by: Jesús Poderoso <120394830+JesusPoderoso@users.noreply.github.com>
1 parent d66d5be commit 8b9830f

2 files changed

Lines changed: 8 additions & 8 deletions

File tree

docs/fastdds/dds_layer/core/policy/standardQosPolicies.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1217,14 +1217,14 @@ List of QoS Policy data members:
12171217
can manage across all the
12181218
instances associated with it.
12191219
In other words, it represents the maximum samples that the middleware can store for a DataReader or DataWriter.
1220-
**Value 0 means infinite resources.**
1220+
**Value less or equal to 0 means infinite resources.**
12211221
* |ResourceLimitsQosPolicy::max_instances-api|: Controls the maximum number of instances that a DataWriter or
12221222
DataReader can manage.
1223-
**Value 0 means infinite resources.**
1223+
**Value less or equal to 0 means infinite resources.**
12241224
* |ResourceLimitsQosPolicy::max_samples_per_instance-api|: Controls the maximum number of samples within an instance
12251225
that the DataWriter or
12261226
DataReader can manage.
1227-
**Value 0 means infinite resources.**
1227+
**Value less or equal to 0 means infinite resources.**
12281228
* |ResourceLimitsQosPolicy::allocated_samples-api|: States the number of samples that will be allocated on
12291229
initialization.
12301230
* |ResourceLimitsQosPolicy::extra_samples-api|: States the number of extra samples that will be allocated on

docs/fastdds/xml_configuration/common.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -303,17 +303,17 @@ Please refer to :ref:`ResourceLimitsQosPolicy` for further information on Resour
303303
+--------------------------------+-----------------------------------------------------------+---------------+---------+
304304
| Name | Description | Values | Default |
305305
+================================+===========================================================+===============+=========+
306-
| ``<max_samples>`` | It must verify that: | ``uint32_t`` | 5000 |
306+
| ``<max_samples>`` | It must verify that: | ``int32_t`` | 5000 |
307307
| | ``<max_samples>`` `>=` ``<max_samples_per_instance>``. | | |
308308
+--------------------------------+-----------------------------------------------------------+---------------+---------+
309-
| ``<max_instances>`` | It defines the maximum number of instances. | ``uint32_t`` | 10 |
309+
| ``<max_instances>`` | It defines the maximum number of instances. | ``int32_t`` | 10 |
310310
+--------------------------------+-----------------------------------------------------------+---------------+---------+
311-
| ``<max_samples_per_instance>`` | It must verify that: :ref:`HistoryQos <hQos>` | ``uint32_t`` | 400 |
311+
| ``<max_samples_per_instance>`` | It must verify that: :ref:`HistoryQos <hQos>` | ``int32_t`` | 400 |
312312
| | ``<depth>`` `<=` ``<max_samples_per_instance>``. | | |
313313
+--------------------------------+-----------------------------------------------------------+---------------+---------+
314-
| ``<allocated_samples>`` | It controls the maximum number of samples to be stored. | ``uint32_t`` | 100 |
314+
| ``<allocated_samples>`` | It controls the maximum number of samples to be stored. | ``int32_t`` | 100 |
315315
+--------------------------------+-----------------------------------------------------------+---------------+---------+
316-
| ``<extra_samples>`` | The number of extra samples to allocate on the pool. | ``uint32_t`` | 1 |
316+
| ``<extra_samples>`` | The number of extra samples to allocate on the pool. | ``int32_t`` | 1 |
317317
+--------------------------------+-----------------------------------------------------------+---------------+---------+
318318

319319
.. _ThreadSettingsType:

0 commit comments

Comments
 (0)