Ezcurl (u.57b1ea66c022c17cad47bcf9737a697a.ezcurl.0.3.doc.ezcurl.Ezcurl)

Synchronous API

include module type of struct include Ezcurl_core end

Sourcemodule Config = Ezcurl_core.Config

Configuration for the client.

Sourcetype t = private Ezcurl_core.t = {

curl : Curl.t;

}

A client, i.e. a cURL instance. The wrapping record has been present since 0.3

Source

val make : 
  ?set_opts:(Curl.t -> unit) ->
  ?cookiejar_file:string ->
  ?enable_session_cookies:bool ->
  unit ->
  t

Create a new client.

parameter set_opts
called before returning the client, to set options

parameter cookiejar_file
if provided, tell curl to use the given file path to store/load cookies (since 0.3)

parameter enable_session_cookies
if provided, enable cookie handling in curl so it store/load cookies (since 0.3)

Sourceval delete : t -> unit

Delete the client. It cannot be used anymore.

Sourceval with_client : ?set_opts:(Curl.t -> unit) -> (t -> 'a) -> 'a

Make a temporary client, call the function with it, then cleanup.

Sourceval set_no_signal : bool -> unit

Set no_signal default value for each new client instance. Default is true. See CURLOPT_NOSIGNAL.

since 0.3

Sourcemodule Cookies = Ezcurl_core.Cookies

Cookie handling.

Sourcetype response_info = Ezcurl_core.response_info = {

ri_response_time : float;
(*
Total time (in seconds) for the request/response pair. See Curl.get_totaltime.
*)
ri_redirect_count : int;
(*
Number of redirects cURL followed. See Curl.get_redirectcount.
*)

}

Metadata about a response from the server.

Sourceval pp_response_info : Format.formatter -> response_info -> unit

Sourceval string_of_response_info : response_info -> string

Sourcetype 'body response = 'body Ezcurl_core.response = {

code : int;
(*
Response code. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status
*)
headers : (string * string) list;
(*
Response headers
*)
body : 'body;
(*
Response body, or ""
*)
info : response_info;
(*
Information about the response
*)

}

Response for a given request.

Source

val pp_response_with : 
  (Format.formatter -> 'a -> unit) ->
  Format.formatter ->
  'a response ->
  unit

Sourceval pp_response : Format.formatter -> string response -> unit

Sourceval string_of_response : string response -> string

Sourcetype meth = Ezcurl_core.meth =

| GET
| POST of Curl.curlHTTPPost list
| PUT
| DELETE
| HEAD
| CONNECT
| OPTIONS
| TRACE
| PATCH

The HTTP method to use

Sourceval pp_meth : Format.formatter -> meth -> unit

Sourceval string_of_meth : meth -> string

Sourcemodule type IO = Ezcurl_core.IO

Sourcemodule type S = Ezcurl_core.S

Sourcemodule Make = Ezcurl_core.Make

include sig ... end

Sourcetype 'a io = 'a

Source

val http : 
  ?tries:int ->
  ?client:Ezcurl_core.t ->
  ?config:Ezcurl_core.Config.t ->
  ?range:string ->
  ?content:[ `String of string | `Write of bytes -> int -> int ] ->
  ?headers:(string * string) list ->
  url:string ->
  meth:Ezcurl_core.meth ->
  unit ->
  (string Ezcurl_core.response, Curl.curlCode * string) result io

Sourceclass type input_stream = object ... end

Source

val http_stream : 
  ?tries:int ->
  ?client:Ezcurl_core.t ->
  ?config:Ezcurl_core.Config.t ->
  ?range:string ->
  ?content:[ `String of string | `Write of bytes -> int -> int ] ->
  ?headers:(string * string) list ->
  url:string ->
  meth:Ezcurl_core.meth ->
  write_into:input_stream ->
  unit ->
  (unit Ezcurl_core.response, Curl.curlCode * string) result io

Source

val get : 
  ?tries:int ->
  ?client:Ezcurl_core.t ->
  ?config:Ezcurl_core.Config.t ->
  ?range:string ->
  ?headers:(string * string) list ->
  url:string ->
  unit ->
  (string Ezcurl_core.response, Curl.curlCode * string) result io

Source

val put : 
  ?tries:int ->
  ?client:Ezcurl_core.t ->
  ?config:Ezcurl_core.Config.t ->
  ?headers:(string * string) list ->
  url:string ->
  content:[ `String of string | `Write of bytes -> int -> int ] ->
  unit ->
  (string Ezcurl_core.response, Curl.curlCode * string) result io

Source

val post : 
  ?tries:int ->
  ?client:Ezcurl_core.t ->
  ?config:Ezcurl_core.Config.t ->
  ?headers:(string * string) list ->
  ?content:[ `String of string | `Write of bytes -> int -> int ] ->
  params:Curl.curlHTTPPost list ->
  url:string ->
  unit ->
  (string Ezcurl_core.response, Curl.curlCode * string) result io