goog.labs.net.webChannel.ChannelRequest

Provided By	`goog.labs.net.webChannel.ChannelRequest`

A new ChannelRequest is created for each request to the server.

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

Parameters

`channel`	`(goog.labs.net.webChannel.Channel\|null)`
	The channel that owns this request.
`channelDebug`	`(goog.labs.net.webChannel.WebChannelDebug\|null)`
	A WebChannelDebug 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

Parameters

None.

Returns

(Object<string, string>|undefined)

Response headers received along with the non-200 status, as a key-value map.

VIEW SOURCE

If the request was not successful, returns the reason.

Parameters

None.

Returns

(goog.labs.net.webChannel.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

Gets the pending messages that this request is handling, in case of a retry.

Parameters

None.

Returns

Array<(goog.labs.net.webChannel.Wire.QueuedMap|null)>

The pending messages for this 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

Returns the XhrIo request object.

Parameters

None.

Returns

(goog.net.XhrIo|null)

Any XhrIo request created for this object.

VIEW SOURCE

Check if the initial response header has been handled.

Parameters

None.

Returns

boolean

true if X_HTTP_INITIAL_RESPONSE has been handled.

VIEW SOURCE

Resets the timeout.

Parameters

`opt_timeout`	`number=`
	The new timeout

VIEW SOURCE

Uses an IMG tag or navigator.sendBeacon 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.

Navigator.sendBeacon is available on Chrome and Firefox as a formal solution to ensure delivery without blocking window close. See https://developer.mozilla.org/en-US/docs/Web/API/Navigator/sendBeacon

For Chrome Apps, sendBeacon is always necessary due to Content Security Policy (CSP) violation of using an IMG tag.

For react-native, we use xhr to send the actual close request, and assume there is no page-close issue with react-native.

Parameters

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

VIEW SOURCE

Decodes X_HTTP_INITIAL_RESPONSE if present.

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 pending messages that this request is handling.

Parameters

`pendingMessages`	`Array<(goog.labs.net.webChannel.Wire.QueuedMap\|null)>`
	The pending messages for this request.

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

Overrides the default HTTP method.

Parameters

`verb`	`string`
	The HTTP method

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.

VIEW SOURCE

Uses XMLHTTP to send an HTTP POST to the server.

Parameters

`uri`	`(goog.Uri\|null)`
	The uri of the request.
`postData`	`(string\|null)`
	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

Convenience factory method.

Parameters

`channel`	`(goog.labs.net.webChannel.Channel\|null)`
	The channel object that owns this request.
`channelDebug`	`(goog.labs.net.webChannel.WebChannelDebug\|null)`
	A WebChannelDebug 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.labs.net.webChannel.ChannelRequest

The created channel request.

VIEW SOURCE

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

Parameters

`errorCode`	`(goog.labs.net.webChannel.ChannelRequest.Error\|null)`
	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.

Parameters

None.

Returns

boolean

Whether XHR streaming is supported.

goog.labs.net.webChannel.ChannelRequest

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

Instance Methods

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

`this.`getErrorResponseHeaders() `→` `(Object<string, string>|undefined)`

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

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

`this.`getPendingMessages() `→` `Array<(goog.labs.net.webChannel.Wire.QueuedMap|null)>`

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

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

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

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

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

`this.`getXhr() `→` `(goog.net.XhrIo|null)`

`this.`isInitialResponseDecoded() `→` `boolean`

`this.`resetTimeout( `opt_timeout` ) `→` `void`

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

`this.`setDecodeInitialResponse() `→` `void`

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

`this.`setPendingMessages( `pendingMessages` ) `→` `void`

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

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

`this.`setVerb( `verb` ) `→` `void`

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

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

Static Functions

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

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

ChannelRequest.supportsXhrStreaming() `→` `boolean`

Enumerations

goog.labs.net.webChannel.ChannelRequest

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

Instance Methods

this.cancel() → void

this.getErrorResponseHeaders() → (Object<string, string>|undefined)

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

this.getLastStatusCode() → number

this.getPendingMessages() → Array<(goog.labs.net.webChannel.Wire.QueuedMap|null)>

this.getPostData() → (string|null)

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

this.getRequestStartTime() → (number|null)

this.getSessionId() → (string|undefined)

this.getSuccess() → boolean

this.getXhr() → (goog.net.XhrIo|null)

this.isInitialResponseDecoded() → boolean

this.resetTimeout( opt_timeout ) → void

this.sendCloseRequest( uri ) → void

this.setDecodeInitialResponse() → void

this.setExtraHeaders( extraHeaders ) → void

this.setPendingMessages( pendingMessages ) → void

this.setReadyStateChangeThrottle( throttle ) → void

this.setTimeout( timeout ) → void

this.setVerb( verb ) → void

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

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

Static Functions

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

ChannelRequest.errorStringFromCode( errorCode, statusCode ) → string

ChannelRequest.supportsXhrStreaming() → boolean

Enumerations

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

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

`this.`getErrorResponseHeaders() `→` `(Object<string, string>|undefined)`

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

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

`this.`getPendingMessages() `→` `Array<(goog.labs.net.webChannel.Wire.QueuedMap|null)>`

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

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

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

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

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

`this.`getXhr() `→` `(goog.net.XhrIo|null)`

`this.`isInitialResponseDecoded() `→` `boolean`

`this.`resetTimeout( `opt_timeout` ) `→` `void`

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

`this.`setDecodeInitialResponse() `→` `void`

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

`this.`setPendingMessages( `pendingMessages` ) `→` `void`

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

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

`this.`setVerb( `verb` ) `→` `void`

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

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

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

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

ChannelRequest.supportsXhrStreaming() `→` `boolean`