package http-lwt-client

You can search for identifiers within the package.

in-package search v0.2.0

http-lwt-client
- Http_lwt_client

Legend:
Library
Module
Module type
Parameter
Class
Class type

HTTP lwt client

A HTTP client using the lwt task library. It does a single HTTP request (though may follow redirects) to a remote uri. Both HTTP protocol 1.1 and 2.0 are supported. Both http and https (via the pure implementation OCaml-TLS) are supported. A connection is established via the happy-eyeballs algorithm.

module Version = Httpaf.Version

Protocol Version

module Status = H2.Status

Response Status Codes

module Headers = H2.Headers

Header fields

type response = {

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

}

A response, consisting of version, status, reason (HTTP 1 only), and headers.

val pp_response : Stdlib.Format.formatter -> response -> unit

pp_response ppf response pretty-prints the response on ppf.

val one_request : 
  ?config:[ `HTTP_1_1 of Httpaf.Config.t | `H2 of H2.Config.t ] ->
  ?tls_config:Tls.Config.client ->
  ?authenticator:X509.Authenticator.t ->
  ?meth:Httpaf.Method.t ->
  ?headers:(string * string) list ->
  ?body:string ->
  ?max_redirect:int ->
  ?follow_redirect:bool ->
  ?happy_eyeballs:Happy_eyeballs_lwt.t ->
  string ->
  (response * string option, [> `Msg of string ]) Lwt_result.t

one_request ~config ~authenticator ~meth ~headers ~body ~max_redirect ~follow_redirect ~happy_eyeballs uri does a single request of uri and returns the response. By default, up to 5 redirects (max_redirect) are followed. If follow_redirect is false, no redirect is followed (defaults to true). The default HTTP request type (meth) is GET.

If no tls_config is provided, a default one is used, with alpn and authenticators. If a tls_config is provided, this is used unmodified.

If no config is provided (the default), and the uri uses the https schema, application layer next protocol negotiation (ALPN) is used to negotiate HTTP2 (prefered) or HTTP1. If the uri uses the http schema, HTTP1 is used by default (unless the config provided is `H2).

The default authenticator is from the ca-certs opam package, which discovers and uses the system trust anchors.

The happy-eyeballs opam package is used to establish the TCP connection, which prefers IPv6 over IPv4.