package piaf

You can search for identifiers within the package.

in-package search v0.2.0

piaf
- Piaf
  - Body
  - Client
    
    Oneshot
  - Config
  - Cookies
    
    Cookie
    
    Set_cookie
  - Error
  - Form
    
    Multipart
  - Headers
    
    Well_known
    
    HTTP1
    
    HTTP2
  - IOVec
  - Method
  - Request
  - Response
  - Scheme
  - Server
    
    Error_response
    
    Handler
    
    Middleware
    
    Service
  - Status
  - Versions
    
    ALPN
    
    HTTP
    
    TLS
piaf.h2
- H2
  - Body
  - Client_connection
  - Config
  - Error_code
  - Headers
  - IOVec
  - Method
  - Reqd
  - Request
  - Response
  - Server_connection
  - Settings
  - Status
piaf.h2-lwt
- H2_lwt
  - Client
  - Server
piaf.h2-lwt-unix
- H2_lwt_unix
  - Client
    
    SSL
    
    TLS
  - Server
    
    SSL
    
    TLS
piaf.hpack
- Hpack
  - Decoder
  - Encoder
piaf.httpaf
- Httpaf
  - Body
  - Client_connection
  - Config
  - Headers
  - IOVec
  - Method
  - Reqd
  - Request
  - Response
  - Server_connection
  - Status
  - Version
piaf.httpaf-lwt
- Httpaf_lwt
  - Client
  - Server
piaf.httpaf-lwt-unix
- Httpaf_lwt_unix
  - Client
    
    SSL
    
    TLS
  - Server
    
    SSL
    
    TLS
piaf.multipart
- Multipart
  - Pp
piaf.multipart_form
- Multipart_form
  - Content_disposition
  - Content_encoding
  - Content_type
    
    Parameters
    
    Map
    
    Subtype
    
    Type
  - Field
  - Field_name
  - Header
    
    Decoder

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t

val create : ?config:Config.t -> Uri.t -> (t, Error.t) Lwt_result.t

create ?config uri opens a connection to uri (initially) that can be used to issue multiple requests to the remote endpoint.

A client instance represents a connection to a single remote endpoint, and the remaining functions in this module will issue requests to that endpoint only.

val head : 
  t ->
  ?headers:(string * string) list ->
  string ->
  (Response.t, Error.t) Lwt_result.t

val get : 
  t ->
  ?headers:(string * string) list ->
  string ->
  (Response.t, Error.t) Lwt_result.t

val post : 
  t ->
  ?headers:(string * string) list ->
  ?body:Body.t ->
  string ->
  (Response.t, Error.t) Lwt_result.t

val put : 
  t ->
  ?headers:(string * string) list ->
  ?body:Body.t ->
  string ->
  (Response.t, Error.t) Lwt_result.t

val patch : 
  t ->
  ?headers:(string * string) list ->
  ?body:Body.t ->
  string ->
  (Response.t, Error.t) Lwt_result.t

val delete : 
  t ->
  ?headers:(string * string) list ->
  ?body:Body.t ->
  string ->
  (Response.t, Error.t) Lwt_result.t

val request : 
  t ->
  ?headers:(string * string) list ->
  ?body:Body.t ->
  meth:Method.t ->
  string ->
  (Response.t, Error.t) Lwt_result.t

val shutdown : t -> unit Lwt.t

shutdown t tears down the connection t and frees up all the resources associated with it.

module Oneshot : sig ... end