• index
• goog
• gears
• search: Go

The goog.gears.Worker Class

goog.gears.Worker
> goog.events.EventTarget
> goog.Disposable

goog.gears.Worker(workerPool, opt_id)

This is an absctraction of workers that can be used with Gears WorkerPool.

workerPool {goog.gears.WorkerPool}

WorkerPool object.

opt_id {number=}

The id of the worker this represents.

The goog.gears.Worker.EventType Enum

Enum for event types fired by the worker. … 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.

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

.getId()

Gets an ID that uniquely identifies this worker. The ID is unique among all worker from the same WorkerPool.

returns {number}

The ID of the worker. This might be null if the worker has not been initialized yet.

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

.handleMessage(messageObject)

Called when we receive a message from this worker. The message will first be dispatched as a WorkerEvent with type {@code EventType.MESSAGE} and then a {@code EventType.COMMAND}. An EventTarget may call {@code WorkerEvent.preventDefault()} to stop further dispatches.

messageObject {GearsMessageObject}

An object containing all information about the message.

.init(id)

Initializes the worker object with a worker id.

id {number}

The id of the worker this represents.

.isCommandLike(obj)

Whether an object looks like a command. A command is an array with length 2 where the first element is a number.

obj {*}

The object to test.

returns {boolean}

true if the object looks like a command.

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

.sendCommand(commandId, params)

Sends a command to the worker.

commandId {number}

The ID of the command to send.

params {Object}

An object to send as the parameters. This object must be something that Gears can serialize. This includes JSON as well as Gears blobs.

.sendMessage(message)

Sends a message to the worker.

message {*}

The message to send to the target worker.

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

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