Class ServerSidePublishEngineForOrphanSubscription

the ServerSidePublishEngineForOrphanSubscription is keeping track of live subscription that have been detached from timed out session. It takes care of providing back those subscription to any session that will claim them again with transferSubscription service It also make sure that subscription are properly disposed when they expire.

internal

Hierarchy

ServerSidePublishEngine
- ServerSidePublishEngineForOrphanSubscription

Implements

IServerSidePublishEngine

Constructors

constructor

Properties

Accessors

Constructors

constructor

new ServerSidePublishEngineForOrphanSubscription(options: any): ServerSidePublishEngineForOrphanSubscription

Overrides ServerSidePublishEngine.constructor
- Defined in packages/node-opcua-server/source/server_publish_engine_for_orphan_subscriptions.ts:24
Parameters
- options: any
Returns ServerSidePublishEngineForOrphanSubscription

Properties

isSessionClosed

isSessionClosed: boolean = false

maxPublishRequestInQueue

maxPublishRequestInQueue: number = 0

Static registry

registry: ObjectRegistry = new ObjectRegistry()

Accessors

currentMonitoredItemCount

get currentMonitoredItemCount(): number

Inherited from ServerSidePublishEngine.currentMonitoredItemCount
- Defined in packages/node-opcua-server/source/server_publish_engine.ts:304
Returns number

hasLateSubscriptions

get hasLateSubscriptions(): boolean

Inherited from ServerSidePublishEngine.hasLateSubscriptions
- Defined in packages/node-opcua-server/source/server_publish_engine.ts:385
Returns boolean

pendingClosedSubscriptionCount

get pendingClosedSubscriptionCount(): number

Inherited from ServerSidePublishEngine.pendingClosedSubscriptionCount
- Defined in packages/node-opcua-server/source/server_publish_engine.ts:300
Returns number

pendingPublishRequestCount

get pendingPublishRequestCount(): number

Inherited from ServerSidePublishEngine.pendingPublishRequestCount
- Defined in packages/node-opcua-server/source/server_publish_engine.ts:289
number of pending PublishRequest available in queue

Returns number

subscriptionCount

get subscriptionCount(): number

Inherited from ServerSidePublishEngine.subscriptionCount
- Defined in packages/node-opcua-server/source/server_publish_engine.ts:296
number of subscriptions

Returns number

subscriptions

get subscriptions(): Subscription[]

Inherited from ServerSidePublishEngine.subscriptions
- Defined in packages/node-opcua-server/source/server_publish_engine.ts:235
get a array of subscription handled by the publish engine.

Returns Subscription[]

Methods

_on_tick

_on_tick(): void

Implementation of IServerSidePublishEngine._on_tick

Inherited from ServerSidePublishEngine._on_tick
- Defined in packages/node-opcua-server/source/server_publish_engine.ts:637
Returns void

_purge_dangling_subscription

_purge_dangling_subscription(subscriptionId: number): void

Inherited from ServerSidePublishEngine._purge_dangling_subscription
- Defined in packages/node-opcua-server/source/server_publish_engine.ts:316
Parameters
- subscriptionId: number
Returns void

_send_response

_send_response(subscription: Subscription, response: PublishResponse): void

Implementation of IServerSidePublishEngine._send_response

Inherited from ServerSidePublishEngine._send_response
- Defined in packages/node-opcua-server/source/server_publish_engine.ts:630
Parameters
- subscription: Subscription
- response: PublishResponse
Returns void

_send_response_for_request

_send_response_for_request(publishData: PublishData, response: PublishResponse): void

Inherited from ServerSidePublishEngine._send_response_for_request
- Defined in packages/node-opcua-server/source/server_publish_engine.ts:658
Parameters
- publishData: PublishData
- response: PublishResponse
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

add_subscription

add_subscription(subscription: Subscription): Subscription

Overrides ServerSidePublishEngine.add_subscription
- Defined in packages/node-opcua-server/source/server_publish_engine_for_orphan_subscriptions.ts:29
Parameters
- subscription: Subscription
Returns Subscription

cancelPendingPublishRequestBeforeChannelChange

cancelPendingPublishRequestBeforeChannelChange(): void

Inherited from ServerSidePublishEngine.cancelPendingPublishRequestBeforeChannelChange
- Defined in packages/node-opcua-server/source/server_publish_engine.ts:396
Returns void

detach_subscription

detach_subscription(subscription: Subscription): Subscription

Overrides ServerSidePublishEngine.detach_subscription
- Defined in packages/node-opcua-server/source/server_publish_engine_for_orphan_subscriptions.ts:45
Parameters
- subscription: Subscription
Returns Subscription

dispose

dispose(): void

Inherited from ServerSidePublishEngine.dispose
- Defined in packages/node-opcua-server/source/server_publish_engine.ts:197
Returns void

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

eventNames

eventNames(): Array<string | symbol>

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

findLateSubscriptions

findLateSubscriptions(): Subscription[]

Inherited from ServerSidePublishEngine.findLateSubscriptions
- Defined in packages/node-opcua-server/source/server_publish_engine.ts:379
Returns Subscription[]

findLateSubscriptionsSortedByAge

findLateSubscriptionsSortedByAge(): Subscription[]

Inherited from ServerSidePublishEngine.findLateSubscriptionsSortedByAge
- Defined in packages/node-opcua-server/source/server_publish_engine.ts:389
Returns Subscription[]

getMaxListeners

getMaxListeners(): number

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

getSubscriptionById

getSubscriptionById(subscriptionId: number | string): Subscription

Inherited from ServerSidePublishEngine.getSubscriptionById
- Defined in packages/node-opcua-server/source/server_publish_engine.ts:350
retrieve a subscription by id.

Parameters
- subscriptionId: number | string
Returns Subscription

Subscription

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

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

onSessionClose

onSessionClose(): void

Inherited from ServerSidePublishEngine.onSessionClose
- Defined in packages/node-opcua-server/source/server_publish_engine.ts:400
Returns void

on_close_subscription

on_close_subscription(subscription: IClosedOrTransferedSubscription): void

Implementation of IServerSidePublishEngine.on_close_subscription

Inherited from ServerSidePublishEngine.on_close_subscription
- Defined in packages/node-opcua-server/source/server_publish_engine.ts:320
Parameters
- subscription: IClosedOrTransferedSubscription
Returns void

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

process_subscriptionAcknowledgements

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

Inherited from ServerSidePublishEngine.process_subscriptionAcknowledgements
- Defined in packages/node-opcua-server/source/server_publish_engine.ts:209
Parameters
- subscriptionAcknowledgements: SubscriptionAcknowledgement[]
Returns StatusCode[]

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

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

send_keep_alive_response

send_keep_alive_response(subscriptionId: number, future_sequence_number: number): boolean

Implementation of IServerSidePublishEngine.send_keep_alive_response

Inherited from ServerSidePublishEngine.send_keep_alive_response
- Defined in packages/node-opcua-server/source/server_publish_engine.ts:594
call by a subscription when no notification message is available after the keep alive delay has expired.

method

send_keep_alive_response

Parameters
- subscriptionId: number
- future_sequence_number: number
Returns boolean

true if a publish response has been sent

setMaxListeners

setMaxListeners(n: number): this

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

shutdown

shutdown(): void

Inherited from ServerSidePublishEngine.shutdown
- Defined in packages/node-opcua-server/source/server_publish_engine.ts:268
Returns void

Class ServerSidePublishEngineForOrphanSubscription

Hierarchy

Implements

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: any

Returns ServerSidePublishEngineForOrphanSubscription

Properties

isSessionClosed

maxPublishRequestInQueue

Static registry

Accessors

currentMonitoredItemCount

Returns number

hasLateSubscriptions

Returns boolean

pendingClosedSubscriptionCount

Returns number

pendingPublishRequestCount

Returns number

subscriptionCount

Returns number

subscriptions

Returns Subscription[]

Methods

_on_tick

Returns void

_purge_dangling_subscription

Parameters

subscriptionId: number

Returns void

_send_response

Parameters

subscription: Subscription

response: PublishResponse

Returns void

_send_response_for_request

Parameters

publishData: PublishData

response: PublishResponse

Returns void

addListener

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

add_subscription

Parameters

subscription: Subscription

Returns Subscription

cancelPendingPublishRequestBeforeChannelChange

Returns void

detach_subscription

Parameters

subscription: Subscription

Returns Subscription

dispose

Returns void

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns Array<string | symbol>

findLateSubscriptions

Returns Subscription[]

findLateSubscriptionsSortedByAge

Returns Subscription[]

getMaxListeners

Returns number

getSubscriptionById