• index
• goog
• net
• search: Go

The goog.net.WebSocket Class

goog.net.WebSocket
> goog.events.EventTarget
> goog.Disposable

goog.net.WebSocket(opt_autoReconnect, opt_getNextReconnect)

Class encapsulating the logic for using a WebSocket.

opt_autoReconnect {boolean=}

True if the web socket should automatically reconnect or not. This is true by default.

opt_getNextReconnect {function(number):number=}

A function for obtaining the time until the next reconnect attempt. Given the reconnect attempt count (which is a positive integer), the function should return a positive integer representing the milliseconds to the next reconnect attempt. The default function used is an exponential back-off. Note that this function is never called if auto reconnect is disabled.

The goog.net.WebSocket.ErrorEvent Class

Object representing an error event. This is fired whenever an error occurs on the web socket. … more

The goog.net.WebSocket.EventType Enum

The events fired by the web socket. … more

The goog.net.WebSocket.MessageEvent Class

Object representing a new incoming message event. … more

.addEventListener(type, handler, opt_capture, opt_handlerScope)

Inherited from goog.events.EventTarget .

Adds an event listener to the event target. The same handler can only be added once per the type. Even if you add the same handler multiple times using the same type then it will only be called once when the event is dispatched. Supported for legacy but use goog.events.listen(src, type, handler) instead.

type {string}

The type of the event to listen for.

handler {Function|Object}

The function to handle the event. The handler can also be an object that implements the handleEvent method which takes the event object as argument.

opt_capture {boolean=}

In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.

opt_handlerScope {Object=}

Object in whose scope to call the listener.

.addOnDisposeCallback(callback, opt_scope)

Inherited from goog.Disposable .

Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added.

callback {!Function}

The callback function.

opt_scope {Object=}

An optional scope to call the callback in.

.close()

Closes the web socket connection.

.creationStack {string}

Inherited from goog.Disposable .

If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.

.dispatchEvent(e)

Inherited from goog.events.EventTarget .

Dispatches an event (or event like object) and calls all listeners listening for events of this type. The type of the event is decided by the type property on the event object. If any of the listeners returns false OR calls preventDefault then this function will return false. If one of the capture listeners calls stopPropagation, then the bubble listeners won't fire.

e {string|Object|goog.events.Event}

Event object.

returns {boolean}

If anyone called preventDefault on the event object (or if any of the handlers returns false this will also return false.

.dispose()

Inherited from goog.Disposable .

Disposes of the object. If the object hasn't already been disposed of, calls {@link #disposeInternal}. Classes that extend {@code goog.Disposable} should override {@link #disposeInternal} in order to delete references to COM objects, DOM nodes, and other disposable objects. Reentrant.

returns {void}

Nothing.

MyClass.prototype.disposeInternal = function() {
  MyClass.superClass_.disposeInternal.call(this);
  // Dispose logic for MyClass
};

.getParentEventTarget()

Inherited from goog.events.EventTarget .

Returns the parent of this event target to use for bubbling.

returns {goog.events.EventTarget}

The parent EventTarget or null if there is no parent.

.isDisposed()

Inherited from goog.Disposable .

returns {boolean}

Whether the object has been disposed of.

.isOpen()

Checks to see if the web socket is open or not.

returns {boolean}

True if the web socket is open, false otherwise.

.open(url, opt_protocol)

Creates and opens the actual WebSocket. Only call this after attaching the appropriate listeners to this object. If listeners aren't registered, then the {@code goog.net.WebSocket.EventType.OPENED} event might be missed.

url {string}

The URL to which to connect.

opt_protocol {string=}

The subprotocol to use. The connection will only be established if the server reports that it has selected this subprotocol. The subprotocol name must all be a non-empty ASCII string with no control characters and no spaces in them (i.e. only characters in the range U+0021 to U+007E).

.protectEntryPoints(errorHandler)

Installs exception protection for all entry points introduced by goog.net.WebSocket instances which are not protected by {@link goog.debug.ErrorHandler#protectWindowSetTimeout}, {@link goog.debug.ErrorHandler#protectWindowSetInterval}, or {@link goog.events.protectBrowserEventEntryPoint}.

errorHandler {!goog.debug.ErrorHandler}

Error handler with which to protect the entry points.

.registerDisposable(disposable)

Inherited from goog.Disposable .

Associates a disposable object with this object so that they will be disposed together.

disposable {goog.disposable.IDisposable}

that will be disposed when this object is disposed.

.removeEventListener(type, handler, opt_capture, opt_handlerScope)

Inherited from goog.events.EventTarget .

Removes an event listener from the event target. The handler must be the same object as the one added. If the handler has not been added then nothing is done.

type {string}

The type of the event to listen for.

handler {Function|Object}

The function to handle the event. The handler can also be an object that implements the handleEvent method which takes the event object as argument.

opt_capture {boolean=}

In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.

opt_handlerScope {Object=}

Object in whose scope to call the listener.

.send(message)

Sends the message over the web socket.

message {string}

The message to send.

.setParentEventTarget(parent)

Inherited from goog.events.EventTarget .

Sets the parent of this event target to use for bubbling.

parent {goog.events.EventTarget?}

Parent EventTarget (null if none).

Documentation generated using JvJsDoc, version 0.5 on 2012-09-03.