messaging.AbstractChannel Extends goog.Disposable
Creates an abstract message channel.

Inheritance

Constructor

goog.messaging.AbstractChannel()

Instance Methods

Public Protected Private
connect()
Immediately calls opt_connectCb if given, and is otherwise a no-op. If subclasses have configuration that needs to happen before the channel is connected, they should override this and #isConnected.
code »
decodePayload(serviceNamepayloadobjectPayload) string | Object
Converts the message payload into the format expected by the registered service (either JSON or string).
Arguments:
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.
code »
defaultService_()
The default service to be run when no other services match.
code »
deliver(serviceNamepayload)
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.
Arguments:
serviceName : string
The name of the service receiving the message.
payload : string | !Object
The contents of the message.
code »
disposeInternal()
No description.
code »
getService(serviceNamepayload) ?{callback: function((string | !Object)), objectPayload: boolean
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.
Arguments:
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.
code »
isConnected()
Always returns true. If subclasses have configuration that needs to happen before the channel is connected, they should override this and #connect.
code »
registerDefaultService()
No description.
code »
registerService()
No description.
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

constructor :
No description.
Code »
Logger for this class.
Code »
send :
No description.
Code »
services_ :
The services registered for this channel.
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.messaging.AbstractChannel.superClass_ :
No description.
Code »

Package messaging

Package Reference