diff options
Diffstat (limited to 'portal/portal.mli')
| -rw-r--r-- | portal/portal.mli | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/portal/portal.mli b/portal/portal.mli index 808e1fa..5efc355 100644 --- a/portal/portal.mli +++ b/portal/portal.mli @@ -23,7 +23,9 @@ val xmlns : string When [from] is specified, a from attribute is included. *) val header : ?from:string -> string -> t -> string Lwt.t -(** [close portal] closes the stream between [portal] and the XMPP server. *) -val close : t -> unit +(** [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 val connect : string -> t Lwt.t |