package dream-httpaf

You can search for identifiers within the package.

in-package search v0.2.0

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

Anton Bachin

Maintainers

Anton Bachin

Sources

dream-1.0.0-alpha6.tar.gz

sha256=8d3b6344c0e175aca628b3d5bb8ee58265e8c1074fc2d40d63f136fef83daf90

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

Module `Httpaf.Reqd`Source

Request Descriptor

Sourcetype t

Sourcetype error = [

| `Bad_request
| `Bad_gateway
| `Internal_server_error
| `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

Source

val 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

On This Page

Request Descriptor
1. Exception Handling