Joseph Doherty
dd2aec3b8b
Adds AVEVA.Historian.Client.StoreForward — a client-side store-and-forward layer over the historian write surface (AddHistoricalValuesAsync / SendEventAsync). Producers enqueue writes; the writer persists them and replays on reconnect so a transient disconnect never drops data. This is the roadmap's recommended pragmatic outbox, NOT a bit-faithful reimplementation of AVEVA's native SF cache (that stays deferred) — pure managed, no RE. - HistorianOutboxEntry / HistorianOutboxEntryKind: buffered-write envelope - IHistorianOutboxStore + InMemoryHistorianOutboxStore (tests) + FileHistorianOutboxStore (crash-durable: atomic temp+move JSON per entry, FIFO by filename sequence that resumes past on-disk max, corrupt-file quarantine). OutboxJson normalizes event object? properties off JsonElement. - IHistorianWriteSink + HistorianClientWriteSink (HistorianClient-backed) - HistorianStoreForwardWriter: enqueue, single-flight FIFO FlushAsync with head-of-line blocking, optional MaxDeliveryAttempts dead-lettering, DropOldest/Reject overflow policy, background drain loop (retry on reconnect), GetStatusAsync snapshot mirroring server SF Pending/Storing/ErrorOccurred. 12 unit tests (no server): durability-across-restart, reconnect-drain, FIFO order/head-of-line, dead-letter, overflow policies, background auto-drain. Full suite 293 green. Roadmap R4.1 marked shipped. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01B6mcaT2PjRFKcogzp9UkfC
24 lines
1.1 KiB
C#
24 lines
1.1 KiB
C#
using AVEVA.Historian.Client.Models;
|
|
|
|
namespace AVEVA.Historian.Client.StoreForward;
|
|
|
|
/// <summary>
|
|
/// The actual delivery target the forwarder replays buffered writes through. Abstracted from
|
|
/// <see cref="HistorianClient"/> so the store-forward logic can be unit-tested without a server, and
|
|
/// so callers can plug a custom delivery path.
|
|
/// <para>
|
|
/// Contract: return <c>true</c> when the historian accepted the write; return <c>false</c> or throw
|
|
/// when it did not. The forwarder treats both a <c>false</c> return and a thrown exception as "not
|
|
/// delivered" and keeps the entry buffered for retry — so a transient disconnect (which throws) and
|
|
/// a soft rejection (which returns false) are both safe.
|
|
/// </para>
|
|
/// </summary>
|
|
public interface IHistorianWriteSink
|
|
{
|
|
/// <summary>Delivers a batch of historical values for <paramref name="tag"/>.</summary>
|
|
Task<bool> SendHistoricalValuesAsync(string tag, IReadOnlyList<HistorianHistoricalValue> values, CancellationToken cancellationToken);
|
|
|
|
/// <summary>Delivers a single event.</summary>
|
|
Task<bool> SendEventAsync(HistorianEvent historianEvent, CancellationToken cancellationToken);
|
|
}
|