kotlin-cesium-engine/cesium.engine/Request

Request

external class Request(options: Request.ConstructorOptions? = definedExternally)(source)

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

Constructors

Request

constructor(options: Request.ConstructorOptions? = definedExternally)

Types

ConstructorOptions

sealed interface ConstructorOptions

Properties

cancelFunction

var cancelFunction: CancelCallback

The function that is called when the request is cancelled.

priority

var priority: Double

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.

priorityFunction

var priorityFunction: PriorityCallback

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

requestFunction

var requestFunction: RequestCallback

The function that makes the actual data request.

state

val state: RequestState

The current state of the request.

throttle

val throttle: Boolean

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.

throttleByServer

val throttleByServer: Boolean

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.

type

val type: RequestType

Type of request.

url

var url: String

The URL to request.

Functions

clone

fun clone(result: Request? = definedExternally): Request

Duplicates a Request instance.

Request

See also

Constructors

Types

Properties

Functions