package cohttp-lwt-unix

  1. Overview
  2. Docs
CoHTTP implementation for Unix and Windows using Lwt

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (11)

Authors

  1. A
    Anil Madhavapeddy
  2. S
    Stefano Zacchiroli
  3. D
    David Sheets
  4. T
    Thomas Gazagnaire
  5. D
    David Scott
  6. R
    Rudi Grinberg
  7. A
    Andy Ray
  8. A
    Anurag Soni

Maintainers

  1. A
    Anil Madhavapeddy <anil@recoil.org>

Sources

cohttp-v6.0.0_beta2.tbz
sha256=90ecec8bd580411b4272c031b2f6b9c0a50485d20683c6a9c615242f3724b017
sha512=83ef539469d982862174a929e9baeb5b2a34e9323ee577d8be7148ebed9e785d835d59cc22982bc083bb872e4544616e2bf531ed7edf96bc397151c28bf618d6

doc/cohttp-lwt-unix/Cohttp_lwt_unix/Server/index.html

Module Cohttp_lwt_unix.ServerSource

The Server module implements the full UNIX HTTP server interface, including the UNIX-specific functions defined in S.

The Logs source name for this module logger is "cohttp.lwt.server". Refer to the Debug module for further details.

include Cohttp_lwt.S.Server with module IO = Cohttp_lwt_unix__.Io
Sourcemodule IO : sig ... end

The Io module contains the IO implementation for cohttp-lwt-unix.

include Cohttp.Generic.Server.S with type body = Cohttp_lwt.Body.t and module IO := IO
Sourcetype body = Cohttp_lwt.Body.t
Sourcetype response_action = [
  1. | `Expert of Http.Response.t * (IO.ic -> IO.oc -> unit IO.t)
  2. | `Response of Http.Response.t * body
]

A request handler can respond in two ways:

  • Using `Response, with a Response.t and a body.
  • Using `Expert, with a Response.t and an IO function that is expected to write the response body. The IO function has access to the underlying IO.ic and IO.oc, which allows writing a response body more efficiently, stream a response or to switch protocols entirely (e.g. websockets). Processing of pipelined requests continue after the unitIO.t is resolved. The connection can be closed by closing the IO.ic.
Sourcetype t
Sourceval make_response_action : ?conn_closed:(conn -> unit) -> callback:(conn -> Http.Request.t -> body -> response_action IO.t) -> unit -> t
Sourceval make_expert : ?conn_closed:(conn -> unit) -> callback: (conn -> Http.Request.t -> body -> (Http.Response.t * (IO.ic -> IO.oc -> unit IO.t)) IO.t) -> unit -> t
Sourceval make : ?conn_closed:(conn -> unit) -> callback:(conn -> Http.Request.t -> body -> (Http.Response.t * body) IO.t) -> unit -> t
Sourceval respond : ?headers:Http.Header.t -> ?flush:bool -> status:Http.Status.t -> body:body -> unit -> (Http.Response.t * body) IO.t

respond ?headers ?flush ~status ~body will respond to an HTTP request with the given status code and response body. If flush is true, then every response chunk will be flushed to the network rather than being buffered. flush is true by default. The transfer encoding will be detected from the body value and set to chunked encoding if it cannot be determined immediately. You can override the encoding by supplying an appropriate Content-length or Transfer-encoding in the headers parameter.

Sourceval respond_string : ?headers:Http.Header.t -> ?flush:bool -> status:Http.Status.t -> body:string -> unit -> (Http.Response.t * body) IO.t
Sourceval callback : t -> IO.conn -> IO.ic -> IO.oc -> unit IO.t
Sourceval resolve_local_file : docroot:string -> uri:Uri.t -> string

Resolve a URI and a docroot into a concrete local filename.

  • deprecated Please use Cohttp.Path.resolve_local_file.
Sourceval respond_error : ?headers:Http.Header.t -> ?status:Http.Status.t -> body:string -> unit -> (Http.Response.t * body) IO.t
Sourceval respond_redirect : ?headers:Http.Header.t -> uri:Uri.t -> unit -> (Http.Response.t * body) IO.t
Sourceval respond_need_auth : ?headers:Http.Header.t -> auth:Cohttp.Auth.challenge -> unit -> (Http.Response.t * body) IO.t
Sourceval respond_not_found : ?uri:Uri.t -> unit -> (Http.Response.t * body) IO.t
Sourceval resolve_file : docroot:string -> uri:Uri.t -> string
  • deprecated Please use Cohttp.Path.resolve_local_file.
Sourceval respond_file : ?headers:Http.Header.t -> fname:string -> unit -> (Http.Response.t * Cohttp_lwt.Body.t) Lwt.t
Sourceval create : ?timeout:int -> ?backlog:int -> ?stop:unit Lwt.t -> ?on_exn:(exn -> unit) -> ?ctx:Net.ctx -> ?mode:Conduit_lwt_unix.server -> t -> unit Lwt.t

create ?timeout ?backlog ?stop ?on_exn ?mode t is a new HTTP server.

The user can decide to start a simple HTTP server (without encryption) or one with TLS encryption. It depends on what the user gives as mode and how conduit-unix is configured.

To create a simple HTTP server listening on port 8089:

  let run = create (`TCP 8080)

When provided, the stop thread will terminate the server if it ever becomes determined.

When provided, backlog will limit the number of open connections.

Every connection will be served in a new lightweight thread that is invoked via the callback defined in t. If the callback raises an exception, it is passed to on_exn (by default, to a function that logs the exception using the Logs library).