Class ServerSidePublishEngine

subscribe now with sterfive to access the online-user manual

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

Overrides EventEmitter.constructor
- Defined in node-opcua-server/dist/server_publish_engine.d.ts:41
Parameters
- Optional options: ServerSidePublishEngineOptions
Returns ServerSidePublishEngine

Properties

isSessionClosed

isSessionClosed: boolean

maxPublishRequestInQueue

maxPublishRequestInQueue: number

Static registry

registry: ObjectRegistry

Accessors

currentMonitoredItemCount

get currentMonitoredItemCount(): number

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

hasLateSubscriptions

get hasLateSubscriptions(): boolean

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

pendingClosedSubscriptionCount

get pendingClosedSubscriptionCount(): number

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

pendingPublishRequestCount

get pendingPublishRequestCount(): number

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

Returns number

subscriptionCount

get subscriptionCount(): number

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

Returns number

subscriptions

get subscriptions(): Subscription[]

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

Returns Subscription[]

Methods

_on_tick

_on_tick(): void

Implementation of IServerSidePublishEngine._on_tick
- Defined in node-opcua-server/dist/server_publish_engine.d.ts:108
Returns void

_purge_dangling_subscription

_purge_dangling_subscription(subscriptionId: number): void

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

_send_response

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

Implementation of IServerSidePublishEngine._send_response
- Defined in node-opcua-server/dist/server_publish_engine.d.ts:107
Parameters
- subscription: Subscription
- response: PublishResponse
Returns void

_send_response_for_request

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

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

add_subscription

add_subscription(subscription: Subscription): Subscription

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

cancelPendingPublishRequestBeforeChannelChange

cancelPendingPublishRequestBeforeChannelChange(): void

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

detach_subscription

detach_subscription(subscription: Subscription): Subscription

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

dispose

dispose(): void

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

findLateSubscriptions

findLateSubscriptions(): Subscription[]

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

findLateSubscriptionsSortedByAge

findLateSubscriptionsSortedByAge(): Subscription[]

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

getSubscriptionById

getSubscriptionById(subscriptionId: string | number): Subscription

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

Parameters
- subscriptionId: string | number
Returns Subscription

Subscription

onSessionClose

onSessionClose(): void

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

on_close_subscription

on_close_subscription(subscription: IClosedOrTransferredSubscription): void

Implementation of IServerSidePublishEngine.on_close_subscription
- Defined in node-opcua-server/dist/server_publish_engine.d.ts:67
Parameters
- subscription: IClosedOrTransferredSubscription
Returns void

process_subscriptionAcknowledgements

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

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

send_keep_alive_response

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

Implementation of IServerSidePublishEngine.send_keep_alive_response
- Defined in node-opcua-server/dist/server_publish_engine.d.ts:106
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

shutdown

shutdown(): void

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

toString

toString(): string

- Defined in node-opcua-server/dist/server_publish_engine.d.ts:42
Returns string

Generated using TypeDoc