Module `Httpaf.Client_connection`Source

Sourcetype t

Sourcetype error = [

| `Malformed_response of string
| `Invalid_response_body_length of Response.t
| `Exn of exn

]

Sourcetype response_handler = Response.t -> [ `read ] Body.t -> unit

Sourcetype error_handler = error -> unit

val request : 
  Request.t ->
  error_handler:error_handler ->
  response_handler:response_handler ->
  [ `write ] Body.t * t

Sourceval next_read_operation : t -> [ `Read of Bigstring.t | `Close ]

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

Sourceval report_read_result : t -> [ `Ok of int | `Eof ] -> unit

report_read_result t result reports the result of the latest read attempt to the connection. report_read_result should be called after a call to next_read_operation that returns a `Read buffer value.

`Ok n indicates that the caller successfully received n bytes of input and wrote them into the the read buffer that the caller was provided by next_read_operation.
`Eof indicates that the input source will no longer provide any bytes to the read processor.

Source

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.

Sourceval 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.

Sourceval 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.

Sourceval 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 swithc t into an error state. Depending on the state t is transitioning from, it may call its error handler before terminating the connection.

Sourceval is_closed : t -> bool

package httpaf

Module Httpaf.Client_connectionSource

Module `Httpaf.Client_connection`Source