Class SerialServer

Base class for service server implementations

Hierarchy

JDServiceServer
- SerialServer

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

off

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

on

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

once

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

Other

constructor

new SerialServer(options?): SerialServer
Parameters
- Optional options: {
      baudRate?: number;
      bufferSize?: number;
      connectionName?: string;
      dataBits?: number;
      parityMode?: SerialParityType;
      stopBits?: number;
  }
  - Optional baudRate?: number
  - Optional bufferSize?: number
  - Optional connectionName?: string
  - Optional dataBits?: number
  - Optional parityMode?: SerialParityType
  - Optional stopBits?: number
Returns SerialServer
Overrides JDServiceServer.constructor
- Defined in src/servers/serialserver.ts:19

`Readonly` baudRate

baudRate: JDRegisterServer<[number]>

`Readonly` bufferSize

bufferSize: JDRegisterServer<[number]>

`Readonly` connected

connected: JDRegisterServer<[boolean]>

`Readonly` dataBits

dataBits: JDRegisterServer<[number]>

`Readonly` instanceName

instanceName: JDRegisterServer<[string]>

`Readonly` parityMode

parityMode: JDRegisterServer<[SerialParityType]>

`Readonly` serviceClass

serviceClass: number

serviceIndex

serviceIndex: number = -1

`Readonly` specification

specification: ServiceSpec

`Readonly` statusCode

statusCode: JDRegisterServer<[SystemStatusCodes, number]>

`Readonly` stopBits

stopBits: JDRegisterServer<[number]>

device

get device(): JDServerServiceProvider
Returns JDServerServiceProvider
Inherited from JDServiceServer.device
- Defined in src/jdom/servers/serviceserver.ts:174
set device(value): void
Parameters
- value: JDServerServiceProvider
Returns void
Inherited from JDServiceServer.device
- Defined in src/jdom/servers/serviceserver.ts:178

registers

get registers(): JDRegisterServer<PackedValues>[]
Returns JDRegisterServer<PackedValues>[]
Inherited from JDServiceServer.registers
- Defined in src/jdom/servers/serviceserver.ts:224

timestamp

get timestamp(): number
Returns number
Inherited from JDServiceServer.timestamp
- Defined in src/jdom/servers/serviceserver.ts:228

twin

get twin(): JDService
Returns JDService
Inherited from JDServiceServer.twin
- Defined in src/jdom/servers/serviceserver.ts:186
set twin(service): void
Parameters
- service: JDService
Returns void
Inherited from JDServiceServer.twin
- Defined in src/jdom/servers/serviceserver.ts:190

`Protected` addCommand

addCommand(identifier, handler): void
Parameters
- identifier: number
- handler: ((pkt) => void)
  - - (pkt): void
    - Parameters
      
      pkt: Packet
      
      Returns void
Returns void
Inherited from JDServiceServer.addCommand
- Defined in src/jdom/servers/serviceserver.ts:280

`Protected` addExistingRegister

addExistingRegister<TValues>(reg): JDRegisterServer<TValues>
Type Parameters
- TValues extends PackedValues = PackedValues
Parameters
- reg: JDRegisterServer<TValues>
Returns JDRegisterServer<TValues>
Inherited from JDServiceServer.addExistingRegister
- Defined in src/jdom/servers/serviceserver.ts:241

addRegister

addRegister<TValues>(identifier, defaultValue?): JDRegisterServer<TValues>
Type Parameters
- TValues extends PackedValues = PackedValues
Parameters
- identifier: number
- Optional defaultValue: TValues
Returns JDRegisterServer<TValues>
Inherited from JDServiceServer.addRegister
- Defined in src/jdom/servers/serviceserver.ts:248

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

calibrate

calibrate(): Promise<void>
Returns Promise<void>
Inherited from JDServiceServer.calibrate
- Defined in src/jdom/servers/serviceserver.ts:337

handlePacket

handlePacket(pkt): Promise<void>
Parameters
- pkt: Packet
Returns Promise<void>
Inherited from JDServiceServer.handlePacket
- Defined in src/jdom/servers/serviceserver.ts:285

lock

lock(): void
Locks the current set of registers

Returns void
Inherited from JDServiceServer.lock
- Defined in src/jdom/servers/serviceserver.ts:276

processLargeFrame

processLargeFrame(command, data): void
Parameters
- command: string
- data: Uint8Array
Returns void
Inherited from JDServiceServer.processLargeFrame
- Defined in src/jdom/servers/serviceserver.ts:333

register

register<TValues>(code): JDRegisterServer<TValues>
Type Parameters
- TValues extends PackedValues = PackedValues
Parameters
- code: number
Returns JDRegisterServer<TValues>
Inherited from JDServiceServer.register
- Defined in src/jdom/servers/serviceserver.ts:233

reset

reset(): void
Returns void
Inherited from JDServiceServer.reset
- Defined in src/jdom/servers/serviceserver.ts:269

sendEvent

sendEvent(eventCode, data?): Promise<void>
Parameters
- eventCode: number
- Optional data: Uint8Array
Returns Promise<void>
Inherited from JDServiceServer.sendEvent
- Defined in src/jdom/servers/serviceserver.ts:311

sendPacketAsync

sendPacketAsync(pkt): Promise<void>
Parameters
- pkt: Packet
Returns Promise<void>
Inherited from JDServiceServer.sendPacketAsync
- Defined in src/jdom/servers/serviceserver.ts:304

Class SerialServer

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 SerialServer

on

Parameters

eventName: string | string[]

handler: EventHandler

Returns SerialServer

once

Parameters

eventName: string | string[]

handler: EventHandler

Returns SerialServer

subscribe

Type Parameters

T

Parameters

eventName: string | string[]

next: ((value) => void)

Parameters

value: T

Returns void

Returns (() => void)

Returns void

Category

Other

constructor

Parameters

Optional options: { baudRate?: number; bufferSize?: number; connectionName?: string; dataBits?: number; parityMode?: SerialParityType; stopBits?: number; }

Optional baudRate?: number

Optional bufferSize?: number

Optional connectionName?: string

Optional dataBits?: number

Optional parityMode?: SerialParityType

Optional stopBits?: number

Returns SerialServer

Readonly baudRate

Readonly bufferSize

Readonly connected

Readonly dataBits

Readonly instanceName

Readonly parityMode

Readonly serviceClass

serviceIndex

Readonly specification

Readonly statusCode

`Readonly` eventStats

`Readonly` nodeId

`Rest` ...args: unknown[]

`Optional` options: {
baudRate?: number;
bufferSize?: number;
connectionName?: string;
dataBits?: number;
parityMode?: SerialParityType;
stopBits?: number;
}

`Optional` baudRate?: number

`Optional` bufferSize?: number

`Optional` connectionName?: string

`Optional` dataBits?: number

`Optional` parityMode?: SerialParityType

`Optional` stopBits?: number

`Readonly` baudRate

`Readonly` bufferSize

`Readonly` connected

`Readonly` dataBits

`Readonly` instanceName

`Readonly` parityMode

`Readonly` serviceClass

`Readonly` specification

`Readonly` statusCode

`Readonly` stopBits

`Protected` addCommand

`Protected` addExistingRegister

`Optional` defaultValue: TValues

`Optional` token: JDCancellationToken

`Optional` data: Uint8Array