Class JDRegister

A Jacdac register client.

Hierarchy

JDServiceMemberNode
- JDRegister

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.

`Readonly` service

service: JDService

Parent service

changeId

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

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

children

get children(): JDNode[]
Gets the list of fields

Returns JDNode[]
Overrides JDServiceMemberNode.children
- Defined in src/jdom/register.ts:80

fields

get fields(): JDField[]
Gets the list of field, if the specification is known

Returns JDField[]
- Defined in src/jdom/register.ts:68

friendlyName

get friendlyName(): string
Gets the event friendly name.

Returns string
Inherited from JDServiceMemberNode.friendlyName
- Defined in src/jdom/servicemembernode.ts:94

id

get id(): string
Gets the node identifier in the JDOM tree

Returns string
Inherited from JDServiceMemberNode.id
- Defined in src/jdom/servicemembernode.ts:46

name

get name(): string
Gets the event name, if specified.

Returns string
Inherited from JDServiceMemberNode.name
- Defined in src/jdom/servicemembernode.ts:56

nodeData

get nodeData(): Record<string, unknown>
Gets a databag to store custom information

Returns Record<string, unknown>
Inherited from JDServiceMemberNode.nodeData
- Defined in src/jdom/node.ts:63

nodeKind

get nodeKind(): string
Returns REGISTER_NODE_NAME

Returns string
Overrides JDServiceMemberNode.nodeKind
- Defined in src/jdom/register.ts:60

notImplemented

get notImplemented(): boolean
Indicates if the member is not implemented on the server side

Returns boolean
Inherited from JDServiceMemberNode.notImplemented
- Defined in src/jdom/servicemembernode.ts:103

parent

get parent(): JDNode
Gets the parent service client instance.

Returns JDNode
Inherited from JDServiceMemberNode.parent
- Defined in src/jdom/servicemembernode.ts:86

qualifiedName

get qualifiedName(): string
Gets the qualitified event name, if specified.

Returns string
Inherited from JDServiceMemberNode.qualifiedName
- Defined in src/jdom/servicemembernode.ts:64

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 JDServiceMemberNode.emit
- Defined in src/jdom/eventsource.ts:237

emitPropagated

emitPropagated(event, arg?): void
Emit event in current node and parent nodes
Parameters
- event: string
  
  event to emit
- Optional arg: any
  
  event arguments
Returns void
Inherited from JDServiceMemberNode.emitPropagated
- Defined in src/jdom/node.ts:74

eventNames

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

Returns string[]
Inherited from JDServiceMemberNode.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 JDServiceMemberNode.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 JDServiceMemberNode.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 JDServiceMemberNode.observe
- Defined in src/jdom/eventsource.ts:303

off

off(eventName, handler): JDRegister
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 JDRegister
current object instance
Inherited from JDServiceMemberNode.off
- Defined in src/jdom/eventsource.ts:137

on

on(eventName, handler): JDRegister
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 JDRegister
current object instance
Inherited from JDServiceMemberNode.on
- Defined in src/jdom/eventsource.ts:122

once

once(eventName, handler): JDRegister
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 JDRegister
current object instance
Inherited from JDServiceMemberNode.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 JDServiceMemberNode.subscribe
- Defined in src/jdom/eventsource.ts:313

Data

boolValue

get boolValue(): boolean
Gets the data as a boolean

Returns boolean
- Defined in src/jdom/register.ts:257

data

get data(): Uint8Array
Gets the raw data from the last report packet

Returns Uint8Array
- Defined in src/jdom/register.ts:195

humanValue

get humanValue(): string
Gets a pretty printed represention of the data

Returns string
- Defined in src/jdom/register.ts:284

intValue

get intValue(): number
Gets the data as a signed integer

Returns number
- Defined in src/jdom/register.ts:239

lastDataTimestamp

get lastDataTimestamp(): number
Gets the timestamp when received the last report with data

Returns number
- Defined in src/jdom/register.ts:203

objectValue

get objectValue(): PackedObject
Gets the data from the last report packet, unpacked and hydrated into an object.

Returns PackedObject
- Defined in src/jdom/register.ts:226

stringValue

get stringValue(): string
Gets the data as a string

Returns string
- Defined in src/jdom/register.ts:266

uintValue

get uintValue(): number
Gets the data as a unsigned integer

Returns number
- Defined in src/jdom/register.ts:248

unpackedValue

get unpackedValue(): PackedValues
Get the data from the last report packet, unpacked according to the specification.

Returns PackedValues
- Defined in src/jdom/register.ts:211

refresh

refresh(skipIfValue?): Promise<boolean>
Refresh the value of the register within a timeout
Parameters
- Optional skipIfValue: boolean
  
  don't refresh if any data if available
Returns Promise<boolean>
true if refresh OK, false if timeout or other error
- Defined in src/jdom/register.ts:321

Other

needsRefresh

get needsRefresh(): boolean
Returns boolean
- Defined in src/jdom/register.ts:311

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 JDServiceMemberNode.awaitOnce
- Defined in src/jdom/eventsource.ts:163

clearData

clearData(): void
Clears all cached data from the register

Returns void
- Defined in src/jdom/register.ts:47

scheduleRefresh

scheduleRefresh(): void
Schedules to query the value for this register

Returns void
- Defined in src/jdom/register.ts:306

setNotImplemented

setNotImplemented(): void
Returns void
Overrides JDServiceMemberNode.setNotImplemented
- Defined in src/jdom/register.ts:369

Packets

lastGetAttempts

get lastGetAttempts(): number
Number of attempts to send a get packet without response

Returns number
- Defined in src/jdom/register.ts:113

lastGetTimestamp

get lastGetTimestamp(): number
Timestamp of the last register get packet

Returns number
- Defined in src/jdom/register.ts:96

lastSetTimestamp

get lastSetTimestamp(): number
Timestamp of the last register set packet

Returns number
- Defined in src/jdom/register.ts:88

sendGetAsync

sendGetAsync(): Promise<void>
Requests the value of the register by sending a get packet

Returns Promise<void>
- Defined in src/jdom/register.ts:139

sendSetAsync

sendSetAsync(data, autoRefresh?): Promise<void>
Send a message to set the register value
Parameters
- data: Uint8Array
  
  packed data
- Optional autoRefresh: boolean
  
  immediately send a get packet
Returns Promise<void>
- Defined in src/jdom/register.ts:124

sendSetBoolAsync

sendSetBoolAsync(value, autoRefresh?): Promise<void>
Sends a message to set the register value as a bpolean
Parameters
- value: boolean
- Optional autoRefresh: boolean
Returns Promise<void>
- Defined in src/jdom/register.ts:176

sendSetPackedAsync

sendSetPackedAsync(values, autoRefresh?): Promise<void>
Send a message to set the register value
Parameters
- values: PackedValues
  
  message to pack and send
- Optional autoRefresh: boolean
  
  immediately send a get packet
Returns Promise<void>
- Defined in src/jdom/register.ts:160

sendSetStringAsync

sendSetStringAsync(value, autoRefresh?): Promise<void>
Sends a message to set the register value as a string
Parameters
- value: string
- Optional autoRefresh: boolean
Returns Promise<void>
- Defined in src/jdom/register.ts:187

Specification

`Readonly` code

code: number

Identifier of the event.

specification

get specification(): PacketInfo
Gets the event specification if known.

Returns PacketInfo
Inherited from JDServiceMemberNode.specification
- Defined in src/jdom/servicemembernode.ts:72

Class JDRegister

Hierarchy

Index

JDOM

Data

Other

Packets

Specification

JDOM

Readonly eventStats

newListenerStats

Readonly nodeId

Readonly service

changeId

Returns number

children

Returns JDNode[]

fields

Returns JDField[]

friendlyName

Returns string

id

Returns string

name

Returns string

nodeData

Returns Record<string, unknown>

nodeKind

Returns string

notImplemented

Returns boolean

parent

Returns JDNode

qualifiedName

Returns string

emit

Parameters

eventName: string

Rest ...args: unknown[]

Returns boolean

emitPropagated

Parameters

event: string

Optional arg: any

Returns void

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 JDRegister

on

Parameters

eventName: string | string[]

handler: EventHandler

Returns JDRegister

once

Parameters

eventName: string | string[]

handler: EventHandler

Returns JDRegister

subscribe

Type Parameters

T

Parameters

`Readonly` eventStats

`Readonly` nodeId

`Readonly` service

`Rest` ...args: unknown[]

`Optional` arg: any

`Optional` skipIfValue: boolean

`Optional` token: JDCancellationToken

`Optional` autoRefresh: boolean

`Optional` autoRefresh: boolean

`Optional` autoRefresh: boolean