httpaf 0.4.1 · OCaml Package

module Config : sig ... end

type 'handle t

type error = [

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

]

type 'handle request_handler = 'handle Reqd.t -> unit

type error_handler =
  ?request:Request.t ->
  error ->
  (Headers.t -> [ `write ] Body.t) ->
  unit

val create : 
  ?config:Config.t ->
  ?error_handler:error_handler ->
  'handle request_handler ->
  'handle t

create ?config ?error_handler ~request_handler creates a connection handler that will service individual requests with request_handler.

val next_read_operation : _ t -> [ `Read | `Yield | `Close ]

next_read_operation t returns a value describing the next operation that the caller should conduct on behalf of the connection.

val read : _ t -> Bigstring.t -> off:int -> len:int -> int

read t bigstring ~off ~len reads bytes of input from the provided range of bigstring and returns the number of bytes consumed by the connection. read should be called after next_read_operation returns a `Read value and additional input is available for the connection to consume.

val yield_reader : _ t -> (unit -> unit) -> unit

yield_reader t continue registers with the connection to call continue when reading should resume. yield_reader should be called after next_read_operation returns a `Yield value.

val shutdown_reader : _ t -> unit

shutdown_reader t shuts down the read processor for the connection. All subsequent calls to next_read_operations will return `Close. shutdown_reader should be called after next_read_operation returns a `Read value and there is no further input available for the connection to consume.

val next_write_operation : 
  _ t ->
  [ `Write of Bigstring.t IOVec.t list | `Yield | `Close of int ]

next_write_operation t returns a value describing the next operation that the caller should conduct on behalf of the connection.

val report_write_result : _ t -> [ `Ok of int | `Closed ] -> unit

report_write_result t result reports the result of the latest write attempt to the connection. report_write_result should be called after a call to next_write_operation that returns a `Write buffer value.

`Ok n indicates that the caller successfully wrote n bytes of output from the buffer that the caller was provided by next_write_operation.
`Closed indicates that the output destination will no longer accept bytes from the write processor.

val yield_writer : _ t -> (unit -> unit) -> unit

yield_writer t continue registers with the connection to call continue when writing should resume. yield_writer should be called after next_write_operation returns a `Yield value.

val report_exn : _ t -> exn -> unit

report_exn t exn reports that an error exn has been caught and that it has been attributed to t. Calling this function will switch t into an error state. Depending on the state t is transitioning from, it may call its error handler before terminating the connection.

val is_closed : _ t -> bool

is_closed t is true if both the read and write processors have been shutdown. When this is the case next_read_operation will return `Close _ and next_write_operation will do the same will return a `Write _ until all buffered output has been flushed.

val error_code : _ t -> error option

error_code t returns the error_code that caused the connection to close, if one exists.

package httpaf