Skip to content
This repository has been archived by the owner on Jan 6, 2025. It is now read-only.

Update documentation #37

Merged
merged 2 commits into from
Feb 5, 2021
Merged

Update documentation #37

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7506430
Update documentation
grouma Feb 5, 2021
472ec95
more documentation
grouma Feb 5, 2021
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
10 changes: 10 additions & 0 deletions lib/src/server/sse_handler.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,16 @@ class SseHandler {

StreamQueue<SseConnection> _connectionsStream;

/// [_uri] is the URL under which the server is listening for
/// incoming bi-directional SSE connections.
///
/// If [keepAlive] is supplied, connections will remain active for this
/// period after a disconnect and can be reconnected transparently. If there
/// is no reconnect within that period, the connection will be closed
/// normally.
///
/// If [keepAlive] is not supplied, connections will be closed immediately
/// after a disconnect.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we document _uri as well while we're at it?

SseHandler(this._uri, {Duration keepAlive}) : _keepAlive = keepAlive;

StreamQueue<SseConnection> get connections =>
Expand Down