cohttp-lwt 2.1.3 · OCaml Package

The Client module implements non-pipelined single HTTP client calls. Each call will open a separate Net connection. For best results, the Body that is returned should be consumed in order to close the file descriptor in a timely fashion. It will still be finalized by a GC hook if it is not used up, but this can take some additional time to happen.

type ctx

val sexp_of_ctx : ctx -> Ppx_sexp_conv_lib.Sexp.t

val default_ctx : ctx

val call : 
  ?ctx:ctx ->
  ?headers:Cohttp.Header.t ->
  ?body:Body.t ->
  ?chunked:bool ->
  Cohttp.Code.meth ->
  Uri.t ->
  (Cohttp.Response.t * Body.t) Lwt.t

call ?ctx ?headers ?body ?chunked meth uri will resolve the uri to a concrete network endpoint using the resolver initialized in ctx. It will then issue an HTTP request with method meth, adding request headers from headers if present. If a body is specified then that will be included with the request, using chunked encoding if chunked is true. The default is to disable chunked encoding for HTTP request bodies for compatibility reasons.

In most cases you should use the more specific helper calls in the interface rather than invoke this function directly. See head, get and post for some examples.

val head : 
  ?ctx:ctx ->
  ?headers:Cohttp.Header.t ->
  Uri.t ->
  Cohttp.Response.t Lwt.t

val get : 
  ?ctx:ctx ->
  ?headers:Cohttp.Header.t ->
  Uri.t ->
  (Cohttp.Response.t * Body.t) Lwt.t

val delete : 
  ?ctx:ctx ->
  ?body:Body.t ->
  ?chunked:bool ->
  ?headers:Cohttp.Header.t ->
  Uri.t ->
  (Cohttp.Response.t * Body.t) Lwt.t

val post : 
  ?ctx:ctx ->
  ?body:Body.t ->
  ?chunked:bool ->
  ?headers:Cohttp.Header.t ->
  Uri.t ->
  (Cohttp.Response.t * Body.t) Lwt.t

val put : 
  ?ctx:ctx ->
  ?body:Body.t ->
  ?chunked:bool ->
  ?headers:Cohttp.Header.t ->
  Uri.t ->
  (Cohttp.Response.t * Body.t) Lwt.t

val patch : 
  ?ctx:ctx ->
  ?body:Body.t ->
  ?chunked:bool ->
  ?headers:Cohttp.Header.t ->
  Uri.t ->
  (Cohttp.Response.t * Body.t) Lwt.t

val post_form : 
  ?ctx:ctx ->
  ?headers:Cohttp.Header.t ->
  params:(string * string list) list ->
  Uri.t ->
  (Cohttp.Response.t * Body.t) Lwt.t

val callv : 
  ?ctx:ctx ->
  Uri.t ->
  (Cohttp.Request.t * Body.t) Lwt_stream.t ->
  (Cohttp.Response.t * Body.t) Lwt_stream.t Lwt.t

package cohttp-lwt