• index
• goog
• net
• search: Go

The goog.net.XhrManager Class

goog.net.XhrManager
> goog.events.EventTarget
> goog.Disposable

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

A manager of an XhrIoPool.

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

The goog.net.XhrManager.Event Class

An event dispatched by XhrManager. … more

The goog.net.XhrManager.Request Class

An encapsulation of everything needed to make a Xhr request. NOTE: This is used internal to the XhrManager. … more

.abort(id, opt_force)

Aborts the request associated with id.

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.

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

.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
};

.getOutstandingCount()

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.

.getOutstandingRequestIds()

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.

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

.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(id, url, opt_method, opt_content, opt_headers, opt_priority, opt_callback, opt_maxRetries)

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.

id {string}

The id of the request.

url {string}

Uri to make the request too.

opt_method {string=}

Send method, default: GET.

opt_content {string=}

Post data.

opt_headers {Object|goog.structs.Map=}

Map of headers to add to the request.

opt_priority {*=}

The priority of the request.

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.

returns {goog.net.XhrManager.Request}

The queued request object.

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

.setTimeoutInterval(ms)

Sets the number of milliseconds after which an incomplete request will be aborted. Zero means no timeout is set.

ms {number}

Timeout interval in milliseconds; 0 means none.

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