package cohttp-lwt

  1. Overview
  2. Docs
CoHTTP implementation using the Lwt concurrency library

Install 

dune-project
 Dependency

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

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

Maintainers

  1. A
    anil@recoil.org

Sources

cohttp-5.3.0.tbz
sha256=b3bd91c704e5ea510e924b83ab2ede1fc46a2cce448b0f8cef4883b9a16eeddd
sha512=529930d9b1f38737d91f47cb94f8bae381df87ea941cb8e75ee798354763bdf5091f4f3be31d0ba14b9944dc68203a3d98e235c38c66e7e176a114be9ff4acf3

doc/cohttp-lwt/Cohttp_lwt/Make_server/index.html

Module Cohttp_lwt.Make_serverSource

Parameters

module IO : S.IO

Signature

Sourcemodule IO = IO
Sourcetype response_action = [
  1. | `Expert of Cohttp.Response.t * (IO.ic -> IO.oc -> unit Lwt.t)
  2. | `Response of Cohttp.Response.t * Body.t
]

A request handler can respond in two ways:

  • Using `Response, with a Response.t and a Body.t.
  • 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 unitLwt.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 -> Cohttp.Request.t -> Body.t -> response_action Lwt.t) -> unit -> t
Sourceval make_expert : ?conn_closed:(conn -> unit) -> callback: (conn -> Cohttp.Request.t -> Body.t -> (Cohttp.Response.t * (IO.ic -> IO.oc -> unit Lwt.t)) Lwt.t) -> unit -> t
Sourceval make : ?conn_closed:(conn -> unit) -> callback: (conn -> Cohttp.Request.t -> Body.t -> (Cohttp.Response.t * Body.t) Lwt.t) -> unit -> 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 : ?headers:Cohttp.Header.t -> ?flush:bool -> status:Cohttp.Code.status_code -> body:Body.t -> unit -> (Cohttp.Response.t * Body.t) Lwt.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 : ?flush:bool -> ?headers:Cohttp.Header.t -> status:Cohttp.Code.status_code -> body:string -> unit -> (Cohttp.Response.t * Body.t) Lwt.t
Sourceval respond_error : ?headers:Cohttp.Header.t -> ?status:Cohttp.Code.status_code -> body:string -> unit -> (Cohttp.Response.t * Body.t) Lwt.t
Sourceval respond_redirect : ?headers:Cohttp.Header.t -> uri:Uri.t -> unit -> (Cohttp.Response.t * Body.t) Lwt.t
Sourceval respond_need_auth : ?headers:Cohttp.Header.t -> auth:Cohttp.Auth.challenge -> unit -> (Cohttp.Response.t * Body.t) Lwt.t
Sourceval respond_not_found : ?uri:Uri.t -> unit -> (Cohttp.Response.t * Body.t) Lwt.t
Sourceval callback : t -> IO.conn -> IO.ic -> IO.oc -> unit Lwt.t