elemental.js.html

Class JsWebSocket

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

elemental.js.util.JsElementalBase

elemental.js.dom.JsElementalMixinBase

elemental.js.html.JsWebSocket

All Implemented Interfaces:

ElementalMixinBase, ElementTraversal, NodeSelector, EventTarget, WebSocket, ElementTimeControl, SVGExternalResourcesRequired, SVGFilterPrimitiveStandardAttributes, SVGFitToViewBox, SVGLangSpace, SVGLocatable, SVGStylable, SVGTests, SVGTransformable, SVGURIReference, SVGZoomAndPan, Indexable, IndexableInt, IndexableNumber, Mappable, Settable, SettableInt, SettableNumber

public class JsWebSocket
extends JsElementalMixinBase
implements WebSocket

Field Summary

Fields inherited from interface elemental.html.WebSocket

CLOSED, CLOSING, CONNECTING, OPEN

Fields inherited from interface elemental.svg.SVGZoomAndPan

SVG_ZOOMANDPAN_DISABLE, SVG_ZOOMANDPAN_MAGNIFY, SVG_ZOOMANDPAN_UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JsWebSocket()

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the WebSocket connection or connection attempt, if any.
void	close(int code) Closes the WebSocket connection or connection attempt, if any.
void	close(int code, String reason) Closes the WebSocket connection or connection attempt, if any.
String	getBinaryType() A string indicating the type of binary data being transmitted by the connection.
int	getBufferedAmount() The number of bytes of data that have been queued using calls to but not yet transmitted to the network.
String	getExtensions() The extensions selected by the server.
EventListener	getOnclose() An event listener to be called when the WebSocket connection's readyState changes to CLOSED.
EventListener	getOnerror() An event listener to be called when an error occurs.
EventListener	getOnmessage() An event listener to be called when a message is received from the server.
EventListener	getOnopen() An event listener to be called when the WebSocket connection's readyState changes to OPEN; this indicates that the connection is ready to send and receive data.
String	getProtocol() A string indicating the name of the sub-protocol the server selected; this will be one of the strings specified in the protocols parameter when creating the WebSocket object.
int	getReadyState() The current state of the connection; this is one of the Ready state constants.
String	getUrl() The URL as resolved by the constructor.
String	getURL()
boolean	send(String data) Transmits data to the server over the WebSocket connection.
void	setBinaryType(String param_binaryType)
void	setOnclose(EventListener listener)
void	setOnerror(EventListener listener)
void	setOnmessage(EventListener listener)
void	setOnopen(EventListener listener)

Methods inherited from class elemental.js.dom.JsElementalMixinBase

addEventListener, addEventListener, beginElement, beginElementAt, dispatchEvent, endElement, endElementAt, getAnimatedClassName, getAnimatedHeight, getAnimatedHref, getAnimatedResult, getAnimatedTransform, getAnimatedWidth, getAnimatedX, getAnimatedY, getBBox, getChildElementCount, getCTM, getExternalResourcesRequired, getFarthestViewportElement, getFirstElementChild, getLastElementChild, getNearestViewportElement, getNextElementSibling, getPresentationAttribute, getPreserveAspectRatio, getPreviousElementSibling, getRequiredExtensions, getRequiredFeatures, getScreenCTM, getSvgStyle, getSystemLanguage, getTransformToElement, getViewBox, getXmllang, getXmlspace, getZoomAndPan, hasExtension, querySelector, querySelectorAll, removeEventListener, removeEventListener, setXmllang, setXmlspace, setZoomAndPan

Methods inherited from class elemental.js.util.JsElementalBase

at, at, intAt, intAt, length, numberAt, numberAt, setAt, setAt, setAt, setAt, setAt, setAt

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface elemental.html.WebSocket

addEventListener, addEventListener, dispatchEvent, removeEventListener, removeEventListener

Methods inherited from interface elemental.util.IndexableInt

intAt, length

Methods inherited from interface elemental.util.IndexableNumber

numberAt

Constructor Detail

JsWebSocket

protected JsWebSocket()

Method Detail

getURL

public final String getURL()

Specified by:

getURL in interface WebSocket

getBinaryType

public final String getBinaryType()

Description copied from interface: WebSocket

A string indicating the type of binary data being transmitted by the connection. This should be either "blob" if DOM Blob objects are being used or "arraybuffer" if ArrayBuffer objects are being used.

Specified by:

getBinaryType in interface WebSocket

setBinaryType

public final void setBinaryType(String param_binaryType)

Specified by:

setBinaryType in interface WebSocket

getBufferedAmount

public final int getBufferedAmount()

Description copied from interface: WebSocket

The number of bytes of data that have been queued using calls to but not yet transmitted to the network. This value does not reset to zero when the connection is closed; if you keep calling , this will continue to climb. Read only.

Specified by:

getBufferedAmount in interface WebSocket

getExtensions

public final String getExtensions()

Description copied from interface: WebSocket

The extensions selected by the server. This is currently only the empty string or a list of extensions as negotiated by the connection.

Specified by:

getExtensions in interface WebSocket

getOnclose

public final EventListener getOnclose()

Description copied from interface: WebSocket

An event listener to be called when the WebSocket connection's readyState changes to CLOSED. The listener receives a CloseEvent named "close".

Specified by:

getOnclose in interface WebSocket

setOnclose

public final void setOnclose(EventListener listener)

Specified by:

setOnclose in interface WebSocket

getOnerror

public final EventListener getOnerror()

Description copied from interface: WebSocket

An event listener to be called when an error occurs. This is a simple event named "error".

Specified by:

getOnerror in interface WebSocket

setOnerror

public final void setOnerror(EventListener listener)

Specified by:

setOnerror in interface WebSocket

getOnmessage

public final EventListener getOnmessage()

Description copied from interface: WebSocket

An event listener to be called when a message is received from the server. The listener receives a MessageEvent named "message".

Specified by:

getOnmessage in interface WebSocket

setOnmessage

public final void setOnmessage(EventListener listener)

Specified by:

setOnmessage in interface WebSocket

getOnopen

public final EventListener getOnopen()

Description copied from interface: WebSocket

An event listener to be called when the WebSocket connection's readyState changes to OPEN; this indicates that the connection is ready to send and receive data. The event is a simple one with the name "open".

Specified by:

getOnopen in interface WebSocket

setOnopen

public final void setOnopen(EventListener listener)

Specified by:

setOnopen in interface WebSocket

getProtocol

public final String getProtocol()

Description copied from interface: WebSocket

A string indicating the name of the sub-protocol the server selected; this will be one of the strings specified in the protocols parameter when creating the WebSocket object.

Specified by:

getProtocol in interface WebSocket

getReadyState

public final int getReadyState()

Description copied from interface: WebSocket

The current state of the connection; this is one of the Ready state constants. Read only.

Specified by:

getReadyState in interface WebSocket

getUrl

public final String getUrl()

Description copied from interface: WebSocket

The URL as resolved by the constructor. This is always an absolute URL. Read only.

Specified by:

getUrl in interface WebSocket

close

public final void close()

Description copied from interface: WebSocket

Closes the WebSocket connection or connection attempt, if any. If the connection is already CLOSED, this method does nothing.

Parameters

code Optional

A numeric value indicating the status code explaining why the connection is being closed. If this parameter is not specified, a default value of 1000 (indicating a normal "transaction complete" closure) is assumed. See the list of status codes on the CloseEvent page for permitted values.

reason Optional

A human-readable string explaining why the connection is closing. This string must be no longer than 123 UTF-8 characters.

Exceptions thrown

INVALID_ACCESS_ERR

An invalid code was specified.

SYNTAX_ERR

The reason string is too long or contains unpaired surrogates.

Specified by:

close in interface WebSocket

close

public final void close(int code)

Description copied from interface: WebSocket

Closes the WebSocket connection or connection attempt, if any. If the connection is already CLOSED, this method does nothing.

Parameters

code Optional

A numeric value indicating the status code explaining why the connection is being closed. If this parameter is not specified, a default value of 1000 (indicating a normal "transaction complete" closure) is assumed. See the list of status codes on the CloseEvent page for permitted values.

reason Optional

A human-readable string explaining why the connection is closing. This string must be no longer than 123 UTF-8 characters.

Exceptions thrown

INVALID_ACCESS_ERR

An invalid code was specified.

SYNTAX_ERR

The reason string is too long or contains unpaired surrogates.

Specified by:

close in interface WebSocket

close

public final void close(int code,
         String reason)

Description copied from interface: WebSocket

Closes the WebSocket connection or connection attempt, if any. If the connection is already CLOSED, this method does nothing.

Parameters

code Optional

A numeric value indicating the status code explaining why the connection is being closed. If this parameter is not specified, a default value of 1000 (indicating a normal "transaction complete" closure) is assumed. See the list of status codes on the CloseEvent page for permitted values.

reason Optional

A human-readable string explaining why the connection is closing. This string must be no longer than 123 UTF-8 characters.

Exceptions thrown

INVALID_ACCESS_ERR

An invalid code was specified.

SYNTAX_ERR

The reason string is too long or contains unpaired surrogates.

Specified by:

close in interface WebSocket

send

public final boolean send(String data)

Description copied from interface: WebSocket

Transmits data to the server over the WebSocket connection.

Parameters

data

A text string to send to the server.

Exceptions thrown

INVALID_STATE_ERR

The connection is not currently OPEN.

SYNTAX_ERR

The data is a string that has unpaired surrogates.

Remarks

Gecko 6.0 note

(Firefox 6.0 / Thunderbird 6.0 / SeaMonkey 2.3)

Gecko's implementation of the send() method differs somewhat from the specification in Gecko 6.0; Gecko returns a boolean indicating whether or not the connection is still open (and, by extension, that the data was successfully queued or transmitted); this is corrected in Gecko 8.0 (Firefox 8.0 / Thunderbird 8.0 / SeaMonkey 2.5) . In addition, at this time, Gecko does not support ArrayBuffer or Blob data types.

Specified by:

send in interface WebSocket