org.cesiumjs.cs.core

Class Request

java.lang.Object

org.cesiumjs.cs.core.Request

@JsType(isNative=true,
        namespace="Cesium",
        name="Request")
public class Request
extends Object

Stores information for making a request. In general this does not need to be constructed directly.

Author:

Serge Silaev aka iSergio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Request.CancelCallback
static interface	Request.PriorityCallback
static interface	Request.RequestCallback

Field Summary

Fields

Modifier and Type	Field and Description
Request.CancelCallback	cancelFunction The function that is called when the request is cancelled.
double	priority Priority is a unit-less value where lower values represent higher priority.
Request.PriorityCallback	priorityFunction The function that is called to update the request's priority, which occurs once per frame.
Number	readonlystate The current state of the request.
Request.RequestCallback	requestFunction The function that makes the actual data request.
String	url The URL to request.

Constructor Summary

Constructors

Constructor and Description
Request() Stores information for making a request.
Request(RequestOptions options) Stores information for making a request.

Method Summary

Modifier and Type	Method and Description
boolean	throttle() Whether to throttle and prioritize the request.
boolean	throttleByServer() Whether to throttle the request by server.
Number	type() Type of request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

cancelFunction

@JsProperty
public Request.CancelCallback cancelFunction

The function that is called when the request is cancelled.

priority

@JsProperty
public double priority

Priority is a unit-less value where lower values represent higher priority. For world-based objects, this is usually the distance from the camera. A request that does not have a priority function defaults to a priority of 0. If priorityFunction is defined, this value is updated every frame with the result of that call. Default: 0.0

priorityFunction

@JsProperty
public Request.PriorityCallback priorityFunction

The function that is called to update the request's priority, which occurs once per frame.

requestFunction

@JsProperty
public Request.RequestCallback requestFunction

The function that makes the actual data request.

readonlystate

@JsProperty
public Number readonlystate

The current state of the request.

See Also:

RequestState

url

@JsProperty
public String url

The URL to request.

Constructor Detail

Request

@JsConstructor
public Request()

Stores information for making a request. In general this does not need to be constructed directly.

Request

@JsConstructor
public Request(RequestOptions options)

Stores information for making a request. In general this does not need to be constructed directly.

Parameters:

options - RequestOptions

Method Detail

throttle

@JsProperty(name="throttle")
public boolean throttle()

Whether to throttle and prioritize the request. If false, the request will be sent immediately. If true, the request will be throttled and sent based on priority. Default: false

throttleByServer

@JsProperty(name="throttleByServer")
public boolean throttleByServer()

Whether to throttle the request by server. Browsers typically support about 6-8 parallel connections for HTTP/1 servers, and an unlimited amount of connections for HTTP/2 servers. Setting this value to true is preferable for requests going through HTTP/1 servers. Default: false

type

@JsProperty(name="type")
public Number type()

Type of request.

See Also:

Default: {@link RequestType#OTHER()}