You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/Overview.md
+24
Original file line number
Diff line number
Diff line change
@@ -73,6 +73,26 @@ The `statusReportingDelay` property allows clients to customize the reporting de
73
73
|:--:|
74
74
|_**Status reporting delay example**_|
75
75
76
+
### Sender status transition counters
77
+
78
+
All sender specific domain statuses have an associated status transition counter property. These increment each time the associated status transitions to a worse state. Transitions to/from neutral states like `Inactive` or `NotUsed` are ignored.
79
+
80
+
The intention is that these properties store historical negative trend transitions for each status.
81
+
82
+
The list of all status transition counter properties is:
83
+
84
+
* linkStatusTransitionCounter
85
+
* transmissionStatusTransitionCounter
86
+
* externalSynchronizationStatusTransitionCounter
87
+
* essenceStatusTransitionCounter
88
+
89
+
Devices MUST be able to reset ALL status transition counter properties in the following two ways:
90
+
91
+
* When a sender activation occurs
92
+
* When a client invokes the `ResetStatusTransitionCounters` method
93
+
94
+
The `autoResetStatusTransitionCounters` property allows clients to configure if ALL status transition counter properties automatically reset with each Sender activation (by default devices MUST have this enabled). If this is enabled, senders MUST reset ALL status transition counter properties to 0 after each activation. Devices MUST allow setting the `autoResetStatusTransitionCounters` property to a value of `true` and MAY allow setting the property to `false`. This supports use cases where users do not want to reset automatically after each activation.
95
+
76
96
### Sender overall status
77
97
78
98
The purpose of the overallStatus is to abstract and combine the specific domain statuses of a monitor into a single status which can be more easily observed and displayed by a simple client.
@@ -96,8 +116,10 @@ Devices MUST follow the rules listed below when mapping specific domain statuses
96
116
* Properties
97
117
* linkStatus
98
118
* linkStatusMessage
119
+
* linkStatusTransitionCounter
99
120
* transmissionStatus
100
121
* transmissionStatusMessage
122
+
* transmissionStatusTransitionCounter
101
123
* autoResetErrorCounters
102
124
* Methods
103
125
* GetTransmissionErrorCounters
@@ -164,6 +186,7 @@ Devices that do not have the capability to detect transmission errors MUST:
164
186
* Properties
165
187
* externalSynchronizationStatus
166
188
* externalSynchronizationStatusMessage
189
+
* externalSynchronizationStatusTransitionCounter
167
190
* synchronizationSourceId
168
191
* synchronizationSourceChanges
169
192
* Methods
@@ -228,6 +251,7 @@ When devices do not use external synchronization they MUST:
0 commit comments