package brr

  1. Overview
  2. Docs
Browser programming toolkit for OCaml

Install 

dune-project
 Dependency

erratique.ch Readme Changelog ISC; BSD-3-Clause License Edit opam file Versions (3)

Authors

  1. T
    The brr programmers

Maintainers

  1. Daniel Bünzli

Sources

brr-0.0.9.tbz
sha512=45cdf73c6a23c8fc4609a32ae2196d4790e5bdba34ca0b784bff9c0b70dab233eb336f1c11dc3002451042ff4cf25b643098ad0d011f14c3d6175842113bed21

doc/brr/Brr_io/Websocket/index.html

Module Brr_io.WebsocketSource

Websocket objects.

See Web Sockets API.

XXX Add a bit of future convenience.

Sourcemodule Binary_type : sig ... end

Binary type enum.

Sourcemodule Ready_state : sig ... end

Ready state enum.

Sourcetype t

The type for WebSocket objects.

Sourceval create : ?protocols:Jv.Jstr.t list -> Jstr.t -> t

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

Sourceval as_target : t -> Brr.Ev.target

as_target s is s as an event target.

Sourceval binary_type : t -> Binary_type.t

binary_type s is the type of binary data received.

Sourceval set_binary_type : t -> Binary_type.t -> unit

set_binary_type s t sets the binary_type of s to t.

Sourceval close : ?code:int -> ?reason:Jstr.t -> t -> unit

close s closes s.

Properties

Sourceval url : t -> Jstr.t

url s is the url of s.

Sourceval ready_state : t -> Ready_state.t

ready_state s is the state of the connection.

Sourceval buffered_amount : t -> int

buffered_amount s is the sent buffered amount of s.

Sourceval extensions : t -> Jstr.t

extensions s are the extensions selected by the server.

Sourceval protocol : t -> Jstr.t

protocol s is the protocol selected by the server.

Sending

Sourceval send_string : t -> Jstr.t -> unit

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

Sourceval send_blob : t -> Brr.Blob.t -> unit

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

Sourceval send_array_buffer : t -> Brr.Tarray.Buffer.t -> unit

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

Sourceval send_tarray : t -> ('a, 'b) Brr.Tarray.t -> unit

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

Events

Sourcemodule Ev : sig ... end

Websocket events.