event · events.tuning
Tuning changed
Reports one runtime tuning value only after the tuning owner commits it.
events.tuning.changed(tuning_id, previous_value, current_value, revision, origin_id, request_sequence)- Stable ID
events.tuning.changed- Owner
- app.runtime-tuning
- Authority
- read_only
- Timing
- post_commit
- Availability
- active-session
- Side effects
- none
- Determinism
- ordered after the tuning commit and before command completion
- Introduced
- 1.1.0
Usage
Listen for committed tuning changes and refresh any displayed values from the detached query when needed.
Parameters
- tuning_id: changed tuning identity.
- previous_value: value before commit.
- current_value: committed value.
- revision: new owner revision.
- origin_id: engine-created caller identity.
- request_sequence: originating command sequence.
Returns
An immutable post-commit event payload.
Cost
One bounded retained event and one callback delivery per subscribed package.
Fields
| ID | Type | Units | Required | Description |
|---|---|---|---|---|
current_value | unsigned-integer | none | yes | Committed tuning value. |
origin_id | string | none | yes | Engine-created caller origin ID. |
previous_value | unsigned-integer | none | yes | Value before the committed change. |
request_sequence | unsigned-integer | none | yes | Command request that produced the change. |
revision | revision | none | yes | Runtime tuning revision after the commit. |
tuning_id | string | none | yes | Registered runtime tuning identity. |
Errors
- None
Examples
local subscription = events.listen("events.tuning.changed", function(event) print(event.payload.current_value) end)API history
- 1.1.0: Post-commit runtime tuning event added.