Class ClientSubscriptionImpl

Hierarchy

EventEmitter
- ClientSubscriptionImpl

Implements

ClientSubscription

Constructors

constructor

Properties

Accessors

Constructors

constructor

new ClientSubscriptionImpl(session: ClientSession, options: ClientSubscriptionOptions): ClientSubscriptionImpl

Overrides ClientMonitoredItemBase.constructor
- Defined in packages/node-opcua-client/source/private/client_subscription_impl.ts:128
Parameters
- session: ClientSession
- options: ClientSubscriptionOptions
Returns ClientSubscriptionImpl

Properties

lifetimeCount

lifetimeCount: number

maxKeepAliveCount

maxKeepAliveCount: number

maxNotificationsPerPublish

maxNotificationsPerPublish: number

monitoredItemGroups

monitoredItemGroups: ClientMonitoredItemGroup[] = []

monitoredItems

monitoredItems: ClientMonitoredItemBaseMap

priority

priority: number

publishEngine

publishEngine: ClientSidePublishEngine

publishingEnabled

publishingEnabled: boolean

publishingInterval

publishingInterval: number

subscriptionId

subscriptionId: SubscriptionId

timeoutHint

timeoutHint: number = 0

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.

Accessors

hasSession

get hasSession(): boolean

- Defined in packages/node-opcua-client/source/private/client_subscription_impl.ts:100
Returns boolean

isActive

get isActive(): boolean

- Defined in packages/node-opcua-client/source/private/client_subscription_impl.ts:103
Returns boolean

session

get session(): ClientSessionImpl

- Defined in packages/node-opcua-client/source/private/client_subscription_impl.ts:96
the associated session

property

session

Returns ClientSessionImpl

Methods

_add_monitored_item

_add_monitored_item(clientHandle: ClientHandle, monitoredItem: ClientMonitoredItemBase): void

- Defined in packages/node-opcua-client/source/private/client_subscription_impl.ts:489
Parameters
- clientHandle: ClientHandle
- monitoredItem: ClientMonitoredItemBase
Returns void

_add_monitored_items_group

_add_monitored_items_group(monitoredItemGroup: ClientMonitoredItemGroupImpl): void

- Defined in packages/node-opcua-client/source/private/client_subscription_impl.ts:502
Parameters
- monitoredItemGroup: ClientMonitoredItemGroupImpl
Returns void

_delete_monitored_items

_delete_monitored_items(monitoredItems: ClientMonitoredItemBase[], callback: ErrorCallback): void

- Defined in packages/node-opcua-client/source/private/client_subscription_impl.ts:315
Parameters
- monitoredItems: ClientMonitoredItemBase[]
- callback: ErrorCallback
Returns void

_removeGroup

_removeGroup(monitoredItemGroup: ClientMonitoredItemGroup): void

- Defined in packages/node-opcua-client/source/private/client_subscription_impl.ts:765
Parameters
- monitoredItemGroup: ClientMonitoredItemGroup
Returns void

_wait_for_subscription_to_be_ready

_wait_for_subscription_to_be_ready(done: ErrorCallback): void

- Defined in packages/node-opcua-client/source/private/client_subscription_impl.ts:506
Parameters
- done: ErrorCallback
Returns void

addListener

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

Inherited from UAStateVariable.addListener
- Defined in node_modules/@types/node/events.d.ts:62
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

Inherited from UAStateVariable.emit
- Defined in node_modules/@types/node/events.d.ts:72
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

evaluateRemainingLifetime

evaluateRemainingLifetime(): number

- Defined in packages/node-opcua-client/source/private/client_subscription_impl.ts:482
returns the approximated remaining life time of this subscription in milliseconds

Returns number

eventNames

eventNames(): Array<string | symbol>

Inherited from UAStateVariable.eventNames
- Defined in node_modules/@types/node/events.d.ts:77
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from UAStateVariable.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:69
Returns number

getMonitoredItems

getMonitoredItems(): Promise<MonitoredItemData>
getMonitoredItems(callback: Callback<MonitoredItemData>): void

- Defined in packages/node-opcua-client/source/private/client_subscription_impl.ts:362
Returns Promise<MonitoredItemData>
- Defined in packages/node-opcua-client/source/private/client_subscription_impl.ts:363
Parameters
- callback: Callback<MonitoredItemData>
Returns void

listenerCount

listenerCount(event: string | symbol): number

Inherited from UAStateVariable.listenerCount
- Defined in node_modules/@types/node/events.d.ts:73
Parameters
- event: string | symbol
Returns number

listeners

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

Inherited from UAStateVariable.listeners
- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

monitor

monitor(itemToMonitor: ReadValueIdOptions, requestedParameters: MonitoringParametersOptions, timestampsToReturn: TimestampsToReturn): Promise<ClientMonitoredItemBase>
monitor(itemToMonitor: ReadValueIdOptions, requestedParameters: MonitoringParametersOptions, timestampsToReturn: TimestampsToReturn, done: Callback<ClientMonitoredItemBase>): void

- Defined in packages/node-opcua-client/source/private/client_subscription_impl.ts:245
Parameters
- itemToMonitor: ReadValueIdOptions
- requestedParameters: MonitoringParametersOptions
- timestampsToReturn: TimestampsToReturn
Returns Promise<ClientMonitoredItemBase>
- Defined in packages/node-opcua-client/source/private/client_subscription_impl.ts:250
Parameters
- itemToMonitor: ReadValueIdOptions
- requestedParameters: MonitoringParametersOptions
- timestampsToReturn: TimestampsToReturn
- done: Callback<ClientMonitoredItemBase>
Returns void

monitorItems

monitorItems(itemsToMonitor: ReadValueIdOptions[], requestedParameters: MonitoringParametersOptions, timestampsToReturn: TimestampsToReturn): Promise<ClientMonitoredItemGroup>
monitorItems(itemsToMonitor: ReadValueIdOptions[], requestedParameters: MonitoringParametersOptions, timestampsToReturn: TimestampsToReturn, done: Callback<ClientMonitoredItemGroup>): void

- Defined in packages/node-opcua-client/source/private/client_subscription_impl.ts:282
Parameters
- itemsToMonitor: ReadValueIdOptions[]
- requestedParameters: MonitoringParametersOptions
- timestampsToReturn: TimestampsToReturn
Returns Promise<ClientMonitoredItemGroup>
- Defined in packages/node-opcua-client/source/private/client_subscription_impl.ts:288
Parameters
- itemsToMonitor: ReadValueIdOptions[]
- requestedParameters: MonitoringParametersOptions
- timestampsToReturn: TimestampsToReturn
- done: Callback<ClientMonitoredItemGroup>
Returns void

nextClientHandle

nextClientHandle(): number

- Defined in packages/node-opcua-client/source/private/client_subscription_impl.ts:240
method

nextClientHandle

Returns number

off

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

Inherited from UAStateVariable.off
- Defined in node_modules/@types/node/events.d.ts:66
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

Inherited from NonHierarchicalReferences.on
- Defined in node_modules/@types/node/events.d.ts:63
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

Inherited from NonHierarchicalReferences.once
- Defined in node_modules/@types/node/events.d.ts:64
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

Inherited from UAStateVariable.prependListener
- Defined in node_modules/@types/node/events.d.ts:75
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

Inherited from UAStateVariable.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:76
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

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

Inherited from UAStateVariable.rawListeners
- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
Returns Function[]

recreateSubscriptionAndMonitoredItem

recreateSubscriptionAndMonitoredItem(callback: ErrorCallback): void

- Defined in packages/node-opcua-client/source/private/client_subscription_impl.ts:372
utility function to recreate new subscription

method

recreateSubscriptionAndMonitoredItem

Parameters
- callback: ErrorCallback
Returns void

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from UAStateVariable.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns this

removeListener

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

Inherited from UAStateVariable.removeListener
- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from UAStateVariable.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns this

setPublishingMode

setPublishingMode(publishingEnabled: boolean): Promise<StatusCode>
setPublishingMode(publishingEnabled: boolean, callback: Callback<StatusCode>): void

- Defined in packages/node-opcua-client/source/private/client_subscription_impl.ts:336
Parameters
- publishingEnabled: boolean
Returns Promise<StatusCode>
- Defined in packages/node-opcua-client/source/private/client_subscription_impl.ts:337
Parameters
- publishingEnabled: boolean
- callback: Callback<StatusCode>
Returns void

terminate

terminate(...args: any[]): any

- Defined in packages/node-opcua-client/source/private/client_subscription_impl.ts:189
Parameters
- Rest ...args: any[]
Returns any

toString

toString(): string

- Defined in packages/node-opcua-client/source/private/client_subscription_impl.ts:457
Returns string

Static listenerCount

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

Inherited from ConditionSnapshot.listenerCount
- Defined in node_modules/@types/node/events.d.ts:44
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Class ClientSubscriptionImpl

Hierarchy

Implements

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

session: ClientSession

options: ClientSubscriptionOptions

Returns ClientSubscriptionImpl

Properties

lifetimeCount

maxKeepAliveCount

maxNotificationsPerPublish

monitoredItemGroups

monitoredItems

priority

publishEngine

publishingEnabled

publishingInterval

subscriptionId

timeoutHint

Static defaultMaxListeners

Static Readonly errorMonitor

Accessors

hasSession

Returns boolean

isActive

Returns boolean

session

Returns ClientSessionImpl

Methods

_add_monitored_item

Parameters

clientHandle: ClientHandle

monitoredItem: ClientMonitoredItemBase

Returns void

_add_monitored_items_group

Parameters

monitoredItemGroup: ClientMonitoredItemGroupImpl

Returns void

_delete_monitored_items

Parameters

monitoredItems: ClientMonitoredItemBase[]

callback: ErrorCallback

Returns void

_removeGroup

Parameters

monitoredItemGroup: ClientMonitoredItemGroup

Returns void

_wait_for_subscription_to_be_ready

Parameters

done: ErrorCallback

Returns void

addListener

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

evaluateRemainingLifetime

Returns number

eventNames

Returns Array<string | symbol>

getMaxListeners

Returns number

getMonitoredItems

Returns Promise<MonitoredItemData>

Parameters

callback: Callback<MonitoredItemData>