using AVEVA.Historian.Client.Models; using AVEVA.Historian.Client.Protocol; using AVEVA.Historian.Client.Transport; using AVEVA.Historian.Client.Wcf; namespace AVEVA.Historian.Client; public sealed class HistorianClient : IAsyncDisposable { private readonly HistorianClientOptions _options; private readonly IHistorianTransportFactory _transportFactory; private readonly Historian2020ProtocolDialect _protocol; public HistorianClient(HistorianClientOptions options) : this(options, TcpHistorianTransport.Factory) { } internal HistorianClient(HistorianClientOptions options, IHistorianTransportFactory transportFactory) { _options = options ?? throw new ArgumentNullException(nameof(options)); _transportFactory = transportFactory ?? throw new ArgumentNullException(nameof(transportFactory)); _protocol = new Historian2020ProtocolDialect(_options); } public async Task ProbeAsync(CancellationToken cancellationToken = default) { return await HistorianWcfProbe.ProbeAsync(_options, cancellationToken).ConfigureAwait(false); } public IAsyncEnumerable ReadRawAsync( string tag, DateTime startUtc, DateTime endUtc, int maxValues, CancellationToken cancellationToken = default) { ArgumentException.ThrowIfNullOrWhiteSpace(tag); ArgumentOutOfRangeException.ThrowIfNegativeOrZero(maxValues); ValidateTimeRange(startUtc, endUtc); return _protocol.ReadRawAsync(tag, startUtc, endUtc, maxValues, cancellationToken); } public IAsyncEnumerable ReadAggregateAsync( string tag, DateTime startUtc, DateTime endUtc, RetrievalMode mode, TimeSpan interval, CancellationToken cancellationToken = default) { ArgumentException.ThrowIfNullOrWhiteSpace(tag); ArgumentOutOfRangeException.ThrowIfLessThanOrEqual(interval, TimeSpan.Zero); ValidateTimeRange(startUtc, endUtc); return _protocol.ReadAggregateAsync(tag, startUtc, endUtc, mode, interval, cancellationToken); } public Task> ReadAtTimeAsync( string tag, IReadOnlyList timestampsUtc, CancellationToken cancellationToken = default) { ArgumentException.ThrowIfNullOrWhiteSpace(tag); ArgumentNullException.ThrowIfNull(timestampsUtc); if (timestampsUtc.Count == 0) { return Task.FromResult>(Array.Empty()); } return _protocol.ReadAtTimeAsync(tag, timestampsUtc, cancellationToken); } public IAsyncEnumerable ReadBlocksAsync( string tag, DateTime startUtc, DateTime endUtc, CancellationToken cancellationToken = default) { ArgumentException.ThrowIfNullOrWhiteSpace(tag); ValidateTimeRange(startUtc, endUtc); return _protocol.ReadBlocksAsync(tag, startUtc, endUtc, cancellationToken); } public IAsyncEnumerable ReadEventsAsync( DateTime startUtc, DateTime endUtc, CancellationToken cancellationToken = default) { ValidateTimeRange(startUtc, endUtc); return _protocol.ReadEventsAsync(startUtc, endUtc, filter: null, cancellationToken); } /// /// Reads events in the time window, server-filtered by a single predicate /// () — e.g. Type Equal "User.Write" or /// Area Contains "Tank". The historian applies the filter and returns only matching /// events. Filtering is a real server-side operation (live-verified: a non-matching predicate /// returns zero events). Single string-valued predicates only; see . /// public IAsyncEnumerable ReadEventsAsync( DateTime startUtc, DateTime endUtc, HistorianEventFilter filter, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(filter); ValidateTimeRange(startUtc, endUtc); return _protocol.ReadEventsAsync(startUtc, endUtc, filter, cancellationToken); } /// /// Sends a single to the Historian's built-in CM_EVENT tag /// over the WCF event pipeline (Open2 event mode → CM_EVENT registration → AddS2). The /// event is appended to the historian's event history and is readable back via /// / the v_AlarmEventHistory2 view. Only original /// events ( = 0) with string-valued properties /// are supported; other property value types and revision/update/delete events throw /// until their wire encoding is captured. /// public Task SendEventAsync(HistorianEvent historianEvent, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(historianEvent); return new HistorianWcfEventOrchestrator(_options).SendEventAsync(historianEvent, cancellationToken); } public IAsyncEnumerable BrowseTagNamesAsync(string filter = "*", CancellationToken cancellationToken = default) { ArgumentException.ThrowIfNullOrWhiteSpace(filter); return HistorianWcfTagClient.BrowseTagNamesAsync(_options, filter, cancellationToken); } public Task GetTagMetadataAsync(string tag, CancellationToken cancellationToken = default) { ArgumentException.ThrowIfNullOrWhiteSpace(tag); return HistorianWcfTagClient.GetTagMetadataAsync(_options, tag, cancellationToken); } public Task GetConnectionStatusAsync(CancellationToken cancellationToken = default) { return _protocol.GetConnectionStatusAsync(cancellationToken); } public Task GetStoreForwardStatusAsync(CancellationToken cancellationToken = default) { return _protocol.GetStoreForwardStatusAsync(cancellationToken); } public Task GetSystemParameterAsync(string name, CancellationToken cancellationToken = default) { ArgumentException.ThrowIfNullOrWhiteSpace(name); return _protocol.GetSystemParameterAsync(name, cancellationToken); } /// /// Reads a named Historian runtime parameter (the live server state surface, /// distinct from the configuration ). Returns the /// string value, or null when the server reports no value. Single string-valued parameters /// only (the evidence-backed surface); see HistorianRuntimeParameterProtocol. /// public Task GetRuntimeParameterAsync(string name, CancellationToken cancellationToken = default) { ArgumentException.ThrowIfNullOrWhiteSpace(name); return _protocol.GetRuntimeParameterAsync(name, cancellationToken); } /// /// Reads the extended (user-defined) properties attached to a tag via the 2020 WCF /// GetTepByNm op. Returns the property name/value pairs (empty when the tag has none). /// String-valued properties only (the evidence-backed surface); other value variants throw /// . See /// HistorianTagExtendedPropertyProtocol. /// public Task> GetTagExtendedPropertiesAsync(string tag, CancellationToken cancellationToken = default) { ArgumentException.ThrowIfNullOrWhiteSpace(tag); return _protocol.GetTagExtendedPropertiesAsync(tag, cancellationToken); } /// /// Creates or updates the named tag in the Historian Runtime database via /// EnsureTags2. Currently only is /// live-verified. Note: writing data values to the new tag (via a separate /// AddStreamedValue/AddS2 path) is NOT supported by the SDK — see /// docs/plans/write-commands-reverse-engineering.md for the architectural /// finding. /// public Task EnsureTagAsync(HistorianTagDefinition definition, CancellationToken cancellationToken = default) { ArgumentNullException.ThrowIfNull(definition); return new HistorianWcfTagWriteOrchestrator(_options).EnsureTagAsync(definition, cancellationToken); } /// /// Deletes the named tag via DeleteTags. **Known issue (2026-05-04):** /// the SDK's DelT call returns true but the server-side cascading deletion does /// not always complete (the row remains in Runtime.dbo.Tag). The /// captured native flow's DelT removes the tag cleanly, so additional priming /// or a side call between WCF DelT and server cascade is missing. Use the SMC /// fallback to clean up sandbox tags until this is resolved. /// public Task DeleteTagAsync(string tagName, CancellationToken cancellationToken = default) { ArgumentException.ThrowIfNullOrWhiteSpace(tagName); return new HistorianWcfTagWriteOrchestrator(_options).DeleteTagAsync(tagName, cancellationToken); } public ValueTask DisposeAsync() { return ValueTask.CompletedTask; } private static void ValidateTimeRange(DateTime startUtc, DateTime endUtc) { if (startUtc.ToUniversalTime() > endUtc.ToUniversalTime()) { throw new ArgumentException("Start time must be less than or equal to end time."); } } }