diff options
Diffstat (limited to 'portal/portal.mli')
| -rw-r--r-- | portal/portal.mli | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/portal/portal.mli b/portal/portal.mli index 8790b77..9652783 100644 --- a/portal/portal.mli +++ b/portal/portal.mli @@ -25,8 +25,11 @@ 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. *) +(** [starttls portal] mutates [portal] into a TLS-encrypted stream with the same state. + + 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 (** [header domain portal] sends an initial stream header to the XMPP server [portal] |