Skip to content

Commit

Permalink
Update documentation (dart-archive/sse#37)
Browse files Browse the repository at this point in the history
* Update documentation

* more documentation
  • Loading branch information
grouma authored Feb 5, 2021
1 parent 9648a35 commit 8ddfc20
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions pkgs/sse/lib/src/server/sse_handler.dart
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.
SseHandler(this._uri, {Duration keepAlive}) : _keepAlive = keepAlive;

StreamQueue<SseConnection> get connections =>
Expand Down

0 comments on commit 8ddfc20

Please sign in to comment.