Interface ParallelExecutionPlan

Represents a parallel execution plan that can be executed concurrently. This interface extends both ExecutionPlan and PlanStep to provide functionality for parallel processing of template operations.

interface ParallelExecutionPlan {
    circular?: boolean;
    completed: boolean;
    data?: any;
    didUpdate: boolean;
    forkId: string;
    forkStack: Fork[];
    jsonPtr: string;
    lastCompletedStep?: PlanStep;
    op?: Op;
    output: object;
    parallel: ParallelExecutionPlan[];
    restore?: boolean;
    type?: "serial|parallel";
}

Hierarchy (view full)

Implemented by

Properties

circular? completed data? didUpdate forkId forkStack jsonPtr lastCompletedStep? op? output parallel restore? type?

Properties

Optional circular

circular?: boolean

completed

completed: boolean

Indicates whether the entire execution subtree rooted at this node has finished processing. When true, all child nodes in the parallel array have also completed their execution.

Optional data

data?: any

The data associated with the plan. May be undefined for initialization plans.

didUpdate

didUpdate: boolean

forkId

forkId: string

The identifier for the fork associated with this execution plan. Will be "ROOT" when the plan is not executing a fork

forkStack

forkStack: Fork[]

The stack of forks involved in this execution plan. Forks will push and pop on top of the ROOT fork corresponding to entering a $forked() and exiting a forked plan on $joined()

jsonPtr

jsonPtr: string

A JSON Pointer string that identifies the location in the template being processed. This pointer is used to track and reference specific nodes in the template structure.

Optional lastCompletedStep

lastCompletedStep?: PlanStep

The last completed step in the execution plan, if any.

Optional op

op?: Op

The operation to perform. If present and op is "set", the data is applied to the first JSON pointer.

output

output: object

The output object associated with the execution plan.

parallel

parallel: ParallelExecutionPlan[]

An array of child ParallelExecutionPlan nodes that can be executed in parallel. This forms the root node of a directed acyclic graph (DAG) of ParallelPlanStep's.

Optional restore

restore?: boolean

Optional flag used to mark plans that are being used during a restore operation. When true, indicates that this plan is part of restoring a previous template state.

Optional type

type?: "serial|parallel"

Plans can be serialized and stored therefor we need to know what type of ExecutionPlan this is. Defaults to "serial" if not present. Allowed values "serial|parallel"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc