aboutsummaryrefslogtreecommitdiff
path: root/portal/portal.mli
diff options
context:
space:
mode:
Diffstat (limited to 'portal/portal.mli')
-rw-r--r--portal/portal.mli17
1 files changed, 17 insertions, 0 deletions
diff --git a/portal/portal.mli b/portal/portal.mli
new file mode 100644
index 0000000..a560f5e
--- /dev/null
+++ b/portal/portal.mli
@@ -0,0 +1,17 @@
+open Markup
+
+type t = (signal, async) stream * ((signal, sync) stream option -> unit)
+
+(** This is the XML namespace of the underlying element stream.
+
+ You can rely on it on your code, as an escape hatch, but you should probably not,
+ since the Portal interface is supposed to be agnostic.
+
+ Still, bad implementations exist -- Use with care. *)
+val xmlns : string
+
+val stanza_open : ?from:string -> string -> (signal, sync) stream
+
+val stanza_close : (signal, sync) stream
+
+val connect : string -> t Lwt.t