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

Handler that upgrades to another protocol.

since 0.17

type handshake_state

Some specific state returned after handshake

val name : string

Name in the "upgrade" header

val handshake : 
  Unix.sockaddr ->
  unit Request.t ->
  (Headers.t * handshake_state, string) result

Perform the handshake and upgrade the connection. This returns either Ok (resp_headers, state) in case of success, in which case the server sends a 101 response with resp_headers; or it returns Error log_msg if the the handshake fails, in which case the connection is closed without further ado and log_msg is logged locally (but not returned to the client).

val handle_connection : handshake_state -> IO.Input.t -> IO.Output.t -> unit

Take control of the connection and take it from ther.e