Tiny_httpd_ws (p.tiny_httpd.0.20.doc.tiny_httpd.ws.Tiny_httpd

Sourcemodule With_lock : sig ... end

Synchronization primitive used to allow both the reader to reply to "ping", and the handler to send messages, without stepping on each other's toes.

Source

type handler =
  unit Tiny_httpd_core.Request.t ->
  Tiny_httpd_core.IO.Input.t ->
  Tiny_httpd_core.IO.Output.t ->
  unit

Websocket handler

Source

val upgrade : 
  ?with_lock:With_lock.t ->
  Tiny_httpd_core.IO.Input.t ->
  Tiny_httpd_core.IO.Output.t ->
  Tiny_httpd_core.IO.Input.t * Tiny_httpd_core.IO.Output.t

Upgrade a byte stream to the websocket framing protocol.

parameter with_lock
if provided, use this to prevent reader and writer to compete on sending frames. since NEXT_RELEASE.

Sourceexception Close_connection

Exception that can be raised from IOs inside the handler, when the connection is closed from underneath.

Source

val add_route_handler : 
  ?accept:(unit Tiny_httpd_core.Request.t -> (unit, int * string) result) ->
  ?accept_ws_protocol:(string -> bool) ->
  ?middlewares:Tiny_httpd_core.Server.Head_middleware.t list ->
  ?with_lock:With_lock.builder ->
  Tiny_httpd_core.Server.t ->
  (Tiny_httpd_core.Server.upgrade_handler,
    Tiny_httpd_core.Server.upgrade_handler)
    Tiny_httpd_core.Route.t ->
  handler ->
  unit

Add a route handler for a websocket endpoint.

parameter accept_ws_protocol
decides whether this endpoint accepts the websocket protocol sent by the client. Default accepts everything.

parameter with_lock
if provided, use this to synchronize writes between the frame reader (replies "pong" to "ping") and the handler emitting writes. since NEXT_RELEASE.