package piaf

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package piaf

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
    
    Client_runtime
  - Server
    
    Server_runtime
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
    
    Client_runtime
  - Server
    
    Server_runtime
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

Parameters

module Client_runtime : Gluten_lwt.Client

Signature

type socket = Client_runtime.socket

type runtime = Client_runtime.t

type t = {

connection : H2.Client_connection.t;
runtime : runtime;

}

val create_connection : 
  ?config:H2.Config.t ->
  ?push_handler:
    (H2.Request.t -> (H2.Client_connection.response_handler, unit) result) ->
  error_handler:H2.Client_connection.error_handler ->
  socket ->
  t Lwt.t

val request : 
  t ->
  ?trailers_handler:H2.Client_connection.trailers_handler ->
  H2.Request.t ->
  error_handler:H2.Client_connection.error_handler ->
  response_handler:H2.Client_connection.response_handler ->
  [ `write ] H2.Body.t

val ping : t -> ?payload:Bigstringaf.t -> ?off:int -> (unit -> unit) -> unit

val shutdown : t -> unit Lwt.t

val is_closed : t -> bool