Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClientMonitoredItemGroupImpl

ClientMonitoredItemGroup event: "initialized" "err" "changed"

note: this.monitoringMode = subscription_service.MonitoringMode.Reporting;

Hierarchy

  • EventEmitter
    • ClientMonitoredItemGroupImpl

Implements

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly monitoredItems

monitoredItems: ClientMonitoredItemBase[]

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

  • Parameters

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

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

  • Returns Array<string | symbol>

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(parameters: MonitoringParametersOptions): Promise<StatusCode>
  • modify(parameters: MonitoringParametersOptions, timestampsToReturn: TimestampsToReturn): Promise<StatusCode>
  • modify(parameters: MonitoringParametersOptions, callback: function): void
  • modify(parameters: MonitoringParametersOptions, timestampsToReturn: TimestampsToReturn | null, callback: function): void
  • method

    modify

    Parameters

    • parameters: MonitoringParametersOptions

    Returns Promise<StatusCode>

  • Parameters

    Returns Promise<StatusCode>

  • Parameters

    • parameters: MonitoringParametersOptions
    • callback: function
        • (err: Error | null, statusCode?: StatusCode): void

        • Parameters

          • err: Error | null
          • Optional statusCode: StatusCode

          Returns void

    Returns void

  • Parameters

    • parameters: MonitoringParametersOptions
    • timestampsToReturn: TimestampsToReturn | null
    • callback: function
        • (err: Error | null, statusCode?: StatusCode): void

        • Parameters

          • err: Error | null
          • Optional statusCode: StatusCode

          Returns void

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

setMaxListeners

  • setMaxListeners(n: number): this

setMonitoringMode

  • Parameters

    Returns Promise<StatusCode>

  • Parameters

    Returns void

terminate

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

    terminate remove the MonitoredItem from its subscription

    async

    Returns Promise<void>

  • Parameters

    Returns void

toString

  • toString(): string

  • Returns string

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