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

Interface ClientSidePublishEnginePrivate

Hierarchy

ClientSidePublishEngine
- ClientSidePublishEnginePrivate

Constructors

constructor

new ClientSidePublishEnginePrivate(session: ClientSession): ClientSidePublishEnginePrivate

Inherited from ClientSidePublishEnginePrivate.constructor
- Defined in packages/node-opcua-client/dist/private/client_publish_engine.d.ts:26
Parameters
- session: ClientSession
Returns ClientSidePublishEnginePrivate

Properties

activeSubscriptionCount

activeSubscriptionCount: number

isSuspended

isSuspended: boolean

nbMaxPublishRequestsAcceptedByServer

nbMaxPublishRequestsAcceptedByServer: number

nbPendingPublishRequests

nbPendingPublishRequests: number

session

session: ClientSession | null

timeoutHint

timeoutHint: number

Static publishRequestCountInPipeline

publishRequestCountInPipeline: number

Accessors

subscriptionCount

get subscriptionCount(): number

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

property

subscriptionCount

Returns number

Methods

acknowledge_notification

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

Inherited from ClientSidePublishEnginePrivate.acknowledge_notification
- Defined in packages/node-opcua-client/dist/private/client_publish_engine.d.ts:35
Parameters
- subscriptionId: SubscriptionId
- sequenceNumber: number
Returns void

cleanup_acknowledgment_for_subscription

cleanup_acknowledgment_for_subscription(subscriptionId: SubscriptionId): void

Inherited from ClientSidePublishEnginePrivate.cleanup_acknowledgment_for_subscription
- Defined in packages/node-opcua-client/dist/private/client_publish_engine.d.ts:36
Parameters
- subscriptionId: SubscriptionId
Returns void

getSubscription

getSubscription(subscriptionId: SubscriptionId): any

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

Parameters
- subscriptionId: SubscriptionId
Returns any

getSubscriptionIds

getSubscriptionIds(): SubscriptionId[]

Inherited from ClientSidePublishEnginePrivate.getSubscriptionIds
- Defined in packages/node-opcua-client/dist/private/client_publish_engine.d.ts:50
Returns SubscriptionId[]

hasSubscription

hasSubscription(subscriptionId: SubscriptionId): boolean

Inherited from ClientSidePublishEnginePrivate.hasSubscription
- Defined in packages/node-opcua-client/dist/private/client_publish_engine.d.ts:55
Parameters
- subscriptionId: SubscriptionId
Returns boolean

internalSendPublishRequest

internalSendPublishRequest(): void

Overrides ClientSidePublishEngine.internalSendPublishRequest
- Defined in packages/node-opcua-end2end-test/test/end_to_end/u_test_e2e_deadband_filter.ts:76
Returns void

registerSubscription

registerSubscription(subscription: any): void

Inherited from ClientSidePublishEnginePrivate.registerSubscription
- Defined in packages/node-opcua-client/dist/private/client_publish_engine.d.ts:42
Parameters
- subscription: any
Returns void

replenish_publish_request_queue

replenish_publish_request_queue(): void

Inherited from ClientSidePublishEnginePrivate.replenish_publish_request_queue
- Defined in packages/node-opcua-client/dist/private/client_publish_engine.d.ts:43
Returns void

republish

republish(callback: function): void

Inherited from ClientSidePublishEnginePrivate.republish
- Defined in packages/node-opcua-client/dist/private/client_publish_engine.d.ts:56
Parameters
- callback: function
  - - (): void
    - Returns void
Returns void

send_publish_request

send_publish_request(): void

Inherited from ClientSidePublishEnginePrivate.send_publish_request
- Defined in packages/node-opcua-client/dist/private/client_publish_engine.d.ts:40
method

send_publish_request

Returns void

suspend

suspend(suspend: boolean): void

Overrides ClientSidePublishEngine.suspend
- Defined in packages/node-opcua-end2end-test/test/end_to_end/u_test_e2e_deadband_filter.ts:77
Parameters
- suspend: boolean
Returns void

terminate

terminate(): void

Inherited from ClientSidePublishEnginePrivate.terminate
- Defined in packages/node-opcua-client/dist/private/client_publish_engine.d.ts:41
Returns void

unregisterSubscription

unregisterSubscription(subscriptionId: SubscriptionId): void

Inherited from ClientSidePublishEnginePrivate.unregisterSubscription
- Defined in packages/node-opcua-client/dist/private/client_publish_engine.d.ts:49
method

unregisterSubscription

Parameters
- subscriptionId: SubscriptionId
Returns void

Generated using TypeDoc