Class: shaka.util.AjaxRequest

Constructor

new AjaxRequest(url, opt_parametersopt)

Creates an asynchronous HTTP request object which manages retries automatically.
Parameters:
Name Type Attributes Description
url string The URL to request.
opt_parameters shaka.util.AjaxRequest.Parameters <optional>
Source:

Classes

shaka.util.AjaxRequest.Parameters

Members

(static) enableCacheBusting :boolean

Type:
  • boolean
Source:

(private) attempts_ :number

The number of times the request has been attempted.
Type:
  • number
Source:

estimator :shaka.util.IBandwidthEstimator

Type:
Source:

(private) lastDelayMs_ :number

The last used delay. This is used in unit tests only.
Type:
  • number
Source:

(protected, non-null) parameters :shaka.util.AjaxRequest.Parameters

A collection of parameters which an instance of a subclass may wish to override.
Type:
Source:

(private) promise_ :shaka.util.PublicPromise.<!XMLHttpRequest>

Resolved when the request is completed successfully. Rejected if it cannot be completed.
Type:
Source:

(private) retryDelayMs_ :number

The delay, in milliseconds, before the next retry.
Type:
  • number
Source:

(private) startTime_ :number

A timestamp in milliseconds when the request began.
Type:
  • number
Source:

(protected) url :string

The request URL.
Type:
  • string
Source:

(private) xhr_ :XMLHttpRequest

Type:
  • XMLHttpRequest
Source:

Methods

abort()

Aborts an in-progress request. If a request is not in-progress then this function does nothing.
Source:

(private) cleanupRequest_()

Remove |xhr_|'s references to bound functions, and set |xhr_| to null.
Source:

(private) createError_(message, type) → (non-null) {Error}

Creates an error object with necessary details about the request.
Parameters:
Name Type Description
message string The error message.
type string The error type.
Source:
Returns:
Type
Error

(private) destroy_()

Destroys the AJAX request. This happens automatically after the internal promise is resolved or rejected.
Source:

(private) handleDataUri_() → (non-null) {Promise}

Handles a data URI. This method does not modify |this|'s state.
Source:
Returns:
Type
Promise

(private) handleOfflineUri_() → (non-null) {Promise}

Handles an offline URI. This method does not modify |this|'s state.
Source:
Returns:
Type
Promise

(private) onError_(eventnon-null)

Handles an "error" event.
Parameters:
Name Type Description
event ProgressEvent The ProgressEvent from this.xhr_.
Source:

(private) onLoad_(eventnon-null)

Handles a "load" event.
Parameters:
Name Type Description
event ProgressEvent The ProgressEvent from the request.
Source:

(private) onReadyStateChange_()

Handles a "readystatechange" event.
Source:

(private) onTimeout_(eventnon-null)

Handles a "timeout" event.
Parameters:
Name Type Description
event ProgressEvent The ProgressEvent from this.xhr_.
Source:

(private) resendInternal_()

Resends request.
Source:

send() → {Promise.<!XMLHttpRequest>}

Sends the request. Called by subclasses.
Source:
Returns:
Type
Promise.<!XMLHttpRequest>