Class SharedWatchableValue<T>

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

Type Parameters

Hierarchy

SharedObjectCounterpart
- SharedWatchableValue

Implements

WatchableValueInterface<T>

Constructors

constructor

new SharedWatchableValue<T>(rpc?: RPC, options?: any): SharedWatchableValue<T>
Type Parameters
- T
Parameters
- Optional rpc: RPC
- options: any = {}
Returns SharedWatchableValue<T>
Overrides SharedObjectCounterpart.constructor
- Defined in src/neuroglancer/shared_watchable_value.ts:37

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.

base

base: WatchableValueInterface<T>

disposedStacks

disposedStacks: any

isOwner

isOwner: undefined | boolean

refCount

refCount: number = 1

referencedGeneration

referencedGeneration: number

rpc

rpc: null | RPC = null

rpcId

rpcId: null | number = null

unreferencedGeneration

unreferencedGeneration: number

`Internal` updatingValue_

updatingValue_: boolean = false

The value is being updated to reflect a remote change.

wasDisposed

wasDisposed: undefined | boolean

Accessors

changed

get changed(): NullaryReadonlySignal
Returns NullaryReadonlySignal
Implementation of WatchableValueInterface.changed
- Defined in src/neuroglancer/shared_watchable_value.ts:83

value

get value(): T
Returns T
Implementation of WatchableValueInterface.value
- Defined in src/neuroglancer/shared_watchable_value.ts:75
set value(value: T): void
Parameters
- value: T
Returns void
Implementation of WatchableValueInterface.value
- Defined in src/neuroglancer/shared_watchable_value.ts:79

Methods

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(): SharedWatchableValue<T>
Returns SharedWatchableValue<T>
Inherited from SharedObjectCounterpart.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 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

initializeCounterpart

initializeCounterpart(rpc: RPC, options?: any): void
Parameters
- rpc: RPC
- options: any = {}
Returns void
Overrides SharedObjectCounterpart.initializeCounterpart
- Defined in src/neuroglancer/shared_watchable_value.ts:45

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

`Protected` ownerDispose

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

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

`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` setupChangedHandler

setupChangedHandler(): void
Returns void
- Defined in src/neuroglancer/shared_watchable_value.ts:50

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

`Static` make

make<T>(rpc: RPC, value: T): SharedWatchableValue<T>
Type Parameters
- T
Parameters
- rpc: RPC
- value: T
Returns SharedWatchableValue<T>
- Defined in src/neuroglancer/shared_watchable_value.ts:71

`Static` makeFromExisting

makeFromExisting<T>(rpc: RPC, base: WatchableValueInterface<T>): SharedWatchableValue<T>
Type Parameters
- T
Parameters
- rpc: RPC
- base: WatchableValueInterface<T>
Returns SharedWatchableValue<T>
- Defined in src/neuroglancer/shared_watchable_value.ts:63

Class SharedWatchableValue<T>

Type Parameters

T

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T

Parameters

Optional rpc: RPC

options: any = {}

Returns SharedWatchableValue<T>

Properties

RPC_TYPE_ID

base

disposedStacks

isOwner

refCount

referencedGeneration

rpc

rpcId

unreferencedGeneration

Internal updatingValue_

wasDisposed

Accessors

changed

Returns NullaryReadonlySignal

value

Returns T

Parameters

value: T

Returns void

Methods

addCounterpartRef

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

gen: number

id: null | number

addRef

Returns SharedWatchableValue<T>

counterpartRefCountReachedZero

Parameters

generation: number

Returns void

dispose

Returns void

disposed

Returns void

initializeCounterpart

Parameters

rpc: RPC

options: any = {}

Returns void

initializeSharedObject

Parameters

rpc: RPC

rpcId: number = ...

Returns void

Protected ownerDispose

Returns void

Protected refCountReachedZero

Returns void

registerCancellable

Type Parameters

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

Parameters

cancellable: T

Returns T

registerDisposer

Type Parameters

T extends Disposer

Parameters

f: T

Returns T

registerEventListener

`Optional` rpc: RPC

`Internal` updatingValue_

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

`Protected` ownerDispose

`Protected` refCountReachedZero

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

`Optional` options: boolean | AddEventListenerOptions

`Private` setupChangedHandler

`Static` make

`Static` makeFromExisting