Class WebSocket

WebSocket provides a bidirectional communication channel. Application developers should use WebSocketFactory#createWebSocket() function to create an instance of WebSocket.

binaryType

String binaryType

Type of binary data for message events. Valid values are "blob", "arraybuffer" and "bytebuffer". Blob and ByteBuffer will work on any supported browser. ArrayBuffer is only an allowable value on browsers that support the Typed Array Specification . If this property is set to an invalid type, a SyntaxError will be thrown. NOTE: On older platforms where setter cannot be defined, the value is checked onmessage is fired. If set to an invalid value, the error event is fired.

bufferedAmount

Number bufferedAmount

(Read only) Number of bytes that are queued to send but not yet written to the network.

connectTimeout

Number(Integer) connectTimeout

(Read only) Connect timeout in milliseconds. The timeout will expire if there is no exchange of packets(for example, 100% packet loss) while establishing the connection. A timeout value of zero indicates no timeout.

extensions

String extensions

Extensions chosen by the server during the connection handshake. If the connection has not yet been established, or if no extensions were selected, this property will be the empty string.

onclose

Function onclose

CloseEvent handler property. See CloseEvent.

onerror

Function onerror

ErrorEvent handler property.

onmessage

Function onmessage

MessageEvent handler property. See MessageEvent.

onopen

Function onopen

Event fired when the WebSocket connection opens.

protocol

String protocol

Protocol name selected by the WebSocket server during the connection handshake.

readyState

Number readyState

(Read only) State of the connection. It can be one of the following constants -

CONNECTING(0): The connection is not yet open.
OPEN(1): The connection is open and ready to communicate.
CLOSING(2): The connection is in the process of closing.
CLOSED(3): The connection is closed or couldn't be opened.

url

String url

(Read only) The location of the WebSocket.

WebSocket

WebSocket(url, protocols)

Creates and immedately connects a new WebSocket instance.. If the url is not valid, the constructor will throw a SyntaxError. If the port is blocked by the browser or if a secure connection is attemped from a non-secure origin, the constructor will throw a SecurityException. If any protocol value is invalid or if a protocol appears in the Array more than once, the constructor will throw a SyntaxError. Application developers should use WebSocketFactory.createWebSocket function to create an instance of WebSocket.

Parameters:
url - {String}
protocols - {String|String[]}

close

void void close(code, reason)

Disconnects the WebSocket. If code is not an integer equal to 1000 or in the range 3000..4999, close() will throw an InvalidAccessError. The reason string must be at most 123 bytes when UTF-8 encoded. If the reason string is too long, close() will throw a SyntaxError.

Parameters:
code - {Number} (Optional) A numeric value indicating close code.
reason - {String} (Optional) A human readable string indicating why the client is closing the WebSocket

Returns:
void 
void 

getChallengeHandler

ChallengeHandler getChallengeHandler()

Gets the ChallengeHandler that is used during authentication both at the connect-time as well as at subsequent revalidation-time that occurs at regular intervals.

Returns:
ChallengeHandler 

getRedirectPolicy

HttpRedirectPolicy getRedirectPolicy()

Gets the default HTTP redirect policy used in a clustered environment for this connection. Default redirect policy is HttpRedirectPolicy.ALWAYS.

Returns:
HttpRedirectPolicy 

send

void send(data)

Sends a WebSocket message containing the given payload. Can be called with a String, Blob, ArrayBuffer or ByteBuffer. When send() is called with a String, a text WebSocket message is sent. When send() is called with a Blob, ArrayBuffer or ByteBuffer, a binary WebSocket message is sent. If send() is called with other data types, an invalid type Error will be thrown. If send() is called while the WebSocket is in the CONNECTING state, an InvalidStateError will be thrown.

Parameters:
data - {String|Blob|ArrayBuffer|ByteBuffer} message payload

Returns:
void 

setChallengeHandler

void setChallengeHandler(challengeHandler)

Sets the ChallengeHandler that is used during authentication both at the connect-time as well as at subsequent revalidation-time that occurs at regular intervals.

Parameters:
challengeHandler - {ChallengeHandler} used for authentication

Returns:
void 

setRedirectPolicy

void setRedirectPolicy(redirectPolicy)

Sets the HTTP redirect policy used in a clustered environment for this connection. Overrides the redirect policy inherited from WebSocketFactory.

Parameters:
redirectPolicy - {HttpRedirectPolicy} HTTP redirect policy

Returns:
void 

close

close()

Event fired when the WebSocket connection closes. See CloseEvent.

error

error()

Event fired when the WebSocket closes uncleanly.

message

message()

Event fired when a WebSocket message arrives. The data property of the MessageEvent will be a String when the WebSocket message is a WebSocket text message. It will be the type specified by binaryType if the message is a WebSocket binary message.

open

open()

Event fired when the WebSocket connection opens.