Class ChunkQueueManager

Base class for defining a SharedObject type that will never be owned.

Hierarchy

SharedObjectCounterpart
- ChunkQueueManager

Index

Constructors

constructor

Constructors

constructor

new ChunkQueueManager(rpc: RPC, options: any): ChunkQueueManager
Parameters
- rpc: RPC
- options: any
Returns ChunkQueueManager
Overrides SharedObjectCounterpart.constructor
- Defined in src/neuroglancer/chunk_manager/backend.ts:645

Properties

RPC_TYPE_ID

RPC_TYPE_ID: string

Should be set to a constant specifying the SharedObject type identifier on the prototype of final derived owner classes. It is not used on counterpart (non-owner) classes.

computeCapacity

computeCapacity: AvailableCapacity

`Private` computeEvictionQueue

computeEvictionQueue: ChunkPriorityQueue = ...

Contains all chunks in COMPUTING state.

disposedStacks

disposedStacks: any

downloadCapacity

downloadCapacity: AvailableCapacity[]

Download capacity for each sourceQueueLevel.

`Private` downloadEvictionQueue

downloadEvictionQueue: ChunkPriorityQueue[] = ...

Contains all chunks in DOWNLOADING state, for each sourceQueueLevel.

enablePrefetch

enablePrefetch: SharedWatchableValue<boolean>

gpuMemoryCapacity

gpuMemoryCapacity: AvailableCapacity

gpuMemoryChanged

gpuMemoryChanged: NullarySignal = ...

`Private` gpuMemoryEvictionQueue

gpuMemoryEvictionQueue: ChunkPriorityQueue = ...

Contains all chunks in GPU_MEMORY state.

`Private` gpuMemoryGeneration

gpuMemoryGeneration: number = 0

`Private` gpuMemoryPromotionQueue

gpuMemoryPromotionQueue: ChunkPriorityQueue = ...

Contains all chunks in SYSTEM_MEMORY state not in RECENT priority tier.

isOwner

isOwner: undefined | boolean

`Private` numFailed

numFailed: number = 0

`Private` numQueued

numQueued: number = 0

`Private` queuedComputePromotionQueue

queuedComputePromotionQueue: ChunkPriorityQueue = ...

Contains all chunks in QUEUED state pending compute.

`Private` queuedDownloadPromotionQueue

queuedDownloadPromotionQueue: ChunkPriorityQueue[] = ...

Contains all chunks in QUEUED state pending download, for each sourceQueueLevel.

refCount

refCount: number = 1

referencedGeneration

referencedGeneration: number

rpc

rpc: null | RPC = null

rpcId

rpcId: null | number = null

sources

sources: Set<ChunkSource> = ...

Set of chunk sources associated with this queue manager.

systemMemoryCapacity

systemMemoryCapacity: AvailableCapacity

`Private` systemMemoryEvictionQueue

systemMemoryEvictionQueue: ChunkPriorityQueue = ...

Contains all chunks that take up memory (DOWNLOADING, SYSTEM_MEMORY, GPU_MEMORY).

unreferencedGeneration

unreferencedGeneration: number

`Private` updatePending

updatePending: any = null

wasDisposed

wasDisposed: undefined | boolean

Methods

`Private` addChunkToQueues_

addChunkToQueues_(chunk: Chunk): boolean
Parameters
- chunk: Chunk
Returns boolean
- Defined in src/neuroglancer/chunk_manager/backend.ts:742

addCounterpartRef

addCounterpartRef(): {
gen: number;
id: null | number;
}
Precondition: this.isOwner === true.

Returns {
gen: number;
id: null | number;
}
- gen: number
- id: null | number
Inherited from SharedObjectCounterpart.addCounterpartRef
- Defined in src/neuroglancer/worker_rpc.ts:199

addRef

addRef(): ChunkQueueManager
Returns ChunkQueueManager
Inherited from SharedObjectCounterpart.addRef
- Defined in src/neuroglancer/util/disposable.ts:48

adjustCapacitiesForChunk

adjustCapacitiesForChunk(chunk: Chunk, add: boolean): void
Parameters
- chunk: Chunk
- add: boolean
Returns void
- Defined in src/neuroglancer/chunk_manager/backend.ts:704

chunkQueuesForChunk

chunkQueuesForChunk(chunk: Chunk): Generator<ChunkPriorityQueue, void, unknown>
Parameters
- chunk: Chunk
Returns Generator<ChunkPriorityQueue, void, unknown>
- Defined in src/neuroglancer/chunk_manager/backend.ts:669

copyChunkToGPU

copyChunkToGPU(chunk: Chunk): void
Parameters
- chunk: Chunk
Returns void
- Defined in src/neuroglancer/chunk_manager/backend.ts:842

counterpartRefCountReachedZero

counterpartRefCountReachedZero(generation: number): void
Precondition: this.isOwner === true.

This should be called when the counterpart's refCount is decremented and reaches zero.
Parameters
- generation: number
Returns void
Inherited from SharedObjectCounterpart.counterpartRefCountReachedZero
- Defined in src/neuroglancer/worker_rpc.ts:234

dispose

dispose(): void
Returns void
Inherited from SharedObjectCounterpart.dispose
- Defined in src/neuroglancer/worker_rpc.ts:192

disposed

disposed(): void
Returns void
Inherited from SharedObjectCounterpart.disposed
- Defined in src/neuroglancer/util/disposable.ts:75

freeChunkGPUMemory

freeChunkGPUMemory(chunk: Chunk): void
Parameters
- chunk: Chunk
Returns void
- Defined in src/neuroglancer/chunk_manager/backend.ts:820

freeChunkSystemMemory

freeChunkSystemMemory(chunk: Chunk): void
Parameters
- chunk: Chunk
Returns void
- Defined in src/neuroglancer/chunk_manager/backend.ts:827

initializeCounterpart

initializeCounterpart(rpc: RPC, options?: any): void
Parameters
- rpc: RPC
- options: any = {}
Returns void
Inherited from SharedObjectCounterpart.initializeCounterpart
- Defined in src/neuroglancer/worker_rpc.ts:182

initializeSharedObject

initializeSharedObject(rpc: RPC, rpcId?: number): void
Parameters
- rpc: RPC
- rpcId: number = ...
Returns void
Inherited from SharedObjectCounterpart.initializeSharedObject
- Defined in src/neuroglancer/worker_rpc.ts:175

invalidateSourceCache

invalidateSourceCache(source: ChunkSource): void
Parameters
- source: ChunkSource
Returns void
- Defined in src/neuroglancer/chunk_manager/backend.ts:939

logStatistics

logStatistics(): void
Returns void
- Defined in src/neuroglancer/chunk_manager/backend.ts:930

`Protected` ownerDispose

ownerDispose(): void
Precondition: this.isOwner === true.

Returns void
Inherited from SharedObjectCounterpart.ownerDispose
- Defined in src/neuroglancer/worker_rpc.ts:219

performChunkPriorityUpdate

performChunkPriorityUpdate(chunk: Chunk): void
Parameters
- chunk: Chunk
Returns void
- Defined in src/neuroglancer/chunk_manager/backend.ts:758

process

process(): void
Returns void
- Defined in src/neuroglancer/chunk_manager/backend.ts:916

`Private` processGPUPromotions_

processGPUPromotions_(): void
Returns void
- Defined in src/neuroglancer/chunk_manager/backend.ts:793

`Private` processQueuePromotions_

processQueuePromotions_(): void
Returns void
- Defined in src/neuroglancer/chunk_manager/backend.ts:858

`Protected` refCountReachedZero

refCountReachedZero(): void
Returns void
Inherited from SharedObjectCounterpart.refCountReachedZero
- Defined in src/neuroglancer/worker_rpc.ts:203

registerCancellable

registerCancellable<T>(cancellable: T): T
Type Parameters
- T extends {
  cancel: (() => void);
  }
Parameters
- cancellable: T
Returns T
Inherited from SharedObjectCounterpart.registerCancellable
- Defined in src/neuroglancer/util/disposable.ts:100

registerDisposer

registerDisposer<T>(f: T): T
Type Parameters
- T extends Disposer
Parameters
- f: T
Returns T
Inherited from SharedObjectCounterpart.registerDisposer
- Defined in src/neuroglancer/util/disposable.ts:76

registerEventListener

registerEventListener(target: EventTarget, type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void
Parameters
- target: EventTarget
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void
Inherited from SharedObjectCounterpart.registerEventListener
- Defined in src/neuroglancer/util/disposable.ts:95

`Private` removeChunkFromQueues_

removeChunkFromQueues_(chunk: Chunk): void
Parameters
- chunk: Chunk
Returns void
- Defined in src/neuroglancer/chunk_manager/backend.ts:734

retrieveChunkData

retrieveChunkData(chunk: Chunk): Promise<TypedArray>
Parameters
- chunk: Chunk
Returns Promise<TypedArray>
- Defined in src/neuroglancer/chunk_manager/backend.ts:837

scheduleUpdate

scheduleUpdate(): void
Returns void
- Defined in src/neuroglancer/chunk_manager/backend.ts:663

unregisterDisposer

unregisterDisposer<T>(f: T): T
Type Parameters
- T extends Disposer
Parameters
- f: T
Returns T
Inherited from SharedObjectCounterpart.unregisterDisposer
- Defined in src/neuroglancer/util/disposable.ts:85

updateChunkState

updateChunkState(chunk: Chunk, newState: ChunkState): void
Parameters
- chunk: Chunk
- newState: ChunkState
Returns void
- Defined in src/neuroglancer/chunk_manager/backend.ts:778

Class ChunkQueueManager

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

rpc: RPC

options: any

Returns ChunkQueueManager

Properties

RPC_TYPE_ID

computeCapacity

Private computeEvictionQueue

disposedStacks

downloadCapacity

Private downloadEvictionQueue

enablePrefetch

gpuMemoryCapacity

gpuMemoryChanged

Private gpuMemoryEvictionQueue

Private gpuMemoryGeneration

Private gpuMemoryPromotionQueue

isOwner

Private numFailed

Private numQueued

Private queuedComputePromotionQueue

Private queuedDownloadPromotionQueue

refCount

referencedGeneration

rpc

rpcId

sources

systemMemoryCapacity

Private systemMemoryEvictionQueue

unreferencedGeneration

Private updatePending

wasDisposed

Methods

Private addChunkToQueues_

Parameters

chunk: Chunk

Returns boolean

addCounterpartRef

Returns { gen: number; id: null | number; }

gen: number

id: null | number

addRef

Returns ChunkQueueManager

adjustCapacitiesForChunk

Parameters

chunk: Chunk

add: boolean

Returns void

chunkQueuesForChunk

Parameters

chunk: Chunk

Returns Generator<ChunkPriorityQueue, void, unknown>

copyChunkToGPU

Parameters

chunk: Chunk

Returns void

counterpartRefCountReachedZero

Parameters

generation: number

Returns void

dispose

Returns void

disposed

Returns void

freeChunkGPUMemory

Parameters

chunk: Chunk

Returns void

freeChunkSystemMemory

Parameters

chunk: Chunk

Returns void

`Private` computeEvictionQueue

`Private` downloadEvictionQueue

`Private` gpuMemoryEvictionQueue

`Private` gpuMemoryGeneration

`Private` gpuMemoryPromotionQueue

`Private` numFailed

`Private` numQueued

`Private` queuedComputePromotionQueue

`Private` queuedDownloadPromotionQueue

`Private` systemMemoryEvictionQueue

`Private` updatePending

`Private` addChunkToQueues_

Returns {
gen: number;
id: null | number;
}

`Protected` ownerDispose

`Private` processGPUPromotions_

`Private` processQueuePromotions_

`Protected` refCountReachedZero

T extends {
cancel: (() => void);
}

`Optional` options: boolean | AddEventListenerOptions

`Private` removeChunkFromQueues_