Class PowerTopologyServer

Hierarchy

  • ClusterBehavior<this> & Omit<PowerTopologyServerLogic,
        | "events"
        | "cluster"
        | "state"
        | "initialize"
        | typeof asyncDispose> & Omit<{} & {}, never> & {
        cluster: Of<{
            extensions: readonly [{
                component: {
                    attributes: {
                        availableEndpoints: FixedAttribute<(...)[], any>;
                    };
                };
                flags: {
                    setTopology: true;
                };
            }, {
                component: {
                    attributes: {
                        activeEndpoints: Attribute<(...)[], any>;
                    };
                };
                flags: {
                    dynamicPowerFlow: true;
                };
            }, {
                component: false;
                flags: {
                    dynamicPowerFlow: true;
                    setTopology: false;
                };
            }, {
                component: false;
                flags: {
                    nodeTopology: true;
                    treeTopology: true;
                };
            }, {
                component: false;
                flags: {
                    nodeTopology: true;
                    setTopology: true;
                };
            }, {
                component: false;
                flags: {
                    setTopology: true;
                    treeTopology: true;
                };
            }, {
                component: false;
                flags: {
                    nodeTopology: false;
                    setTopology: false;
                    treeTopology: false;
                };
            }];
            features: {
                dynamicPowerFlow: BitFlag;
                nodeTopology: BitFlag;
                setTopology: BitFlag;
                treeTopology: BitFlag;
            };
            id: 156;
            name: "PowerTopology";
            revision: 1;
        }>;
        events: ClusterEvents<Of<{
            extensions: readonly [{
                component: {
                    attributes: {
                        availableEndpoints: FixedAttribute<(...), (...)>;
                    };
                };
                flags: {
                    setTopology: true;
                };
            }, {
                component: {
                    attributes: {
                        activeEndpoints: Attribute<(...), (...)>;
                    };
                };
                flags: {
                    dynamicPowerFlow: true;
                };
            }, {
                component: false;
                flags: {
                    dynamicPowerFlow: true;
                    setTopology: false;
                };
            }, {
                component: false;
                flags: {
                    nodeTopology: true;
                    treeTopology: true;
                };
            }, {
                component: false;
                flags: {
                    nodeTopology: true;
                    setTopology: true;
                };
            }, {
                component: false;
                flags: {
                    setTopology: true;
                    treeTopology: true;
                };
            }, {
                component: false;
                flags: {
                    nodeTopology: false;
                    setTopology: false;
                    treeTopology: false;
                };
            }];
            features: {
                dynamicPowerFlow: BitFlag;
                nodeTopology: BitFlag;
                setTopology: BitFlag;
                treeTopology: BitFlag;
            };
            id: 156;
            name: "PowerTopology";
            revision: 1;
        }>, typeof PowerTopologyServerLogic>;
        features: TypeFromBitSchema<{
            dynamicPowerFlow: BitFlag;
            nodeTopology: BitFlag;
            setTopology: BitFlag;
            treeTopology: BitFlag;
        }>;
        state: ClusterState<Of<{
            extensions: readonly [{
                component: {
                    attributes: {
                        availableEndpoints: FixedAttribute<(...), (...)>;
                    };
                };
                flags: {
                    setTopology: true;
                };
            }, {
                component: {
                    attributes: {
                        activeEndpoints: Attribute<(...), (...)>;
                    };
                };
                flags: {
                    dynamicPowerFlow: true;
                };
            }, {
                component: false;
                flags: {
                    dynamicPowerFlow: true;
                    setTopology: false;
                };
            }, {
                component: false;
                flags: {
                    nodeTopology: true;
                    treeTopology: true;
                };
            }, {
                component: false;
                flags: {
                    nodeTopology: true;
                    setTopology: true;
                };
            }, {
                component: false;
                flags: {
                    setTopology: true;
                    treeTopology: true;
                };
            }, {
                component: false;
                flags: {
                    nodeTopology: false;
                    setTopology: false;
                    treeTopology: false;
                };
            }];
            features: {
                dynamicPowerFlow: BitFlag;
                nodeTopology: BitFlag;
                setTopology: BitFlag;
                treeTopology: BitFlag;
            };
            id: 156;
            name: "PowerTopology";
            revision: 1;
        }>, typeof PowerTopologyServerLogic>;
        [asyncDispose](): MaybePromise<void>;
    }
    • PowerTopologyServer

Constructors

constructor

Properties

[reference] agent cluster context endpoint env events features session state cluster defaults dependencies? early Events ExtensionInterface id Interface Internal name schema? State supervisor supports

Methods

[asyncDispose] asAdmin assertAttributeEnabled callback initialize reactTo requireAttributeEnabled toString alter enable for set with

Constructors

constructor

Properties

[reference]

[reference]: Datasource<StateType>

agent

agent: Agent

cluster

cluster: never

The implemented cluster.

context

context: ActionContext

endpoint

endpoint: Endpoint<Empty>

env

env: Environment

Readonlyevents

events: EventEmitter & Omit<ClusterEvents<WithFeatures<Of<{
    extensions: readonly [{
        component: {
            attributes: {
                availableEndpoints: FixedAttribute<(...), (...)>;
            };
        };
        flags: {
            setTopology: true;
        };
    }, {
        component: {
            attributes: {
                activeEndpoints: Attribute<(...), (...)>;
            };
        };
        flags: {
            dynamicPowerFlow: true;
        };
    }, {
        component: false;
        flags: {
            dynamicPowerFlow: true;
            setTopology: false;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            setTopology: true;
        };
    }, {
        component: false;
        flags: {
            setTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: false;
            setTopology: false;
            treeTopology: false;
        };
    }];
    features: {
        dynamicPowerFlow: BitFlag;
        nodeTopology: BitFlag;
        setTopology: BitFlag;
        treeTopology: BitFlag;
    };
    id: 156;
    name: "PowerTopology";
    revision: 1;
}>, readonly [SetTopology, DynamicPowerFlow]>, Type<Of<{
    extensions: readonly [{
        component: {
            attributes: {
                availableEndpoints: FixedAttribute<(...), (...)>;
            };
        };
        flags: {
            setTopology: true;
        };
    }, {
        component: {
            attributes: {
                activeEndpoints: Attribute<(...), (...)>;
            };
        };
        flags: {
            dynamicPowerFlow: true;
        };
    }, {
        component: false;
        flags: {
            dynamicPowerFlow: true;
            setTopology: false;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            setTopology: true;
        };
    }, {
        component: false;
        flags: {
            setTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: false;
            setTopology: false;
            treeTopology: false;
        };
    }];
    features: {
        dynamicPowerFlow: BitFlag;
        nodeTopology: BitFlag;
        setTopology: BitFlag;
        treeTopology: BitFlag;
    };
    id: 156;
    name: "PowerTopology";
    revision: 1;
}>, typeof ClusterBehavior, {
    components: never[];
}>>,
    | "availableEndpoints$Changing"
    | "activeEndpoints$Changing"
    | "availableEndpoints$Changed"
    | "activeEndpoints$Changed"> & {} & {} & {} & {} & {} & {}

Access the behavior's events.

features

features: TypeFromBitSchema<{
    dynamicPowerFlow: BitFlag;
    nodeTopology: BitFlag;
    setTopology: BitFlag;
    treeTopology: BitFlag;
}>

Supported features as a flag object.

Type declaration

  • ReadonlydynamicPowerFlow: BitFlag

    DynamicPowerFlow

    The specified set of endpoints may change

  • ReadonlynodeTopology: BitFlag

    NodeTopology

    This endpoint provides or consumes power to/from the entire node

  • ReadonlysetTopology: BitFlag

    SetTopology

    This endpoint provides or consumes power to/from a specified set of endpoints

  • ReadonlytreeTopology: BitFlag

    TreeTopology

    This endpoint provides or consumes power to/from itself and its child endpoints

session

session: SecureSession

Readonlystate

state: Omit<ClusterState.Type<WithFeatures<Of<{
    extensions: readonly [{
        component: {
            attributes: {
                availableEndpoints: FixedAttribute<(...), (...)>;
            };
        };
        flags: {
            setTopology: true;
        };
    }, {
        component: {
            attributes: {
                activeEndpoints: Attribute<(...), (...)>;
            };
        };
        flags: {
            dynamicPowerFlow: true;
        };
    }, {
        component: false;
        flags: {
            dynamicPowerFlow: true;
            setTopology: false;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            setTopology: true;
        };
    }, {
        component: false;
        flags: {
            setTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: false;
            setTopology: false;
            treeTopology: false;
        };
    }];
    features: {
        dynamicPowerFlow: BitFlag;
        nodeTopology: BitFlag;
        setTopology: BitFlag;
        treeTopology: BitFlag;
    };
    id: 156;
    name: "PowerTopology";
    revision: 1;
}>, readonly [SetTopology, DynamicPowerFlow]>, Type<Of<{
    extensions: readonly [{
        component: {
            attributes: {
                availableEndpoints: FixedAttribute<(...), (...)>;
            };
        };
        flags: {
            setTopology: true;
        };
    }, {
        component: {
            attributes: {
                activeEndpoints: Attribute<(...), (...)>;
            };
        };
        flags: {
            dynamicPowerFlow: true;
        };
    }, {
        component: false;
        flags: {
            dynamicPowerFlow: true;
            setTopology: false;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            setTopology: true;
        };
    }, {
        component: false;
        flags: {
            setTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: false;
            setTopology: false;
            treeTopology: false;
        };
    }];
    features: {
        dynamicPowerFlow: BitFlag;
        nodeTopology: BitFlag;
        setTopology: BitFlag;
        treeTopology: BitFlag;
    };
    id: 156;
    name: "PowerTopology";
    revision: 1;
}>, typeof ClusterBehavior, {
    components: never[];
}>>, "availableEndpoints" | "activeEndpoints"> & {} & {} & {} & {}

Access the behavior's state.

Static Readonlycluster

cluster: Of<{
    extensions: readonly [{
        component: {
            attributes: {
                availableEndpoints: FixedAttribute<EndpointNumber[], any>;
            };
        };
        flags: {
            setTopology: true;
        };
    }, {
        component: {
            attributes: {
                activeEndpoints: Attribute<EndpointNumber[], any>;
            };
        };
        flags: {
            dynamicPowerFlow: true;
        };
    }, {
        component: false;
        flags: {
            dynamicPowerFlow: true;
            setTopology: false;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            setTopology: true;
        };
    }, {
        component: false;
        flags: {
            setTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: false;
            setTopology: false;
            treeTopology: false;
        };
    }];
    features: {
        dynamicPowerFlow: BitFlag;
        nodeTopology: BitFlag;
        setTopology: BitFlag;
        treeTopology: BitFlag;
    };
    id: 156;
    name: "PowerTopology";
    revision: 1;
}>

Base cluster state include all attribute values but may be extended by subclasses.

Type declaration

  • Readonlyextensions: readonly [{
        component: {
            attributes: {
                availableEndpoints: FixedAttribute<EndpointNumber[], any>;
            };
        };
        flags: {
            setTopology: true;
        };
    }, {
        component: {
            attributes: {
                activeEndpoints: Attribute<EndpointNumber[], any>;
            };
        };
        flags: {
            dynamicPowerFlow: true;
        };
    }, {
        component: false;
        flags: {
            dynamicPowerFlow: true;
            setTopology: false;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            setTopology: true;
        };
    }, {
        component: false;
        flags: {
            setTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: false;
            setTopology: false;
            treeTopology: false;
        };
    }]

    This metadata controls which PowerTopologyCluster elements matter.js activates for specific feature combinations.

  • Readonlyfeatures: {
        dynamicPowerFlow: BitFlag;
        nodeTopology: BitFlag;
        setTopology: BitFlag;
        treeTopology: BitFlag;
    }
    • ReadonlydynamicPowerFlow: BitFlag

      DynamicPowerFlow

      The specified set of endpoints may change

    • ReadonlynodeTopology: BitFlag

      NodeTopology

      This endpoint provides or consumes power to/from the entire node

    • ReadonlysetTopology: BitFlag

      SetTopology

      This endpoint provides or consumes power to/from a specified set of endpoints

    • ReadonlytreeTopology: BitFlag

      TreeTopology

      This endpoint provides or consumes power to/from itself and its child endpoints

  • Readonlyid: 156
  • Readonlyname: "PowerTopology"
  • Readonlyrevision: 1

Static Readonlydefaults

defaults: ClusterState.Type<Of<{
    extensions: readonly [{
        component: {
            attributes: {
                availableEndpoints: FixedAttribute<EndpointNumber[], any>;
            };
        };
        flags: {
            setTopology: true;
        };
    }, {
        component: {
            attributes: {
                activeEndpoints: Attribute<EndpointNumber[], any>;
            };
        };
        flags: {
            dynamicPowerFlow: true;
        };
    }, {
        component: false;
        flags: {
            dynamicPowerFlow: true;
            setTopology: false;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            setTopology: true;
        };
    }, {
        component: false;
        flags: {
            setTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: false;
            setTopology: false;
            treeTopology: false;
        };
    }];
    features: {
        dynamicPowerFlow: BitFlag;
        nodeTopology: BitFlag;
        setTopology: BitFlag;
        treeTopology: BitFlag;
    };
    id: 156;
    name: "PowerTopology";
    revision: 1;
}>, typeof PowerTopologyServerLogic>

Static Optional Readonlydependencies

dependencies?: Iterable<Type, any, any>

Static Readonlyearly

early: boolean

Static ReadonlyEvents

Events: ClusterEvents.Type<Of<{
    extensions: readonly [{
        component: {
            attributes: {
                availableEndpoints: FixedAttribute<EndpointNumber[], any>;
            };
        };
        flags: {
            setTopology: true;
        };
    }, {
        component: {
            attributes: {
                activeEndpoints: Attribute<EndpointNumber[], any>;
            };
        };
        flags: {
            dynamicPowerFlow: true;
        };
    }, {
        component: false;
        flags: {
            dynamicPowerFlow: true;
            setTopology: false;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            setTopology: true;
        };
    }, {
        component: false;
        flags: {
            setTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: false;
            setTopology: false;
            treeTopology: false;
        };
    }];
    features: {
        dynamicPowerFlow: BitFlag;
        nodeTopology: BitFlag;
        setTopology: BitFlag;
        treeTopology: BitFlag;
    };
    id: 156;
    name: "PowerTopology";
    revision: 1;
}>, typeof PowerTopologyServerLogic>

Static ReadonlyExtensionInterface

ExtensionInterface: {}

Static Readonlyid

id

The behavior ID for ClusterBehaviors is the name of the cluster.

Static ReadonlyInterface

Interface: {
    components: never[];
}

Static ReadonlyInternal

Internal: (new () => {})

Static Readonlyname

name: string

Static Optional Readonlyschema

schema?: Schema

Static ReadonlyState

State: (new () => ClusterState.Type<Of<{
    extensions: readonly [{
        component: {
            attributes: {
                availableEndpoints: FixedAttribute<EndpointNumber[], any>;
            };
        };
        flags: {
            setTopology: true;
        };
    }, {
        component: {
            attributes: {
                activeEndpoints: Attribute<EndpointNumber[], any>;
            };
        };
        flags: {
            dynamicPowerFlow: true;
        };
    }, {
        component: false;
        flags: {
            dynamicPowerFlow: true;
            setTopology: false;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: true;
            setTopology: true;
        };
    }, {
        component: false;
        flags: {
            setTopology: true;
            treeTopology: true;
        };
    }, {
        component: false;
        flags: {
            nodeTopology: false;
            setTopology: false;
            treeTopology: false;
        };
    }];
    features: {
        dynamicPowerFlow: BitFlag;
        nodeTopology: BitFlag;
        setTopology: BitFlag;
        treeTopology: BitFlag;
    };
    id: 156;
    name: "PowerTopology";
    revision: 1;
}>, typeof PowerTopologyServerLogic>)

Static Readonlysupervisor

supervisor: RootSupervisor

Staticsupports

supports: ((other: Type) => boolean)

Type declaration

    • (other): boolean

    • Does this behavior support functionality of a specific implementation?

      Parameters

      Returns boolean

Methods

[asyncDispose]

asAdmin

  • asAdmin(fn): void

  • Parameters

    • fn: (() => void)

      the elevated logic

        • (): void

        • Returns void

    Returns void

assertAttributeEnabled

Protectedcallback

  • callback<A, R>(reactor, options?): ((...args: A) => undefined | R)

  • Create a generic callback function that has the same properties as a Reactor.

    Like a reactor, the callback's "this" will be bound to an active Behavior instance. Because of this: The reactor MUST be a real JS function - arrow functions will not work!

    Type Parameters

    • A extends any[]
    • R

    Parameters

    Returns ((...args: A) => undefined | R)

      • (...args): undefined | R

      • Parameters

        • Rest...args: A

        Returns undefined | R

initialize

  • initialize(_options?): MaybePromise

  • Behaviors are ephemeral and should not perform initialization in their constructor. They can override this method instead.

    This method may be synchronous or asyncronous. If asynchronous, the behavior will not be available for external use until initialization completes.

    Parameters

    • Optional_options: {}

      Returns MaybePromise

    ProtectedreactTo

    • reactTo<O>(observable, reactor, options?): void

    • Install a Reactor.

      Important: The reactor MUST be a real JS function - arrow functions will not work!

      Type Parameters

      Parameters

      Returns void

    requireAttributeEnabled

    toString

    Staticalter

    Staticenable

    Staticfor

    Staticset

    Staticwith

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods