Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClientMonitoredItem

Hierarchy

Implemented by

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional filterResult

filterResult: ExtensionObject

itemToMonitor

itemToMonitor: ReadValueId

Optional monitoredItemId

monitoredItemId: any

monitoringMode

monitoringMode: MonitoringMode

monitoringParameters

monitoringParameters: MonitoringParameters

Optional result

result: MonitoredItemCreateResult

statusCode

statusCode: StatusCode

subscription

subscription: ClientSubscription

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: unique symbol

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

addListener

  • addListener(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

emit

  • emit(event: string | symbol, ...args: any[]): boolean

eventNames

  • eventNames(): Array<string | symbol>

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(event: string | symbol): number

listeners

  • listeners(event: string | symbol): Function[]

modify

  • modify(parameters: MonitoringParametersOptions, timestampsToReturn?: TimestampsToReturn): Promise<StatusCode>
  • modify(parameters: MonitoringParametersOptions, callback: Callback<StatusCode>): void
  • modify(parameters: MonitoringParametersOptions, timestampsToReturn: TimestampsToReturn | null, callback: Callback<StatusCode>): void

off

  • off(event: string | symbol, listener: function): this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: "changed", eventHandler: function): this
  • on(event: "changed", eventHandler: function): this
  • on(event: "terminated", eventHandler: function): this
  • on(event: "initialized", eventHandler: function): this
  • on(event: "err", eventHandler: function): this

  • Parameters

    • event: "changed"
    • eventHandler: function
        • (dataValue: DataValue): void

        • Parameters

          • dataValue: DataValue

          Returns void

    Returns this

  • Parameters

    • event: "changed"
    • eventHandler: function
        • (values: Variant[]): void

        • Parameters

          • values: Variant[]

          Returns void

    Returns this

  • Parameters

    • event: "terminated"
    • eventHandler: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "initialized"
    • eventHandler: function
        • (): void

        • Returns void

    Returns this

  • Parameters

    • event: "err"
    • eventHandler: function
        • (message: string): void

        • Parameters

          • message: string

          Returns void

    Returns this

once

  • once(event: string | symbol, listener: function): this

prependListener

  • prependListener(event: string | symbol, listener: function): this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: function): this

rawListeners

  • rawListeners(event: string | symbol): Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

removeListener

  • removeListener(event: string | symbol, listener: function): this

setMaxListeners

  • setMaxListeners(n: number): this

setMonitoringMode

terminate

  • terminate(): Promise<void>
  • terminate(done: ErrorCallback): void

Static create

  • Parameters

    • subscription: ClientSubscription
    • itemToMonitor: ReadValueIdOptions
    • monitoringParameters: MonitoringParametersOptions
    • Default value timestampsToReturn: TimestampsToReturn = TimestampsToReturn.Neither

    Returns ClientMonitoredItem

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc