summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
Diffstat (limited to 'lib')
-rw-r--r--lib/stream.ml3
1 files changed, 3 insertions, 0 deletions
diff --git a/lib/stream.ml b/lib/stream.ml
index 5da4aea..dc779f8 100644
--- a/lib/stream.ml
+++ b/lib/stream.ml
@@ -1,6 +1,9 @@
open Lwt.Syntax
let start domain : Portal.t Lwt.t =
+ (** [start domain] is a promise containing a Portal (stream * push) connected to the XMPP server [domain].
+
+ Currently, it doesn't handle anything except the initial [<open/>] stanza. *)
let* stream, _push = Portal.connect domain
in let push = function
| None -> _push (Some Portal.stanza_close);