CachedRegionTracker
@UnstableApi
class CachedRegionTracker : Cache.Listener
Utility class for efficiently tracking regions of data that are stored in a Cache for a given cache key.
Summary
Constants |
|
|---|---|
const Int |
CACHED_TO_END = -2 |
const Int |
NOT_CACHED = -1 |
Public constructors |
|---|
CachedRegionTracker(cache: Cache!, cacheKey: String!, chunkIndex: ChunkIndex!) |
Public functions |
|
|---|---|
synchronized Int |
getRegionEndTimeMs(byteOffset: Long)When provided with a byte offset, this method locates the cached region within which the offset falls, and returns the approximate end position in milliseconds of that region. |
synchronized Unit |
onSpanAdded(cache: Cache!, span: CacheSpan!)Called when a |
synchronized Unit |
onSpanRemoved(cache: Cache!, span: CacheSpan!)Called when a |
Unit |
onSpanTouched(cache: Cache!, oldSpan: CacheSpan!, newSpan: CacheSpan!)Called when an existing |
Unit |
release() |
Public constructors
Public functions
getRegionEndTimeMs
synchronized fun getRegionEndTimeMs(byteOffset: Long): Int
When provided with a byte offset, this method locates the cached region within which the offset falls, and returns the approximate end position in milliseconds of that region. If the byte offset does not fall within a cached region then NOT_CACHED is returned. If the cached region extends to the end of the stream, CACHED_TO_END is returned.
| Parameters | |
|---|---|
byteOffset: Long |
The byte offset in the underlying stream. |
| Returns | |
|---|---|
Int |
The end position of the corresponding cache region, |
onSpanAdded
synchronized fun onSpanAdded(cache: Cache!, span: CacheSpan!): Unit
Called when a CacheSpan is added to the cache.
onSpanRemoved
synchronized fun onSpanRemoved(cache: Cache!, span: CacheSpan!): Unit
Called when a CacheSpan is removed from the cache.
onSpanTouched
fun onSpanTouched(cache: Cache!, oldSpan: CacheSpan!, newSpan: CacheSpan!): Unit
Called when an existing CacheSpan is touched, causing it to be replaced. The new CacheSpan is guaranteed to represent the same data as the one it replaces, however file and lastTouchTimestamp may have changed.
Note that for span replacement, onSpanAdded and onSpanRemoved are not called in addition to this method.