OpenLIME

Class: Cache

Cache

Cache manager for efficient tile management and retrieval in layers. Implements a singleton pattern for centralized cache control across the application. Handles tile loading, prefetching, and memory management with rate limiting capabilities.

new Cache( [options])

Creates or returns the existing Cache instance.

Parameters:
Name Type Argument Description
options Object <optional>

Configuration options for the cache

Properties
Name Type Argument Default Description
capacity number <optional>
 536870912

Total cache capacity in bytes (default: 512MB)
maxRequest number <optional>
 6

Maximum concurrent HTTP requests
maxRequestsRate number <optional>
 0

Maximum requests per second (0 for unlimited)
maxPrefetch number <optional>
 8388608

Maximum prefetch size in bytes (default: 8MB)
Source:
Returns:

The singleton Cache instance

Type
Cache

Methods

flushLayer(layer)

Removes all tiles associated with a specific layer from the cache.

Parameters:
Name Type Description
layer Layer

The layer whose tiles should be flushed
Source:

getStats()

Gets current cache statistics.

Source:
Returns:

Current cache statistics

Type
Object

setCandidates(layer)

Registers a layer's tiles as candidates for downloading and initiates the update process.

Parameters:
Name Type Description
layer Layer

The layer whose tiles should be considered for caching
Source:

update()

Updates the cache state by processing the download queue while respecting capacity and rate limits.

Source:

<static> getInstance( [options])

Gets the singleton instance with optional configuration update.

Parameters:
Name Type Argument Description
options Object <optional>

Configuration options to update
Source:
Returns:

The singleton Cache instance

Type
Cache