aboutsummaryrefslogtreecommitdiff
path: root/portal/portal.mli
diff options
context:
space:
mode:
authorClombrong <cromblong@egregore.fun>2025-06-29 05:00:16 +0200
committerClombrong <cromblong@egregore.fun>2025-06-29 05:13:52 +0200
commitc94278c2e3ac251ee0c4201599f79fdd7a089c5e (patch)
treef7ce220103f844527d8025d28a4efc260bc99c93 /portal/portal.mli
parent6fa404ae05d65e6dbd1f29361c76569e19e463ed (diff)
chore(portal_tcp): move header and close to the bottom of the file
Diffstat (limited to 'portal/portal.mli')
-rw-r--r--portal/portal.mli14
1 files changed, 7 insertions, 7 deletions
diff --git a/portal/portal.mli b/portal/portal.mli
index fab9197..8790b77 100644
--- a/portal/portal.mli
+++ b/portal/portal.mli
@@ -22,6 +22,13 @@ type t = {
since the Portal interface is supposed to be agnostic. *)
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. *)
+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.
@@ -33,10 +40,3 @@ val header : ?from:string -> string -> t -> string Lwt.t
that the connection is closed. Namely, it does {b not} interact with the Portal in
any way: It's the caller's job to provide it to the stream. *)
val close : (signal, sync) stream
-
-(** [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. *)
-val starttls : t -> unit Lwt.t