package httpaf_caged

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Request Descriptor
1. Exception Handling

httpaf_caged
- Httpaf_caged
  - Accept
  - Body
  - Client_connection
  - Config
  - Cookie
  - Headers
  - IOVec
  - Method
  - Reqd
  - Request
  - Response
  - Server
    
    Response_body
  - Server_connection
  - Status
  - Version

Legend:
Library
Module
Module type
Parameter
Class
Class type

Request Descriptor

type t

val request : t -> Request.t

val request_body : t -> [ `read ] Httpaf.Body.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 ->
  [ `write ] Httpaf.Body.t

Exception Handling

val report_exn : t -> exn -> unit

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