Module `Brr_io.Websocket`

Websocket objects.

XXX Add a bit of future convenience.

module Binary_type : sig ... end

Binary type enum.

module Ready_state : sig ... end

Ready state enum.

type t

The type for WebSocket objects.

val create : ?protocols:Jv.Jstr.t list -> Jstr.t -> Brr_io.Websocket.t

create ~protocols url creates a new socket connected to url.

val as_target : Brr_io.Websocket.t -> Brr.Ev.target

as_target s is s as an event target.

val binary_type : Brr_io.Websocket.t -> Brr_io.Websocket.Binary_type.t

binary_type s is the type of binary data received.

val set_binary_type : 
  Brr_io.Websocket.t ->
  Brr_io.Websocket.Binary_type.t ->
  unit

set_binary_type s t sets the binary_type of s to t.

val close : ?code:int -> ?reason:Jstr.t -> Brr_io.Websocket.t -> unit

close s closes s.

Properties

val url : Brr_io.Websocket.t -> Jstr.t

url s is the url of s.

val ready_state : Brr_io.Websocket.t -> Brr_io.Websocket.Ready_state.t

ready_state s is the state of the connection.

val buffered_amount : Brr_io.Websocket.t -> int

buffered_amount s is the sent buffered amount of s.

val extensions : Brr_io.Websocket.t -> Jstr.t

extensions s are the extensions selected by the server.

val protocol : Brr_io.Websocket.t -> Jstr.t

protocol s is the protocol selected by the server.

val send_string : Brr_io.Websocket.t -> Jstr.t -> unit

send_string s d sends the UTF-8 encoding of d on s.

val send_blob : Brr_io.Websocket.t -> Brr.Blob.t -> unit

send_blob s d sends the binary content of d on s.

val send_array_buffer : Brr_io.Websocket.t -> Brr.Tarray.Buffer.t -> unit

send_blob s d sends the binary content of d on s.

val send_tarray : Brr_io.Websocket.t -> ('a, 'b) Brr.Tarray.t -> unit

send_blob s d sends the binary content of d on s.

module Ev : sig ... end

Websocket events.

val to_jv : Brr_io.Websocket.t -> Jv.jv

val of_jv : Jv.jv -> Brr_io.Websocket.t