ClientSubscriptionImpl | node-opcua-client

Hierarchy

EventEmitter
- ClientSubscriptionImpl

Implements

ClientSubscription

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

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

- Defined in node-opcua-client/source/private/client_subscription_impl.ts:94
Parameters
- session: ClientSession
- options: ClientSubscriptionOptions
Returns ClientSubscriptionImpl

Properties

lifetimeCount

lifetimeCount: number

maxKeepAliveCount

maxKeepAliveCount: number

maxNotificationsPerPublish

maxNotificationsPerPublish: number

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

Accessors

hasSession

get hasSession(): boolean

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

isActive

get isActive(): boolean

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

session

get session(): ClientSessionImpl

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

property

session

type

{ClientSession}

Returns ClientSessionImpl

Methods

_add_monitored_item

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

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

_delete_monitored_items

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

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

_wait_for_subscription_to_be_ready

_wait_for_subscription_to_be_ready(done: ErrorCallback): void

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

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

evaluateRemainingLifetime

evaluateRemainingLifetime(): number

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

Returns number

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: Callback<ClientMonitoredItemBase>): void

- Defined in node-opcua-client/source/private/client_subscription_impl.ts:216
Parameters
- itemToMonitor: ReadValueIdOptions
- requestedParameters: MonitoringParametersOptions
- timestampsToReturn: TimestampsToReturn
Returns Promise<ClientMonitoredItemBase>
- Defined in node-opcua-client/source/private/client_subscription_impl.ts:221
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 node-opcua-client/source/private/client_subscription_impl.ts:254
Parameters
- itemsToMonitor: ReadValueIdOptions[]
- requestedParameters: MonitoringParametersOptions
- timestampsToReturn: TimestampsToReturn
Returns Promise<ClientMonitoredItemGroup>
- Defined in node-opcua-client/source/private/client_subscription_impl.ts:260
Parameters
- itemsToMonitor: ReadValueIdOptions[]
- requestedParameters: MonitoringParametersOptions
- timestampsToReturn: TimestampsToReturn
- done: Callback<ClientMonitoredItemGroup>
Returns void

nextClientHandle

nextClientHandle(): number

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

nextClientHandle

Returns number

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

on

on(event: string | symbol, listener: 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

once

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

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[]

recreateSubscriptionAndMonitoredItem

recreateSubscriptionAndMonitoredItem(callback: ErrorCallback): void

- Defined in node-opcua-client/source/private/client_subscription_impl.ts:419
utility function to recreate new subscription @method recreateSubscriptionAndMonitoredItem

Parameters
- callback: ErrorCallback
Returns void

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

setPublishingMode

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

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

terminate

terminate(): Promise<void>
terminate(callback: ErrorCallback): void

- Defined in node-opcua-client/source/private/client_subscription_impl.ts:159
Returns Promise<void>
- Defined in node-opcua-client/source/private/client_subscription_impl.ts:160
Parameters
- callback: ErrorCallback
Returns void

toString

toString(): string

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

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

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

session: ClientSession

options: ClientSubscriptionOptions

Returns ClientSubscriptionImpl

Properties

lifetimeCount

maxKeepAliveCount

maxNotificationsPerPublish

monitoredItems

priority

publishEngine

publishingEnabled

publishingInterval

subscriptionId

timeoutHint

Static defaultMaxListeners

Accessors

hasSession

Returns boolean

isActive

Returns boolean

session

Returns ClientSessionImpl

Methods

_add_monitored_item

Parameters

clientHandle: ClientHandle

monitoredItem: ClientMonitoredItemBase

Returns void

_delete_monitored_items

Parameters

monitoredItems: ClientMonitoredItemBase[]

callback: ErrorCallback

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

listenerCount

Parameters

type: string | symbol

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

monitor

Parameters

itemToMonitor: ReadValueIdOptions

requestedParameters: MonitoringParametersOptions

timestampsToReturn: TimestampsToReturn

Returns Promise<ClientMonitoredItemBase>