package tiny_httpd

  1. Overview
  2. Docs

Module Tiny_httpd_wsSource

Websockets for Tiny_httpd.

This sub-library (tiny_httpd.ws) exports a small implementation for a websocket server. It has no additional dependencies.

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.

Websocket handler

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 0.21.

Sourceexception Close_connection

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

Sourceval add_route_handler : ?accept:(unit Tiny_httpd_core.Request.t -> (unit, int * string) result) -> ?accept_ws_protocol:(string -> bool) -> ?accept_origin:(string option -> 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 accept_origin

    decides whether this endpoint accepts the Origin header sent by the client (None means the header was absent). Default accepts everything. For browser-facing endpoints, provide an allowlist here to prevent Cross-Site WebSocket Hijacking (CSWSH).

  • parameter with_lock

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