Skip to content
Merged
Changes from all 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
21 changes: 12 additions & 9 deletions docs/fastdds/dds_layer/domain/domainParticipant/partition.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,12 @@ In this sense, partitions represent a light mechanism to provide data separation
The Partition membership of an endpoint can be configured on the |api_pim_partitionqospolicy|
data member of the :ref:`dds_layer_publisher_publisherQos` or :ref:`dds_layer_subscriber_subscriberQos` objects.
This member holds a list of Partition name strings.
If no Partition is defined for an entity, it will be automatically included in the default nameless Partition.
Therefore, a Publisher and a Subscriber that specify no Partition will still
be able to communicate through the default nameless Partition.
In DDS, the default Partition name is the empty string ``""``.
Therefore, an empty list (``{}``) is equivalent to a list containing only the empty string (``{""}``).
As a result, a Publisher and a Subscriber that specify no Partition can still communicate through the default
Partition, and explicitly configuring ``""`` has the same behavior.
If ``""`` is included together with additional names, the endpoint belongs to the default Partition and to those
additional Partitions.

.. warning::

Expand Down Expand Up @@ -69,7 +72,8 @@ For example, consider the following configuration:
Even though ``partition*`` does not match ``part*``, these Publisher and Subscriber
will communicate between them because ``part*`` matches ``partition*``.

Note that a Partition with name ``*`` will match any other partition **except the default Partition**.
Note that a Partition with name ``*`` will match any other partition,
including the default Partition ``""``.

Full example
------------
Expand All @@ -81,7 +85,7 @@ Given a system with the following Partition configuration:
+ +---------+--------------------------------+
| | Pub_12 | {"*"} |
+----------------+---------+--------------------------------+
| Participant_2 | Pub_21 | {} |
| Participant_2 | Pub_21 | {default} ≡ {""} ≡ {} |
+ +---------+--------------------------------+
| | Pub_22 | {"Partition*"} |
+----------------+---------+--------------------------------+
Expand All @@ -91,11 +95,10 @@ Given a system with the following Partition configuration:
+ +---------+--------------------------------+
| | Subs_33 | {"Partition_3"} |
+ +---------+--------------------------------+
| | Subs_34 | {} |
| | Subs_34 | {default} ≡ {""} ≡ {} |
+----------------+---------+--------------------------------+

The endpoints will finally match the Partitions depicted on the following table.
Note that ``Pub_12`` does not match the default Partition.

+--------------+-------------------+-------------------+---------------------------------------+
| | Participant_1 | Participant_2 | Participant_3 |
Expand All @@ -108,7 +111,7 @@ Note that ``Pub_12`` does not match the default Partition.
+--------------+---------+---------+---------+---------+---------+---------+---------+---------+
| Partition_3 | ✕ | ✓ | ✕ | ✓ | ✕ | ✕ | ✓ | ✕ |
+--------------+---------+---------+---------+---------+---------+---------+---------+---------+
| {default} | ✕ | | ✓ | ✕ | ✕ | ✕ | ✕ | ✓ |
| {default} | ✕ | | ✓ | ✕ | ✕ | ✕ | ✕ | ✓ |
+--------------+---------+---------+---------+---------+---------+---------+---------+---------+

The following table provides the communication matrix for the given example:
Expand All @@ -124,7 +127,7 @@ The following table provides the communication matrix for the given example:
+ +---------+---------+---------+---------+---------+
| | Subs_33 | ✕ | ✓ | ✕ | ✓ |
+ +---------+---------+---------+---------+---------+
| | Subs_34 | ✕ | | ✓ | ✕ |
| | Subs_34 | ✕ | | ✓ | ✕ |
+----------------+---------+---------+---------+---------+---------+

The following piece of code shows the set of parameters needed for the use case depicted in this example.
Expand Down
Loading