Skip to content

Commit dd7642d

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

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
@@ -482,6 +482,9 @@ The HistoryQos must be set consistently with the :ref:`resourcelimitsqospolicy`,
482482
|ResourceLimitsQosPolicy::max_samples_per_instance-api|.
483483
Also, |ResourceLimitsQosPolicy::max_samples-api| must be equal or higher than the product of
484484
|ResourceLimitsQosPolicy::max_samples_per_instance-api| times |ResourceLimitsQosPolicy::max_instances-api|.
485+
* When |HistoryQosPolicy::depth-api| is set higher than
486+
|ResourceLimitsQosPolicy::max_samples_per_instance-api|, the effective depth used
487+
will be limited by |ResourceLimitsQosPolicy::max_samples_per_instance-api|.
485488
* The |HistoryQosPolicy::depth-api| cannot be lower or equal than zero.
486489
If an unlimited depth is required, please consider using |HistoryQosPolicy::kind-api| as |KEEP_ALL_HISTORY_QOS-api|.
487490
* Setting the |HistoryQosPolicy::kind-api| as |KEEP_ALL_HISTORY_QOS-api| entails that limits are set by the
@@ -1214,19 +1217,19 @@ List of QoS Policy data members:
12141217
+----------------------------------------------------------------------------------------+-------------+---------------+
12151218

12161219
* |ResourceLimitsQosPolicy::max_samples-api|: Controls the maximum number of samples that the DataWriter or DataReader
1217-
can manage across all the
1218-
instances associated with it.
1220+
can manage across all the instances associated with it.
12191221
In other words, it represents the maximum samples that the middleware can store for a DataReader or DataWriter.
12201222
**Value less or equal to 0 means infinite resources.**
12211223
* |ResourceLimitsQosPolicy::max_instances-api|: Controls the maximum number of instances that a DataWriter or
12221224
DataReader can manage.
12231225
**Value less or equal to 0 means infinite resources.**
12241226
* |ResourceLimitsQosPolicy::max_samples_per_instance-api|: Controls the maximum number of samples within an instance
1225-
that the DataWriter or
1226-
DataReader can manage.
1227+
that the DataWriter or DataReader can manage.
1228+
It will be ignored for topics without keys (|ResourceLimitsQosPolicy::max_samples-api| will be used instead).
12271229
**Value less or equal to 0 means infinite resources.**
12281230
* |ResourceLimitsQosPolicy::allocated_samples-api|: States the number of samples that will be allocated on
12291231
initialization.
1232+
Will be limited by |ResourceLimitsQosPolicy::max_samples-api| (i.e. the minimum between both values will be used).
12301233
* |ResourceLimitsQosPolicy::extra_samples-api|: States the number of extra samples that will be allocated on
12311234
the pool, so the maximum number of samples on the pool will be
12321235
|ResourceLimitsQosPolicy::max_samples-api| plus |ResourceLimitsQosPolicy::extra_samples-api|.
@@ -1248,8 +1251,9 @@ conditions:
12481251
* The value of |ResourceLimitsQosPolicy::max_samples-api| must be higher or equal to the value of
12491252
|ResourceLimitsQosPolicy::max_samples_per_instance-api|.
12501253
* The value established for the :ref:`historyqospolicy` |HistoryQosPolicy::depth-api| must be lower or equal to the
1251-
value stated for
1252-
|ResourceLimitsQosPolicy::max_samples_per_instance-api|.
1254+
value stated for |ResourceLimitsQosPolicy::max_samples_per_instance-api|.
1255+
If the depth is configured higher, |ResourceLimitsQosPolicy::max_samples_per_instance-api|
1256+
will take precedence as the effective depth.
12531257

12541258

12551259
Example

0 commit comments

Comments
 (0)