Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MonitoredItem

a server side monitored item

  • Once created, the MonitoredItem will raised an "samplingEvent" event every "samplingInterval" millisecond until {{#crossLink "MonitoredItem/terminate:method"}}{{/crossLink}} is called.

  • It is up to the event receiver to call {{#crossLink "MonitoredItem/recordValue:method"}}{{/crossLink}}.

Hierarchy

  • EventEmitter
    • MonitoredItem

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Optional $subscription

$subscription: ISubscription

Optional _samplingId

_samplingId: TimerKey | string

Optional clientHandle

clientHandle: number

discardOldest

discardOldest: boolean = true

filter

filter: MonitoringFilter | null

itemToMonitor

itemToMonitor: any

monitoredItemId

monitoredItemId: number

monitoringMode

monitoringMode: MonitoringMode

Optional oldDataValue

oldDataValue: DataValue

overflow

overflow: boolean

queueSize

queueSize: number = 0

samplingFunc

samplingFunc: function | null = null

samplingInterval

samplingInterval: number = -1

timestampsToReturn

timestampsToReturn: TimestampsToReturn

Static defaultMaxListeners

defaultMaxListeners: number

Static defaultSamplingInterval

defaultSamplingInterval: number = 1500

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.

Static maximumSamplingInterval

maximumSamplingInterval: number = 1000 * 60 * 60

Static minimumSamplingInterval

minimumSamplingInterval: number = 50

Static registry

registry: ObjectRegistry = new ObjectRegistry()

Accessors

hasMonitoredItemNotifications

  • get hasMonitoredItemNotifications(): boolean

  • Returns boolean

isSampling

  • get isSampling(): boolean

  • Returns boolean

node

  • get node(): BaseNode | null
  • set node(someNode: BaseNode | null): void

  • Returns BaseNode | null

  • Parameters

    • someNode: BaseNode | null

    Returns void

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

dispose

  • dispose(): void

  • Returns void

emit

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

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<string | symbol>

extractMonitoredItemNotifications

  • extractMonitoredItemNotifications(): QueueItem[]

  • Returns QueueItem[]

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

modify

  • modify(timestampsToReturn: TimestampsToReturn, monitoringParameters: MonitoringParameters): MonitoredItemModifyResult

  • Parameters

    Returns MonitoredItemModifyResult

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: string | symbol, listener: function): this

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

once

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

rawListeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

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

removeListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

resendInitialValues

  • resendInitialValues(): Promise<void>

  • Returns Promise<void>

setMaxListeners

  • setMaxListeners(n: number): this

setMonitoringMode

  • Parameters

    Returns void

setNode

  • setNode(node: BaseNode): void

  • Parameters

    • node: BaseNode

    Returns void

terminate

  • terminate(): void

  • Terminate the MonitoredItem.

    method

    terminate

    This will stop the internal sampling timer.

    Returns void

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