Class ClientSidePublishEngine

A client side implementation to deal with publish service.

class: ClientSidePublishEngine The ClientSidePublishEngine encapsulates the mechanism to deal with a OPCUA Server and constantly sending PublishRequest The ClientSidePublishEngine also performs notification acknowledgements. Finally, ClientSidePublishEngine dispatch PublishResponse to the correct Subscription id callback
param: the client session
constructor

Hierarchy

ClientSidePublishEngine

Constructors

constructor

new ClientSidePublishEngine(session: ClientSession): ClientSidePublishEngine

- Defined in node-opcua-client/source/private/client_publish_engine.ts:46
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 node-opcua-client/source/private/client_publish_engine.ts:76
the number of active subscriptions managed by this publish engine.

property

subscriptionCount

type

{Number}

Returns number

Methods

acknowledge_notification

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

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

cleanup_acknowledgment_for_subscription

cleanup_acknowledgment_for_subscription(subscriptionId: SubscriptionId): void

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

getSubscription

getSubscription(subscriptionId: SubscriptionId): any

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

Parameters
- subscriptionId: SubscriptionId
Returns any

getSubscriptionIds

getSubscriptionIds(): SubscriptionId[]

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

hasSubscription

hasSubscription(subscriptionId: SubscriptionId): boolean

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

registerSubscription

registerSubscription(subscription: any): void

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

replenish_publish_request_queue

replenish_publish_request_queue(): void

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

republish

republish(callback: function): void

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

send_publish_request

send_publish_request(): void

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

send_publish_request

Returns void

suspend

suspend(suspendedState: boolean): void

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

terminate

terminate(): void

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

unregisterSubscription

unregisterSubscription(subscriptionId: SubscriptionId): void

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

unregisterSubscription

Parameters
- subscriptionId: SubscriptionId
Returns void

Generated using TypeDoc