goog.net.BrowserChannel.Handler

Provided By	`goog.net.BrowserChannel.Handler`

Abstract base class for the browser channel handler

new Handler()

Parameters	None.

VIEW SOURCE

Instance Methods

Called by the channel if enumeration of the map throws an exception.

Parameters

`browserChannel`	`(goog.net.BrowserChannel\|null)`
	The browser channel.
`map`	`(Object\|null)`
	The map that can't be enumerated.

VIEW SOURCE

Indicates the BrowserChannel is closed. Also notifies about which maps, if any, that may not have been delivered to the server.

Parameters

`browserChannel`	`(goog.net.BrowserChannel\|null)`
	The browser channel.
`opt_pendingMaps`	`(Array<(goog.net.BrowserChannel.QueuedMap\|null)>\|null)=`
	The array of pending maps, which may or may not have been delivered to the server.
`opt_undeliveredMaps`	`(Array<(goog.net.BrowserChannel.QueuedMap\|null)>\|null)=`
	The array of undelivered maps, which have definitely not been delivered to the server.

VIEW SOURCE

Indicates an error occurred on the BrowserChannel.

Parameters

`browserChannel`	`(goog.net.BrowserChannel\|null)`
	The browser channel.
`error`	`goog.net.BrowserChannel.Error`
	The error code.

VIEW SOURCE

New input is available for the application to process.

Parameters

`browserChannel`	`(goog.net.BrowserChannel\|null)`
	The browser channel.
`array`	`(Array<?>\|null)`
	The data array.

VIEW SOURCE

Indicates the BrowserChannel has successfully negotiated with the server and can now send and receive data.

Parameters

`browserChannel`	`(goog.net.BrowserChannel\|null)`
	The browser channel.

VIEW SOURCE

Indicates maps were successfully sent on the BrowserChannel.

Parameters

`browserChannel`	`(goog.net.BrowserChannel\|null)`
	The browser channel.
`deliveredMaps`	`(Array<(goog.net.BrowserChannel.QueuedMap\|null)>\|null)`
	The array of maps that have been delivered to the server. This is a direct reference to the internal BrowserChannel array, so a copy should be made if the caller desires a reference to the data.

VIEW SOURCE

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.

Parameters

`serverHostPrefix`	`(string\|null)`
	The host prefix provided by the server.

Returns

(string|null)

The host prefix the client should use.

VIEW SOURCE

Gets any parameters that should be added at the time another connection is made to the server.

Parameters

`browserChannel`	`(goog.net.BrowserChannel\|null)`
	The browser channel.

Returns

Object

Extra parameter keys and values to add to the requests.

VIEW SOURCE

Gets the URI of an image that can be used to test network connectivity.

Parameters

`browserChannel`	`(goog.net.BrowserChannel\|null)`
	The browser channel.

Returns

(goog.Uri|null)

A custom URI to load for the network test.

VIEW SOURCE

Gets whether this channel is currently active. This is used to determine the length of time to wait before retrying.

Parameters

`browserChannel`	`(goog.net.BrowserChannel\|null)`
	The browser channel.

Returns

boolean

Whether the channel is currently active.

VIEW SOURCE

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.

Parameters

`browserChannel`	`(goog.net.BrowserChannel\|null)`
	The browser channel.

Returns

goog.net.BrowserChannel.Error

An error code. The code should return goog.net.BrowserChannel.Error.OK to indicate it's okay. Any other error code will cause a failure.

VIEW SOURCE

Instance Properties

Callback handler for when a batch of response arrays is received from the server.

VIEW SOURCE

goog.net.BrowserChannel.Handler

new Handler()

Instance Methods

`this.`badMapError( `browserChannel`, `map` ) `→` `void`

`this.`channelClosed( `browserChannel`, `opt_pendingMaps`, `opt_undeliveredMaps` ) `→` `void`

`this.`channelError( `browserChannel`, `error` ) `→` `void`

`this.`channelHandleArray( `browserChannel`, `array` ) `→` `void`

`this.`channelOpened( `browserChannel` ) `→` `void`

`this.`channelSuccess( `browserChannel`, `deliveredMaps` ) `→` `void`

`this.`correctHostPrefix( `serverHostPrefix` ) `→` `(string|null)`

`this.`getAdditionalParams( `browserChannel` ) `→` `Object`

`this.`getNetworkTestImageUri( `browserChannel` ) `→` `(goog.Uri|null)`

`this.`isActive( `browserChannel` ) `→` `boolean`

`this.`okToMakeRequest( `browserChannel` ) `→` `goog.net.BrowserChannel.Error`

Instance Properties

`this.`channelHandleMultipleArrays `→` `(function(goog.net.BrowserChannel, Array<Array<?>>): ?|null)`

goog.net.BrowserChannel.Handler

new Handler()

Instance Methods

this.badMapError( browserChannel, map ) → void

this.channelClosed( browserChannel, opt_pendingMaps, opt_undeliveredMaps ) → void

this.channelError( browserChannel, error ) → void

this.channelHandleArray( browserChannel, array ) → void

this.channelOpened( browserChannel ) → void

this.channelSuccess( browserChannel, deliveredMaps ) → void

this.correctHostPrefix( serverHostPrefix ) → (string|null)

this.getAdditionalParams( browserChannel ) → Object

this.getNetworkTestImageUri( browserChannel ) → (goog.Uri|null)

this.isActive( browserChannel ) → boolean

this.okToMakeRequest( browserChannel ) → goog.net.BrowserChannel.Error

Instance Properties

this.channelHandleMultipleArrays → (function(goog.net.BrowserChannel, Array<Array<?>>): ?|null)

`this.`badMapError( `browserChannel`, `map` ) `→` `void`

`this.`channelClosed( `browserChannel`, `opt_pendingMaps`, `opt_undeliveredMaps` ) `→` `void`

`this.`channelError( `browserChannel`, `error` ) `→` `void`

`this.`channelHandleArray( `browserChannel`, `array` ) `→` `void`

`this.`channelOpened( `browserChannel` ) `→` `void`

`this.`channelSuccess( `browserChannel`, `deliveredMaps` ) `→` `void`

`this.`correctHostPrefix( `serverHostPrefix` ) `→` `(string|null)`

`this.`getAdditionalParams( `browserChannel` ) `→` `Object`

`this.`getNetworkTestImageUri( `browserChannel` ) `→` `(goog.Uri|null)`

`this.`isActive( `browserChannel` ) `→` `boolean`

`this.`okToMakeRequest( `browserChannel` ) `→` `goog.net.BrowserChannel.Error`

`this.`channelHandleMultipleArrays `→` `(function(goog.net.BrowserChannel, Array<Array<?>>): ?|null)`