Document client stack XML docs progress

tests/ZB.MOM.WW.LmxOpcUa.Client.Shared.Tests/Fakes/FakeSessionAdapter.cs

@@ -3,12 +3,22 @@ using ZB.MOM.WW.LmxOpcUa.Client.Shared.Adapters;
 
 namespace ZB.MOM.WW.LmxOpcUa.Client.Shared.Tests.Fakes;
 
+/// <summary>
+/// Test double for <see cref="ISessionAdapter" /> used to simulate reads, writes, browsing, history, and failover callbacks.
+/// </summary>
 internal sealed class FakeSessionAdapter : ISessionAdapter
 {
     private readonly List<FakeSubscriptionAdapter> _createdSubscriptions = [];
     private Action<bool>? _keepAliveCallback;
 
+    /// <summary>
+    /// Gets a value indicating whether the fake session has been closed through the client disconnect path.
+    /// </summary>
     public bool Closed { get; private set; }
+
+    /// <summary>
+    /// Gets a value indicating whether the fake session has been disposed.
+    /// </summary>
     public bool Disposed { get; private set; }
     public int ReadCount { get; private set; }
     public int WriteCount { get; private set; }
@@ -38,27 +48,47 @@ internal sealed class FakeSessionAdapter : ISessionAdapter
     public bool ThrowOnHistoryReadAggregate { get; set; }
 
     /// <summary>
-    ///     The next FakeSubscriptionAdapter to return from CreateSubscriptionAsync.
-    ///     If null, a new one is created automatically.
+    /// Gets or sets the next fake subscription returned when the client creates a monitored-item subscription.
+    /// If unset, the fake builds a new subscription automatically.
     /// </summary>
     public FakeSubscriptionAdapter? NextSubscription { get; set; }
 
+    /// <summary>
+    /// Gets the fake subscriptions created by this session so tests can inspect replay and cleanup behavior.
+    /// </summary>
     public IReadOnlyList<FakeSubscriptionAdapter> CreatedSubscriptions => _createdSubscriptions;
 
+    /// <inheritdoc />
     public bool Connected { get; set; } = true;
+
+    /// <inheritdoc />
     public string SessionId { get; set; } = "ns=0;i=12345";
+
+    /// <inheritdoc />
     public string SessionName { get; set; } = "FakeSession";
+
+    /// <inheritdoc />
     public string EndpointUrl { get; set; } = "opc.tcp://localhost:4840";
+
+    /// <inheritdoc />
     public string ServerName { get; set; } = "FakeServer";
+
+    /// <inheritdoc />
     public string SecurityMode { get; set; } = "None";
+
+    /// <inheritdoc />
     public string SecurityPolicyUri { get; set; } = "http://opcfoundation.org/UA/SecurityPolicy#None";
+
+    /// <inheritdoc />
     public NamespaceTable NamespaceUris { get; set; } = new();
 
+    /// <inheritdoc />
     public void RegisterKeepAliveHandler(Action<bool> callback)
     {
         _keepAliveCallback = callback;
     }
 
+    /// <inheritdoc />
     public Task<DataValue> ReadValueAsync(NodeId nodeId, CancellationToken ct)
     {
         ReadCount++;
@@ -71,6 +101,7 @@ internal sealed class FakeSessionAdapter : ISessionAdapter
         return Task.FromResult(ReadResponse ?? new DataValue(new Variant(0), StatusCodes.Good));
     }
 
+    /// <inheritdoc />
     public Task<StatusCode> WriteValueAsync(NodeId nodeId, DataValue value, CancellationToken ct)
     {
         WriteCount++;
@@ -79,6 +110,7 @@ internal sealed class FakeSessionAdapter : ISessionAdapter
         return Task.FromResult(WriteResponse);
     }
 
+    /// <inheritdoc />
     public Task<(byte[]? ContinuationPoint, ReferenceDescriptionCollection References)> BrowseAsync(
         NodeId nodeId, uint nodeClassMask, CancellationToken ct)
     {
@@ -88,6 +120,7 @@ internal sealed class FakeSessionAdapter : ISessionAdapter
         return Task.FromResult((BrowseContinuationPoint, BrowseResponse));
     }
 
+    /// <inheritdoc />
     public Task<(byte[]? ContinuationPoint, ReferenceDescriptionCollection References)> BrowseNextAsync(
         byte[] continuationPoint, CancellationToken ct)
     {
@@ -95,12 +128,14 @@ internal sealed class FakeSessionAdapter : ISessionAdapter
         return Task.FromResult((BrowseNextContinuationPoint, BrowseNextResponse));
     }
 
+    /// <inheritdoc />
     public Task<bool> HasChildrenAsync(NodeId nodeId, CancellationToken ct)
     {
         HasChildrenCount++;
         return Task.FromResult(HasChildrenResponse);
     }
 
+    /// <inheritdoc />
     public Task<IReadOnlyList<DataValue>> HistoryReadRawAsync(
         NodeId nodeId, DateTime startTime, DateTime endTime, int maxValues, CancellationToken ct)
     {
@@ -110,6 +145,7 @@ internal sealed class FakeSessionAdapter : ISessionAdapter
         return Task.FromResult<IReadOnlyList<DataValue>>(HistoryReadRawResponse);
     }
 
+    /// <inheritdoc />
     public Task<IReadOnlyList<DataValue>> HistoryReadAggregateAsync(
         NodeId nodeId, DateTime startTime, DateTime endTime, NodeId aggregateId, double intervalMs,
         CancellationToken ct)
@@ -120,6 +156,7 @@ internal sealed class FakeSessionAdapter : ISessionAdapter
         return Task.FromResult<IReadOnlyList<DataValue>>(HistoryReadAggregateResponse);
     }
 
+    /// <inheritdoc />
     public Task<ISubscriptionAdapter> CreateSubscriptionAsync(int publishingIntervalMs, CancellationToken ct)
     {
         var sub = NextSubscription ?? new FakeSubscriptionAdapter();
@@ -128,12 +165,14 @@ internal sealed class FakeSessionAdapter : ISessionAdapter
         return Task.FromResult<ISubscriptionAdapter>(sub);
     }
 
+    /// <inheritdoc />
     public Task<IList<object>?> CallMethodAsync(NodeId objectId, NodeId methodId, object[] inputArguments,
         CancellationToken ct = default)
     {
         return Task.FromResult<IList<object>?>(null);
     }
 
+    /// <inheritdoc />
     public Task CloseAsync(CancellationToken ct)
     {
         Closed = true;
@@ -141,6 +180,9 @@ internal sealed class FakeSessionAdapter : ISessionAdapter
         return Task.CompletedTask;
     }
 
+    /// <summary>
+    /// Marks the fake session as disposed so tests can verify cleanup after disconnect or failover.
+    /// </summary>
     public void Dispose()
     {
         Disposed = true;
@@ -154,4 +196,4 @@ internal sealed class FakeSessionAdapter : ISessionAdapter
     {
         _keepAliveCallback?.Invoke(isGood);
     }
-}
+}