package dream-httpaf

  1. Overview
  2. Docs
package dream-httpaf
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

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. mode : mode;
  3. mutable wakeup : Optional_thunk.t;
  4. error_handler : error_handler;
  5. 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 -> ?is_fin:bool -> kind:[< Websocket.Opcode.t ] -> Bigstringaf.t -> off:int -> len:int -> unit
Sourceval send_bytes : t -> ?is_fin:bool -> kind:[< Websocket.Opcode.t ] -> Bytes.t -> off:int -> len:int -> unit
Sourceval send_ping : ?application_data:Bigstringaf.t IOVec.t -> t -> unit
Sourceval send_pong : ?application_data:Bigstringaf.t IOVec.t -> 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.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct