goog.net.xpc.CrossPageChannel

Invokes a callback function when this object is disposed. Callbacks are invoked in the order in which they were added. If a callback is added to an already disposed Disposable, it will be called immediately.

Closes the channel.

Initiates connecting the channel. When this method is called, all the information needed to connect the channel has to be available.

Creates the iframe containing the peer page in a specified parent element. This method does not connect the channel, connect() still has to be called separately.

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

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.

Disposes of the object and its resources.

Performs appropriate cleanup. See description of goog.disposable.IDisposable for examples. 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');
   };
 

Returns the configuration object for this channel. Package private. Do not call from outside goog.net.xpc.

Returns a reference to the iframe-element. Package private. Do not call from outside goog.net.xpc.

Returns the peer URI, with an optional URL parameter for configuring the peer window.

Returns the window object the foreign document resides in.

Returns the role of this channel (either inner or outer).

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.

Returns the tranport name in use for this channel.

Returns the transport type in use for this channel.

Gets whether the channel is connected.

If #connect is not required for this class, this should always return true. Otherwise, this should return true by the time the callback passed to #connect has been called and always after that.

Returns whether an incoming message with the given origin is acceptable. If an incoming request comes with a specified (non-empty) origin, and the PEER_HOSTNAME config parameter has also been provided, the two must match, or the message is unacceptable.

Determines whether the peer window is available (e.g. not closed).

Package-private. Called by the transport when the channel is connected.

Called by the transport in case of an unrecoverable failure. Package private. Do not call from outside goog.net.xpc.

Registers a service to be called when a message is received that doesn't match any other services.

Associates a disposable object with this object so that they will be disposed together.

Registers a service to be called when a message is received.

Implementers shouldn't impose any restrictions on the service names that may be registered. If some services are needed as control codes, goog.messaging.MultiMessageChannel can be used to safely split the channel into "public" and "control" virtual channels.

Sends a message over the channel.

Sets the window object the foreign document resides in.

Sets the channel name. Note, this doesn't establish a unique channel to communicate on.

Delivers messages to the appropriate service-handler. Named xpcDeliver to avoid name conflict with deliver function in superclass goog.messaging.AbstractChannel.

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

Logger for this class.

The name of the channel. Please use updateChannelNameAndCatalog to change this from the transports vs changing the property directly.

Object holding active channels.