goog.net.ChannelRequest

Provided By	`goog.net.ChannelRequest`

Creates a ChannelRequest object which encapsulates a request to the server. A new ChannelRequest is created for each request to the server.

new ChannelRequest( `channel`, `channelDebug`, `opt_sessionId`, `opt_requestId`, `opt_retryId` )

Parameters

`channel`	`(goog.net.BrowserChannel\|goog.net.BrowserTestChannel\|null)`
	The BrowserChannel that owns this request.
`channelDebug`	`(goog.net.ChannelDebug\|null)`
	A ChannelDebug to use for logging.
`opt_sessionId`	`string=`
	The session id for the channel.
`opt_requestId`	`(string\|number)=`
	The request id for this request.
`opt_retryId`	`number=`
	The retry id for this request.

VIEW SOURCE

Instance Methods

Cancels the request no matter what the underlying transport is.

VIEW SOURCE

If the request was not successful, returns the reason.

Parameters

None.

Returns

(goog.net.ChannelRequest.Error|null)

The last error.

VIEW SOURCE

Returns the status code of the last request.

Parameters

None.

Returns

number

The status code of the last request.

VIEW SOURCE

Returns the data for a post, if this request is a post.

Parameters

None.

Returns

(string|null)

The POST data provided by the request initiator.

VIEW SOURCE

Returns the request id for this request. Each request has a unique request id and the request IDs are a sequential increasing count.

Parameters

None.

Returns

(string|number|undefined)

The request ID.

VIEW SOURCE

Returns the time that the request started, if it has started.

Parameters

None.

Returns

(number|null)

The time the request started, as returned by Date.now().

VIEW SOURCE

Returns the session id for this channel.

Parameters

None.

Returns

(string|undefined)

The session ID.

VIEW SOURCE

Indicates whether the request was successful. Only valid after the handler is called to indicate completion of the request.

Parameters

None.

Returns

boolean

True if the request succeeded.

VIEW SOURCE

Uses an IMG tag to send an HTTP get to the server. This is only currently used to terminate the connection, as an IMG tag is the most reliable way to send something to the server while the page is getting torn down.

Parameters

`uri`	`(goog.Uri\|null)`
	The uri to send a request to.

VIEW SOURCE

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

Parameters

`extraHeaders`	`(Object\|null)`
	The HTTP headers.

VIEW SOURCE

Sets the throttle for handling onreadystatechange events for the request.

Parameters

`throttle`	`number`
	The throttle in ms. A value of zero indicates no throttle.

VIEW SOURCE

Sets the timeout for a request

Parameters

`timeout`	`number`
	The timeout in MS for when we fail the request.

VIEW SOURCE

Uses the Trident htmlfile ActiveX control to send a GET request in IE. This is the innovation discovered that lets us get intermediate results in Internet Explorer. Thanks to http://go/kev

Parameters

`uri`	`(goog.Uri\|null)`
	The uri to request from.
`usingSecondaryDomain`	`boolean`
	Whether to use a secondary domain.

VIEW SOURCE

Uses XMLHTTP to send an HTTP GET to the server.

Parameters

`uri`	`(goog.Uri\|null)`
	The uri of the request.
`decodeChunks`	`boolean`
	Whether to the result is expected to be encoded for chunking and thus requires decoding.
`hostPrefix`	`(string\|null)`
	The host prefix, if we might be using a secondary domain. Note that it should also be in the URL, adding this won't cause it to be added to the URL.
`opt_noClose`	`boolean=`
	Whether to request that the tcp/ip connection should be closed.

VIEW SOURCE

Uses XMLHTTP to send an HTTP POST to the server.

Parameters

`uri`	`(goog.Uri\|null)`
	The uri of the request.
`postData`	`string`
	The data for the post body.
`decodeChunks`	`boolean`
	Whether to the result is expected to be encoded for chunking and thus requires decoding.

VIEW SOURCE

Static Functions

Instantiates a ChannelRequest with the given parameters. Overidden in tests.

Parameters

`channel`	`(goog.net.BrowserChannel\|goog.net.BrowserTestChannel\|null)`
	The BrowserChannel that owns this request.
`channelDebug`	`(goog.net.ChannelDebug\|null)`
	A ChannelDebug to use for logging.
`opt_sessionId`	`string=`
	The session id for the channel.
`opt_requestId`	`(string\|number)=`
	The request id for this request.
`opt_retryId`	`number=`
	The retry id for this request.

Returns

goog.net.ChannelRequest

The created channel request.

VIEW SOURCE

Returns a useful error string for debugging based on the specified error code.

Parameters

`errorCode`	`goog.net.ChannelRequest.Error`
	The error code.
`statusCode`	`number`
	The HTTP status code.

Returns

string

The error string for the given code combination.

VIEW SOURCE

Returns whether XHR streaming is supported on this browser.

If XHR streaming is not supported, we will try to use an ActiveXObject to create a Forever IFrame.

Parameters

None.

Returns

boolean

Whether XHR streaming is supported.

Static Properties

How often to poll (in MS) for changes to responseText in browsers that don't fire onreadystatechange during incremental loading of responseText.

VIEW SOURCE

Default timeout in MS for a request. The server must return data within this time limit for the request to not timeout.

VIEW SOURCE

goog.net.ChannelRequest

new ChannelRequest( `channel`, `channelDebug`, `opt_sessionId`, `opt_requestId`, `opt_retryId` )

Instance Methods

`this.`cancel() `→` `void`

`this.`getLastError() `→` `(goog.net.ChannelRequest.Error|null)`

`this.`getLastStatusCode() `→` `number`

`this.`getPostData() `→` `(string|null)`

`this.`getRequestId() `→` `(string|number|undefined)`

`this.`getRequestStartTime() `→` `(number|null)`

`this.`getSessionId() `→` `(string|undefined)`

`this.`getSuccess() `→` `boolean`

`this.`sendUsingImgTag( `uri` ) `→` `void`

`this.`setExtraHeaders( `extraHeaders` ) `→` `void`

`this.`setReadyStateChangeThrottle( `throttle` ) `→` `void`

`this.`setTimeout( `timeout` ) `→` `void`

`this.`tridentGet( `uri`, `usingSecondaryDomain` ) `→` `void`

`this.`xmlHttpGet( `uri`, `decodeChunks`, `hostPrefix`, `opt_noClose` ) `→` `void`

`this.`xmlHttpPost( `uri`, `postData`, `decodeChunks` ) `→` `void`

Static Functions

ChannelRequest.createChannelRequest( `channel`, `channelDebug`, `opt_sessionId`, `opt_requestId`, `opt_retryId` ) `→` `goog.net.ChannelRequest`

ChannelRequest.errorStringFromCode( `errorCode`, `statusCode` ) `→` `string`

ChannelRequest.supportsXhrStreaming() `→` `boolean`

Static Properties

ChannelRequest.POLLING_INTERVAL_MS `→` `number`

ChannelRequest.TIMEOUT_MS `→` `number`

Enumerations

goog.net.ChannelRequest

new ChannelRequest( channel, channelDebug, opt_sessionId, opt_requestId, opt_retryId )

Instance Methods

this.cancel() → void

this.getLastError() → (goog.net.ChannelRequest.Error|null)

this.getLastStatusCode() → number

this.getPostData() → (string|null)

this.getRequestId() → (string|number|undefined)

this.getRequestStartTime() → (number|null)

this.getSessionId() → (string|undefined)

this.getSuccess() → boolean

this.sendUsingImgTag( uri ) → void

this.setExtraHeaders( extraHeaders ) → void

this.setReadyStateChangeThrottle( throttle ) → void

this.setTimeout( timeout ) → void

this.tridentGet( uri, usingSecondaryDomain ) → void

this.xmlHttpGet( uri, decodeChunks, hostPrefix, opt_noClose ) → void

this.xmlHttpPost( uri, postData, decodeChunks ) → void

Static Functions

ChannelRequest.createChannelRequest( channel, channelDebug, opt_sessionId, opt_requestId, opt_retryId ) → goog.net.ChannelRequest

ChannelRequest.errorStringFromCode( errorCode, statusCode ) → string

ChannelRequest.supportsXhrStreaming() → boolean

Static Properties

ChannelRequest.POLLING_INTERVAL_MS → number

ChannelRequest.TIMEOUT_MS → number

Enumerations

new ChannelRequest( `channel`, `channelDebug`, `opt_sessionId`, `opt_requestId`, `opt_retryId` )

`this.`cancel() `→` `void`

`this.`getLastError() `→` `(goog.net.ChannelRequest.Error|null)`

`this.`getLastStatusCode() `→` `number`

`this.`getPostData() `→` `(string|null)`

`this.`getRequestId() `→` `(string|number|undefined)`

`this.`getRequestStartTime() `→` `(number|null)`

`this.`getSessionId() `→` `(string|undefined)`

`this.`getSuccess() `→` `boolean`

`this.`sendUsingImgTag( `uri` ) `→` `void`

`this.`setExtraHeaders( `extraHeaders` ) `→` `void`

`this.`setReadyStateChangeThrottle( `throttle` ) `→` `void`

`this.`setTimeout( `timeout` ) `→` `void`

`this.`tridentGet( `uri`, `usingSecondaryDomain` ) `→` `void`

`this.`xmlHttpGet( `uri`, `decodeChunks`, `hostPrefix`, `opt_noClose` ) `→` `void`

`this.`xmlHttpPost( `uri`, `postData`, `decodeChunks` ) `→` `void`

ChannelRequest.createChannelRequest( `channel`, `channelDebug`, `opt_sessionId`, `opt_requestId`, `opt_retryId` ) `→` `goog.net.ChannelRequest`

ChannelRequest.errorStringFromCode( `errorCode`, `statusCode` ) `→` `string`

ChannelRequest.supportsXhrStreaming() `→` `boolean`

ChannelRequest.POLLING_INTERVAL_MS `→` `number`

ChannelRequest.TIMEOUT_MS `→` `number`