package tiny_httpd

You can search for identifiers within the package.

in-package search v0.2.0

package tiny_httpd

tiny_httpd
- Tiny_httpd
- Tiny_httpd_atomic_
- Tiny_httpd_buf
- Tiny_httpd_dir
  - Embedded_fs
  - VFS
- Tiny_httpd_html
- Tiny_httpd_html_
  - A
  - Out
- Tiny_httpd_io
  - Input
  - Output
  - TCP_server
  - Writer
- Tiny_httpd_pool
- Tiny_httpd_server
  - Headers
  - IO_BACKEND
  - Meth
  - Middleware
  - Request
  - Response
  - Response_code
  - Route
  - SERVER_SENT_GENERATOR
- Tiny_httpd_stream
- Tiny_httpd_util

Legend:
Library
Module
Module type
Parameter
Class
Class type

A TCP server abstraction.

type conn_handler = {

handle : client_addr:Unix.sockaddr -> Input.t -> Output.t -> unit;
(*
Handle client connection
*)

}

type t = {

endpoint : unit -> string * int;
(*
Endpoint we listen on. This can only be called from within serve.
*)
active_connections : unit -> int;
(*
Number of connections currently active
*)
running : unit -> bool;
(*
Is the server currently running?
*)
stop : unit -> unit;
(*
Ask the server to stop. This might not take effect immediately, and is idempotent. After this server.running() must return false.
*)

}

A running TCP server.

This contains some functions that provide information about the running server, including whether it's active (as opposed to stopped), a function to stop it, and statistics about the number of connections.

type builder = {

serve : after_init:(t -> unit) -> handle:conn_handler -> unit -> unit;
(*
Blocking call to listen for incoming connections and handle them. Uses the connection handler handle to handle individual client connections in individual threads/fibers/tasks.
- parameter after_init
  is called once with the server after the server has started.
*)

}

A TCP server builder implementation.

Calling builder.serve ~after_init ~handle () starts a new TCP server on an unspecified endpoint (most likely coming from the function returning this builder) and returns the running server.