Skip to content

Class: DynamicSubscription ​

Defined in: netconf/src/operations/subscriptions/dynamic-subscription.ts:63

A dynamic subscription (RFC 8639): an AsyncIterable of its updates, in arrival order. Read it once. Iteration ends when the subscription ends (see ended), and fails with SubscriptionOverflowError if more than queueSize updates wait unread. Leaving a for await early, or an await using scope, deletes the subscription on the server.

Implements ​

Properties ​

datastore ​

ts
readonly datastore: string | undefined;

Defined in: netconf/src/operations/subscriptions/dynamic-subscription.ts:71

A datastore subscription's datastore identity, module-qualified (RFC 7951): ietf-datastores:operational.


ended ​

ts
readonly ended: Promise<SubscriptionEnd>;

Defined in: netconf/src/operations/subscriptions/dynamic-subscription.ts:79

Resolves when the subscription ends, with the reason. Never rejects.


id ​

ts
readonly id: number;

Defined in: netconf/src/operations/subscriptions/dynamic-subscription.ts:65

The server's subscription id.


kind ​

ts
readonly kind: "datastore" | "stream";

Defined in: netconf/src/operations/subscriptions/dynamic-subscription.ts:67

Whether it subscribes to an event stream or to a datastore (YANG-Push).


replay ​

ts
readonly replay: boolean;

Defined in: netconf/src/operations/subscriptions/dynamic-subscription.ts:75

True if a replay was requested.


replayComplete ​

ts
readonly replayComplete: Promise<boolean>;

Defined in: netconf/src/operations/subscriptions/dynamic-subscription.ts:77

Resolves true when the server reports replay complete; false if there was no replay or it ended first.


stream ​

ts
readonly stream: string | undefined;

Defined in: netconf/src/operations/subscriptions/dynamic-subscription.ts:69

A stream subscription's stream.


trigger ​

ts
readonly trigger: "periodic" | "on-change" | undefined;

Defined in: netconf/src/operations/subscriptions/dynamic-subscription.ts:73

A datastore subscription's trigger.

Accessors ​

end ​

Get Signature ​

ts
get end(): SubscriptionEnd | undefined;

Defined in: netconf/src/operations/subscriptions/dynamic-subscription.ts:119

Why and how it ended, or undefined while it is active.

Returns ​

SubscriptionEnd | undefined

Methods ​

[asyncDispose]() ​

ts
[asyncDispose](): Promise<void>;

Defined in: netconf/src/operations/subscriptions/dynamic-subscription.ts:203

Delete the subscription if still active, ignoring the caller's AbortSignal.

Returns ​

Promise<void>

Implementation of ​

AsyncDisposable.[asyncDispose]


[asyncIterator]() ​

ts
[asyncIterator](): this;

Defined in: netconf/src/operations/subscriptions/dynamic-subscription.ts:208

The subscription itself, so it can be read with for await.

Returns ​

this

Implementation of ​

AsyncIterableIterator.[asyncIterator]


delete() ​

ts
delete(options?): Promise<void>;

Defined in: netconf/src/operations/subscriptions/dynamic-subscription.ts:152

<delete-subscription>, then end with deleted. Does nothing once the subscription has ended, and shares a delete already in progress.

Parameters ​

options? ​

RpcOptions = {}

Returns ​

Promise<void>


modify() ​

ts
modify(options?): Promise<void>;

Defined in: netconf/src/operations/subscriptions/dynamic-subscription.ts:128

<modify-subscription>: change the filter or stop-time, and for a datastore subscription the period (periodic) or dampening period (on-change). A stream subscription's modify must give a filter.

Parameters ​

options? ​

ModifyOptions = {}

Returns ​

Promise<void>


next() ​

ts
next(): Promise<IteratorResult<SubscriptionUpdate, any>>;

Defined in: netconf/src/operations/subscriptions/dynamic-subscription.ts:183

The next update, waiting for one if none is queued; done once the subscription has ended, after rejecting once with a SubscriptionOverflowError if it ended because the queue overflowed.

Returns ​

Promise<IteratorResult<SubscriptionUpdate, any>>

Implementation of ​

AsyncIterableIterator.next


resync() ​

ts
resync(options?): Promise<void>;

Defined in: netconf/src/operations/subscriptions/dynamic-subscription.ts:142

YANG-Push <resync-subscription>: ask an on-change subscription for a fresh push-update.

Parameters ​

options? ​

RpcOptions = {}

Returns ​

Promise<void>


return() ​

ts
return(): Promise<IteratorResult<SubscriptionUpdate, any>>;

Defined in: netconf/src/operations/subscriptions/dynamic-subscription.ts:195

Stop reading: delete the subscription (if still active) and end iteration.

Returns ​

Promise<IteratorResult<SubscriptionUpdate, any>>

Implementation of ​

AsyncIterableIterator.return

Released under the MIT Licence.