Class BossMeshSource

Hierarchy

__type<MeshSourceParameters, {
    prototype: __type<any, any>;
    encodeOptions(options: {
        credentialsProvider: CredentialsProvider<string>;
    }): any;
    new (...args: any[]): __type<string, typeof MeshSource>;
} & typeof MeshSource, this> & __type<string, typeof MeshSource, this> & MeshSource<this>
- BossMeshSource

Constructors

constructor

new BossMeshSource(chunkManager: ChunkManager, options: MeshSourceOptions): BossMeshSource
Parameters
- chunkManager: ChunkManager
- options: MeshSourceOptions
Returns BossMeshSource
Inherited from (WithParameters(WithCredentialsProvider<BossToken>()(MeshSource), MeshSourceParameters)).constructor
- Defined in src/neuroglancer/mesh/frontend.ts:470

Properties

OPTIONS

OPTIONS: {
credentialsProvider: CredentialsProvider<string>;
} & {
parameters: MeshSourceParameters;
}

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.

chunkManager

chunkManager: ChunkManager

chunks

chunks: Map<string, ManifestChunk>

credentialsProvider

credentialsProvider: CredentialsProvider<string>

disposedStacks

disposedStacks: any

fragmentSource

fragmentSource: FragmentSource = ...

immediateChunkUpdates

immediateChunkUpdates: boolean = false

If set to true, chunk updates will be applied to this source immediately, rather than queueing them. Sources that dynamically update chunks and need to ensure a consistent order of processing relative to other messages between the frontend and worker should set this to true.

isOwner

isOwner: undefined | boolean

key

key: any

parameters

parameters: MeshSourceParameters

refCount

refCount: number = 1

referencedGeneration

referencedGeneration: number

rpc

rpc: null | RPC = null

rpcId

rpcId: null | number = null

unreferencedGeneration

unreferencedGeneration: number

wasDisposed

wasDisposed: undefined | boolean

Accessors

gl

get gl(): GL
Returns GL
Inherited from (WithParameters(WithCredentialsProvider<BossToken>()(MeshSource), MeshSourceParameters)).gl
- Defined in src/neuroglancer/chunk_manager/frontend.ts:372

Methods

addChunk

addChunk(key: string, chunk: Chunk): void
Parameters
- key: string
- chunk: Chunk
Returns void
Inherited from (WithParameters(WithCredentialsProvider<BossToken>()(MeshSource), MeshSourceParameters)).addChunk
- Defined in src/neuroglancer/chunk_manager/frontend.ts:384

addCounterpartRef

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

Returns {
gen: number;
id: null | number;
}
- gen: number
- id: null | number
Inherited from (WithParameters(WithCredentialsProvider<BossToken>()(MeshSource), MeshSourceParameters)).addCounterpartRef
- Defined in src/neuroglancer/worker_rpc.ts:199

addRef

addRef(): BossMeshSource
Returns BossMeshSource
Inherited from (WithParameters(WithCredentialsProvider<BossToken>()(MeshSource), MeshSourceParameters)).addRef
- Defined in src/neuroglancer/util/disposable.ts:48

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 (WithParameters(WithCredentialsProvider<BossToken>()(MeshSource), MeshSourceParameters)).counterpartRefCountReachedZero
- Defined in src/neuroglancer/worker_rpc.ts:234

deleteChunk

deleteChunk(key: string): void
Parameters
- key: string
Returns void
Inherited from (WithParameters(WithCredentialsProvider<BossToken>()(MeshSource), MeshSourceParameters)).deleteChunk
- Defined in src/neuroglancer/chunk_manager/frontend.ts:376

dispose

dispose(): void
Returns void
Inherited from (WithParameters(WithCredentialsProvider<BossToken>()(MeshSource), MeshSourceParameters)).dispose
- Defined in src/neuroglancer/worker_rpc.ts:192

disposed

disposed(): void
Returns void
Inherited from (WithParameters(WithCredentialsProvider<BossToken>()(MeshSource), MeshSourceParameters)).disposed
- Defined in src/neuroglancer/util/disposable.ts:75

getChunk

getChunk(x: any): ManifestChunk
Parameters
- x: any
Returns ManifestChunk
Inherited from (WithParameters(WithCredentialsProvider<BossToken>()(MeshSource), MeshSourceParameters)).getChunk
- Defined in src/neuroglancer/mesh/frontend.ts:479

initializeCounterpart

initializeCounterpart(rpc: RPC, options: any): void
Parameters
- rpc: RPC
- options: any
Returns void
Inherited from (WithParameters(WithCredentialsProvider<BossToken>()(MeshSource), MeshSourceParameters)).initializeCounterpart
- Defined in src/neuroglancer/chunk_manager/frontend.ts:423

initializeSharedObject

initializeSharedObject(rpc: RPC, rpcId?: number): void
Parameters
- rpc: RPC
- rpcId: number = ...
Returns void
Inherited from (WithParameters(WithCredentialsProvider<BossToken>()(MeshSource), MeshSourceParameters)).initializeSharedObject
- Defined in src/neuroglancer/worker_rpc.ts:175

invalidateCache

invalidateCache(): void
Invalidates the chunk cache. Operates asynchronously.

Returns void
Inherited from (WithParameters(WithCredentialsProvider<BossToken>()(MeshSource), MeshSourceParameters)).invalidateCache
- Defined in src/neuroglancer/chunk_manager/frontend.ts:398

`Protected` ownerDispose

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

Returns void
Inherited from (WithParameters(WithCredentialsProvider<BossToken>()(MeshSource), MeshSourceParameters)).ownerDispose
- Defined in src/neuroglancer/worker_rpc.ts:219

`Protected` refCountReachedZero

refCountReachedZero(): void
Returns void
Inherited from (WithParameters(WithCredentialsProvider<BossToken>()(MeshSource), MeshSourceParameters)).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 (WithParameters(WithCredentialsProvider<BossToken>()(MeshSource), MeshSourceParameters)).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 (WithParameters(WithCredentialsProvider<BossToken>()(MeshSource), MeshSourceParameters)).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 (WithParameters(WithCredentialsProvider<BossToken>()(MeshSource), MeshSourceParameters)).registerEventListener
- Defined in src/neuroglancer/util/disposable.ts:95

unregisterDisposer

unregisterDisposer<T>(f: T): T
Type Parameters
- T extends Disposer
Parameters
- f: T
Returns T
Inherited from (WithParameters(WithCredentialsProvider<BossToken>()(MeshSource), MeshSourceParameters)).unregisterDisposer
- Defined in src/neuroglancer/util/disposable.ts:85

`Static` encodeOptions

encodeOptions(options: WithParametersOptions): any
Parameters
- options: WithParametersOptions
Returns any
Inherited from (WithParameters(WithCredentialsProvider<BossToken>()(MeshSource), MeshSourceParameters)).encodeOptions
- Defined in src/neuroglancer/chunk_manager/frontend.ts:427
encodeOptions(options: {
credentialsProvider: CredentialsProvider<string>;
}): any
Parameters
- options: {
  credentialsProvider: CredentialsProvider<string>;
  }
  - credentialsProvider: CredentialsProvider<string>
Returns any
Inherited from (WithParameters(WithCredentialsProvider<BossToken>()(MeshSource), MeshSourceParameters)).encodeOptions
- Defined in src/neuroglancer/credentials_provider/chunk_source_frontend.ts:67
encodeOptions(_options: {}): {
[key: string]: any;
}
Parameters
- _options: {}
Returns {
[key: string]: any;
}
- [key: string]: any
Inherited from (WithParameters(WithCredentialsProvider<BossToken>()(MeshSource), MeshSourceParameters)).encodeOptions
- Defined in src/neuroglancer/chunk_manager/frontend.ts:402

Class BossMeshSource

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

chunkManager: ChunkManager

options: MeshSourceOptions

Returns BossMeshSource

Properties

OPTIONS

RPC_TYPE_ID

chunkManager

chunks

credentialsProvider

disposedStacks

fragmentSource

immediateChunkUpdates

isOwner

key

parameters

refCount

referencedGeneration

rpc

rpcId

unreferencedGeneration

wasDisposed

Accessors

gl

Returns GL

Methods

addChunk

Parameters

key: string

chunk: Chunk

Returns void

addCounterpartRef

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

gen: number

id: null | number

addRef

Returns BossMeshSource

counterpartRefCountReachedZero

Parameters

generation: number

Returns void

deleteChunk

Parameters

key: string

Returns void

dispose

Returns void

disposed

Returns void

getChunk

Parameters

x: any

Returns ManifestChunk

initializeCounterpart

Parameters

rpc: RPC

options: any

Returns void

initializeSharedObject

Parameters

rpc: RPC

rpcId: number = ...

Returns void

invalidateCache

Returns void

Protected ownerDispose

Returns void

Protected refCountReachedZero

Returns void

registerCancellable

Type Parameters

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

`Protected` ownerDispose

`Protected` refCountReachedZero

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

`Optional` options: boolean | AddEventListenerOptions

`Static` encodeOptions

options: {
credentialsProvider: CredentialsProvider<string>;
}

Returns {
[key: string]: any;
}