diff options
| author | Clombrong <cromblong@egregore.fun> | 2025-06-26 10:32:11 +0200 |
|---|---|---|
| committer | Clombrong <cromblong@egregore.fun> | 2025-06-26 16:25:25 +0200 |
| commit | 0baebf01516b68f07fe69038828f503a517b0d34 (patch) | |
| tree | 1b99a72da55776b57cf2b0f585b0011ab0b4ad2c /portal/portal.mli | |
| parent | 2402c5c9d027d13f864121bde1d8948c0d5efddc (diff) | |
refactor(portal_ws): stanza_open to header
Diffstat (limited to 'portal/portal.mli')
| -rw-r--r-- | portal/portal.mli | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/portal/portal.mli b/portal/portal.mli index f063cd7..dea8b38 100644 --- a/portal/portal.mli +++ b/portal/portal.mli @@ -12,11 +12,12 @@ type t = (signal, async) stream * ((signal, sync) stream option -> unit) Still, bad implementations exist -- Use with care. *) val xmlns : string -(** [negotiate domain portal] negotiates an open stream between the provided [portal] - and the XMPP server. It returns the server-assigned [id] of the stream. +(** [header domain portal] sends an initial stream header to the provided [portal] and + the XMPP server. It returns the server-assigned [id] of the stream included in the + response stream header. - If [from] is specified, the opening stanza is signed with the JID specified. *) -val negotiate : ?from:string -> string -> t -> string Lwt.t + When [from] is specified, a from attribute is included. *) +val header : ?from:string -> string -> t -> string Lwt.t (** [close portal] closes the stream between [portal] and the XMPP server. *) val close : t -> unit |