diff options
Diffstat (limited to 'portal/portal.mli')
| -rw-r--r-- | portal/portal.mli | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/portal/portal.mli b/portal/portal.mli index fab9197..8790b77 100644 --- a/portal/portal.mli +++ b/portal/portal.mli @@ -22,6 +22,13 @@ type t = { since the Portal interface is supposed to be agnostic. *) val xmlns : string +(** [connect domain] returns a Portal connected to the XMPP server [domain]. *) +val connect : string -> t Lwt.t + +(** [starttls portal] mutates [portal] into a TLS-encrypted stream with the same + state. *) +val starttls : t -> unit Lwt.t + (** [header domain portal] sends an initial stream header to the XMPP server [portal] addressed to [domain]. It returns the server-assigned [id] of the stream included in the response stream header. @@ -33,10 +40,3 @@ val header : ?from:string -> string -> t -> string Lwt.t 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 - -(** [connect domain] returns a Portal connected to the XMPP server [domain]. *) -val connect : string -> t Lwt.t - -(** [starttls portal] mutates [portal] into a TLS-encrypted stream with the same - state. *) -val starttls : t -> unit Lwt.t |