Skip to content

Commit b11bb36

Browse files
Mario-DLMario-DL
authored
Extended incompatible qos for monitor service documentation (#947)
Signed-off-by: Mario Dominguez <mariodominguez@eprosima.com>
1 parent 9a852c1 commit b11bb36

File tree

1 file changed

+71
-54
lines changed

1 file changed

+71
-54
lines changed

‎docs/fastdds/statistics/monitor_service/monitor_service_topics.rst

Lines changed: 71 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -28,33 +28,36 @@ The possible values are described in the following table:
2828

2929
.. _monitoring_statuses:
3030

31-
+---------+-----------------------------+-----------------------------------------+
32-
|**Value**| **Name** | **Description** |
33-
+---------+-----------------------------+-----------------------------------------+
34-
| 0 | ``ProxyInfo`` | Collection of Parameters describing the |
35-
| | | ``Proxy Data`` of that entity |
36-
+---------+-----------------------------+-----------------------------------------+
37-
| 1 | ``ConnectionList`` | List of connections that this entity is |
38-
| | | using with its matched remote entities. |
39-
+---------+-----------------------------+-----------------------------------------+
40-
| 2 | ``IncompatibleQoSInfo`` | Status of the Incompatible QoS |
41-
| | | of that entity. |
42-
+---------+-----------------------------+-----------------------------------------+
43-
| 3 | ``InconsistentTopicInfo`` | Status of Inconsistent topics that the |
44-
| | | topic of that entity has. |
45-
+---------+-----------------------------+-----------------------------------------+
46-
| 4 | ``LivelinessLostInfo`` | Tracks the status of the number of times|
47-
| | | a writer lost liveliness. |
48-
+---------+-----------------------------+-----------------------------------------+
49-
| 5 | ``LivelinessChangedInfo`` | Tracks the status of the number of times|
50-
| | | the liveliness changed in a reader. |
51-
+---------+-----------------------------+-----------------------------------------+
52-
| 6 | ``DeadlineMissedInfo`` | The Status of the number of deadlines |
53-
| | | missed of a sample for that entity. |
54-
+---------+-----------------------------+-----------------------------------------+
55-
| 7 | ``SampleLostInfo`` | Tracks the status of the number of times|
56-
| | | this entity lost samples. |
57-
+---------+-----------------------------+-----------------------------------------+
31+
+---------+-----------------------------+----------------------------------------------------+
32+
|**Value**| **Name** | **Description** |
33+
+---------+-----------------------------+----------------------------------------------------+
34+
| 0 | ``ProxyInfo`` | Collection of Parameters describing the |
35+
| | | ``Proxy Data`` of that entity |
36+
+---------+-----------------------------+----------------------------------------------------+
37+
| 1 | ``ConnectionList`` | List of connections that this entity is |
38+
| | | using with its matched remote entities. |
39+
+---------+-----------------------------+----------------------------------------------------+
40+
| 2 | ``IncompatibleQoSInfo`` | Status of the Incompatible QoS |
41+
| | | of that entity. |
42+
+---------+-----------------------------+----------------------------------------------------+
43+
| 3 | ``InconsistentTopicInfo`` | Status of Inconsistent topics that the |
44+
| | | topic of that entity has. |
45+
+---------+-----------------------------+----------------------------------------------------+
46+
| 4 | ``LivelinessLostInfo`` | Tracks the status of the number of times |
47+
| | | a writer lost liveliness. |
48+
+---------+-----------------------------+----------------------------------------------------+
49+
| 5 | ``LivelinessChangedInfo`` | Tracks the status of the number of times |
50+
| | | the liveliness changed in a reader. |
51+
+---------+-----------------------------+----------------------------------------------------+
52+
| 6 | ``DeadlineMissedInfo`` | The Status of the number of deadlines |
53+
| | | missed of a sample for that entity. |
54+
+---------+-----------------------------+----------------------------------------------------+
55+
| 7 | ``SampleLostInfo`` | Tracks the status of the number of times |
56+
| | | this entity lost samples. |
57+
+---------+-----------------------------+----------------------------------------------------+
58+
| 8 | ``ExtendedIncompatibleQoS`` | Stores the list of remote incompatible ``GUIDs`` |
59+
| | | and QoS policies for each local entity guid. |
60+
+---------+-----------------------------+----------------------------------------------------+
5861

5962
.. note::
6063

@@ -124,32 +127,46 @@ The actual field names for the different values are described below:
124127

125128
* *sample_lost_status:* The number of samples that entity lost.
126129

130+
* *extended_incompatible_qos_status:* Details a list of remote GUIDs with incompatible QoS with
131+
a local entity and the particular |QosPolicyId_t-api| of those incompatible policies.
132+
133+
.. code-block:: bash
134+
135+
ExtendedIncompatibleQoSStatus_s
136+
GUID remote_guid
137+
sequence<unsigned long> current_incompatible_policies
138+
139+
ExtendedIncompatibleQoSStatusSeq = sequence<ExtendedIncompatibleQoSStatus>
140+
127141
The following table depicts the relation between each of the ``StatusKind`` values and the ``Data`` field:
128142

129-
+---------------------+---------------------------+---------------------------+---------------------------+
130-
|**StatusKind Value** | **StatusKind Name** | **Data field Name** | **IDL Data field Type** |
131-
+---------------------+---------------------------+---------------------------+---------------------------+
132-
| 0 | ``ProxyInfo`` | entity_proxy | sequence<octet> |
133-
| | | | |
134-
+---------------------+---------------------------+---------------------------+---------------------------+
135-
| 1 | ``ConnectionList`` | connection_list | sequence<Connection> |
136-
| | | | |
137-
+---------------------+---------------------------+---------------------------+---------------------------+
138-
| 2 | ``IncompatibleQoSInfo`` | incompatible_qos_status | IncompatibleQoSStatus |
139-
| | | | |
140-
+---------------------+---------------------------+---------------------------+---------------------------+
141-
| 3 | ``InconsistentTopicInfo`` | inconsistent_topic_status | InconsistentTopicStatus |
142-
| | | | |
143-
+---------------------+---------------------------+---------------------------+---------------------------+
144-
| 4 | ``LivelinessLostInfo`` | liveliness_lost_status | LivelinessLostStatus |
145-
| | | | |
146-
+---------------------+---------------------------+---------------------------+---------------------------+
147-
| 5 | ``LivelinessLostInfo`` | liveliness_changed_status | LivelinessChangedStatus |
148-
| | | | |
149-
+---------------------+---------------------------+---------------------------+---------------------------+
150-
| 6 | ``DeadlineMissedInfo`` | deadline_missed_status | DeadlineMissedStatus |
151-
| | | | |
152-
+---------------------+---------------------------+---------------------------+---------------------------+
153-
| 7 | ``SampleLostInfo`` | sample_lost_status | SampleLostStatus |
154-
| | | | |
155-
+---------------------+---------------------------+---------------------------+---------------------------+
143+
+--------------+---------------------------+----------------------------------+----------------------------------+
144+
|**StatusKind**| **StatusKind Name** | **Data field Name** | **IDL Data field Type** |
145+
+--------------+---------------------------+----------------------------------+----------------------------------+
146+
| 0 | ``ProxyInfo`` | entity_proxy | sequence<octet> |
147+
| | | | |
148+
+--------------+---------------------------+----------------------------------+----------------------------------+
149+
| 1 | ``ConnectionList`` | connection_list | sequence<Connection> |
150+
| | | | |
151+
+--------------+---------------------------+----------------------------------+----------------------------------+
152+
| 2 | ``IncompatibleQoSInfo`` | incompatible_qos_status | IncompatibleQoSStatus |
153+
| | | | |
154+
+--------------+---------------------------+----------------------------------+----------------------------------+
155+
| 3 | ``InconsistentTopicInfo`` | inconsistent_topic_status | InconsistentTopicStatus |
156+
| | | | |
157+
+--------------+---------------------------+----------------------------------+----------------------------------+
158+
| 4 | ``LivelinessLostInfo`` | liveliness_lost_status | LivelinessLostStatus |
159+
| | | | |
160+
+--------------+---------------------------+----------------------------------+----------------------------------+
161+
| 5 | ``LivelinessLostInfo`` | liveliness_changed_status | LivelinessChangedStatus |
162+
| | | | |
163+
+--------------+---------------------------+----------------------------------+----------------------------------+
164+
| 6 | ``DeadlineMissedInfo`` | deadline_missed_status | DeadlineMissedStatus |
165+
| | | | |
166+
+--------------+---------------------------+----------------------------------+----------------------------------+
167+
| 7 | ``SampleLostInfo`` | sample_lost_status | SampleLostStatus |
168+
| | | | |
169+
+--------------+---------------------------+----------------------------------+----------------------------------+
170+
| 8 |``ExtendedIncompatibleQoS``| extended_incompatible_qos_status | ExtendedIncompatibleQoSStatusSeq |
171+
| | | | |
172+
+--------------+---------------------------+----------------------------------+----------------------------------+

0 commit comments

Comments
 (0)