• index
• goog
• net
• xpc
• search: Go

The goog.net.xpc.Transport Class

goog.net.xpc.Transport
> goog.Disposable

goog.net.xpc.Transport(opt_domHelper)

The base class for transports.

opt_domHelper {goog.dom.DomHelper=}

The dom helper to use for finding the window objects.

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

.connect()

Connects this transport. The transport implementation is expected to call CrossPageChannel.prototype.notifyConnected when the channel is ready to be used.

.creationStack {string}

Inherited from goog.Disposable .

If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.

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

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

.getName()

Return the transport name.

returns {string}

the transport name.

.getType()

returns {number}

The transport type identifier.

.getWindow()

Returns the window associated with this transport instance.

returns {Window}

The window to use.

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

.send(service, payload)

Sends a message.

service {string}

The name off the service the message is to be delivered to.

payload {string}

The message content.

.transportServiceHandler(payload)

Handles transport service messages (internal signalling).

payload {string}

The message content.

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