package piaf

You can search for identifiers within the package.

in-package search v0.2.0

package piaf

piaf
- Piaf
  - Body
  - Cert
  - Client
    
    Oneshot
  - Config
  - Cookies
    
    Cookie
    
    Set_cookie
  - Error
  - Form
    
    Multipart
  - Headers
    
    Well_known
    
    HTTP1
    
    HTTP2
    
    Values
  - IOVec
  - Method
  - Request
  - Request_info
  - Response
    
    Upgrade
  - Scheme
  - Server
    
    Command
    
    Config
    
    HTTPS
    
    Error_response
    
    Handler
    
    Middleware
    
    Service
  - Status
  - Versions
    
    ALPN
    
    HTTP
    
    Raw
    
    TLS
  - Ws
    
    Descriptor
    
    Message
piaf.multipart
- Multipart
  - Pp
piaf.multipart_form
- Piaf_multipart_form
  - Content_disposition
    
    Decoder
    
    Encoder
  - Content_encoding
    
    Decoder
    
    Encoder
  - Content_type
    
    Decoder
    
    Encoder
    
    Parameters
    
    Map
    
    Subtype
    
    Type
  - Field
    
    Decoder
    
    Encoder
  - Field_name
    
    Decoder
    
    Encoder
    
    Map
    
    Set
  - Header
    
    Decoder
    
    Encoder
  - Multipart_form
    
    Content_disposition
    
    Content_encoding
    
    Content_type
    
    Parameters
    
    Map
    
    Subtype
    
    Type
    
    Field
    
    Field_name
    
    Header
    
    Decoder
  - Rfc2046
piaf.sendfile
- Sendfile
piaf.stream
- Piaf_stream

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t = {

follow_redirects : bool;
(*
whether to follow redirects
*)
max_redirects : int;
(*
max redirects to follow. Could probably be rolled up into one option
*)
allow_insecure : bool;
(*
Wether to allow insecure server connections when using SSL
*)
max_http_version : Versions.HTTP.t;
(*
Use this as the highest HTTP version when sending requests
*)
h2c_upgrade : bool;
(*
Send an upgrade to `h2c` (HTTP/2 over TCP) request to the server. `http2_prior_knowledge` below ignores this option.
*)
http2_prior_knowledge : bool;
(*
Assume HTTP/2 prior knowledge -- don't use HTTP/1.1 Upgrade when communicating with "http" URIs, default to HTTP/2.0 when we can't agree to an ALPN protocol and communicating with "https" URIs.
*)
cacert : Cert.t option;
(*
The path to a CA certificates file in PEM format
*)
capath : string option;
(*
The path to a directory which contains CA certificates in PEM format
*)
clientcert : (Cert.t * Cert.t) option;
(*
Client certificate in PEM format
*)
min_tls_version : Versions.TLS.t;
max_tls_version : Versions.TLS.t;
tcp_nodelay : bool;
connect_timeout : float;
buffer_size : int;
(*
Buffer size used for requests and responses. Defaults to 16384 bytes
*)
body_buffer_size : int;
(*
Buffer size used for request and response bodies.
*)
enable_http2_server_push : bool;
default_headers : (Headers.name * Headers.value) list;
(*
Set default headers (on the client) to be sent on every request.
*)
flush_headers_immediately : bool;
(*
Specifies whether to flush message headers to the transport immediately, or if Piaf should wait for the first body bytes to be written. Defaults to false.
*)
prefer_ip_version : [ `V4 | `V6 | `Both ];
(*
Specify IP version preference
*)

}

val default : t