Class Service

constructor

• new Service(): Service

• Returns Service

bus

controller

dataPath

evaDir

id

initial

logger

rpc

systemName

timeout

block

• block(prepare?): Promise<void>

• Blocks the service while active

  Parameters

  • prepare: boolean = true

    register signals and mark active (default: true)

  Returns Promise<void>

dropPrivileges

• dropPrivileges(): void

• Drops service privileges to a restricted user

  Returns void

getConfig

• getConfig(): object

• Get service configuration

  Returns object

  Throws

getTimeout

• getTimeout(): number

• Get the service default timeout (seconds)

  Returns number

init

• init(__namedParameters): Promise<void>

• Automatically calls inutBus, initRpc and drops service privileges

  Parameters

  • __namedParameters: {
        info: ServiceInfo;
        onFrame?: ((frame) => void | Promise<void>);
        onRpcCall?: ((e) => undefined | Buffer | Promise<undefined | Buffer>);
    }

    • info: ServiceInfo

    • Optional onFrame?: ((frame) => void | Promise<void>)

      • • (frame): void | Promise<void>

        • Parameters

          • frame: RpcEvent

          Returns void | Promise<void>

    • Optional onRpcCall?: ((e) => undefined | Buffer | Promise<undefined | Buffer>)

      • • (e): undefined | Buffer | Promise<undefined | Buffer>

        • Parameters

          • e: RpcEvent

          Returns undefined | Buffer | Promise<undefined | Buffer>

  Returns Promise<void>

initBus

• initBus(): Promise<void>

• Init bus client

  Returns Promise<void>

initRpc

• initRpc(svcInfo): Promise<void>

• Init bus RPC client

  Parameters

  • svcInfo: ServiceInfo

    service information

  Returns Promise<void>

isActive

• isActive(): boolean

• Is the service active

  Returns boolean

isModeNormal

• isModeNormal(): boolean

• Is service mode normal

  Returns boolean

isModeRTF

• isModeRTF(): boolean

• Is service mode react-to-fail

  Returns boolean

isShutdownRequested

• isShutdownRequested(): boolean

• Is the service shutdown requested

  Returns boolean

load

• load(): Promise<void>

• Service loader, must be always called first and once

  Returns Promise<void>

markReady

• markReady(): Promise<void>

• Manually mark the service ready

  Returns Promise<void>

markTerminating

• markTerminating(m?): Promise<void>

• Manually mark the service terminating

  Parameters

  • Optional m: Service

  Returns Promise<void>

needReady

• needReady(): void

• Throws RPC error if the service is not ready yet

  Returns void

  Throws

registerSignals

• registerSignals(): void

• Registers service signal handlers (SIGINT, SIGTERM)

  Returns void

subscribeOIDs

• subscribeOIDs(items, kind): Promise<void>

• Subscribes bus client to item events

  Parameters

  • items: (string | OID)[]

    items to subscribe

  • kind: EventKind

    bus event kind

  Returns Promise<void>

waitCore

• waitCore(wait_forever?, timeout?): Promise<void>

• Wait until the core become ready (in sub-functions)

  Parameters

  • Optional wait_forever: boolean

    wait forever

  • Optional timeout: number

    wait timeout

  Returns Promise<void>