Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MonitoredItem

  subscribe now with sterfive to access the online-user manual

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

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Optional $subscription

$subscription: ISubscription

Optional _samplingId

_samplingId: string | Timer

Optional clientHandle

clientHandle: number

discardOldest

discardOldest: boolean

filter

filter: MonitoringFilter

itemToMonitor

itemToMonitor: any

monitoredItemId

monitoredItemId: number

monitoringMode

monitoringMode: MonitoringMode

Optional oldDataValue

oldDataValue: DataValue

overflow

overflow: boolean

queueSize

queueSize: number

samplingFunc

samplingFunc: (value: DataValue, callback: (err: Error, dataValue?: DataValue) => void) => void

Type declaration

    • Parameters

      Returns void

samplingInterval

samplingInterval: number

timestampsToReturn

timestampsToReturn: TimestampsToReturn

Readonly Static captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static defaultSamplingInterval

defaultSamplingInterval: number

Readonly Static errorMonitor

errorMonitor: typeof errorMonitor

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

Static minimumSamplingInterval

minimumSamplingInterval: number

Static registry

registry: ObjectRegistry

Accessors

hasMonitoredItemNotifications

  • get hasMonitoredItemNotifications(): boolean

  • Returns boolean

isSampling

  • get isSampling(): boolean

  • Returns boolean

node

  • Returns BaseNode

  • Parameters

    Returns any

Methods

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): MonitoredItem

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns MonitoredItem

dispose

  • dispose(): void

  • Returns void

emit

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

  • Parameters

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

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

extractMonitoredItemNotifications

  • extractMonitoredItemNotifications(): QueueItem[]

  • Returns QueueItem[]

getMaxListeners

  • getMaxListeners(): number

  • Returns 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

off

  • off(event: string | symbol, listener: (...args: any[]) => void): MonitoredItem

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns MonitoredItem

on

  • on(event: string | symbol, listener: (...args: any[]) => void): MonitoredItem

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns MonitoredItem

once

  • once(event: string | symbol, listener: (...args: any[]) => void): MonitoredItem

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns MonitoredItem

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): MonitoredItem

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns MonitoredItem

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): MonitoredItem

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns MonitoredItem

rawListeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • Parameters

    • Optional event: string | symbol

    Returns MonitoredItem

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): MonitoredItem

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns MonitoredItem

resendInitialValues

  • resendInitialValues(): Promise<void>

  • Returns Promise<void>

setMaxListeners

  • Parameters

    • n: number

    Returns MonitoredItem

setMonitoringMode

  • Parameters

    Returns void

setNode

  • Parameters

    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

Static on

  • on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

  • Parameters

    • emitter: EventEmitter
    • event: string

    Returns AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
  • once(emitter: DOMEventTarget, event: string): Promise<any[]>

  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string

    Returns Promise<any[]>

Generated using TypeDoc