aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--portal/portal.mli7
1 files changed, 3 insertions, 4 deletions
diff --git a/portal/portal.mli b/portal/portal.mli
index ae2b0c5..0d3003c 100644
--- a/portal/portal.mli
+++ b/portal/portal.mli
@@ -38,12 +38,11 @@ val connect : domain -> socket Lwt.t
anyways, according to the XMPP spec). *)
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.
+(** [stream socket] sends an initial stream header to the XMPP server [socket]. It
+ returns a Portal, connected to the given socket.
When [from] is specified, a from attribute is included. *)
-val header : ?from:string -> socket -> t Lwt.t
+val stream : ?from:string -> socket -> t Lwt.t
(** [_encrypted socket] returns whether [socket] is encrypted, using TLS or otherwise. *)
val _encrypted : socket -> bool