net.xpc.FrameElementMethodTransport Extends goog.net.xpc.Transport
Frame-element method transport. Firefox allows a document within an iframe to call methods on the iframe-element added by the containing document. NOTE(user): Tested in all FF versions starting from 1.0

Inheritance

Constructor

goog.net.xpc.FrameElementMethodTransport(channelopt_domHelper)

Parameters

channel : goog.net.xpc.CrossPageChannel
The channel this transport belongs to.
opt_domHelper : goog.dom.DomHelper=
The dom helper to use for finding the correct window.

Instance Methods

Public Protected Private
attemptSetup_()
Only used from within an iframe. Attempts to attach the method to be used for sending messages by the containing document. Has to wait until the containing document has finished. Therefore calls itself in a timeout if not successful.
code »
connect()
Connect this transport.
code »
deliverQueued_()
Delivers queued messages.
code »
disposeInternal()
No description.
code »
incoming_(serviceNamepayload)
Process incoming message.
Arguments:
serviceName : string
The name of the service the message is to be delivered to.
payload : string
The message to process.
code »
send(servicepayload)
Send a message
Arguments:
service : string
The name off the service the message is to be delivered to.
payload : string
The message content.
code »
transportServiceHandler(payload)
Handles transport service messages.
Arguments:
payload : string
The message content.
code »
getName() string
Return the transport name.
Returns: string  the transport name.
code »
getType() number
No description.
Returns: number  The transport type identifier.
code »
getWindow() !Window
Returns the window associated with this transport instance.
Returns: !Window  The window to use.
code »
send(servicepayload)
Sends a message.
Arguments:
service : string
The name off the service the message is to be delivered to.
payload : string
The message content.
code »
transportServiceHandler(payload)
Handles transport service messages (internal signalling).
Arguments:
payload : string
The message content.
code »
addOnDisposeCallback(callbackopt_scope)
Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added.
Arguments:
callback : function(this:T):?
The callback function.
opt_scope : T=
An optional scope to call the callback in.
code »
dispose() void
Disposes of the object. If the object hasn't already been disposed of, calls #disposeInternal. Classes that extend goog.Disposable should override #disposeInternal in order to delete references to COM objects, DOM nodes, and other disposable objects. Reentrant.
Returns: void  Nothing.
code »
disposeInternal()
Deletes or nulls out any references to COM objects, DOM nodes, or other disposable objects. Classes that extend goog.Disposable should override this method. Not reentrant. To avoid calling it twice, it must only be called from the subclass' disposeInternal method. Everywhere else the public dispose method must be used. For example:
  mypackage.MyClass = function() {
    mypackage.MyClass.base(this, 'constructor');
    // Constructor logic specific to MyClass.
    ...
  };
  goog.inherits(mypackage.MyClass, goog.Disposable);

  mypackage.MyClass.prototype.disposeInternal = function() {
    // Dispose logic specific to MyClass.
    ...
    // Call superclass's disposeInternal at the end of the subclass's, like
    // in C++, to avoid hard-to-catch issues.
    mypackage.MyClass.base(this, 'disposeInternal');
  };
code »
getDisposed() boolean
Use #isDisposed instead. No description.
Returns: boolean  Whether the object has been disposed of.
code »
isDisposed() boolean
No description.
Returns: boolean  Whether the object has been disposed of.
code »
registerDisposable(disposable)
Associates a disposable object with this object so that they will be disposed together.
Arguments:
disposable : goog.disposable.IDisposable
that will be disposed when this object is disposed.
code »

Instance Properties

The channel this transport belongs to.
Code »
constructor :
No description.
Code »
deliverQueuedCb_ :
Callback function which wraps deliverQueued_.
Code »
queue_ :
Array for queued messages.
Code »
recursive_ :
Flag used to enforce asynchronous messaging semantics.
Code »
timer_ :
Timer used to enforce asynchronous message delivery.
Code »
transportType :
The transport type.
Code »
connect :
Connects this transport. The transport implementation is expected to call CrossPageChannel.prototype.notifyConnected when the channel is ready to be used.
Code »
constructor :
No description.
Code »
domHelper_ : goog.dom.DomHelper
The dom helper to use for finding the window objects to reference.
Code »
transportType :
The transport type.
Code »
creationStack :
If monitoring the goog.Disposable instances is enabled, stores the creation stack trace of the Disposable instance.
Code »
disposed_ :
Whether the object has been disposed of.
Code »
onDisposeCallbacks_ :
Callbacks to invoke when this object is disposed.
Code »

Static Properties

goog.net.xpc.FrameElementMethodTransport.outgoing_ :
Holds the function to send messages to the peer (once it becomes available).
Code »
goog.net.xpc.FrameElementMethodTransport.superClass_ :
No description.
Code »

Package net.xpc

Package Reference