Class ClientSidePublishEngine

subscribe now with sterfive to access the online-user manual

A client side implementation to deal with publish service.

param: the client session

Hierarchy

ClientSidePublishEngine

Index

Constructors

constructor

new ClientSidePublishEngine(session: ClientSession): ClientSidePublishEngine

- Defined in packages/node-opcua-client/dist/private/client_publish_engine.d.ts:27
Parameters
- session: ClientSession
Returns ClientSidePublishEngine

Properties

activeSubscriptionCount

activeSubscriptionCount: number

isSuspended

isSuspended: boolean

nbMaxPublishRequestsAcceptedByServer

nbMaxPublishRequestsAcceptedByServer: number

nbPendingPublishRequests

nbPendingPublishRequests: number

session

session: ClientSession

timeoutHint

timeoutHint: number

Static publishRequestCountInPipeline

publishRequestCountInPipeline: number

Accessors

subscriptionCount

get subscriptionCount(): number

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

property

subscriptionCount

Returns number

Methods

acknowledge_notification

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

- Defined in packages/node-opcua-client/dist/private/client_publish_engine.d.ts:36
Parameters
- subscriptionId: number
- sequenceNumber: number
Returns void

cleanup_acknowledgment_for_subscription

cleanup_acknowledgment_for_subscription(subscriptionId: number): void

- Defined in packages/node-opcua-client/dist/private/client_publish_engine.d.ts:37
Parameters
- subscriptionId: number
Returns void

getSubscription

getSubscription(subscriptionId: number): ClientSubscription

- Defined in packages/node-opcua-client/dist/private/client_publish_engine.d.ts:55
get the client subscription from Id

Parameters
- subscriptionId: number
Returns ClientSubscription

getSubscriptionIds

getSubscriptionIds(): number[]

- Defined in packages/node-opcua-client/dist/private/client_publish_engine.d.ts:51
Returns number[]

hasSubscription

hasSubscription(subscriptionId: number): boolean

- Defined in packages/node-opcua-client/dist/private/client_publish_engine.d.ts:56
Parameters
- subscriptionId: number
Returns boolean

internalSendPublishRequest

internalSendPublishRequest(): void

- Defined in packages/node-opcua-client/dist/private/client_publish_engine.d.ts:58
Returns void

registerSubscription

registerSubscription(subscription: ClientSubscription): void

- Defined in packages/node-opcua-client/dist/private/client_publish_engine.d.ts:43
Parameters
- subscription: ClientSubscription
Returns void

replenish_publish_request_queue

replenish_publish_request_queue(): void

- Defined in packages/node-opcua-client/dist/private/client_publish_engine.d.ts:44
Returns void

republish

republish(callback: () => void): void

- Defined in packages/node-opcua-client/dist/private/client_publish_engine.d.ts:57
Parameters
- callback: () => void
  - - (): void
    - Returns void
Returns void

send_publish_request

send_publish_request(): void

- Defined in packages/node-opcua-client/dist/private/client_publish_engine.d.ts:41
method

send_publish_request

Returns void

suspend

suspend(suspendedState: boolean): void

- Defined in packages/node-opcua-client/dist/private/client_publish_engine.d.ts:35
Parameters
- suspendedState: boolean
Returns void

terminate

terminate(): void

- Defined in packages/node-opcua-client/dist/private/client_publish_engine.d.ts:42
Returns void

unregisterSubscription

unregisterSubscription(subscriptionId: number): void

- Defined in packages/node-opcua-client/dist/private/client_publish_engine.d.ts:50
method

unregisterSubscription

Parameters
- subscriptionId: number
Returns void

Generated using TypeDoc