net.XhrManager Extends goog.events.EventTarget
A manager of an XhrIoPool.

Inheritance

Constructor

goog.net.XhrManager(opt_maxRetries, opt_headers, opt_minCount, opt_maxCount, opt_timeoutInterval)

Parameters

opt_maxRetries :
(number | undefined)
Max. number of retries (Default: 1).
opt_headers :
(goog.structs.Map | null | undefined)
Map of default headers to add to every request.
opt_minCount :
(number | undefined)
Min. number of objects (Default: 1).
opt_maxCount :
(number | undefined)
Max. number of objects (Default: 10).
opt_timeoutInterval :
(number | undefined)
Timeout (in ms) before aborting an attempt (Default: 0ms).

Instance Methods

Public Protected Private
Defined in goog.net.XhrManager
abort(id, opt_force)
Aborts the request associated with id.
Arguments:
id :
string
The id of the request to abort.
opt_force :
(boolean | undefined)
If true, remove the id now so it can be reused. No events are fired and the callback is not called when forced.
code »
addXhrListener_(xhrIo, func, opt_types)
Adds a listener for XHR events on an XhrIo object.
Arguments:
xhrIo :
(goog.net.XhrIo | null)
The object listen to events on.
func :
(Function | null)
The callback when the event occurs.
opt_types :
(Array | null | string | undefined)
Event types to attach listeners to. Defaults to XHR_EVENT_TYPES_.
code »
disposeInternal()
No description.
code »
getOutstandingCount() ⇒
number
Returns the number of reuqests either in flight, or waiting to be sent.
Returns: 
number
  The number of requests in flight or pending send.
code »
handleAbort_(id, xhrIo)
Handles the abort of an underlying XhrIo object.
Arguments:
id :
string
The id of the request.
xhrIo :
(goog.net.XhrIo | null)
The XhrIo object.
code »
handleAvailableXhr_(id, xhrIo)
Handles when an XhrIo object becomes available. Sets up the events, fires the READY event, and starts the process to send the request.
Arguments:
id :
string
The id of the request the XhrIo is for.
xhrIo :
(goog.net.XhrIo | null)
The available XhrIo object.
code »
handleComplete_(id, xhrIo, e) ⇒
(Object | null)
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:
id :
string
The id of the request.
xhrIo :
(goog.net.XhrIo | null)
The XhrIo object.
e :
(goog.events.Event | null)
The original event.
Returns: 
(Object | null)
  The return value from the callback, if any.
code »
handleError_(id, xhrIo)
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:
id :
string
The id of the request.
xhrIo :
(goog.net.XhrIo | null)
The XhrIo object.
code »
handleEvent_(id, e) ⇒
(Object | null)
Handles all events fired by the XhrIo object for a given request.
Arguments:
id :
string
The id of the request.
e :
(goog.events.Event | null)
The event.
Returns: 
(Object | null)
  The return value from the handler, if any.
code »
handleSuccess_(id, xhrIo)
Handles the success of a request. Dispatches the SUCCESS event and sets the the request as completed.
Arguments:
id :
string
The id of the request.
xhrIo :
(goog.net.XhrIo | null)
The XhrIo object.
code »
removeXhrListener_(xhrIo, func, opt_types)
Remove listeners for XHR events on an XhrIo object.
Arguments:
xhrIo :
(goog.net.XhrIo | null)
The object to stop listenening to events on.
func :
(Function | null)
The callback to remove from event handling.
opt_types :
(Array | null | string | undefined)
Event types to remove listeners for. Defaults to XHR_EVENT_TYPES_.
code »
retry_(id, xhrIo)
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:
id :
string
The id of the request.
xhrIo :
(goog.net.XhrIo | null)
The XhrIo object.
code »
send(id, url, opt_method, opt_content, opt_headers, opt_priority, opt_callback, opt_maxRetries) ⇒
(goog.net.XhrManager.Request | null)
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:
id :
string
The id of the request.
url :
string
Uri to make the request too.
opt_method :
(string | undefined)
Send method, default: GET.
opt_content :
(string | undefined)
Post data.
opt_headers :
(Object | null | undefined)
Map of headers to add to the request.
opt_priority :
*
The priority of the request.
opt_callback :
(Function | null | undefined)
Callback function for when request is complete. The only param is the event object from the COMPLETE event.
opt_maxRetries :
(number | undefined)
The maximum number of times the request should be retried.
Returns: 
(goog.net.XhrManager.Request | null)
  The queued request object.
code »
setTimeoutInterval(ms)
Sets the number of milliseconds after which an incomplete request will be aborted. Zero means no timeout is set.
Arguments:
ms :
number
Timeout interval in milliseconds; 0 means none.
code »
Defined in goog.events.EventTarget
addEventListener(type, handler, opt_capture, opt_handlerScope)
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.
Arguments:
type :
string
The type of the event to listen for.
handler :
(Object | null)
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 | undefined)
In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.
opt_handlerScope :
(Object | null | undefined)
Object in whose scope to call the listener.
code »
dispatchEvent(e) ⇒
boolean
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.
Arguments:
e :
(Object | goog.events.Event | null | string)
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.
code »
disposeInternal()
Unattach 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, it should be something like this: 
MyClass.prototype.disposeInternal = function() {
MyClass.superClass_.disposeInternal.call(this);
// Dispose logic for MyClass
};
code »
getParentEventTarget() ⇒
(goog.events.EventTarget | null)
Returns the parent of this event target to use for bubbling.
Returns: 
(goog.events.EventTarget | null)
  The parent EventTarget or null if there is no parent.
code »
removeEventListener(type, handler, opt_capture, opt_handlerScope)
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:
type :
string
The type of the event to listen for.
handler :
(Object | null)
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 | undefined)
In DOM-compliant browsers, this determines whether the listener is fired during the capture or bubble phase of the event.
opt_handlerScope :
(Object | null | undefined)
Object in whose scope to call the listener.
code »
setParentEventTarget(parent)
Sets the parent of this event target to use for bubbling.
Arguments:
parent :
(goog.events.EventTarget | null)
Parent EventTarget (null if none).
code »
Defined in goog.Disposable
dispose() ⇒
undefined
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: 
undefined
  Nothing.
code »
disposeInternal()
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() {
goog.base(this);
// Constructor logic specific to MyClass.
...
};
goog.inherits(mypackage.MyClass, goog.Disposable);

mypackage.MyClass.prototype.disposeInternal = function() {
goog.base(this, 'disposeInternal');
// Dispose logic specific to MyClass.
...
};
code »
getDisposed() ⇒
boolean
Use #isDisposed instead. No description.
Returns: 
boolean
  Whether the object has been disposed of.
code »
isDisposed() ⇒
boolean
No description.
Returns: 
boolean
  Whether the object has been disposed of.
code »
registerDisposable(disposable)
Associates a disposable object with this object so that they will be disposed together.
Arguments:
disposable :
(goog.disposable.IDisposable | null)
that will be disposed when this object is disposed.
code »

Instance Properties

Defined in goog.net.XhrManager
eventHandler_ :
(goog.events.EventHandler | null)
The event handler.
Code »
maxRetries_ :
number
Maximum number of retries for a given request
Code »
requests_ :
(goog.structs.Map | null)
Map of ID's to requests.
Code »
timeoutInterval_ :
number
Timeout interval for an attempt of a given request.
Code »
xhrPool_ :
(goog.net.XhrIoPool | null)
The pool of XhrIo's to use.
Code »
Defined in goog.events.EventTarget
customEvent_ :
boolean
Used to tell if an event is a real event in goog.events.listen() so we don't get listen() calling addEventListener() and vice-versa.
Code »
parentEventTarget_ :
(goog.events.EventTarget | null)
Parent event target, used during event bubbling.
Code »
Defined in goog.Disposable
dependentDisposables_ :
(Array | null)
Disposables that should be disposed when this object is disposed.
Code »
disposed_ :
boolean
Whether the object has been disposed of.
Code »

Static Properties

goog.net.XhrManager.ERROR_ID_IN_USE_ :
string
Error to throw when a send is attempted with an ID that the manager already has registered for another request.
Code »
goog.net.XhrManager.XHR_EVENT_TYPES_ :
(Array | null)
The goog.net.EventType's to listen/unlisten for on the XhrIo object.
Code »

Package net

Package Reference