⚠️ You are reading documentation for an OLD version (v2.20.0). The current released version is v2.173.1. View latest documentation →

Class ClientSidePublishEngine

A client side implementation to deal with publish service.

param: the client session

Hierarchy

ClientSidePublishEngine

Constructors

constructor

new ClientSidePublishEngine(session: ClientSession): ClientSidePublishEngine

- Defined in packages/node-opcua-client/source/private/client_publish_engine.ts:43
Parameters
- session: ClientSession
Returns ClientSidePublishEngine

Properties

activeSubscriptionCount

activeSubscriptionCount: number

isSuspended

isSuspended: boolean

nbMaxPublishRequestsAcceptedByServer

nbMaxPublishRequestsAcceptedByServer: number

nbPendingPublishRequests

nbPendingPublishRequests: number

session

session: ClientSession | null

timeoutHint

timeoutHint: number

Static publishRequestCountInPipeline

publishRequestCountInPipeline: number = 5

Accessors

subscriptionCount

get subscriptionCount(): number

- Defined in packages/node-opcua-client/source/private/client_publish_engine.ts:71
the number of active subscriptions managed by this publish engine.

property

subscriptionCount

Returns number

Methods

acknowledge_notification

acknowledge_notification(subscriptionId: SubscriptionId, sequenceNumber: number): void

- Defined in packages/node-opcua-client/source/private/client_publish_engine.ts:83
Parameters
- subscriptionId: SubscriptionId
- sequenceNumber: number
Returns void

cleanup_acknowledgment_for_subscription

cleanup_acknowledgment_for_subscription(subscriptionId: SubscriptionId): void

- Defined in packages/node-opcua-client/source/private/client_publish_engine.ts:87
Parameters
- subscriptionId: SubscriptionId
Returns void

getSubscription

getSubscription(subscriptionId: SubscriptionId): any

- Defined in packages/node-opcua-client/source/private/client_publish_engine.ts:186
get the client subscription from Id

Parameters
- subscriptionId: SubscriptionId
Returns any

getSubscriptionIds

getSubscriptionIds(): SubscriptionId[]

- Defined in packages/node-opcua-client/source/private/client_publish_engine.ts:179
Returns SubscriptionId[]

hasSubscription

hasSubscription(subscriptionId: SubscriptionId): boolean

- Defined in packages/node-opcua-client/source/private/client_publish_engine.ts:192
Parameters
- subscriptionId: SubscriptionId
Returns boolean

internalSendPublishRequest

internalSendPublishRequest(): void

- Defined in packages/node-opcua-client/source/private/client_publish_engine.ts:222
Returns void

registerSubscription

registerSubscription(subscription: any): void

- Defined in packages/node-opcua-client/source/private/client_publish_engine.ts:125
Parameters
- subscription: any
Returns void

replenish_publish_request_queue

replenish_publish_request_queue(): void

- Defined in packages/node-opcua-client/source/private/client_publish_engine.ts:144
Returns void

republish

republish(callback: function): void

- Defined in packages/node-opcua-client/source/private/client_publish_engine.ts:197
Parameters
- callback: function
  - - (): void
    - Returns void
Returns void

send_publish_request

send_publish_request(): void

- Defined in packages/node-opcua-client/source/private/client_publish_engine.ts:94
method

send_publish_request

Returns void

suspend

suspend(suspendedState: boolean): void

- Defined in packages/node-opcua-client/source/private/client_publish_engine.ts:75
Parameters
- suspendedState: boolean
Returns void

terminate

terminate(): void

- Defined in packages/node-opcua-client/source/private/client_publish_engine.ts:121
Returns void

unregisterSubscription

unregisterSubscription(subscriptionId: SubscriptionId): void

- Defined in packages/node-opcua-client/source/private/client_publish_engine.ts:164
method

unregisterSubscription

Parameters
- subscriptionId: SubscriptionId
Returns void

Generated using TypeDoc