Skip to content

Commit 1d6bc19

Browse files
Document limits in duration values (#1261)
* Refs #24416. Document limits in duration values. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> * Refs #24416. Document non-infinite max_blocking_time. Signed-off-by: Miguel Company <miguelcompany@eprosima.com> --------- Signed-off-by: Miguel Company <miguelcompany@eprosima.com>
1 parent 0156f9a commit 1d6bc19

2 files changed

Lines changed: 8 additions & 0 deletions

File tree

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1062,6 +1062,9 @@ List of QoS Policy data members:
10621062
:raw-html:`<br />`
10631063
It cannot be changed on enabled entities.
10641064

1065+
.. note::
1066+
It is inconsistent to set an infinite |ReliabilityQosPolicy::max_blocking_time-api|.
1067+
10651068
.. important::
10661069
Setting this QoS Policy to |BEST_EFFORT_RELIABILITY_QOS-api| affects to the :ref:`durabilityqospolicy`, making the
10671070
endpoints behave as |VOLATILE_DURABILITY_QOS-api|.

docs/fastdds/xml_configuration/common.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,11 @@ An infinite value can be specified by using the values :cpp:concept:`DURATION_IN
225225
- ``uint32_t``
226226
- 0
227227

228+
.. note::
229+
230+
It is inconsistent to specify a negative value for the ``<sec>`` element, or
231+
a ``<nanosec>`` value greater than or equal to 1 second (i.e., 1,000,000,000 nanoseconds).
232+
228233
**Example**
229234

230235
.. literalinclude:: /../code/XMLTester.xml

0 commit comments

Comments
 (0)