Class JDService

A Jacdac service client hosting registers, events.

Hierarchy

JDNode
- JDService

JDOM

`Readonly` device

device: JDDevice

Gets the device this service belongs to

`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 JDNode.changeId
- Defined in src/jdom/eventsource.ts:325

children

get children(): JDNode[]
Gets the registers and events

Returns JDNode[]
Overrides JDNode.children
- Defined in src/jdom/service.ts:315

friendlyName

get friendlyName(): string
Gets the service name and parent names and service instance index

Returns string
Overrides JDNode.friendlyName
- Defined in src/jdom/service.ts:129

id

get id(): string
Gets the node identifier

Returns string
Overrides JDNode.id
- Defined in src/jdom/service.ts:103

name

get name(): string
Gets the service name

Returns string
Overrides JDNode.name
- Defined in src/jdom/service.ts:121

nodeData

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

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

nodeKind

get nodeKind(): string
Gets the SERVICE_NODE_NAME identifier

Returns string
Overrides JDNode.nodeKind
- Defined in src/jdom/service.ts:113

parent

get parent(): JDNode
Gets the device holding the service

Returns JDNode
Overrides JDNode.parent
- Defined in src/jdom/service.ts:158

qualifiedName

get qualifiedName(): string
Gets the service qualified name and service instance index

Returns string
Overrides JDNode.qualifiedName
- Defined in src/jdom/service.ts:141

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 JDNode.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 JDNode.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 JDNode.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 JDNode.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 JDNode.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 JDNode.observe
- Defined in src/jdom/eventsource.ts:303

off

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

on

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

once

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

Control

`Readonly` serviceClass

serviceClass: number

Gets the service class

`Readonly` serviceIndex

serviceIndex: number

Gets the service index in the service list

instanceName

get instanceName(): string
Gets the service instance name, if resolved

Returns string
- Defined in src/jdom/service.ts:258

resolveInstanceName

resolveInstanceName(): Promise<string>
Resolves the service instance name, if resolved

Returns Promise<string>
- Defined in src/jdom/service.ts:267

Events

event

event(eventCode): JDEvent
Gets an event for the given code
Parameters
- eventCode: number
  
  event identifier as found in the specification
Returns JDEvent
a event instance (if found in specifiaction)
- Defined in src/jdom/service.ts:364

Other

registersUseAcks

registersUseAcks: boolean = false

clients

get clients(): JDServiceClient[]
Returns JDServiceClient[]
- Defined in src/jdom/service.ts:525

disposed

get disposed(): boolean
Returns boolean
- Defined in src/jdom/service.ts:95

events

get events(): JDEvent[]
Returns JDEvent[]
- Defined in src/jdom/service.ts:285

isMixin

get isMixin(): boolean
Returns boolean
- Defined in src/jdom/service.ts:196

mixins

get mixins(): JDService[]
Returns JDService[]
- Defined in src/jdom/service.ts:182

reports

get reports(): Packet[]
Returns Packet[]
- Defined in src/jdom/service.ts:178

role

get role(): string
Returns string
- Defined in src/jdom/service.ts:162
set role(value): void
Parameters
- value: string
Returns void
- Defined in src/jdom/service.ts:166

serviceInstanceIndex

get serviceInstanceIndex(): number
Gets the index of this service class instance. Provides a stable ordering into a list of services.

Returns number
- Defined in src/jdom/service.ts:148

twin

get twin(): JDServiceServer
Returns JDServiceServer
- Defined in src/jdom/service.ts:200
set twin(server): void
Parameters
- server: JDServiceServer
Returns void
- Defined in src/jdom/service.ts:204

addClient

addClient(client): void
Parameters
- client: JDServiceClient
Returns void
- Defined in src/jdom/service.ts:529

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

receiveWithInPipe

receiveWithInPipe<TValues>(cmd, packFormat, timeout?): Promise<TValues[]>
Type Parameters
- TValues extends PackedValues
Parameters
- cmd: number
- packFormat: string
- Optional timeout: number
Returns Promise<TValues[]>
- Defined in src/jdom/service.ts:544

registers

registers(options?): JDRegister[]
Gets the list of registers in the service
Parameters
- Optional options: {
  ignoreNacks?: boolean;
  }
  - Optional ignoreNacks?: boolean
Returns JDRegister[]
- Defined in src/jdom/service.ts:298

removeClient

removeClient(client): void
Parameters
- client: JDServiceClient
Returns void
- Defined in src/jdom/service.ts:536

report

report(identifier): Packet
Parameters
- identifier: number
Returns Packet
- Defined in src/jdom/service.ts:174

Packets

sendCmdAsync

sendCmdAsync(cmd, data?, ack?): Promise<void>
Send a command to the service server
Parameters
- cmd: number
- Optional data: Uint8Array
- Optional ack: boolean
  
  acknolegment required
Returns Promise<void>
- Defined in src/jdom/service.ts:412

sendCmdAwaitResponseAsync

sendCmdAwaitResponseAsync(pkt, timeout?): Promise<Packet>
Send a command and await response to the service server
Parameters
- pkt: Packet
  
  packet to send
- timeout: number = 500
Returns Promise<Packet>
- Defined in src/jdom/service.ts:444

sendCmdPackedAsync

sendCmdPackedAsync<TValues>(cmd, values?, ack?): Promise<void>
Packs values and sends command to the service server
Type Parameters
- TValues extends PackedValues
Parameters
- cmd: number
  
  packet to send
- Optional values: TValues
  
  unpacked values, layed as specified
- Optional ack: boolean
  
  acknolegment required
Returns Promise<void>
- Defined in src/jdom/service.ts:424

sendPacketAsync

sendPacketAsync(pkt, ack?): Promise<void>
Send packet to the service server
Parameters
- pkt: Packet
  
  packet to send
- Optional ack: boolean
  
  acknolegment required
Returns Promise<void>
- Defined in src/jdom/service.ts:397

Registers

intensityRegister

get intensityRegister(): JDRegister
Gets the intensity register associated to this service, if the specification supports it.

Returns JDRegister
- Defined in src/jdom/service.ts:244

readingRegister

get readingRegister(): JDRegister
Gets the reading register associated to this service, if the specification supports it.

Returns JDRegister
- Defined in src/jdom/service.ts:218

valueRegister

get valueRegister(): JDRegister
Gets the value register associated to this service, if the specification supports it.

Returns JDRegister
- Defined in src/jdom/service.ts:231

register

register(registerCode): JDRegister
Gets a register for the given code
Parameters
- registerCode: number
  
  register identifier as found in the specification
Returns JDRegister
a register instance (if found in specifiaction)
- Defined in src/jdom/service.ts:325

Services

specification

get specification(): ServiceSpec
Gets the specification of the service. Undefined if unknown

Returns ServiceSpec
- Defined in src/jdom/service.ts:277

Class JDService

Hierarchy

Index

JDOM

Control

Events

Other

Packets

Registers

Services

JDOM

Readonly device

Readonly eventStats

newListenerStats

Readonly nodeId

changeId

Returns number

children

Returns JDNode[]

friendlyName

Returns string

id

Returns string

name

Returns string

nodeData

Returns Record<string, unknown>

nodeKind

Returns string

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 JDService

on

Parameters

eventName: string | string[]

handler: EventHandler

Returns JDService

once

Parameters

eventName: string | string[]

handler: EventHandler

Returns JDService

subscribe

Type Parameters

T

Parameters

eventName: string | string[]

next: ((value) => void)

`Readonly` device

`Readonly` eventStats

`Readonly` nodeId

`Rest` ...args: unknown[]

`Optional` arg: any

`Readonly` serviceClass

`Readonly` serviceIndex

`Optional` token: JDCancellationToken

`Optional` timeout: number

`Optional` options: {
ignoreNacks?: boolean;
}

`Optional` ignoreNacks?: boolean