Variable WatermarksComponentConst

WatermarksComponent: {
    attributes: {
        currentHeapHighWatermark: Attribute<number | bigint, any>;
    };
    commands: {
        resetWatermarks: Command<void, void, any>;
    };
}

A SoftwareDiagnosticsCluster supports these elements if it supports feature Watermarks.

Type declaration

  • Readonlyattributes: {
        currentHeapHighWatermark: Attribute<number | bigint, any>;
    }
    • ReadonlycurrentHeapHighWatermark: Attribute<number | bigint, any>

      The CurrentHeapHighWatermark attribute shall indicate the maximum amount of heap memory, in bytes, that has been used by the Node. This value shall only be reset upon a Node reboot or upon receiving of the ResetWatermarks command.

      See

      MatterSpecification.v13.Core § 11.13.6.4

  • Readonlycommands: {
        resetWatermarks: Command<void, void, any>;
    }
    • ReadonlyresetWatermarks: Command<void, void, any>

      Receipt of this command shall reset the following values which track high and lower watermarks:

      • The StackFreeMinimum field of the ThreadMetrics attribute

      • The CurrentHeapHighWatermark attribute This command has no payload.

      Effect on Receipt

      On receipt of this command, the Node shall make the following modifications to attributes it supports:

      If implemented, the server shall set the value of the CurrentHeapHighWatermark attribute to the value of the CurrentHeapUsed attribute.

      If implemented, the server shall set the value of the StackFreeMinimum field for every thread to the value of the corresponding thread’s StackFreeCurrent field.

      See

      MatterSpecification.v13.Core § 11.13.7.1

Settings

Member Visibility