Class ServerSidePublishEngine

a Publish Engine for a given session

Hierarchy

EventEmitter
- ServerSidePublishEngine
  - ServerSidePublishEngineForOrphanSubscription

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ServerSidePublishEngine(options: ServerSidePublishEngineOptions): ServerSidePublishEngine

- Defined in node-opcua-server/source/server_publish_engine.ts:148
Parameters
- options: ServerSidePublishEngineOptions
Returns ServerSidePublishEngine

Properties

isSessionClosed

isSessionClosed: boolean = false

maxPublishRequestInQueue

maxPublishRequestInQueue: number = 0

Static defaultMaxListeners

defaultMaxListeners: number

Static registry

registry: ObjectRegistry = new ObjectRegistry()

Accessors

currentMonitoredItemCount

get currentMonitoredItemCount(): number

- Defined in node-opcua-server/source/server_publish_engine.ts:304
Returns number

hasLateSubscriptions

get hasLateSubscriptions(): boolean

- Defined in node-opcua-server/source/server_publish_engine.ts:374
Returns boolean

pendingClosedSubscriptionCount

get pendingClosedSubscriptionCount(): number

- Defined in node-opcua-server/source/server_publish_engine.ts:300
Returns number

pendingPublishRequestCount

get pendingPublishRequestCount(): number

- Defined in node-opcua-server/source/server_publish_engine.ts:289
number of pending PublishRequest available in queue

Returns number

subscriptionCount

get subscriptionCount(): number

- Defined in node-opcua-server/source/server_publish_engine.ts:296
number of subscriptions

Returns number

subscriptions

get subscriptions(): Subscription[]

- Defined in node-opcua-server/source/server_publish_engine.ts:222
get a array of subscription handled by the publish engine.

Returns Subscription[]

Methods

Private _on_PublishRequest

_on_PublishRequest(request: PublishRequest, callback: any): void

- Defined in node-opcua-server/source/server_publish_engine.ts:430
Parameters
- request: PublishRequest
- callback: any
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

add_subscription

add_subscription(subscription: Subscription): Subscription

- Defined in node-opcua-server/source/server_publish_engine.ts:228
Parameters
- subscription: Subscription
Returns Subscription

Private cancelPendingPublishRequest

cancelPendingPublishRequest(): void

- Defined in node-opcua-server/source/server_publish_engine.ts:419
Returns void

cancelPendingPublishRequestBeforeChannelChange

cancelPendingPublishRequestBeforeChannelChange(): void

- Defined in node-opcua-server/source/server_publish_engine.ts:407
Returns void

detach_subscription

detach_subscription(subscription: Subscription): Subscription

- Defined in node-opcua-server/source/server_publish_engine.ts:244
Parameters
- subscription: Subscription
Returns Subscription

dispose

dispose(): void

- Defined in node-opcua-server/source/server_publish_engine.ts:180
Returns void

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>

findLateSubscriptionSortedByPriority

findLateSubscriptionSortedByPriority(): Subscription

- Defined in node-opcua-server/source/server_publish_engine.ts:378
Returns Subscription

findLateSubscriptions

findLateSubscriptions(): Subscription[]

- Defined in node-opcua-server/source/server_publish_engine.ts:367
Returns Subscription[]

findLateSubscriptionsSortedByAge

findLateSubscriptionsSortedByAge(): Subscription[]

- Defined in node-opcua-server/source/server_publish_engine.ts:399
Returns Subscription[]

findSubscriptionWaitingForFirstPublish

findSubscriptionWaitingForFirstPublish(): Subscription

- Defined in node-opcua-server/source/server_publish_engine.ts:352
Returns Subscription

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

getSubscriptionById

getSubscriptionById(subscriptionId: number | string): Subscription

- Defined in node-opcua-server/source/server_publish_engine.ts:348
retrieve a subscription by id.

Parameters
- subscriptionId: number | string
Returns Subscription

Subscription

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

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

onSessionClose

onSessionClose(): void

- Defined in node-opcua-server/source/server_publish_engine.ts:411
Returns void

on_close_subscription

on_close_subscription(subscription: Subscription): void

- Defined in node-opcua-server/source/server_publish_engine.ts:313
Parameters
- subscription: Subscription
Returns void

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

process_subscriptionAcknowledgements

process_subscriptionAcknowledgements(subscriptionAcknowledgements: SubscriptionAcknowledgement[]): StatusCode[]

- Defined in node-opcua-server/source/server_publish_engine.ts:200
Parameters
- subscriptionAcknowledgements: SubscriptionAcknowledgement[]
Returns StatusCode[]

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

shutdown

shutdown(): void

- Defined in node-opcua-server/source/server_publish_engine.ts:261
Returns void

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

Static Private transferSubscription

transferSubscription(subscription: Subscription, destPublishEngine: ServerSidePublishEngine, sendInitialValues: boolean): void

- Defined in node-opcua-server/source/server_publish_engine.ts:116
Parameters
- subscription: Subscription
- destPublishEngine: ServerSidePublishEngine
- sendInitialValues: boolean
  
  true if initial values should be sent
Returns void

Static Private transferSubscriptionsToOrphan

transferSubscriptionsToOrphan(srcPublishEngine: ServerSidePublishEngine, destPublishEngine: ServerSidePublishEngine): void

- Defined in node-opcua-server/source/server_publish_engine.ts:84
Parameters
- srcPublishEngine: ServerSidePublishEngine
- destPublishEngine: ServerSidePublishEngine
Returns void

Generated using TypeDoc