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.

Sign up for GitHub

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

[20722] Update docs to force unlimited ResourceLimits if lower or equal to zero (backport #738) #742

Closed
wants to merge 1 commit into from
Closed

[20722] Update docs to force unlimited ResourceLimits if lower or equal to zero (backport #738) #742

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions docs/fastdds/dds_layer/core/policy/standardQosPolicies.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions docs/fastdds/xml_configuration/common.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,17 +211,17 @@ Please refer to :ref:`ResourceLimitsQosPolicy` for further information on Resour
+--------------------------------+-----------------------------------------------------------+---------------+---------+
| Name | Description | Values | Default |
+================================+===========================================================+===============+=========+
| ``<max_samples>`` | It must verify that: | ``uint32_t`` | 5000 |
| ``<max_samples>`` | It must verify that: | ``int32_t`` | 5000 |
| | ``<max_samples>`` `>=` ``<max_samples_per_instance>``. | | |
+--------------------------------+-----------------------------------------------------------+---------------+---------+
| ``<max_instances>`` | It defines the maximum number of instances. | ``uint32_t`` | 10 |
| ``<max_instances>`` | It defines the maximum number of instances. | ``int32_t`` | 10 |
+--------------------------------+-----------------------------------------------------------+---------------+---------+
| ``<max_samples_per_instance>`` | It must verify that: :ref:`HistoryQos <hQos>` | ``uint32_t`` | 400 |
| ``<max_samples_per_instance>`` | It must verify that: :ref:`HistoryQos <hQos>` | ``int32_t`` | 400 |
| | ``<depth>`` `<=` ``<max_samples_per_instance>``. | | |
+--------------------------------+-----------------------------------------------------------+---------------+---------+
| ``<allocated_samples>`` | It controls the maximum number of samples to be stored. | ``uint32_t`` | 100 |
| ``<allocated_samples>`` | It controls the maximum number of samples to be stored. | ``int32_t`` | 100 |
+--------------------------------+-----------------------------------------------------------+---------------+---------+
| ``<extra_samples>`` | The number of extra samples to allocate on the pool. | ``uint32_t`` | 1 |
| ``<extra_samples>`` | The number of extra samples to allocate on the pool. | ``int32_t`` | 1 |
+--------------------------------+-----------------------------------------------------------+---------------+---------+

.. _CommonQOS:
Expand Down