Because browsers throttle the number of parallel requests allowed to each server,
this function tracks the number of active requests in progress to each server, and
returns undefined immediately if the request would exceed the maximum, allowing
the caller to retry later, instead of queueing indefinitely under the browser's control.
Parameters:
Name | Type | Description |
---|---|---|
url |
String | The URL to request. |
requestFunction |
throttleRequestByServer~RequestFunction | The actual function that makes the request. |
- Source:
- See:
Returns:
Either undefined, meaning the request would exceed the maximum number of
parallel requests, or a Promise for the requested data.
- Type
- Promise.<Object> | undefined
Example
// throttle requests for an image
var url = 'http://madeupserver.example.com/myImage.png';
function requestFunction(url) {
// in this simple example, loadImage could be used directly as requestFunction.
return Cesium.loadImage(url);
};
var promise = Cesium.throttleRequestByServer(url, requestFunction);
if (!Cesium.defined(promise)) {
// too many active requests in progress, try again later.
} else {
promise.then(function(image) {
// handle loaded image
});
}
Members
(static) maximumRequestsPerServer :Number
Specifies the maximum number of requests that can be simultaneously open to a single server. If this value is higher than
the number of requests per server actually allowed by the web browser, Cesium's ability to prioritize requests will be adversely
affected.
Type:
- Number
- Default Value:
- 6
- Source: