Class JDRegisterServer<TValues>

A register "server" instance, used to assembly service servers.

Type Parameters

TValues extends PackedValues

Hierarchy

JDEventSource
- JDRegisterServer

JDOM

`Readonly` eventStats

eventStats: Record<string, number> = {}

Gets a counter of event emit calls.

newListenerStats

newListenerStats: Record<string, number> = undefined

Gets a counter map from events to new listener counts

`Readonly` nodeId

nodeId: number = ...

Gets an internal unique node identifier, mostly used for debugging.

changeId

get changeId(): number
Gets a counter for the CHANGE event.

Returns number
Inherited from JDEventSource.changeId
- Defined in src/jdom/eventsource.ts:325

emit

emit(eventName, ...args): boolean
Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.
Parameters
- eventName: string
- Rest ...args: unknown[]
Returns boolean
Inherited from JDEventSource.emit
- Defined in src/jdom/eventsource.ts:237

eventNames

eventNames(): string[]
Returns an array listing the events for which the emitter has registered listeners.

Returns string[]
Inherited from JDEventSource.eventNames
- Defined in src/jdom/eventsource.ts:294

listenerCount

listenerCount(eventName): number
Gets the number of listeners for a given event
Parameters
- eventName: string
  
  name of the event
Returns number
number of registered handlers
Inherited from JDEventSource.listenerCount
- Defined in src/jdom/eventsource.ts:273

listenerStackTraces

listenerStackTraces(eventName): string[]
Gets the list stack trace where an event was registered. Only enabled if Flags.debug is true.
Parameters
- eventName: string
  
  name of the event
Returns string[]
stack traces where a listener was added
Inherited from JDEventSource.listenerStackTraces
- Defined in src/jdom/eventsource.ts:285

observe

observe<T>(eventName): Observable<T>
Creates an observable from the given event
Type Parameters
- T
Parameters
- eventName: string | string[]
Returns Observable<T>
Inherited from JDEventSource.observe
- Defined in src/jdom/eventsource.ts:303

off

off(eventName, handler): JDRegisterServer<TValues>
Unregisters a handler for one or more events
Parameters
- eventName: string | string[]
  
  name or names of the events to subscribe
- handler: EventHandler
  
  handler to unregister
Returns JDRegisterServer<TValues>
current object instance
Inherited from JDEventSource.off
- Defined in src/jdom/eventsource.ts:137

on

on(eventName, handler): JDRegisterServer<TValues>
Registers a handler for one or more events
Parameters
- eventName: string | string[]
  
  name or names of the events to subscribe
- handler: EventHandler
  
  handler to register
Returns JDRegisterServer<TValues>
current object instance
Inherited from JDEventSource.on
- Defined in src/jdom/eventsource.ts:122

once

once(eventName, handler): JDRegisterServer<TValues>
Registers a handler for one or more events to run only once.
Parameters
- eventName: string | string[]
  
  name or names of the events to subscribe
- handler: EventHandler
  
  handler to execute
Returns JDRegisterServer<TValues>
current object instance
Inherited from JDEventSource.once
- Defined in src/jdom/eventsource.ts:151

subscribe<T>(eventName, next): (() => void)
Subscribes to an event and returns the unsubscription handler
Type Parameters
- T
Parameters
- eventName: string | string[]
- next: ((value) => void)
  - - (value): void
    - Parameters
      
      value: T
      
      Returns void
Returns (() => void)
- - (): void
  - Subscribes to an event and returns the unsubscription handler
    
    Returns void
    
    Category
    JDOM
Inherited from JDEventSource.subscribe
- Defined in src/jdom/eventsource.ts:313

Other

constructor

new JDRegisterServer<TValues>(service, identifier, defaultValue?): JDRegisterServer<TValues>
Type Parameters
- TValues extends PackedValues
Parameters
- service: JDServiceServer
- identifier: number
- Optional defaultValue: TValues
Returns JDRegisterServer<TValues>
Overrides JDEventSource.constructor
- Defined in src/jdom/servers/registerserver.ts:86

allowLargeFrames

allowLargeFrames: boolean = false

data

data: Uint8Array

errorRegister

errorRegister: JDRegisterServer<TValues>

`Readonly` identifier

identifier: number

lastSetTime

lastSetTime: number

readOnly

readOnly: boolean

`Readonly` service

service: JDServiceServer

skipBoundaryCheck

skipBoundaryCheck: boolean = false

skipErrorInjection

skipErrorInjection: boolean = false

`Readonly` specification

specification: PacketInfo

valueProcessor

valueProcessor: ((values) => TValues)

Type declaration

- (values): TValues
- Parameters
  - values: TValues
  Returns TValues

packFormat

get packFormat(): string
Returns string
- Defined in src/jdom/servers/registerserver.ts:112

awaitOnce

awaitOnce(eventName, token?): Promise<void>
Awaits an event with a timeout. Throws JacdacError with timeout if operation does not return.
Parameters
- eventName: string | string[]
- Optional token: JDCancellationToken
Returns Promise<void>
Inherited from JDEventSource.awaitOnce
- Defined in src/jdom/eventsource.ts:163

handlePacket

handlePacket(pkt): boolean
Parameters
- pkt: Packet
Returns boolean
- Defined in src/jdom/servers/registerserver.ts:200

reset

reset(): void
Returns void
- Defined in src/jdom/servers/registerserver.ts:169

sendGetAsync

sendGetAsync(): Promise<void>
Returns Promise<void>
- Defined in src/jdom/servers/registerserver.ts:175

setValues

setValues(values, skipChangeEvent?): boolean
Sets the value on the register
Parameters
- values: TValues
  
  values to set
- Optional skipChangeEvent: boolean
  
  true to avoid emitting CHANGE
Returns boolean
true if values changed; false otherwise
- Defined in src/jdom/servers/registerserver.ts:153

values

values(): TValues
Returns TValues
- Defined in src/jdom/servers/registerserver.ts:116

Class JDRegisterServer<TValues>

Type Parameters

TValues extends PackedValues

Hierarchy

Index

JDOM

Other

JDOM

Readonly eventStats

newListenerStats

Readonly nodeId

changeId

Returns number

emit

Parameters

eventName: string

Rest ...args: unknown[]

Returns boolean

eventNames

Returns string[]

listenerCount

Parameters

eventName: string

Returns number

listenerStackTraces

Parameters

eventName: string

Returns string[]

observe

Type Parameters

T

Parameters

eventName: string | string[]

Returns Observable<T>

off

Parameters

eventName: string | string[]

handler: EventHandler

Returns JDRegisterServer<TValues>

on

Parameters

eventName: string | string[]

handler: EventHandler

Returns JDRegisterServer<TValues>

once

Parameters

eventName: string | string[]

handler: EventHandler

Returns JDRegisterServer<TValues>

subscribe

Type Parameters

T

Parameters

eventName: string | string[]

next: ((value) => void)

Parameters

value: T

Returns void

Returns (() => void)

Returns void

Category

Other

constructor

Type Parameters

TValues extends PackedValues

Parameters

service: JDServiceServer

identifier: number

Optional defaultValue: TValues

Returns JDRegisterServer<TValues>

allowLargeFrames

data

errorRegister

Readonly identifier

lastSetTime

readOnly

Readonly service

skipBoundaryCheck

skipErrorInjection

Readonly specification

`Readonly` eventStats

`Readonly` nodeId

`Rest` ...args: unknown[]

`Optional` defaultValue: TValues

`Readonly` identifier

`Readonly` service

`Readonly` specification

`Optional` token: JDCancellationToken

`Optional` skipChangeEvent: boolean