diff options
| author | Clombrong <cromblong@egregore.fun> | 2025-08-17 16:47:46 +0200 |
|---|---|---|
| committer | Clombrong <cromblong@egregore.fun> | 2025-08-17 16:48:22 +0200 |
| commit | 1f439bf652c76c3a222919cff7d62350a107dbf3 (patch) | |
| tree | ef7c118499a8ec971b471693468a3f0ea03e4efb | |
| parent | bd7533186094ffdf9b1bd9908f603807472eacb5 (diff) | |
refactor!(portal): rename header function to stream
| -rw-r--r-- | portal/portal.mli | 7 |
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 |