ClientSubscription | node-opcua-client

Hierarchy

EventEmitter
- ClientSubscription

Implemented by

ClientSubscriptionImpl

Index

Events

on

on(event: string | symbol, listener: function): this
on(event: string | symbol, listener: function): this
on(event: "started", eventHandler: function): this
on(event: "terminated", eventHandler: function): this
on(event: "item_added", eventHandler: function): this
on(event: "keepalive", eventHandler: function): this
on(event: "internal_error", eventHandler: function): this
on(event: "raw_notification", eventHandler: function): this
on(event: "received_notifications", eventHandler: function): this
on(event: "status_changed", eventHandler: function): this
on(event: "error", eventHandler: function): this

Inherited from EventEmitter.on

Overrides EventEmitter.on
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:12
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Inherited from ClientSubscription.on
- Defined in node-opcua-client/source/client_subscription.ts:222
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Inherited from ClientSubscription.on
- Defined in node-opcua-client/source/client_subscription.ts:227
notify the observers that the subscription has now started

Parameters
- event: "started"
- eventHandler: function
  - - (subscriptionId: number): void
    - Parameters
      - subscriptionId: number
      Returns void
Returns this
Inherited from ClientSubscription.on
- Defined in node-opcua-client/source/client_subscription.ts:234
notify the observers tha the client subscription has terminated

Parameters
- event: "terminated"
- eventHandler: function
  - - (): void
    - Returns void
Returns this
Inherited from ClientSubscription.on
- Defined in node-opcua-client/source/client_subscription.ts:241
notify the observers that a new monitored item has been added to the subscription.

Parameters
- event: "item_added"
- eventHandler: function
  - - (monitoredItem: ClientMonitoredItem): void
    - Parameters
      - monitoredItem: ClientMonitoredItem
      Returns void
Returns this
Inherited from ClientSubscription.on
- Defined in node-opcua-client/source/client_subscription.ts:248
notify the observers that a keep alive Publish Response has been received from the server.

Parameters
- event: "keepalive"
- eventHandler: function
  - - (): void
    - Returns void
Returns this
Inherited from ClientSubscription.on
- Defined in node-opcua-client/source/client_subscription.ts:257
notify the observers that an error has occurred

Parameters
- event: "internal_error"
- eventHandler: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from ClientSubscription.on
- Defined in node-opcua-client/source/client_subscription.ts:260
Parameters
- event: "raw_notification"
- eventHandler: function
  - - (notificationMessage: NotificationMessage): void
    - Parameters
      - notificationMessage: NotificationMessage
      Returns void
Returns this
Inherited from ClientSubscription.on
- Defined in node-opcua-client/source/client_subscription.ts:268
notify the observers that some notifications has been received from the server in a PublishResponse each modified monitored Item

Parameters
- event: "received_notifications"
- eventHandler: function
  - - (notificationMessage: NotificationMessage): void
    - Parameters
      - notificationMessage: NotificationMessage
      Returns void
Returns this
Inherited from ClientSubscription.on
- Defined in node-opcua-client/source/client_subscription.ts:275
notify the observers that the server has send a status changed notification (such as BadTimeout )

Parameters
- event: "status_changed"
- eventHandler: function
  - - (status: StatusCode, diagnosticInfo: DiagnosticInfo): void
    - Parameters
      - status: StatusCode
      - diagnosticInfo: DiagnosticInfo
      Returns void
Returns this
Inherited from ClientSubscription.on
- Defined in node-opcua-client/source/client_subscription.ts:278
Parameters
- event: "error"
- eventHandler: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this

Properties

isActive

isActive: boolean

true is the subscription is fully active

lifetimeCount

lifetimeCount: number

maxKeepAliveCount

maxKeepAliveCount: number

maxNotificationsPerPublish

maxNotificationsPerPublish: number

monitoredItems

monitoredItems: ClientMonitoredItemBaseMap

priority

priority: number

publishingEnabled

publishingEnabled: boolean

publishingInterval

publishingInterval: number

session

session: ClientSession

subscriptionId

subscriptionId: SubscriptionId

timeoutHint

timeoutHint: number

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

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

Inherited from EventEmitter.addListener

Overrides EventEmitter.addListener
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:11
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 EventEmitter.emit

Overrides EventEmitter.emit
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:23
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:24
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:20
Returns number

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:25
Parameters
- type: string | symbol
Returns number

listeners

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

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:21
Parameters
- event: string | symbol
Returns Function[]

monitor

monitor(itemToMonitor: ReadValueIdOptions, requestedParameters: MonitoringParametersOptions, timestampsToReturn: TimestampsToReturn): Promise<ClientMonitoredItemBase>
monitor(itemToMonitor: ReadValueIdOptions, requestedParameters: MonitoringParametersOptions, timestampsToReturn: TimestampsToReturn, done: function): void
monitor(...args: any[]): any

- Defined in node-opcua-client/source/client_subscription.ts:170
add a monitor item to the subscription
method

monitor

async

example:

clientSubscription.monitor( // itemToMonitor: { nodeId: "ns=0;i=2258", attributeId: AttributeIds.Value, indexRange: null, dataEncoding: { namespaceIndex: 0, name: null } }, // requestedParameters: { samplingInterval: 3000, filter: null, queueSize: 1, discardOldest: true }, TimestampsToReturn.Neither );

Monitoring a Value Change With a DataChange Filter

options.trigger {DataChangeTrigger} {Status|StatusValue|StatusValueTimestamp} options.deadbandType {DeadbandType} {None|Absolute|Percent} options.deadbandValue {Double}

example:

clientSubscription.monitor( // itemToMonitor: { nodeId: "ns=0;i=2258", attributeId: AttributeIds.Value, }, // requestedParameters: { samplingInterval: 3000, filter: new DataChangeFilter({ trigger: DataChangeTrigger.StatusValue, deadbandType: DeadbandType.Absolute, deadbandValue: 0.1 }), queueSize: 1, discardOldest: true }, TimestampsToReturn.Neither );

Monitoring an Event

If the monitor attributeId is EventNotifier then the filter must be specified

example:
var filter = new EventFilter({ selectClauses: [ { browsePath: [ {name: 'ActiveState' }, {name: 'id'} ]}, { browsePath: [ {name: 'ConditionName'} ]} ], whereClause: [] });

clientSubscription.monitor( // itemToMonitor: { nodeId: "ns=0;i=2258", attributeId: AttributeIds.EventNotifier, indexRange: null, dataEncoding: { namespaceIndex: 0, name: null } }, // requestedParameters: { samplingInterval: 3000,
```
   filter: filter,

   queueSize: 1,
   discardOldest: true
},
TimestampsToReturn.Neither
```
);
Parameters
- itemToMonitor: ReadValueIdOptions
- requestedParameters: MonitoringParametersOptions
- timestampsToReturn: TimestampsToReturn
  
  //{TimestampsToReturnId}
Returns Promise<ClientMonitoredItemBase>

Monitoring a simple Value Change
- Defined in node-opcua-client/source/client_subscription.ts:175
Parameters
- itemToMonitor: ReadValueIdOptions
- requestedParameters: MonitoringParametersOptions
- timestampsToReturn: TimestampsToReturn
- done: function
  - - (err: Error | null, monitoredItem?: ClientMonitoredItemBase): void
    - Parameters
      - err: Error | null
      - Optional monitoredItem: ClientMonitoredItemBase
      Returns void
Returns void
- Defined in node-opcua-client/source/client_subscription.ts:181
Parameters
- Rest ...args: any[]
Returns any

monitorItems

monitorItems(itemsToMonitor: ReadValueIdOptions[], requestedParameters: MonitoringParametersOptions, timestampsToReturn: TimestampsToReturn): Promise<ClientMonitoredItemGroup>
monitorItems(itemsToMonitor: ReadValueIdOptions[], requestedParameters: MonitoringParametersOptions, timestampsToReturn: TimestampsToReturn, done: function): void
monitorItems(...args: any[]): any

- Defined in node-opcua-client/source/client_subscription.ts:191
method

monitorItems

async

Parameters
- itemsToMonitor: ReadValueIdOptions[]
- requestedParameters: MonitoringParametersOptions
- timestampsToReturn: TimestampsToReturn
Returns Promise<ClientMonitoredItemGroup>

a ClientMonitoredItemGroup
- Defined in node-opcua-client/source/client_subscription.ts:205
method

monitorItems

async

Parameters
- itemsToMonitor: ReadValueIdOptions[]
- requestedParameters: MonitoringParametersOptions
- timestampsToReturn: TimestampsToReturn
- done: function
  - - (err: Error | null, monitoredItemGroup?: ClientMonitoredItemGroup): void
    - Parameters
      - err: Error | null
      - Optional monitoredItemGroup: ClientMonitoredItemGroup
      Returns void
Returns void
- Defined in node-opcua-client/source/client_subscription.ts:211
Parameters
- Rest ...args: any[]
Returns any

off

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

Inherited from EventEmitter.off

Overrides EventEmitter.off
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:17
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
once(event: string | symbol, listener: function): this

Inherited from EventEmitter.once

Overrides EventEmitter.once
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:13
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this
Inherited from ClientSubscription.once
- Defined in node-opcua-client/source/client_subscription.ts:220
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 EventEmitter.prependListener

Overrides EventEmitter.prependListener
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:14
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 EventEmitter.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:15
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 EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:22
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:18
Parameters
- Optional event: string | symbol
Returns this

removeListener

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

Inherited from EventEmitter.removeListener

Overrides EventEmitter.removeListener
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:16
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:19
Parameters
- n: number
Returns this

terminate

terminate(): Promise<void>
terminate(callback: ErrorCallback): void
terminate(...args: any[]): any

- Defined in node-opcua-client/source/client_subscription.ts:213
Returns Promise<void>
- Defined in node-opcua-client/source/client_subscription.ts:214
Parameters
- callback: ErrorCallback
Returns void
- Defined in node-opcua-client/source/client_subscription.ts:215
Parameters
- Rest ...args: any[]
Returns any

Static create

create(clientSession: ClientSession, options: ClientSubscriptionOptions): ClientSubscription

- Defined in node-opcua-client/source/client_subscription.ts:283
Parameters
- clientSession: ClientSession
- options: ClientSubscriptionOptions
Returns ClientSubscription

Static listenerCount

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

Inherited from EventEmitter.listenerCount
- Defined in /home/etienne/projects/node-opcua/node_modules/@types/node/events.d.ts:8
deprecated

since v4.0.0

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

Hierarchy

Implemented by

Index

Events

Properties

Methods

Events

on

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

Parameters

event: "started"

eventHandler: function

Parameters

subscriptionId: number

Returns void

Returns this

Parameters

event: "terminated"

eventHandler: function

Returns void

Returns this

Parameters

event: "item_added"

eventHandler: function

Parameters

monitoredItem: ClientMonitoredItem

Returns void

Returns this

Parameters

event: "keepalive"

eventHandler: function

Returns void

Returns this

Parameters

event: "internal_error"

eventHandler: function

Parameters

err: Error

Returns void

Returns this

Parameters

event: "raw_notification"

eventHandler: function

Parameters

notificationMessage: NotificationMessage

Returns void

Returns this

Parameters

event: "received_notifications"

eventHandler: function

Parameters

notificationMessage: NotificationMessage

Returns void

Returns this

Parameters

event: "status_changed"

eventHandler: function

Parameters

status: StatusCode

diagnosticInfo: DiagnosticInfo

Returns void

Returns this

Parameters

event: "error"

eventHandler: function

Parameters

err: Error