goog.Disposable | |
goog.events.EventTarget | goog.Disposable |
goog.net.XhrManager | goog.events.EventTarget |
opt_maxRetries
: number=
Max. number of retries (Default: 1).
|
opt_headers
: goog.structs.Map=
Map of default headers to add to every
request.
|
opt_minCount
: number=
Min. number of objects (Default: 1).
|
opt_maxCount
: number=
Max. number of objects (Default: 10).
|
opt_timeoutInterval
: number=
Timeout (in ms) before aborting an
attempt (Default: 0ms).
|
![]()
Aborts the request associated with id.
Arguments:
|
code » | ||||||||||
![]()
Adds a listener for XHR events on an XhrIo object.
Arguments:
|
code » | ||||||||||
![]()
No description.
|
code » | ||||||||||
Returns the number of requests either in flight, or waiting to be sent.
The count will include the current request if used within a COMPLETE event
handler or callback.
Returns: number
The number of requests in flight or pending send.
|
code » | ||||||||||
Returns an array of request ids that are either in flight, or waiting to
be sent. The id of the current request will be included if used within a
COMPLETE event handler or callback.
|
code » | ||||||||||
![]()
Handles the abort of an underlying XhrIo object.
Arguments:
|
code » | ||||||||||
![]()
Handles when an XhrIo object becomes available. Sets up the events, fires
the READY event, and starts the process to send the request.
Arguments:
|
code » | ||||||||||
Handles the complete of a request. Dispatches the COMPLETE event and sets the
the request as completed if the request has succeeded, or is done retrying.
Arguments:
Returns: Object
The return value from the callback, if any.
|
code » | ||||||||||
![]()
Handles the error of a request. If the request has not reach its maximum
number of retries, then it lets the request retry naturally (will let the
request hit the READY state). Else, it dispatches the ERROR event.
Arguments:
|
code » | ||||||||||
Handles all events fired by the XhrIo object for a given request.
Arguments:
Returns: Object
The return value from the handler, if any.
|
code » | ||||||||||
![]()
Handles the success of a request. Dispatches the SUCCESS event and sets the
the request as completed.
Arguments:
|
code » | ||||||||||
![]()
Remove listeners for XHR events on an XhrIo object.
Arguments:
|
code » | ||||||||||
![]()
Attempts to retry the given request. If the request has already attempted
the maximum number of retries, then it removes the request and releases
the XhrIo object back into the pool.
Arguments:
|
code » | ||||||||||
![]()
Registers the given request to be sent. Throws an error if a request
already exists with the given ID.
NOTE: It is not sent immediately. It is queued and will be sent when an
XhrIo object becomes available, taking into account the request's
priority.
Arguments:
Returns: !goog.net.XhrManager.Request
The queued request object.
|
code » | ||||||||||
![]()
Sets the number of milliseconds after which an incomplete request will be
aborted. Zero means no timeout is set.
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 » |
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 » |
![]()
Error to throw when a send is attempted with an ID that the manager already
has registered for another request.
|
Code » | |
![]()
The goog.net.EventType's to listen/unlisten for on the XhrIo object.
|
Code » | |
![]()
No description.
|
Code » |