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

module HTTPS : sig ... end

type t = {

max_http_version : Versions.HTTP.t;
(*
Use this as:
- the highest HTTP version that ALPN will negotiate with the remote peer
- the version to listen on the insecure server:
- max_http_version == HTTP/2 && h2c_upgrade => HTTP/1.1 + H2c upgrade
- max_http_version == HTTP/2 => HTTP/2 server
*)
https : HTTPS.t option;
h2c_upgrade : bool;
(*
Send an upgrade to `h2c` (HTTP/2 over TCP) request to the server. `http2_prior_knowledge` below ignores this option.
*)
tcp_nodelay : bool;
accept_timeout : float;
shutdown_timeout : float;
(*
seconds. How long to wait until connections terminate before shutting down the server.
*)
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;
(*
TODO(anmonteiro): these are HTTP/2 specific and we're probably OK with the defaults
*)
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.
*)
backlog : int;
(*
The maximum length of the queue of pending connections.
*)
address : Eio.Net.Sockaddr.stream;
(*
The address to listen on.
*)
domains : int;
(*
The number of domains to use.
*)
reuse_addr : bool;
reuse_port : bool;

}

val create : 
  ?max_http_version:Versions.HTTP.t ->
  ?https:HTTPS.t ->
  ?h2c_upgrade:bool ->
  ?tcp_nodelay:bool ->
  ?accept_timeout:float ->
  ?shutdown_timeout:float ->
  ?buffer_size:int ->
  ?body_buffer_size:int ->
  ?flush_headers_immediately:bool ->
  ?backlog:int ->
  ?reuse_addr:bool ->
  ?reuse_port:bool ->
  ?domains:int ->
  Eio.Net.Sockaddr.stream ->
  t