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

Inheritance

Constructor

goog.net.XhrManager(opt_maxRetriesopt_headersopt_minCountopt_maxCountopt_timeoutInterval)

Parameters

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).

Instance Methods

Public Protected Private
abort(idopt_force)
Aborts the request associated with id.
Arguments:
id : string
The id of the request to abort.
opt_force : boolean=
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_(xhrIofuncopt_types)
Adds a listener for XHR events on an XhrIo object.
Arguments:
xhrIo : goog.net.XhrIo
The object listen to events on.
func : Function
The callback when the event occurs.
opt_types : string | Array.<string>>
Event types to attach listeners to. Defaults to XHR_EVENT_TYPES_.
code »
disposeInternal()
No description.
code »
getOutstandingCount() number
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 »
getOutstandingRequestIds() !Array.<string>
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.
Returns: !Array.<string>  Request ids in flight or pending send.
code »
handleAbort_(idxhrIo)
Handles the abort of an underlying XhrIo object.
Arguments:
id : string
The id of the request.
xhrIo : goog.net.XhrIo
The XhrIo object.
code »
handleAvailableXhr_(idxhrIo)
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
The available XhrIo object.
code »
handleComplete_(idxhrIoe) Object
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
The XhrIo object.
e : goog.events.Event
The original event.
Returns: Object  The return value from the callback, if any.
code »
handleError_(idxhrIo)
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
The XhrIo object.
code »
handleEvent_(ide) Object
Handles all events fired by the XhrIo object for a given request.
Arguments:
id : string
The id of the request.
e : goog.events.Event
The event.
Returns: Object  The return value from the handler, if any.
code »
handleSuccess_(idxhrIo)
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
The XhrIo object.
code »
removeXhrListener_(xhrIofuncopt_types)
Remove listeners for XHR events on an XhrIo object.
Arguments:
xhrIo : goog.net.XhrIo
The object to stop listenening to events on.
func : Function
The callback to remove from event handling.
opt_types : string | Array.<string>>
Event types to remove listeners for. Defaults to XHR_EVENT_TYPES_.
code »
retry_(idxhrIo)
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
The XhrIo object.
code »
send(idurlopt_methodopt_contentopt_headersopt_priorityopt_callbackopt_maxRetriesopt_responseType) !goog.net.XhrManager.Request
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=
Send method, default: GET.
opt_content : ArrayBuffer | ArrayBufferView | Blob | Document | FormData | string=
Post data.
opt_headers : Object | goog.structs.Map=
Map of headers to add to the request.
opt_priority : number=
The priority of the request. A smaller value means a higher priority.
opt_callback : Function=
Callback function for when request is complete. The only param is the event object from the COMPLETE event.
opt_maxRetries : number=
The maximum number of times the request should be retried.
opt_responseType : goog.net.XhrIo.ResponseType=
The response type of this request; defaults to goog.net.XhrIo.ResponseType.DEFAULT.
Returns: !goog.net.XhrManager.Request  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 »
addEventListener(typeopt_captureopt_handlerScope)
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:
type : string
The type of the event to listen for.
: ?function():? | ?{handleEvent:function():?
No description.
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.
code »
assertInitialized_()
Asserts that the event target instance is initialized properly.
code »
dispatchEvent()
No description.
code »
disposeInternal()
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 »
fireListeners()
No description.
code »
getListener()
No description.
code »
getListeners()
No description.
code »
getParentEventTarget() 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.
code »
hasListener()
No description.
code »
listen()
No description.
code »
listenOnce()
No description.
code »
removeAllListeners()
No description.
code »
removeEventListener(typeopt_captureopt_handlerScope)
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:
type : string
The type of the event to listen for.
: ?function():? | ?{handleEvent:function():?
No description.
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.
code »
setParentEventTarget(parent)
Sets the parent of this event target to use for capture/bubble mechanism.
Arguments:
parent : goog.events.EventTarget
Parent listenable (null if none).
code »
setTargetForTesting(target)
Sets the target to be used for event.target when firing event. Mainly used for testing. For example, see goog.testing.events.mixinListenable.
Arguments:
target : !Object
The target.
code »
unlisten()
No description.
code »
unlistenByKey()
No description.
code »
addOnDisposeCallback(callbackopt_scope)
Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added.
Arguments:
callback : function(this:T):?
The callback function.
opt_scope : T=
An optional scope to call the callback in.
code »
dispose() void
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 »
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() {
    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 »
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
that will be disposed when this object is disposed.
code »

Instance Properties

constructor :
No description.
Code »
eventHandler_ : goog.events.EventHandler
The event handler.
Code »
maxRetries_ :
Maximum number of retries for a given request
Code »
requests_ : goog.structs.Map
Map of ID's to requests.
Code »
timeoutInterval_ :
Timeout interval for an attempt of a given request.
Code »
xhrPool_ : goog.net.XhrIoPool
The pool of XhrIo's to use.
Code »
actualEventTarget_ : goog.events.EventTarget
The object to use for event.target. Useful when mixing in an EventTarget to another object.
Code »
constructor :
No description.
Code »
eventTargetListeners_ : goog.events.ListenerMap
Maps of event type to an array of listeners.
Code »
parentEventTarget_ : goog.events.EventTarget
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 »
creationStack :
If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.
Code »
disposed_ :
Whether the object has been disposed of.
Code »
onDisposeCallbacks_ :
Callbacks to invoke when this object is disposed.
Code »

Static Properties

goog.net.XhrManager.ERROR_ID_IN_USE_ :
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_ :
The goog.net.EventType's to listen/unlisten for on the XhrIo object.
Code »
goog.net.XhrManager.superClass_ :
No description.
Code »

Package net

Package Reference