package dream-httpaf

You can search for identifiers within the package.

in-package search v0.2.0

Internal: shared http/af stack for Dream (server) and Hyper (client)

Install

Dune Dependency

github.com Readme MIT License Edit opam file Versions (4)

Authors

Anton Bachin

Maintainers

Anton Bachin

Sources

dream-1.0.0-alpha5.tar.gz

sha256=05bc7f6aff94893c151f3a5bcdee3328920c69b3763fac49ba27348dc7745901

md5=de6f6908ae899c9e85f2c751a0263932

doc/dream-httpaf.dream-httpaf_/Dream_httpaf_/Httpaf/Body/Reader/index.html

Module `Body.Reader`Source

Sourcetype t

Source

val schedule_read : 
  t ->
  on_eof:(unit -> unit) ->
  on_read:(Bigstringaf.t -> off:int -> len:int -> unit) ->
  unit

schedule_read t ~on_eof ~on_read will setup on_read and on_eof as callbacks for when bytes are available in t for the application to consume, or when the input channel has been closed and no further bytes will be received by the application.

Once either of these callbacks have been called, they become inactive. The application is responsible for scheduling subsequent reads, either within the on_read callback or by some other mechanism.

Sourceval close : t -> unit

close t closes t, indicating that any subsequent input received should be discarded.

Sourceval is_closed : t -> bool

is_closed t is true if close has been called on t and false otherwise. A closed t may still have bytes available for reading.