package httpun-ws

  1. Overview
  2. Docs
type mode = [
  1. | `Client of unit -> int32
  2. | `Server
]
type t
val schedule : t -> ?is_fin:bool -> kind:[ `Text | `Binary | `Continuation ] -> Bigstringaf.t -> off:int -> len:int -> unit

is_fin defaults to true. Set to `false` if sending multiple frames, except on the last one. NOTE: this function mutates the bigarray on clients due to the WebSocket protocol masking requirements.

val send_bytes : t -> ?is_fin:bool -> kind:[ `Text | `Binary | `Continuation ] -> Bytes.t -> off:int -> len:int -> unit

is_fin defaults to true. Set to `false` if sending multiple frames, except on the last one. NOTE: this function mutates the `bytes` argument on clients due to the WebSocket protocol masking requirements.

val send_ping : ?application_data:Bigstringaf.t IOVec.t -> t -> unit
val send_pong : ?application_data:Bigstringaf.t IOVec.t -> t -> unit
val flushed : t -> (unit -> unit) -> unit
val close : ?code:Websocket.Close_code.t -> t -> unit
val is_closed : t -> bool
val error_code : t -> [> `Exn of exn ] option
OCaml

Innovation. Community. Security.