package dream-httpaf

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Request Descriptor
1. Exception Handling

dream-httpaf
- Dream_httpaf
  - Websocket
dream-httpaf.gluten
- Gluten
  - Client
  - RUNTIME
  - Reqd
  - Server
dream-httpaf.gluten-lwt
- Gluten_lwt
  - Client
    
    Io
  - IO
  - Server
    
    Io
dream-httpaf.gluten-lwt-unix
- Gluten_lwt_unix
  - Client
    
    SSL
    
    TLS
  - Server
    
    SSL
    
    TLS
dream-httpaf.h2
- H2
  - Body
  - Client_connection
  - Config
  - Error_code
  - Headers
  - IOVec
  - Method
  - Reqd
  - Request
  - Response
  - Server_connection
  - Settings
  - Status
dream-httpaf.h2-lwt
- H2_lwt
  - Client
    
    Client_runtime
  - Server
    
    Server_runtime
dream-httpaf.h2-lwt-unix
- H2_lwt_unix
  - Client
    
    SSL
    
    TLS
  - Server
    
    SSL
    
    TLS
dream-httpaf.hpack
- Hpack
  - Decoder
  - Encoder
dream-httpaf.httpaf
- Httpaf
  - Body
    
    Reader
    
    Writer
  - Client_connection
  - Config
  - Headers
  - IOVec
  - Method
  - Reqd
  - Request
    
    Body_length
  - Response
    
    Body_length
  - Server_connection
  - Status
  - Version
dream-httpaf.httpaf-lwt
- Httpaf_lwt
  - Client
    
    Client_runtime
  - Server
    
    Server_runtime
dream-httpaf.httpaf-lwt-unix
- Httpaf_lwt_unix
  - Client
    
    SSL
    
    TLS
  - Server
    
    SSL
    
    TLS
dream-httpaf.websocketaf
- Websocketaf
  - Client_connection
  - Handshake
  - Payload
  - Server_connection
  - Websocket
    
    Close_code
    
    Frame
    
    Opcode
  - Wsd
dream-httpaf.websocketaf-lwt
- Websocketaf_lwt
  - Client
    
    Client_runtime
  - Server
    
    Server_runtime
dream-httpaf.websocketaf-lwt-unix
- Websocketaf_lwt_unix
  - Client
  - Server

Legend:
Library
Module
Module type
Parameter
Class
Class type

Request Descriptor

type t

type error = [

| `Bad_request
| `Bad_gateway
| `Internal_server_error
| `Exn of exn

]

val request : t -> Request.t

val request_body : t -> Body.Reader.t

val response : t -> Response.t option

val response_exn : t -> Response.t

Responding

The following functions will initiate a response for the corresponding request in t. Depending on the state of the current connection, and the header values of the response, this may cause the connection to close or to persist for reuse by the client.

See RFC7230§6.3 for more details.

val respond_with_string : t -> Response.t -> string -> unit

val respond_with_bigstring : t -> Response.t -> Bigstringaf.t -> unit

val respond_with_streaming : 
  ?flush_headers_immediately:bool ->
  t ->
  Response.t ->
  Body.Writer.t

val respond_with_upgrade : t -> Headers.t -> (unit -> unit) -> unit

Exception Handling

val error_code : t -> error option

val report_exn : t -> exn -> unit

val try_with : t -> (unit -> unit) -> (unit, exn) Result.result