diff options
Diffstat (limited to 'portal')
| -rw-r--r-- | portal/portal.mli | 9 |
1 files changed, 2 insertions, 7 deletions
diff --git a/portal/portal.mli b/portal/portal.mli index 9652783..62a7bd7 100644 --- a/portal/portal.mli +++ b/portal/portal.mli @@ -8,8 +8,8 @@ type socket [stream] is the data sent by the XMPP server. - [push None] disconnects brutally the underlying XMPP server and closes [_socket], - without closing the element stream first. *) + [push None] closes the XMPP stream and disconnects the underlying [_socket]. This is + how XMPP streams should be ended. *) type t = { mutable stream : (signal, async) stream; mutable push : (signal, sync) stream option -> unit; @@ -38,8 +38,3 @@ val starttls : t -> unit Lwt.t When [from] is specified, a from attribute is included. *) val header : ?from:string -> string -> t -> string Lwt.t - -(** [close] is a stream of signals that close the Portal, indicating to the XMPP server - that the connection is closed. Namely, it does {b not} interact with the Portal in - any way: It's the caller's job to provide it to the stream. *) -val close : (signal, sync) stream |