WebSocket Interface Reference

import"WebSocket.idl";

Inheritance diagram for WebSocket:

Public Member Functions
void	send (ArrayBuffer data)
void	send (ArrayBufferView data)
void	send (Blob data)
void	send (USVString data)
void	close ([Clamp] optional unsigned short code, optional DOMString reason)
Public Member Functions inherited from EventTarget
void	addEventListener ([AtomicString] DOMString type, EventListener? callback, optional(AddEventListenerOptions or boolean) options=false)
void	removeEventListener ([AtomicString] DOMString type, EventListener? callback, optional(EventListenerOptions or boolean) options=false)
boolean	dispatchEvent (Event event)

Public Attributes
readonly attribute USVString	URL
readonly attribute USVString	url
const unsigned short	CONNECTING = 0
const unsigned short	OPEN = 1
const unsigned short	CLOSING = 2
const unsigned short	CLOSED = 3
readonly attribute unsigned short	readyState
readonly attribute unsigned long	bufferedAmount
attribute EventHandler	onopen
attribute EventHandler	onmessage
attribute EventHandler	onerror
attribute EventHandler	onclose
readonly attribute DOMString	protocol
readonly attribute DOMString	extensions
attribute DOMString	binaryType

Member Function Documentation

close()

void WebSocket::close	(	[Clamp] optional unsigned short	code,
		optional DOMString	reason
	)

send() [1/4]

void WebSocket::send

(

ArrayBuffer

data

)

send() [2/4]

void WebSocket::send

(

ArrayBufferView

data

)

send() [3/4]

void WebSocket::send

(

Blob

data

)

send() [4/4]

void WebSocket::send

(

USVString

data

)

Member Data Documentation

binaryType

attribute DOMString WebSocket::binaryType

bufferedAmount

readonly attribute unsigned long WebSocket::bufferedAmount

CLOSED

const unsigned short WebSocket::CLOSED = 3

CLOSING

const unsigned short WebSocket::CLOSING = 2

CONNECTING

const unsigned short WebSocket::CONNECTING = 0

extensions

readonly attribute DOMString WebSocket::extensions

onclose

attribute EventHandler WebSocket::onclose

onerror

attribute EventHandler WebSocket::onerror

onmessage

attribute EventHandler WebSocket::onmessage

onopen

attribute EventHandler WebSocket::onopen

OPEN

const unsigned short WebSocket::OPEN = 1

protocol

readonly attribute DOMString WebSocket::protocol

readyState

readonly attribute unsigned short WebSocket::readyState

URL

readonly attribute USVString WebSocket::URL

url

readonly attribute USVString WebSocket::url

---

The documentation for this interface was generated from the following file:

• Source/WebCore/Modules/websockets/WebSocket.idl