diff options
| -rw-r--r-- | portal/lib/portal_ws.ml | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/portal/lib/portal_ws.ml b/portal/lib/portal_ws.ml index 0b21f4b..b808733 100644 --- a/portal/lib/portal_ws.ml +++ b/portal/lib/portal_ws.ml @@ -49,8 +49,11 @@ let ws_endpoint (domain : string) = | None -> failwith (domain ^ "doesn't advertise a WebSocket endpoint via Web-host Metadata.") let ws_stream (url : string) = - (** [ws_stream url] returns an Lwt stream (and its push function) communicating with the websocket located at [url] - using the XMPP protocol. + (** [ws_stream url] returns a framed Lwt stream (and its push function) communicating with the websocket located at + [url] using the XMPP protocol.Lwt + + Valid XMPP WebSocket subprotocol frames must be sent to the stream, because it directly exposes the websocket + under. Pushing [None] closes the websocket. |