goog.Disposable | |
goog.events.EventTarget | goog.Disposable |
goog.net.WebSocket | goog.events.EventTarget |
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.
|
![]()
Clears the reconnect timer.
|
code » | |||
![]()
Closes the web socket connection.
|
code » | |||
![]()
No description.
|
code » | |||
![]()
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.
|
code » | |||
Checks to see if the web socket is open or not.
Returns: boolean
True if the web socket is open, false otherwise.
|
code » | |||
![]()
Called when the web socket has closed.
Arguments:
|
code » | |||
![]()
Called when there is any error in communication.
Arguments:
|
code » | |||
![]()
Called when a new message arrives from the server.
Arguments:
|
code » | |||
![]()
Called when the web socket has connected.
|
code » | |||
![]()
Creates and opens the actual WebSocket. Only call this after attaching the
appropriate listeners to this object. If listeners aren't registered, then
the
goog.net.WebSocket.EventType.OPENED event might be missed.
Arguments:
|
code » | |||
![]()
Sends the message over the web socket.
Arguments:
|
code » |
![]()
Use
#listen instead, when possible. Otherwise, use
goog.events.listen if you are passing Object
(instead of Function) as handler.
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.
Arguments:
|
code » | |||||
![]()
Asserts that the event target instance is initialized properly.
|
code » | |||||
![]()
No description.
|
code » | |||||
![]()
Removes listeners from this object. Classes that extend EventTarget may
need to override this method in order to remove references to DOM Elements
and additional listeners.
|
code » | |||||
![]()
No description.
|
code » | |||||
![]()
No description.
|
code » | |||||
![]()
No description.
|
code » | |||||
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.
|
code » | |||||
![]()
No description.
|
code » | |||||
![]()
No description.
|
code » | |||||
![]()
No description.
|
code » | |||||
![]()
No description.
|
code » | |||||
![]()
Use
#unlisten instead, when possible. Otherwise, use
goog.events.unlisten if you are passing Object
(instead of Function) as handler.
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.
Arguments:
|
code » | |||||
![]()
Sets the parent of this event target to use for capture/bubble
mechanism.
Arguments:
|
code » | |||||
![]()
Sets the target to be used for
event.target when firing
event. Mainly used for testing. For example, see
goog.testing.events.mixinListenable .
Arguments:
|
code » | |||||
![]()
No description.
|
code » | |||||
![]()
No description.
|
code » |
![]()
Invokes a callback function when this object is disposed. Callbacks are
invoked in the order in which they were added.
Arguments:
|
code » | |||
![]()
Disposes of the object. If the object hasn't already been disposed of, calls
#disposeInternal . Classes that extend goog.Disposable should
override #disposeInternal in order to delete references to COM
objects, DOM nodes, and other disposable objects. Reentrant.
Returns: void
Nothing.
|
code » | |||
![]()
Deletes or nulls out any references to COM objects, DOM nodes, or other
disposable objects. Classes that extend
goog.Disposable should
override this method.
Not reentrant. To avoid calling it twice, it must only be called from the
subclass' disposeInternal method. Everywhere else the public
dispose method must be used.
For example:
mypackage.MyClass = function() { mypackage.MyClass.base(this, 'constructor'); // Constructor logic specific to MyClass. ... }; goog.inherits(mypackage.MyClass, goog.Disposable); mypackage.MyClass.prototype.disposeInternal = function() { // Dispose logic specific to MyClass. ... // Call superclass's disposeInternal at the end of the subclass's, like // in C++, to avoid hard-to-catch issues. mypackage.MyClass.base(this, 'disposeInternal'); }; |
code » | |||
Use
#isDisposed instead.
No description.
Returns: boolean
Whether the object has been disposed of.
|
code » | |||
No description.
Returns: boolean
Whether the object has been disposed of.
|
code » | |||
![]()
Associates a disposable object with this object so that they will be disposed
together.
Arguments:
|
code » |
![]()
True if the web socket should automatically reconnect or not.
|
Code » | |
![]()
True if a call to the close callback is expected or not.
|
Code » | |
![]()
No description.
|
Code » | |
The logger for this class.
|
Code » | |
![]()
The time, in milliseconds, that must elapse before the next attempt to
reconnect.
|
Code » | |
![]()
The subprotocol name used when establishing the web socket connection.
|
Code » | |
![]()
Keeps track of the number of reconnect attempts made since the last
successful connection.
|
Code » | |
![]()
The URL to which the web socket will connect.
|
Code » | |
![]()
The actual web socket that will be used to send/receive messages.
|
Code » |
The object to use for event.target. Useful when mixing in an
EventTarget to another object.
|
Code » | |
![]()
No description.
|
Code » | |
Maps of event type to an array of listeners.
|
Code » | |
Parent event target, used during event bubbling.
TODO(user): Change this to goog.events.Listenable. This
currently breaks people who expect getParentEventTarget to return
goog.events.EventTarget.
|
Code » |
Computes the next reconnect time given the number of reconnect attempts since
the last successful connection.
|
code » | ||
![]()
Installs exception protection for all entry points introduced by
goog.net.WebSocket instances which are not protected by
goog.debug.ErrorHandler#protectWindowSetTimeout ,
goog.debug.ErrorHandler#protectWindowSetInterval , or
goog.events.protectBrowserEventEntryPoint .
Arguments:
|
code » |
![]()
The maximum amount of time between reconnect attempts for the exponential
back-off in milliseconds.
|
Code » | |
![]()
No description.
|
Code » |
![]()
The events fired by the web socket.
Constants:
|
Code » | |||||
![]()
The various states of the web socket.
Constants:
|
Code » |