The goog.gears.WorkerChannel Class

.checkMessageOrigin(messageOrigin) [protected]

Checks whether the origin for a given message is the expected origin. If it's not, a warning is logged and the message is ignored. This checks that the origin matches the peerOrigin property. It can be overridden if more complex origin detection is necessary.

messageOrigin {string}

The origin of the message, of the form SCHEME://HOST[:PORT]. The port is omitted for standard ports (http port 80, https port 443).

returns {boolean}

True if the origin is acceptable, false otherwise.

.decodePayload(serviceName, payload, objectPayload) [protected]

Inherited from goog.messaging.AbstractChannel .

Converts the message payload into the format expected by the registered service (either JSON or string).

serviceName {string}

The name of the service receiving the message.

payload {string|!Object}

The contents of the message.

objectPayload {boolean}

Whether the service expects an object or a plain string.

returns {string|Object}

The payload in the format expected by the service, or null if something went wrong.

.deliver(serviceName, payload) [protected]

Inherited from goog.messaging.AbstractChannel .

Delivers a message to the appropriate service. This is meant to be called by subclasses when they receive messages. This method takes into account both explicitly-registered and default services, as well as making sure that JSON payloads are decoded when necessary. If the subclass is capable of passing objects as payloads, those objects can be passed in to this method directly. Otherwise, the (potentially JSON-encoded) strings should be passed in.

serviceName {string}

The name of the service receiving the message.

payload {string|!Object}

The contents of the message.

.disposeInternal() [protected]

Deletes or nulls out any references to COM objects, DOM nodes, or other disposable objects. Classes that extend {@code goog.Disposable} should override this method. Not reentrant. To avoid calling it twice, it must only be called from the subclass' {@code disposeInternal} method. Everywhere else the public {@code 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.
     ...
   };
 

.getDisposed [deprecated]

Deprecated. Use {@link #isDisposed} instead.

Inherited from goog.Disposable .

returns {boolean}

Whether the object has been disposed of.

.getService(serviceName, payload) [protected]

Inherited from goog.messaging.AbstractChannel .

Find the service object for a given service name. If there's no service explicitly registered, but there is a default service, a service object is constructed for it.

serviceName {string}

The name of the service receiving the message.

payload {string|!Object}

The contents of the message.

returns {?{callback: function((string|!Object)), objectPayload: boolean}}

The service object for the given service, or null if none was found.

.logger [protected] {goog.debug.Logger}

Logger for this class.