labs.net.webChannel.WebChannelBaseTransport.Channel.Handler_ Extends goog.labs.net.webChannel.WebChannelBase.Handler
Implementation of WebChannelBase.Handler interface.

Inheritance

Constructor

goog.labs.net.webChannel.WebChannelBaseTransport.Channel.Handler_(channel)

Parameters

channel : !WebChannelBaseTransport.Channel
The enclosing WebChannel.

Instance Methods

Public Protected Private
channelClosed()
No description.
code »
channelError()
No description.
code »
channelHandleArray()
No description.
code »
channelOpened()
No description.
code »
badMapError(channelmap)
Called by the channel if enumeration of the map throws an exception.
Arguments:
channel : WebChannelBase
The channel.
map : Object
The map that can't be enumerated.
code »
channelClosed(channelopt_pendingMapsopt_undeliveredMaps)
Indicates the WebChannel is closed. Also notifies about which maps, if any, that may not have been delivered to the server.
Arguments:
channel : WebChannelBase
The channel.
opt_pendingMaps : Array.<Wire.QueuedMap>>
The array of pending maps, which may or may not have been delivered to the server.
opt_undeliveredMaps : Array.<Wire.QueuedMap>>
The array of undelivered maps, which have definitely not been delivered to the server.
code »
channelError(channelerror)
Indicates an error occurred on the WebChannel.
Arguments:
channel : WebChannelBase
The channel.
error : WebChannelBase.Error
The error code.
code »
channelHandleArray(channelarray)
New input is available for the application to process.
Arguments:
channel : WebChannelBase
The channel.
array : Array
The data array.
code »
channelHandleMultipleArrays()
Callback handler for when a batch of response arrays is received from the server. When null, batched dispatching is disabled.
code »
channelOpened(channel)
Indicates the WebChannel has successfully negotiated with the server and can now send and receive data.
Arguments:
channel : WebChannelBase
The channel.
code »
channelSuccess(channeldeliveredMaps)
Indicates maps were successfully sent on the channel.
Arguments:
channel : WebChannelBase
The channel.
deliveredMaps : Array.<Wire.QueuedMap>
The array of maps that have been delivered to the server. This is a direct reference to the internal array, so a copy should be made if the caller desires a reference to the data.
code »
correctHostPrefix(serverHostPrefix) ?string
Allows the handler to override a host prefix provided by the server. Will be called whenever the channel has received such a prefix and is considering its use.
Arguments:
serverHostPrefix : ?string
The host prefix provided by the server.
Returns: ?string  The host prefix the client should use.
code »
getAdditionalParams(channel) !Object
Gets any parameters that should be added at the time another connection is made to the server.
Arguments:
channel : WebChannelBase
The channel.
Returns: !Object  Extra parameter keys and values to add to the requests.
code »
getNetworkTestImageUri(channel) ?goog.Uri
Gets the URI of an image that can be used to test network connectivity.
Arguments:
channel : WebChannelBase
The channel.
Returns: ?goog.Uri  A custom URI to load for the network test.
code »
isActive(channel) boolean
Gets whether this channel is currently active. This is used to determine the length of time to wait before retrying.
Arguments:
channel : WebChannelBase
The channel.
Returns: boolean  Whether the channel is currently active.
code »
okToMakeRequest(channel) WebChannelBase.Error
Whether it's okay to make a request to the server. A handler can return false if the channel should fail. For example, if the user has logged out, the handler may want all requests to fail immediately.
Arguments:
channel : WebChannelBase
The channel.
Returns: WebChannelBase.Error  An error code. The code should return WebChannelBase.Error.OK to indicate it's okay. Any other error code will cause a failure.
code »

Instance Properties

No description.
Code »
constructor :
No description.
Code »

Static Properties

goog.labs.net.webChannel.WebChannelBaseTransport.Channel.Handler_.superClass_ :
No description.
Code »

Package labs.net.webChannel.WebChannelBaseTransport.Channel

Package Reference