package irmin-http

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

Module `Irmin_http_unix.Http_client`Source

Parameters

module P : Sock

Signature

include module type of Cohttp_lwt_unix.Client

include Cohttp_lwt.S.Client with type ctx = Cohttp_lwt_unix.Net.ctx

Sourcetype ctx = Cohttp_lwt_unix.Net.ctx

Sourcemodule IO : Cohttp_lwt.S.IO with type 'a t = 'a Lwt.t

parameter ctx
If provided, no connection cache is used, but Connection_cache.Make_no_cache.create is used to resolve uri and create a dedicated connection with ctx.

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.

include Cohttp.Generic.Client.S
  with type 'a io = 'a Lwt.t
   and type body = Cohttp_lwt.Body.t
   and type 'a with_context = ?ctx:ctx -> 'a

Sourcetype 'a io = 'a Lwt.t

Sourcetype 'a with_context = ?ctx:ctx -> 'a

Sourcetype body = Cohttp_lwt.Body.t

Sourceval map_context : 'a with_context -> ('a -> 'b) -> 'b with_context

Source

val call : 
  (?headers:Http.Header.t ->
    ?body:body ->
    ?chunked:bool ->
    Http.Method.t ->
    Uri.t ->
    (Http.Response.t * body) io)
    with_context

call ?headers ?body ?chunked meth uri

returns
(response, response_body) Consume response_body in a timely fashion. Please see call about how and why.

parameter chunked
use chunked encoding if true. The default is false for compatibility reasons.

Sourceval head : (?headers:Http.Header.t -> Uri.t -> Http.Response.t io) with_context

Source

val get : 
  (?headers:Http.Header.t -> Uri.t -> (Http.Response.t * body) io) with_context

Source

val delete : 
  (?body:body ->
    ?chunked:bool ->
    ?headers:Http.Header.t ->
    Uri.t ->
    (Http.Response.t * body) io)
    with_context

Source

val post : 
  (?body:body ->
    ?chunked:bool ->
    ?headers:Http.Header.t ->
    Uri.t ->
    (Http.Response.t * body) io)
    with_context

Source

val put : 
  (?body:body ->
    ?chunked:bool ->
    ?headers:Http.Header.t ->
    Uri.t ->
    (Http.Response.t * body) io)
    with_context

Source

val patch : 
  (?body:body ->
    ?chunked:bool ->
    ?headers:Http.Header.t ->
    Uri.t ->
    (Http.Response.t * body) io)
    with_context

Sourceval set_cache : Cohttp_lwt.S.call -> unit

Provide a function used to process requests. Please see call. The provided function is only used when no ctx argument is passed to the convenience functions below.

Source

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

Source

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

deprecated
use Cohttp_lwt.Connection instead.

Source

val custom_ctx : 
  ?ctx:Conduit_lwt_unix.ctx ->
  ?resolver:Resolver_lwt.t ->
  unit ->
  Cohttp_lwt_unix.Net.ctx

custom_ctx ?ctx ?resolver () will return a context that is the same as the default_ctx, but with either the connection handling or resolution module overridden with ctx or resolver respectively. This is useful to supply a Conduit_lwt_unix.ctx with a custom source network interface, or a Resolver_lwt.t with a different name resolution strategy (for instance to override a hostname to point it to a Unix domain socket).

Sourceval ctx : unit -> ctx option

package irmin-http

Module Irmin_http_unix.Http_clientSource

Parameters

Signature

Module `Irmin_http_unix.Http_client`Source