package dream-httpaf

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

Install

Dune Dependency

Authors

Maintainers

Sources

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

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

Module Dream_websocketaf.WsdSource

Sourcemodule IOVec = Httpaf.IOVec
Sourcetype error = [
  1. | `Exn of exn
]
Sourcetype mode = [
  1. | `Client of unit -> int32
  2. | `Server
]
Sourcetype t = {
  1. faraday : Faraday.t;
  2. mutable bytes_sent : int;
  3. mode : mode;
  4. mutable wakeup : Optional_thunk.t;
  5. error_handler : error_handler;
  6. mutable error_code : [ `Ok | error ];
}
Sourceand error_handler = t -> error -> unit
Sourceval default_ready_to_write : unit -> unit
Sourceval create : error_handler:error_handler -> mode -> t
Sourceval mask : t -> int32 option
Sourceval is_closed : t -> bool
Sourceval on_wakeup : t -> (unit -> unit) -> unit
Sourceval wakeup : t -> unit
Sourceval schedule : t -> kind:[< Websocket.Opcode.t ] -> Bigstringaf.t -> off:int -> len:int -> unit
Sourceval send_bytes : t -> kind:[< Websocket.Opcode.t ] -> Bytes.t -> off:int -> len:int -> unit
Sourceval send_ping : t -> unit
Sourceval send_pong : t -> unit
Sourceval flushed : t -> (unit -> unit) -> unit
Sourceval close : ?code: [< `Abnormal_closure | `Going_away | `Internal_server_error | `Invalid_frame_payload_data | `Mandatory_ext | `Message_too_big | `No_status_rcvd | `Normal_closure | `Other of int | `Policy_violation | `Protocol_error | `TLS_handshake | `Unsupported_data ] -> t -> unit
Sourceval error_code : t -> [> `Exn of exn ] option
Sourceval report_error : t -> error -> unit
Sourceval next : t -> [> `Close of int | `Write of Faraday.bigstring Faraday.iovec list | `Yield ]
Sourceval report_result : t -> [< `Closed | `Ok of int ] -> unit
OCaml

Innovation. Community. Security.