package piaf

Overview
No Docs

You can search for identifiers within the package.

in-package search v0.2.0

An HTTP library with HTTP/2 support written entirely in OCaml

Install

dune-project

Dependency

github.com Edit opam file Versions (2)

Authors

A

Antonio Monteiro <anmonteiro@gmail.com>

Maintainers

A

Antonio Monteiro <anmonteiro@gmail.com>

Sources

piaf-0.1.0.tbz

sha256=00c3bea6d1a8c77dc18bbbbf1f449a78253cf17391ad153751b2e87f71307265

sha512=0f35e88b78ec1f1cd06a972ee69e29a8983b4c07dbc0268cc9764d8df5d9c2402cc3710874f54a111095fb57a08fe582d99d1b7e070e141e260af6ced50172aa

doc/piaf.httpaf/Httpaf/Response/index.html

Module `Httpaf.Response`Source

Response

A server-generated message to a

equest

.

Sourcetype t = {

version : Version.t;
status : Status.t;
reason : string;
headers : Headers.t;

}

Source

val create : 
  ?reason:string ->
  ?version:Version.t ->
  ?headers:Headers.t ->
  Status.t ->
  t

create ?reason ?version ?headers status creates an HTTP response with the given parameters. For typical use cases, it's sufficient to provide values for headers and status.

Source

val body_length : 
  ?proxy:bool ->
  request_method:Method.standard ->
  t ->
  [ `Fixed of Int64.t
  | `Chunked
  | `Close_delimited
  | `Error of [ `Bad_gateway | `Internal_server_error ] ]

body_length ?proxy ~request_method t is the length of the message body accompanying t assuming it is a response to a request whose method was request_method. If the calling code is acting as a proxy, it should pass ~proxy:true. This optional parameter only affects error reporting.

See RFC7230§3.3.3 for more details.

Sourceval persistent_connection : ?proxy:bool -> t -> bool

persistent_connection ?proxy t indicates whether the connection for t can be reused for multiple requests and responses. If the calling code is acting as a proxy, it should pass ~proxy:true.

See RFC7230§6.3 for more details.

Sourceval pp_hum : Format.formatter -> t -> unit