ServerSidePublishEngine | NodeOPCUA reference documentation

a Publish Engine for a given session

Hierarchy

EventEmitter
- ServerSidePublishEngine

Implements

IServerSidePublishEngine

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ServerSidePublishEngine(options?: ServerSidePublishEngineOptions): ServerSidePublishEngine

- Defined in packages/node-opcua-server/dist/server_publish_engine.d.ts:37
Parameters
- Optional options: ServerSidePublishEngineOptions
Returns ServerSidePublishEngine

Properties

isSessionClosed

isSessionClosed: boolean

maxPublishRequestInQueue

maxPublishRequestInQueue: number

Readonly Static captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Readonly Static errorMonitor

errorMonitor: typeof errorMonitor

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.

Static registry

registry: ObjectRegistry

Accessors

currentMonitoredItemCount

get currentMonitoredItemCount(): number

- Defined in packages/node-opcua-server/dist/server_publish_engine.d.ts:61
Returns number

hasLateSubscriptions

get hasLateSubscriptions(): boolean

- Defined in packages/node-opcua-server/dist/server_publish_engine.d.ts:71
Returns boolean

pendingClosedSubscriptionCount

get pendingClosedSubscriptionCount(): number

- Defined in packages/node-opcua-server/dist/server_publish_engine.d.ts:60
Returns number

pendingPublishRequestCount

get pendingPublishRequestCount(): number

- Defined in packages/node-opcua-server/dist/server_publish_engine.d.ts:55
number of pending PublishRequest available in queue

Returns number

subscriptionCount

get subscriptionCount(): number

- Defined in packages/node-opcua-server/dist/server_publish_engine.d.ts:59
number of subscriptions

Returns number

subscriptions

get subscriptions(): Subscription[]

- Defined in packages/node-opcua-server/dist/server_publish_engine.d.ts:44
get a array of subscription handled by the publish engine.

Returns Subscription[]

Methods

_on_tick

_on_tick(): void

- Defined in packages/node-opcua-server/dist/server_publish_engine.d.ts:103
Returns void

_purge_dangling_subscription

_purge_dangling_subscription(subscriptionId: number): void

- Defined in packages/node-opcua-server/dist/server_publish_engine.d.ts:62
Parameters
- subscriptionId: number
Returns void

_send_response

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

- Defined in packages/node-opcua-server/dist/server_publish_engine.d.ts:102
Parameters
- subscription: Subscription
- response: PublishResponse
Returns void

_send_response_for_request

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

- Defined in packages/node-opcua-server/dist/server_publish_engine.d.ts:105
Parameters
- publishData: PublishData
- response: PublishResponse
Returns void

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): ServerSidePublishEngine

- Defined in node_modules/@types/node/events.d.ts:62
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ServerSidePublishEngine

add_subscription

add_subscription(subscription: Subscription): Subscription

- Defined in packages/node-opcua-server/dist/server_publish_engine.d.ts:47
Parameters
- subscription: Subscription
Returns Subscription

cancelPendingPublishRequestBeforeChannelChange

cancelPendingPublishRequestBeforeChannelChange(): void

- Defined in packages/node-opcua-server/dist/server_publish_engine.d.ts:73
Returns void

detach_subscription

detach_subscription(subscription: Subscription): Subscription

- Defined in packages/node-opcua-server/dist/server_publish_engine.d.ts:48
Parameters
- subscription: Subscription
Returns Subscription

dispose

dispose(): void

- Defined in packages/node-opcua-server/dist/server_publish_engine.d.ts:39
Returns void

emit

emit(event: string | symbol, ...args: any[]): boolean

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

eventNames

eventNames(): (string | symbol)[]

- Defined in node_modules/@types/node/events.d.ts:77
Returns (string | symbol)[]

findLateSubscriptions

findLateSubscriptions(): Subscription[]

- Defined in packages/node-opcua-server/dist/server_publish_engine.d.ts:70
Returns Subscription[]

findLateSubscriptionsSortedByAge

findLateSubscriptionsSortedByAge(): Subscription[]

- Defined in packages/node-opcua-server/dist/server_publish_engine.d.ts:72
Returns Subscription[]

getMaxListeners

getMaxListeners(): number

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

getSubscriptionById

getSubscriptionById(subscriptionId: string | number): Subscription

- Defined in packages/node-opcua-server/dist/server_publish_engine.d.ts:69
retrieve a subscription by id.

Parameters
- subscriptionId: string | number
Returns Subscription

Subscription

listenerCount

listenerCount(event: string | symbol): number

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

listeners

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

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

off

off(event: string | symbol, listener: (...args: any[]) => void): ServerSidePublishEngine

- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ServerSidePublishEngine

on

on(event: string | symbol, listener: (...args: any[]) => void): ServerSidePublishEngine

- Defined in node_modules/@types/node/events.d.ts:63
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ServerSidePublishEngine

onSessionClose

onSessionClose(): void

- Defined in packages/node-opcua-server/dist/server_publish_engine.d.ts:74
Returns void

on_close_subscription

on_close_subscription(subscription: IClosedOrTransferredSubscription): void

- Defined in packages/node-opcua-server/dist/server_publish_engine.d.ts:63
Parameters
- subscription: IClosedOrTransferredSubscription
Returns void

once

once(event: string | symbol, listener: (...args: any[]) => void): ServerSidePublishEngine

- Defined in node_modules/@types/node/events.d.ts:64
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ServerSidePublishEngine

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): ServerSidePublishEngine

- Defined in node_modules/@types/node/events.d.ts:75
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ServerSidePublishEngine

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): ServerSidePublishEngine

- Defined in node_modules/@types/node/events.d.ts:76
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ServerSidePublishEngine

process_subscriptionAcknowledgements

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

- Defined in packages/node-opcua-server/dist/server_publish_engine.d.ts:40
Parameters
- subscriptionAcknowledgements: SubscriptionAcknowledgement[]
Returns StatusCode[]

rawListeners

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

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

removeAllListeners

removeAllListeners(event?: string | symbol): ServerSidePublishEngine

- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns ServerSidePublishEngine

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): ServerSidePublishEngine

- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns ServerSidePublishEngine

send_keep_alive_response

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

- Defined in packages/node-opcua-server/dist/server_publish_engine.d.ts:101
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): ServerSidePublishEngine

- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns ServerSidePublishEngine

shutdown

shutdown(): void

- Defined in packages/node-opcua-server/dist/server_publish_engine.d.ts:51
Returns void

Static listenerCount

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

- Defined in node_modules/@types/node/events.d.ts:31
deprecated

since v4.0.0

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

Static on

on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

- Defined in node_modules/@types/node/events.d.ts:28
Parameters
- emitter: EventEmitter
- event: string
Returns AsyncIterableIterator<any>

Static once

once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
once(emitter: DOMEventTarget, event: string): Promise<any[]>

- Defined in node_modules/@types/node/events.d.ts:26
Parameters
- emitter: NodeEventTarget
- event: string | symbol
Returns Promise<any[]>
- Defined in node_modules/@types/node/events.d.ts:27
Parameters
- emitter: DOMEventTarget
- event: string
Returns Promise<any[]>

subscribe now with sterfive to access the online-user manual

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: ServerSidePublishEngineOptions

Returns ServerSidePublishEngine

Properties

isSessionClosed

maxPublishRequestInQueue

Readonly Static captureRejectionSymbol

Static captureRejections

Static defaultMaxListeners

Readonly Static errorMonitor

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: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns ServerSidePublishEngine

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 (string | symbol)[]

findLateSubscriptions

Returns Subscription[]