rwf2
/
Rocket
mirror of https://github.com/rwf2/Rocket.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Document "reconnect ad-infinitum" SSE pitfall.

This commit is contained in:
Martyn 2023-12-06 21:57:06 +00:00 committed by Sergio Benitez
parent 10b5da7035
commit 61e77c5e13
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
core/lib/src/response/stream/sse.rs
View File

@ -475,6 +475,16 @@ impl Event {
///
/// To send messages losslessly, they must be encoded first, for instance, by
/// using [`Event::json()`].
///
/// * **Clients reconnect ad-infinitum**
///
/// The [SSE standard] stipulates: _"Clients will reconnect if the connection
/// is closed; a client can be told to stop reconnecting using the HTTP 204
/// No Content response code."_ As a result, clients will typically reconnect
/// exhaustively until either they choose to disconnect or they receive a
/// `204 No Content` response.
///
/// [SSE standard]: https://html.spec.whatwg.org/multipage/server-sent-events.html
pub struct EventStream<S> {
stream: S,
heartbeat: Option<Duration>,