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.

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

[21538] Allow all durability configurations #907

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
4 changes: 2 additions & 2 deletions docs/fastdds/dds_layer/core/policy/standardQosPolicies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -211,8 +211,8 @@ There are four possible values (see |DurabilityQosPolicyKind-api|):
* |TRANSIENT_LOCAL_DURABILITY_QOS-api|: When a new DataReader joins, its History is filled with past samples.
* |TRANSIENT_DURABILITY_QOS-api|: When a new DataReader joins, its History is filled with past samples, which are stored
on persistent storage (see :ref:`persistence_service`).
* |PERSISTENT_DURABILITY_QOS-api|: (`Not Implemented`): All the samples are stored on a permanent storage, so that they
can outlive a system session.
* |PERSISTENT_DURABILITY_QOS-api|: When a new DataReader joins, its History is filled with past samples,
which are stored on persistent storage (see :ref:`persistence_service`).

.. _durability_compatibilityrule:

Expand Down
10 changes: 9 additions & 1 deletion docs/fastdds/persistence/persistence.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The configuration of the persistence service is accomplished by setting of the a
or DataReader) |PropertyPolicyQos|.

* For the :ref:`persistence_service` to have any effect, the |DurabilityQosPolicyKind-api| needs to be set to
|TRANSIENT_DURABILITY_QOS-api|.
|TRANSIENT_DURABILITY_QOS-api| or |PERSISTENT_DURABILITY_QOS-api|.

* A persistence identifier (|Guid_t-api|) must be set for the entity using the property ``dds.persistence.guid``.
This identifier is used to load the appropriate data from the database, and also to synchronize DataWriter and
Expand All @@ -56,9 +56,17 @@ or DataReader) |PropertyPolicyQos|.
For selecting an appropriate GUID for the DataReader and DataWriter, please refer to
`RTPS standard <https://www.omg.org/spec/DDSI-RTPS/2.2/PDF>`_ (section *9.3.1 The Globally Unique Identifier (GUID)*).

If no ``dds.persistence.guid`` is specified,
the durability behavior will fallback to |TRANSIENT_LOCAL_DURABILITY_QOS-api|.

MiguelCompany marked this conversation as resolved.
Show resolved Hide resolved
* A persistence plugin must be configured for managing the database using property ``dds.persistence.plugin`` (see
:ref:`persistence_sqlite3_builtin_plugin`):

.. note::

If the |DurabilityQosPolicyKind-api| is set to |TRANSIENT_DURABILITY_QOS-api| or |PERSISTENT_DURABILITY_QOS-api|
and no ``dds.persistence.guid`` is specified, |TRANSIENT_LOCAL_DURABILITY_QOS-api| will be used.


.. _persistence_sqlite3_builtin_plugin:

Expand Down