Skip to content

Interface: StreamSubscriptionOptions ​

Defined in: netconf/src/operations/subscriptions/types.ts:20

Subscribe to an event stream (RFC 8639).

Extends ​

  • CommonOptions

Properties ​

filter? ​

ts
readonly filter?: Filter;

Defined in: netconf/src/operations/subscriptions/types.ts:12

A subtree filter, or an XPath filter. Checked against the server's subtree / xpath features.

Inherited from ​

CommonOptions.filter


queueSize? ​

ts
readonly queueSize?: number;

Defined in: netconf/src/operations/subscriptions/types.ts:16

Most updates held for a slow reader before the subscription fails. Default 1000.

Inherited from ​

CommonOptions.queueSize


replayStartTime? ​

ts
readonly replayStartTime?: string | Date;

Defined in: netconf/src/operations/subscriptions/types.ts:24

Replay logged events from this time first (needs the replay feature).


signal? ​

ts
readonly signal?: AbortSignal;

Defined in: netconf/src/messages/session.ts:100

Stop waiting for the reply. NETCONF has no way to cancel an RPC, so the server still processes it; its reply is discarded when it arrives.

Inherited from ​

CommonOptions.signal


stopTime? ​

ts
readonly stopTime?: string | Date;

Defined in: netconf/src/operations/subscriptions/types.ts:14

End the subscription at this time (RFC 3339 string or Date).

Inherited from ​

CommonOptions.stopTime


stream ​

ts
readonly stream: string;

Defined in: netconf/src/operations/subscriptions/types.ts:22

The stream, such as NETCONF. See streams().


timeout? ​

ts
readonly timeout?: number;

Defined in: netconf/src/messages/session.ts:95

Milliseconds to wait for the reply. Default: the session's timeouts.rpc. Infinity waits with no limit, and values above 2,147,483,647 are shortened to it. A value that is not a number rejects with a TypeError, and zero, a negative number or NaN with a RangeError, before anything is sent.

Inherited from ​

CommonOptions.timeout

Released under the MIT Licence.