package dream-httpaf

  1. Overview
  2. Docs
Internal: shared http/af stack for Dream (server) and Hyper (client)

Install 

dune-project
 Dependency

github.com Readme MIT License Edit opam file Versions (4)

Authors

  1. Anton Bachin

Maintainers

  1. Anton Bachin

Sources

dream-1.0.0-alpha3.tar.gz
sha256=f289253109aee39ab912f9f38aa5e7b44e0b4b01fd7d3dd5c407b034c57f01bc
md5=148588e6f584cd9f2438e56da7df2f56

doc/dream-httpaf.httpaf/Httpaf/Reqd/index.html

Module Httpaf.ReqdSource

Request Descriptor

Sourcetype t
Sourcetype error = [
  1. | `Bad_request
  2. | `Bad_gateway
  3. | `Internal_server_error
  4. | `Exn of exn
]
Sourceval request : t -> Request.t
Sourceval request_body : t -> Body.Reader.t
Sourceval response : t -> Response.t option
Sourceval response_exn : t -> Response.t

Responding

The following functions will initiate a response for the corresponding request in t. Depending on the state of the current connection, and the header values of the response, this may cause the connection to close or to persist for reuse by the client.

See RFC7230§6.3 for more details.

Sourceval respond_with_string : t -> Response.t -> string -> unit
Sourceval respond_with_bigstring : t -> Response.t -> Bigstringaf.t -> unit
Sourceval respond_with_streaming : ?flush_headers_immediately:bool -> t -> Response.t -> Body.Writer.t
Sourceval respond_with_upgrade : t -> Headers.t -> (unit -> unit) -> unit

Exception Handling

Sourceval error_code : t -> error option
Sourceval report_exn : t -> exn -> unit
Sourceval try_with : t -> (unit -> unit) -> (unit, exn) Result.result