package dream-httpaf

  1. Overview
  2. Docs
Internal: shared http/af stack for Dream (server) and Hyper (client)

Install 

dune-project
 Dependency

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

Authors

  1. Anton Bachin

Maintainers

  1. Anton Bachin

Sources

dream-1.0.0-alpha5.tar.gz
sha256=05bc7f6aff94893c151f3a5bcdee3328920c69b3763fac49ba27348dc7745901
md5=de6f6908ae899c9e85f2c751a0263932

doc/dream-httpaf.dream-websocketaf/Dream_websocketaf/Client_connection/index.html

Module Dream_websocketaf.Client_connectionSource

Sourcemodule Headers = Httpaf.Headers
Sourcetype state =
  1. | Handshake of Client_handshake.t
  2. | Websocket of Websocket_connection.t
Sourcetype t = {
  1. mutable state : state;
}
Sourceval passes_scrutiny : status:[> `Switching_protocols ] -> accept:String.t -> Headers.t -> bool
Sourceval handshake_exn : t -> Client_handshake.t
Sourceval connect : nonce:string -> ?headers:Httpaf.Headers.t -> sha1:(string -> string) -> error_handler: ([> `Exn of exn | `Handshake_failure of Httpaf.Response.t * Httpaf.Body.Reader.t | `Invalid_response_body_length of Dream_httpaf___Httpaf.Response.t | `Malformed_response of string ] -> unit) -> websocket_handler:(Wsd.t -> Websocket_connection.input_handlers) -> string -> t
Sourceval next_read_operation : t -> [ `Close | `Read | `Yield ]
Sourceval read : t -> Bigstringaf.t -> off:int -> len:int -> int
Sourceval read_eof : t -> Bigstringaf.t -> off:int -> len:int -> int
Sourceval next_write_operation : t -> [ `Close of int | `Write of Bigstringaf.t Faraday.iovec list | `Yield ]
Sourceval report_write_result : t -> [ `Closed | `Ok of int ] -> unit
Sourceval report_exn : t -> exn -> unit
Sourceval yield_reader : t -> (unit -> unit) -> unit
Sourceval yield_writer : t -> (unit -> unit) -> unit
Sourceval is_closed : t -> bool
Sourceval shutdown : t -> unit