• index
• goog
• gears
• search: Go

The goog.gears.WorkerPool Class

goog.gears.WorkerPool
> goog.events.EventTarget
> goog.Disposable

goog.gears.WorkerPool()

This class implements a wrapper around the Gears Worker Pool.

The goog.gears.WorkerPool.Event Class

Event used when the workerpool recieves a message … more

The goog.gears.WorkerPool.EventType Enum

Enum for event types fired by the WorkerPool. … more

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

.allowCrossOrigin()

Allows the worker who calls this to be used cross origin.

.createWorker(code)

Creates a new worker.

code {string}

The code to execute inside the worker.

returns {goog.gears.Worker}

The worker that was just created.

.createWorkerFromUrl(url)

Creates a new worker from a URL.

url {string}

URL from which to get the code to execute inside the worker.

returns {goog.gears.Worker}

The worker that was just created.

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

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

.registerWorker(worker)

Registers a worker object.

worker {goog.gears.Worker}

The worker to register.

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

.sendMessage(message, worker)

Sends a message to a given worker.

message {*}

The message to send to the worker.

worker {goog.gears.Worker}

The worker to send the message to.

.setErrorHandler(fn, opt_handler)

Sets a last-chance error handler for a worker pool. WARNING: This will only succeed from inside a worker thread. In main thread, use window.onerror handler.

fn {function(!GearsErrorObject):boolean}

An error handler function that gets passed an error object with message and line number attributes. Returns whether the error was handled. If true stops propagation.

opt_handler {Object=}

This object for the function.

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

.unregisterWorker(worker)

Unregisters a worker object.

worker {goog.gears.Worker}

The worker to unregister.

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