goog.labs.net.webChannel.WebChannelBase

Starts the channel. This initiates connections to the server.

Decides which host prefix should be used, if any. If there is a handler, allows the handler to validate a host prefix provided by the server, and optionally override it.

Not needed for testchannel.

Creates a data Uri applying logic for secondary hostprefix, port overrides, and versioning.

Called when creating an XhrIo object. Override in a subclass if you need to customize the behavior, for example to enable the creation of XHR's capable of calling a secondary domain. Will also allow calling a secondary domain if withCredentials (CORS) is enabled.

Disconnects and closes the channel.

Returns whether the channel allows the use of a subdomain. There may be cases where this isn't allowed.

Returns whether streaming mode is allowed. In certain debugging situations, it's useful for the application to have a way to disable streaming mode for a user.

Not needed for testchannel.

Gets the Uri used for the connection that receives data from the server.

Returns the logger.

Not needed for testchannel. Gets the result of previous connectivity tests.

Returns the extra HTTP headers to add to all the requests sent to the server.

Not needed for testchannel.

Gets the Uri used for the connection that sends data to the server.

Returns the handler used for channel callback events.

Gets the http session id.

Gets the parameter name for the http session id.

Returns the extra HTTP headers to add to the init requests sent to the server.

Returns the session id of the channel. Only available after the channel has been opened.

Returns the channel state.

Returns whether there are outstanding requests servicing the channel.

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

Returns whether the channel is buffered or not. This may be queried in the WebChannelBase.okToMakeRequest() callback.

Returns whether the channel is closed

Callback from ChannelRequest for when the first byte of response body has been received. This is needed for detecting buffering proxies.

Callback from ChannelRequest that indicates a request has completed.

Callback from ChannelRequest for when new data is received

Sends a request to the server. The format of the request is a Map data structure of key/value pairs. These maps are then encoded in a format suitable for the wire and then reconstituted as a Map data structure that the server can process.

Sets whether the channel allows the use of a subdomain. There may be cases where this isn't allowed, for example, logging in with troutboard where using a subdomain causes Apache to force the user to authenticate twice.

Sets whether streaming mode is allowed. In certain debugging situations, it's useful for the application to have a way to disable streaming mode for a user.

Sets the logger.

Sets extra HTTP headers to add to all the requests sent to the server.

When set to true, this changes the behavior of the forward channel so it will not retry requests; it will fail after one network failure, and if there was already one network failure, the request will fail immediately.

Sets (overwrites) the forward channel flush callback.

Sets the maximum number of attempts to connect to the server for forward channel requests.

Sets the timeout for a forward channel request.

Sets the handler used for channel callback events.

Sets the URL param name to overwrite custom HTTP headers.

Sets the http session id.

Sets the parameter name for the http session id.

Sets extra HTTP headers to add to the init requests sent to the server.

Sets the throttle for handling onreadystatechange events for the request.

Sets whether cross origin requests are supported for the channel.

Setting this allows the creation of requests to secondary domains and sends XHRs with the CORS withCredentials bit set to true.

In order for cross-origin requests to work, the server will also need to set CORS response headers as per: https://developer.mozilla.org/en-US/docs/HTTP_access_control

See goog.net.XhrIo#setWithCredentials.

Determines whether to use a secondary domain when the server gives us a host prefix. This allows us to work around browser per-domain connection limits.

If you need to use secondary domains on different browsers and IE10, you have two choices: 1) If you only care about browsers that support CORS (https://developer.mozilla.org/en-US/docs/HTTP_access_control), you can use #setSupportsCrossDomainXhrs and set the appropriate CORS response headers on the server. 2) Or, override this method in a subclass, and make sure that those browsers use some messaging mechanism that works cross-domain (e.g iframes and window.postMessage).

Whether or not this channel uses WHATWG Fetch/streams.

Maximum number of attempts to connect to the server for back channel requests.

The timeout in milliseconds for a forward channel request.

When retrying for an inactive channel, we will multiply the total delay by this number.

A guess at a cutoff at which to no longer assume the backchannel is dead when we are slow to receive data. Number in bytes.

Assumption: The worst bandwidth we work on is 50 kilobits/sec 50kbits/sec * (1 byte / 8 bits) * 6 sec dead backchannel timeout

A number in MS of how long we guess the maxmium amount of time a round trip to the server should take. In the future this could be substituted with a real measurement of the RTT.