File: webSockets.mli

package info (click to toggle)
js-of-ocaml 4.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 7,372 kB
  • sloc: ml: 70,468; javascript: 8,238; ansic: 319; makefile: 217; lisp: 23; sh: 6; perl: 4
file content (100 lines) | stat: -rw-r--r-- 2,961 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
(* Js_of_ocaml library
 * http://www.ocsigen.org/js_of_ocaml/
 * Copyright (C) 2012 Jacques-Pascal Deplaix
 * Laboratoire PPS - CNRS Université Paris Diderot
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, with linking exception;
 * either version 2.1 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *)

(** WebSocket binding *)

type readyState =
  | CONNECTING
  | OPEN
  | CLOSING
  | CLOSED

class type ['a] closeEvent =
  object
    inherit ['a] Dom.event

    method code : int Js.readonly_prop

    method reason : Js.js_string Js.t Js.readonly_prop

    method wasClean : bool Js.t Js.readonly_prop
  end

class type ['a] messageEvent =
  object
    inherit ['a] Dom.event

    method data : Js.js_string Js.t Js.readonly_prop

    method data_buffer : Typed_array.arrayBuffer Js.t Js.readonly_prop

    method data_blob : File.blob Js.t Js.readonly_prop
  end

class type webSocket =
  object ('self)
    inherit Dom_html.eventTarget

    method url : Js.js_string Js.t Js.readonly_prop

    method readyState : readyState Js.readonly_prop

    method bufferedAmount : int Js.readonly_prop

    method onopen :
      ('self Js.t, 'self Dom.event Js.t) Dom.event_listener Js.writeonly_prop

    method onclose :
      ('self Js.t, 'self closeEvent Js.t) Dom.event_listener Js.writeonly_prop

    method onerror :
      ('self Js.t, 'self Dom.event Js.t) Dom.event_listener Js.writeonly_prop

    method extensions : Js.js_string Js.t Js.readonly_prop

    method protocol : Js.js_string Js.t Js.readonly_prop

    method close : unit Js.meth

    method close_withCode : int -> unit Js.meth

    method close_withCodeAndReason : int -> Js.js_string Js.t -> unit Js.meth

    method onmessage :
      ('self Js.t, 'self messageEvent Js.t) Dom.event_listener Js.writeonly_prop

    method binaryType : Js.js_string Js.t Js.prop

    method send : Js.js_string Js.t -> unit Js.meth

    method send_buffer : Typed_array.arrayBuffer Js.t -> unit Js.meth

    method send_blob : File.blob Js.t -> unit Js.meth
  end

val webSocket : (Js.js_string Js.t -> webSocket Js.t) Js.constr

val webSocket_withProtocol :
  (Js.js_string Js.t -> Js.js_string Js.t -> webSocket Js.t) Js.constr

val webSocket_withProtocols :
  (Js.js_string Js.t -> Js.js_string Js.t Js.js_array Js.t -> webSocket Js.t) Js.constr

val is_supported : unit -> bool