Skip to content

Commit 93b7567

Browse files
authored
Clarify language around sending Stream Updated events (#177)
* Clarify language around sending Stream Updated events * Add missing 'the'
1 parent 9a0efa0 commit 93b7567

File tree

1 file changed

+6
-26
lines changed

1 file changed

+6
-26
lines changed

openid-sharedsignals-framework-1_0.md

+6-26
Original file line numberDiff line numberDiff line change
@@ -1403,29 +1403,9 @@ Errors are signaled with HTTP status codes as follows:
14031403
### Stream Status {#status}
14041404
Event Streams are managed independently. A Receiver MAY request that events from a
14051405
stream be interrupted by Updating the Stream Status ({{updating-a-streams-status}}).
1406-
1407-
A Transmitter MAY decide to enable, pause or disable updates from a stream
1408-
independently of an update request from a Receiver. If a Transmitter decides to
1409-
start or stop events for a stream then the Transmitter MUST do the following
1410-
according to the status of the stream.
1411-
1412-
If the stream is:
1413-
1414-
Enabled
1415-
1416-
> the Transmitter MUST send a Stream Updated ({{stream-updated-event}}) event
1417-
to the Receiver within the Event Stream.
1418-
1419-
Paused
1420-
1421-
> the Transmitter SHOULD send a Stream Updated ({{stream-updated-event}}) event after the Event Stream is
1422-
re-started. A Receiver MUST assume that events may have been lost during the
1423-
time when the Stream was paused.
1424-
1425-
Disabled
1426-
1427-
> the Transmitter MAY send a Stream Updated ({{stream-updated-event}}) event after the Event Stream is
1428-
re-enabled.
1406+
If a Transmitter decides to enable, pause or disable updates from a stream
1407+
independently of an update request from a Receiver, it MUST send a Stream Updated Event
1408+
({{stream-updated-event}}) to the Receiver.
14291409

14301410
#### Reading a Stream’s Status {#reading-a-streams-status}
14311411
An Event Receiver checks the current status of an Event Stream by making an HTTP
@@ -1880,11 +1860,11 @@ that it has changed the status of the Event Stream.
18801860

18811861
If a Transmitter decides to change the status of an Event Stream from "enabled"
18821862
to either "paused" or "disabled", then the Transmitter MUST send this event to
1883-
any Receiver that is currently "enabled" to receive events from this stream.
1863+
the Receiver before stopping the stream.
18841864

18851865
If the Transmitter changes the status of the stream from either
1886-
"paused" or "disabled" to "enabled", then it MUST send this event to any
1887-
Receiver that has previously been enabled to receive events for the stream.
1866+
"paused" or "disabled" to "enabled", then it MUST send this event to the
1867+
Receiver upon re-enabling the stream.
18881868

18891869
A Transmitter MAY send a Stream Updated event even if the event is not present in the `events_supported`, `events_requested` and / or `events_delivered` fields in the Stream Configuration ({{stream-config}}).
18901870

0 commit comments

Comments
 (0)