docs(code): honest rationales — Akka restart semantics, per-key shards, EF literal inlining; retire or annotate orphaned members

2026-08-16 05:33:33 -04:00
parent dbc9223206
commit b9e9df4081
11 changed files with 133 additions and 58 deletions
@@ -8,16 +8,20 @@ namespace ZB.MOM.WW.OtOpcUa.Runtime.Historian;
 /// <summary>
 ///     Continuous-historization engine for non-Galaxy (driver) tags. Registers interest with the
 ///     per-node <see cref="DependencyMuxActor"/> for the configured historized tag refs, then taps the
-///     <see cref="VirtualTagActor.DependencyValueChanged"/> values the mux fans for those refs:
+///     values the mux fans for those refs — in production a
+///     <see cref="VirtualTagActor.DependencyValueBatch"/> per driver burst, with the per-value
+///     <see cref="VirtualTagActor.DependencyValueChanged"/> receive retained for direct senders and tests:
 ///     value → coerce to numeric → append to the durable <see cref="IHistorizationOutbox"/> (the crash
 ///     boundary) → a self-paced drain writes the outbox through <see cref="IHistorianValueWriter"/>'s
 ///     live-value path and acks (truncates) on success.
 /// </summary>
 /// <remarks>
 ///     <para>
-///         <b>Message path (grounded against the real actors).</b> The mux fans
-///         <see cref="VirtualTagActor.DependencyValueChanged"/> — which carries only
-///         <c>(TagId, Value, TimestampUtc)</c> and <em>no quality</em> — to every registered subscriber.
+///         <b>Message path (grounded against the real actors).</b> The mux fans each value — carrying
+///         only <c>(TagId, Value, TimestampUtc)</c> and <em>no quality</em> — to every registered
+///         subscriber, batched as a <see cref="VirtualTagActor.DependencyValueBatch"/> on the production
+///         path and as a bare <see cref="VirtualTagActor.DependencyValueChanged"/> from a direct sender
+///         or a test.
 ///         The recorder reuses that existing fan-out (no change to <c>DriverHostActor</c>), so values
 ///         arrive Good-quality by the same convention the scripted-alarm host uses (the mux only
 ///         forwards driver-published values); historized samples are recorded with