Joseph Doherty
9cad9ed0fc
v2-ci / build (push) Failing after 41s
v2-ci / unit-tests (tests/Core/ZB.MOM.WW.OtOpcUa.Cluster.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.ControlPlane.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.OpcUaServer.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.Runtime.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.Security.Tests) (push) Has been skipped
v2-ci / integration (tests/Server/ZB.MOM.WW.OtOpcUa.Host.IntegrationTests) (push) Has been skipped
v2-ci / integration (tests/Server/ZB.MOM.WW.OtOpcUa.OpcUaServer.IntegrationTests) (push) Has been skipped
Adds <summary>/<param>/<returns>/<inheritdoc> where missing and removes project bookkeeping IDs (task/tracking refs) from shipped code comments, so the docs read cleanly and CommentChecker is quiet except for known false positives (PLC/protocol terms, event/IEqualityComparer inheritdoc). Doc/comment-only; no logic changed; solution builds clean.
38 lines
2.1 KiB
C#
38 lines
2.1 KiB
C#
using ZB.MOM.WW.OtOpcUa.Commons.Messages.Drivers;
|
|
|
|
namespace ZB.MOM.WW.OtOpcUa.AdminUI.Hubs;
|
|
|
|
/// <summary>
|
|
/// Singleton last-snapshot-per-instance cache. Populated by
|
|
/// <c>DriverStatusSignalRBridge</c> as it forwards DPS messages; read by
|
|
/// <see cref="DriverStatusHub.JoinDriver"/> so newly-joined clients see current state
|
|
/// without waiting for the next change event, and subscribed to directly by the Blazor
|
|
/// Server <c>DriverStatusPanel</c> via <see cref="SnapshotChanged"/>.
|
|
/// </summary>
|
|
public interface IDriverStatusSnapshotStore
|
|
{
|
|
/// <summary>Stores or replaces the last-known health snapshot for a driver instance.</summary>
|
|
/// <param name="snapshot">The driver health snapshot to store.</param>
|
|
void Upsert(DriverHealthChanged snapshot);
|
|
|
|
/// <summary>Attempts to retrieve the last-known health snapshot for a driver instance.</summary>
|
|
/// <param name="driverInstanceId">The driver instance's stable logical ID.</param>
|
|
/// <param name="snapshot">The stored snapshot, if found.</param>
|
|
/// <returns><see langword="true"/> if a snapshot was found; otherwise <see langword="false"/>.</returns>
|
|
bool TryGet(string driverInstanceId, out DriverHealthChanged snapshot);
|
|
|
|
/// <summary>Returns a point-in-time snapshot of every driver instance's last-known health.</summary>
|
|
/// <returns>A read-only collection of the last-known health snapshot for each driver instance.</returns>
|
|
IReadOnlyCollection<DriverHealthChanged> GetAll();
|
|
|
|
/// <summary>
|
|
/// Raised after every <see cref="Upsert"/> with the just-stored snapshot. Lets in-process
|
|
/// consumers (the Blazor Server <c>DriverStatusPanel</c>) receive live updates by reading
|
|
/// this singleton directly instead of opening a self-targeted SignalR connection — which a
|
|
/// server-side Blazor component cannot reach when the public URL (e.g. a reverse-proxy port)
|
|
/// differs from the local Kestrel bind. Handlers run on the caller's thread (the bridge
|
|
/// actor), so subscribers must marshal to their own sync context.
|
|
/// </summary>
|
|
event Action<DriverHealthChanged>? SnapshotChanged;
|
|
}
|