Skip to content

Variable: partialLock ​

ts
const partialLock: object;

Defined in: netconf/src/operations/partial-lock.ts:332

The RFC 5717 partial-lock extension. Enable it with connect({ extensions: [partialLock] }).

Type Declaration ​

description ​

ts
readonly description: "RFC 5717: lock and unlock parts of the running datastore" = 'RFC 5717: lock and unlock parts of the running datastore';

A one-line summary of the extension.

descriptors ​

ts
readonly descriptors: readonly [OperationDescriptor, OperationDescriptor];

Descriptors for the RPCs this extension adds (each needs a builder in requests), and for its reads (kind: 'read', run through the method of content they name).

id ​

ts
readonly id: "partialLock" = 'partialLock';

Becomes client.ops.<id> and client.content.<id>, for the layers the extension contributes to.

ops ​

ts
readonly ops: (ctx) => PartialLockOps;

Operations layer: called once per client, after the hello. The result becomes client.ops.<id>: calls that send operations and hand back XML, a reply, or a handle on what they started (a subscription, a lock).

Parameters ​

ctx ​

ExtensionContext

Returns ​

PartialLockOps

requests ​

ts
readonly requests: object;

Builders for the RPCs in descriptors, by RPC name. Each may type its own arguments ((args: { readonly name: string }) => …): the client calls it only with arguments whose names its descriptor lists, so give the descriptor required and type to match, and check values a tool could send wrongly.

requests.partial-lock ​

ts
readonly "partial-lock": (args) => OperationRequest = partialLockRequest;

Builds the request for the <partial-lock> RPC from its arguments.

Build a <partial-lock> request from plain arguments ({ select }). Sends nothing.

Parameters ​
args ​

Readonly<Record<string, unknown>>

Returns ​

OperationRequest

requests.partial-unlock ​

ts
readonly "partial-unlock": (args) => OperationRequest = partialUnlockRequest;

Builds the request for the <partial-unlock> RPC from its arguments.

Build a <partial-unlock> request from plain arguments ({ lockId }). Sends nothing.

Parameters ​
args ​

Readonly<Record<string, unknown>>

Returns ​

OperationRequest

requires ​

ts
readonly requires: readonly ["urn:ietf:params:netconf:capability:partial-lock:1.0"];

Capabilities the server must advertise, checked after the hello under capabilityCheck.

Released under the MIT Licence.