package cohttp
Library
Module
Module type
Parameter
Class
Class type
HTTP/1.1 response handling
This contains the metadata for a HTTP/1.1 response header, including the encoding, headers, version, status code and whether to flush the connection after every body chunk (useful for server-side events and other long-lived connection protocols). The body is handled by the separate S module type, as it is dependent on the IO implementation.
The interface exposes a fieldslib interface which provides individual accessor functions for each of the records below. It also provides sexp serializers to convert to-and-from an Core.Std.Sexp.t.
include S.Response
type t = {encoding : Transfer.encoding;(*Transfer encoding of this HTTP response
*)headers : Header.t;(*response HTTP headers
*)version : Code.version;(*(** HTTP version, usually 1.1 *)
*)status : Code.status_code;(*HTTP status code of the response
*)flush : bool;
}include Ppx_sexp_conv_lib.Sexpable.S with type t := t
val t_of_sexp : Sexplib0.Sexp.t -> tval sexp_of_t : t -> Sexplib0.Sexp.tval encoding : t -> Transfer.encodingval version : t -> Code.versionval status : t -> Code.status_codeval flush : t -> boolval make :
?version:Code.version ->
?status:Code.status_code ->
?flush:bool ->
?encoding:Transfer.encoding ->
?headers:Header.t ->
unit ->
tThe response creates by make ~encoding ~headers () has an encoding value determined from the content of headers or if no proper header is present, using the value of encoding. Checked headers are "content-length", "content-range" and "transfer-encoding". The default value of encoding is chunked.
val pp_hum : Format.formatter -> t -> unitHuman-readable output, used by the toplevel printer