package dream

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

Module Websocketaf.Client_connectionSource

Sourcetype t
Sourcetype error = [
  1. | Httpaf.Client_connection.error
  2. | `Handshake_failure of Httpaf.Response.t * [ `read ] Httpaf.Body.t
]
Sourcetype input_handlers = {
  1. frame : opcode:Websocket.Opcode.t -> is_fin:bool -> Bigstringaf.t -> off:int -> len:int -> unit;
  2. eof : unit -> unit;
}
Sourceval connect : nonce:string -> ?headers:Httpaf.Headers.t -> sha1:(string -> string) -> error_handler:(error -> unit) -> websocket_handler:(Wsd.t -> input_handlers) -> string -> t
Sourceval create : ?error_handler:(Wsd.t -> [ `Exn of exn ] -> unit) -> (Wsd.t -> input_handlers) -> t
Sourceval next_read_operation : t -> [ `Read | `Yield | `Close ]
Sourceval next_write_operation : t -> [ `Write of Bigstringaf.t IOVec.t list | `Yield | `Close of int ]
Sourceval read : t -> Bigstringaf.t -> off:int -> len:int -> int
Sourceval read_eof : t -> Bigstringaf.t -> off:int -> len:int -> int
Sourceval yield_reader : t -> (unit -> unit) -> unit
Sourceval report_write_result : t -> [ `Ok of int | `Closed ] -> unit
Sourceval yield_writer : t -> (unit -> unit) -> unit
Sourceval report_exn : t -> exn -> unit
Sourceval is_closed : t -> bool
Sourceval shutdown : t -> 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