Skip to content

Commit fc163f3

Browse files
authored
Better explanation for depth vs max_samples_per_instance behavior (#1194)
* Better explanation for depth vs mspi behavior Signed-off-by: Raül <raulojeda@eprosima.com> * Remove references to 3.5.0 and some tweaks to previous changes Signed-off-by: Raül <raulojeda@eprosima.com> --------- Signed-off-by: Raül <raulojeda@eprosima.com>
1 parent a1cc0ea commit fc163f3

1 file changed

Lines changed: 10 additions & 6 deletions

File tree

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

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -463,6 +463,9 @@ The HistoryQos must be set consistently with the :ref:`resourcelimitsqospolicy`,
463463
|ResourceLimitsQosPolicy::max_samples_per_instance-api|.
464464
Also, |ResourceLimitsQosPolicy::max_samples-api| must be equal or higher than the product of
465465
|ResourceLimitsQosPolicy::max_samples_per_instance-api| times |ResourceLimitsQosPolicy::max_instances-api|.
466+
* When |HistoryQosPolicy::depth-api| is set higher than
467+
|ResourceLimitsQosPolicy::max_samples_per_instance-api|, the effective depth used
468+
will be limited by |ResourceLimitsQosPolicy::max_samples_per_instance-api|.
466469
* The |HistoryQosPolicy::depth-api| cannot be lower or equal than zero.
467470
If an unlimited depth is required, please consider using |HistoryQosPolicy::kind-api| as |KEEP_ALL_HISTORY_QOS-api|.
468471
* Setting the |HistoryQosPolicy::kind-api| as |KEEP_ALL_HISTORY_QOS-api| entails that limits are set by the
@@ -1167,19 +1170,19 @@ List of QoS Policy data members:
11671170
+----------------------------------------------------------------------------------------+-------------+---------------+
11681171

11691172
* |ResourceLimitsQosPolicy::max_samples-api|: Controls the maximum number of samples that the DataWriter or DataReader
1170-
can manage across all the
1171-
instances associated with it.
1173+
can manage across all the instances associated with it.
11721174
In other words, it represents the maximum samples that the middleware can store for a DataReader or DataWriter.
11731175
**Value less or equal to 0 means infinite resources.**
11741176
* |ResourceLimitsQosPolicy::max_instances-api|: Controls the maximum number of instances that a DataWriter or
11751177
DataReader can manage.
11761178
**Value less or equal to 0 means infinite resources.**
11771179
* |ResourceLimitsQosPolicy::max_samples_per_instance-api|: Controls the maximum number of samples within an instance
1178-
that the DataWriter or
1179-
DataReader can manage.
1180+
that the DataWriter or DataReader can manage.
1181+
It will be ignored for topics without keys (|ResourceLimitsQosPolicy::max_samples-api| will be used instead).
11801182
**Value less or equal to 0 means infinite resources.**
11811183
* |ResourceLimitsQosPolicy::allocated_samples-api|: States the number of samples that will be allocated on
11821184
initialization.
1185+
Will be limited by |ResourceLimitsQosPolicy::max_samples-api| (i.e. the minimum between both values will be used).
11831186
* |ResourceLimitsQosPolicy::extra_samples-api|: States the number of extra samples that will be allocated on
11841187
the pool, so the maximum number of samples on the pool will be
11851188
|ResourceLimitsQosPolicy::max_samples-api| plus |ResourceLimitsQosPolicy::extra_samples-api|.
@@ -1201,8 +1204,9 @@ conditions:
12011204
* The value of |ResourceLimitsQosPolicy::max_samples-api| must be higher or equal to the value of
12021205
|ResourceLimitsQosPolicy::max_samples_per_instance-api|.
12031206
* The value established for the :ref:`historyqospolicy` |HistoryQosPolicy::depth-api| must be lower or equal to the
1204-
value stated for
1205-
|ResourceLimitsQosPolicy::max_samples_per_instance-api|.
1207+
value stated for |ResourceLimitsQosPolicy::max_samples_per_instance-api|.
1208+
If the depth is configured higher, |ResourceLimitsQosPolicy::max_samples_per_instance-api|
1209+
will take precedence as the effective depth.
12061210

12071211

12081212
Example

0 commit comments

Comments
 (0)