package tiny_httpd

You can search for identifiers within the package.

in-package search v0.2.0

tiny_httpd
- Tiny_httpd
tiny_httpd.core
- Tiny_httpd_core
  - Atomic_
  - Buf
  - Common_
  - Headers
  - IO
    
    Input
    
    bufferized
    
    of_bytes
    
    of_in_channel
    
    of_string
    
    open_file
    
    t
    
    t_from_refill
    
    Output
    
    bufferized
    
    dummy
    
    of_buffer
    
    of_out_channel
    
    of_unix_fd
    
    open_file
    
    t
    
    t_from_output
    
    t_seekable
    
    TCP_server
    
    Writer
  - Log
  - Meth
  - Parse_
  - Pool
  - Request
  - Response
  - Response_code
  - Route
    
    Private_
  - Server
    
    Head_middleware
    
    IO_BACKEND
    
    Middleware
    
    SERVER_SENT_GENERATOR
    
    UPGRADE_HANDLER
  - Util
tiny_httpd.html
- Tiny_httpd_html
  - A
  - Out
tiny_httpd.prometheus
- Tiny_httpd_prometheus
  - Counter
  - GC_metrics
  - Gauge
  - Histogram
  - Registry
tiny_httpd.unix
- Tiny_httpd_unix
  - Dir
    
    Embedded_fs
    
    VFS
  - Sem
  - Unix_tcp_server_
tiny_httpd.ws
- Tiny_httpd_ws

Legend:
Library
Module
Module type
Parameter
Class
Class type

Websockets for Tiny_httpd.

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

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

Websocket handler

val upgrade : 
  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.

exception Close_connection

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

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