diff options
| -rw-r--r-- | portal/portal.mli | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/portal/portal.mli b/portal/portal.mli index 55cea74..604e360 100644 --- a/portal/portal.mli +++ b/portal/portal.mli @@ -31,12 +31,11 @@ val xmlns : string (** [connect domain] returns a socket connected to the XMPP server [domain]. *) val connect : domain -> socket Lwt.t -(** [starttls portal] mutates [portal] into a TLS-encrypted stream with the same state. +(** [starttls socket] returns a TLS-encrypted [socket] wrapping the original socket. - Note that when you call this function, the [stream] and [push] of the Portal are - invalidated, and need to be regenerated using [header] (this should always be done - anyways, according to the XMPP spec). *) -val starttls : t -> unit Lwt.t + Once this function is called, the old socket and the portal depending on this socket + MUST NOT be used. *) +val starttls : socket -> socket Lwt.t (** [stream socket] sends an initial stream header to the XMPP server [socket]. It returns a Portal, connected to the given socket. |