docs: fill missing XML docs and strip tracking IDs from src comments
Clears CommentChecker findings in src/ (3,280 -> 209, the remainder being false positives like PLC-5/IEEE-754/M0.0) by adding missing summaries/params/returns, normalising inheritdoc usage, and removing Gitea/review tracking IDs while keeping the rationale they annotated. Comment-only: comment-stripped sources are identical to the parent commit.
This commit is contained in:
@@ -29,7 +29,7 @@ public sealed class AdminOperationsActor : ReceiveActor
|
||||
private readonly TagConfigValidationMode _tagConfigValidationMode;
|
||||
|
||||
/// <summary>
|
||||
/// Where central→node commands are handed off (per-cluster mesh Phase 2), or
|
||||
/// Where central→node commands are handed off (per-cluster mesh), or
|
||||
/// <see langword="null"/> to publish on the mediator directly.
|
||||
/// </summary>
|
||||
private readonly IActorRef? _meshRouter;
|
||||
@@ -43,7 +43,7 @@ public sealed class AdminOperationsActor : ReceiveActor
|
||||
/// <param name="tagConfigValidationMode">Deploy-gate TagConfig strictness mode (Warn default | Error opt-in).</param>
|
||||
/// <param name="meshRouter">
|
||||
/// Central comm actor commands are handed to, or <see langword="null"/> to publish on the
|
||||
/// DistributedPubSub mediator directly (the pre-Phase-2 behaviour).
|
||||
/// DistributedPubSub mediator directly (the behaviour before the per-cluster mesh).
|
||||
/// </param>
|
||||
/// <returns>Props configured to create an AdminOperationsActor.</returns>
|
||||
public static Props Props(
|
||||
@@ -87,8 +87,8 @@ public sealed class AdminOperationsActor : ReceiveActor
|
||||
/// no router is wired.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// The fallback keeps ~12 existing tests (and any node wired before per-cluster mesh Phase 2)
|
||||
/// on exactly the pre-Phase-2 behaviour. The DistributedPubSub branch behind it is
|
||||
/// The fallback keeps ~12 existing tests (and any node wired before per-cluster mesh)
|
||||
/// on exactly the pre-mesh behaviour. The DistributedPubSub branch behind it is
|
||||
/// <b>retained</b>, not scheduled for deletion — an earlier note here promised Phase 6 would
|
||||
/// remove it, which was deliberately reversed (<c>docs/Configuration.md</c> § "The compiled
|
||||
/// transport-mode defaults were deliberately NOT flipped"): DPS is still the correct and
|
||||
@@ -245,12 +245,12 @@ public sealed class AdminOperationsActor : ReceiveActor
|
||||
errors.AddRange(DraftValidator.ValidateClusterTopology(cluster, nodes));
|
||||
}
|
||||
|
||||
// R2-11 (05/CONV-2): deploy-time TagConfig strictness inspection over equipment tags. The
|
||||
// Deploy-time TagConfig strictness inspection over equipment tags. The
|
||||
// driver-typed EquipmentTagConfigInspector surfaces every blob the driver's own reader would
|
||||
// REJECT — a present-but-invalid enum value, an absent or malformed address field, a
|
||||
// structurally-unparseable TagConfig — each of which makes the driver skip the tag so it reads
|
||||
// BadNodeIdUnknown forever. (Pre-R2-11 Phase C the runtime silently defaulted a typo'd enum;
|
||||
// it has rejected the tag since, so these warnings describe rejections.) In Warn mode
|
||||
// BadNodeIdUnknown forever. (The runtime used to silently default a typo'd enum;
|
||||
// it now rejects the tag, so these warnings describe rejections.) In Warn mode
|
||||
// (default) these are non-blocking (logged + appended to the accepted result Message); in Error
|
||||
// mode they fold into the reject list so a typo'd config cannot be re-deployed until fixed.
|
||||
// Running servers are untouched either way — the gate only sees re-deploys.
|
||||
|
||||
@@ -51,7 +51,7 @@ public static class ConfigComposer
|
||||
UnsAreas = await db.UnsAreas.AsNoTracking().OrderBy(x => x.UnsAreaId).ToListAsync(ct),
|
||||
UnsLines = await db.UnsLines.AsNoTracking().OrderBy(x => x.UnsLineId).ToListAsync(ct),
|
||||
NodeAcls = await db.NodeAcls.AsNoTracking().OrderBy(x => x.NodeAclId).ToListAsync(ct),
|
||||
// #520 stage 4: the data-plane credentials travel with the config, because a driver-only node
|
||||
// the data-plane credentials travel with the config, because a driver-only node
|
||||
// has no ConfigDb to read them from (per-cluster mesh Phase 4) and would otherwise deny every
|
||||
// UserName token. Only the peppered HMAC of each secret ships — never the secret — and the
|
||||
// pepper is node configuration that is deliberately NOT in the artifact, so a stolen blob
|
||||
|
||||
+3
-3
@@ -15,17 +15,17 @@ using ZB.MOM.WW.OtOpcUa.Driver.TwinCAT;
|
||||
namespace ZB.MOM.WW.OtOpcUa.ControlPlane.AdminOperations;
|
||||
|
||||
/// <summary>
|
||||
/// Deploy-time TagConfig inspection dispatched by <c>DriverType</c> (R2-11, 05/CONV-2). Mirrors the
|
||||
/// Deploy-time TagConfig inspection dispatched by <c>DriverType</c>. Mirrors the
|
||||
/// AdminUI <c>TagConfigValidator</c> shape: a case-insensitive map from the canonical driver-type string
|
||||
/// to that driver's lightweight <c>Contracts</c> parser <c>Inspect()</c>, returning human-readable
|
||||
/// warnings. Never throws.
|
||||
/// <para><b>The warnings describe REJECTIONS, not silent defaults.</b> Every driver's runtime read has
|
||||
/// been strict since R2-11 Phase C (<c>TagConfigJson.TryReadEnumStrict</c>): a present-but-invalid enum
|
||||
/// been strict (<c>TagConfigJson.TryReadEnumStrict</c>): a present-but-invalid enum
|
||||
/// value — like an absent or malformed address field, or an unparseable document — makes the reader
|
||||
/// refuse the whole tag, so the driver skips it and it reads <c>BadNodeIdUnknown</c> forever with the
|
||||
/// deployment otherwise green. That is what these warnings are for. (Before Phase C the runtime did
|
||||
/// silently substitute a default for a typo'd enum; the doc-comments here and on the per-driver
|
||||
/// <c>Inspect</c> methods still said so until Gitea #551.) Because a warning can be PROMOTED to a
|
||||
/// <c>Inspect</c> methods used to say so.) Because a warning can be PROMOTED to a
|
||||
/// blocking error by <c>TagConfigValidationMode.Error</c>, each <c>Inspect</c> asks its driver's own
|
||||
/// reader for the verdict and only explains a refusal — never restating the rule, and so never able to
|
||||
/// be stricter than the runtime it reports on.</para>
|
||||
|
||||
+1
-1
@@ -1,7 +1,7 @@
|
||||
namespace ZB.MOM.WW.OtOpcUa.ControlPlane.AdminOperations;
|
||||
|
||||
/// <summary>
|
||||
/// How the deploy gate treats TagConfig strictness inspection results (R2-11, 05/CONV-2). Sourced from
|
||||
/// How the deploy gate treats TagConfig strictness inspection results. Sourced from
|
||||
/// <c>Deployment:TagConfigValidationMode</c> in appsettings; defaults to <see cref="Warn"/> so existing
|
||||
/// deployments are never blocked by a previously-tolerated typo.
|
||||
/// </summary>
|
||||
|
||||
+2
-2
@@ -75,7 +75,7 @@ public sealed class CentralCommunicationActor : ReceiveActor, IWithTimers
|
||||
|
||||
// Memoize-on-first-use, NOT PreStart-only: PreStart runs on a dispatcher thread concurrently
|
||||
// with the builder's remaining starters, so its resolve can lose a millisecond-wide race
|
||||
// against AuditWriterActorKey's registration (starter #4) and Resolve() would swallow that
|
||||
// against AuditWriterActorKey's registration (the fourth starter) and Resolve() would swallow that
|
||||
// into a silent null — the known-cluster gate unpublished, fail-open. These properties
|
||||
// retry on first use, but the first RefreshContacts is sent from PreStart (TimeSpan.Zero) and
|
||||
// can ALSO land inside the starter window (a fast DB load finishes in ms), so first-use is not
|
||||
@@ -241,7 +241,7 @@ public sealed class CentralCommunicationActor : ReceiveActor, IWithTimers
|
||||
//
|
||||
// Quiet (firstUse: false — see Resolve): PreStart runs on a dispatcher thread concurrently
|
||||
// with the builder's remaining starters and loses a millisecond-wide race against
|
||||
// AuditWriterActorKey's registration (starter #4) on essentially every admin boot (live
|
||||
// AuditWriterActorKey's registration (the fourth starter) on essentially every admin boot (live
|
||||
// gates: 1A 2/3 boots, 1B 4/4 boots). That is the ORDINARY case, not a malfunction — the
|
||||
// memoized PskProvider/Dialer properties retry on first use, and the bounded bootstrap
|
||||
// retry re-arms RefreshContacts until the gate publishes (the first refresh itself can
|
||||
|
||||
@@ -181,7 +181,7 @@ public sealed class MeshGrpcCommandDialer : IMeshCommandDialer, IDisposable
|
||||
await call.ResponseAsync.ConfigureAwait(false);
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
/// <summary>Marks the dialer disposed and disposes every cached gRPC channel.</summary>
|
||||
public void Dispose()
|
||||
{
|
||||
_disposed = true;
|
||||
|
||||
+18
-13
@@ -58,7 +58,7 @@ public sealed class ConfigPublishCoordinator : ReceiveActor, IWithTimers
|
||||
public const string DeploymentsTopic = "deployments";
|
||||
public const string DeploymentAcksTopic = "deployment-acks";
|
||||
/// <summary>Central's apply deadline — the shared <see cref="DeployTimings.ApplyDeadline"/>, which the node's
|
||||
/// apply-outcome timeout is derived from (Gitea #601).</summary>
|
||||
/// apply-outcome timeout is derived from.</summary>
|
||||
public static readonly TimeSpan DefaultApplyDeadline = DeployTimings.ApplyDeadline;
|
||||
|
||||
private readonly IDbContextFactory<OtOpcUaConfigDbContext> _dbFactory;
|
||||
@@ -69,9 +69,9 @@ public sealed class ConfigPublishCoordinator : ReceiveActor, IWithTimers
|
||||
/// <see langword="null"/> to publish on the mediator directly.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Null in tests and on any node wired before Phase 2, where the fallback reproduces the
|
||||
/// pre-Phase-2 behaviour exactly. The DistributedPubSub branch behind it is <b>retained</b>,
|
||||
/// not scheduled for deletion — an earlier note here promised Phase 6 would remove it, which
|
||||
/// Null in tests and on any node wired without a mesh router, where the fallback reproduces the
|
||||
/// original behaviour exactly. The DistributedPubSub branch behind it is <b>retained</b>,
|
||||
/// not scheduled for deletion — an earlier note here promised it would be removed, which
|
||||
/// was deliberately reversed (<c>docs/Configuration.md</c> § "The compiled transport-mode
|
||||
/// defaults were deliberately NOT flipped"): DPS is still the correct and default transport
|
||||
/// for a single-mesh topology; gRPC is what crosses a mesh boundary.
|
||||
@@ -85,12 +85,12 @@ public sealed class ConfigPublishCoordinator : ReceiveActor, IWithTimers
|
||||
private static readonly IEqualityComparer<NodeId> NodeIdComparer = new CaseInsensitiveNodeIdComparer();
|
||||
private readonly Dictionary<NodeId, ApplyAckOutcome> _acks = new(NodeIdComparer);
|
||||
|
||||
/// <summary>Gitea #601 — the expected nodes whose Applied ack was DEGRADED (address-space apply partial).
|
||||
/// <summary>The expected nodes whose Applied ack was DEGRADED (address-space apply partial).
|
||||
/// Recovered from the DB on failover via <see cref="IsDegraded"/>.</summary>
|
||||
private readonly HashSet<NodeId> _degraded = new(NodeIdComparer);
|
||||
|
||||
/// <summary>
|
||||
/// Gitea #601 — prefix of <c>NodeDeploymentState.FailureReason</c> on an <b>Applied</b> row whose apply
|
||||
/// Prefix of <c>NodeDeploymentState.FailureReason</c> on an <b>Applied</b> row whose apply
|
||||
/// was degraded. The status model is deliberately unchanged (no new enum value, no migration): a
|
||||
/// degraded node DID apply the revision, so its status stays <see cref="NodeDeploymentStatus.Applied"/>
|
||||
/// and the degradation rides the existing reason column, which <c>/fleet</c> already renders.
|
||||
@@ -98,7 +98,7 @@ public sealed class ConfigPublishCoordinator : ReceiveActor, IWithTimers
|
||||
public const string DegradedReasonPrefix = ApplyAck.DegradedReasonPrefix;
|
||||
|
||||
/// <summary>
|
||||
/// Gitea #601 — whether a <c>NodeDeploymentState</c> row records a degraded apply: status
|
||||
/// Whether a <c>NodeDeploymentState</c> row records a degraded apply: status
|
||||
/// <see cref="NodeDeploymentStatus.Applied"/> with a non-empty <c>FailureReason</c>. A clean Applied row
|
||||
/// never carries a reason (neither this coordinator nor <c>DriverHostActor</c> writes one), so an
|
||||
/// old node's row reads as clean exactly as before.
|
||||
@@ -121,7 +121,7 @@ public sealed class ConfigPublishCoordinator : ReceiveActor, IWithTimers
|
||||
/// <returns>The Akka.NET <see cref="Akka.Actor.Props"/> used to spawn this actor.</returns>
|
||||
/// <param name="meshRouter">
|
||||
/// Central comm actor the dispatch is handed to, or <see langword="null"/> to publish on the
|
||||
/// DistributedPubSub mediator directly (the pre-Phase-2 behaviour).
|
||||
/// DistributedPubSub mediator directly (the original behaviour).
|
||||
/// </param>
|
||||
public static Props Props(
|
||||
IDbContextFactory<OtOpcUaConfigDbContext> dbFactory,
|
||||
@@ -267,7 +267,7 @@ public sealed class ConfigPublishCoordinator : ReceiveActor, IWithTimers
|
||||
}
|
||||
|
||||
_acks[msg.NodeId] = msg.Outcome;
|
||||
// #601 — an old node never sets Degraded, so its ack takes the clean branch exactly as before.
|
||||
// An old node never sets Degraded, so its ack takes the clean branch exactly as before.
|
||||
if (IsDegradedAck(msg)) _degraded.Add(msg.NodeId);
|
||||
else _degraded.Remove(msg.NodeId);
|
||||
PersistNodeAck(msg);
|
||||
@@ -291,7 +291,7 @@ public sealed class ConfigPublishCoordinator : ReceiveActor, IWithTimers
|
||||
? NodeDeploymentStatus.Applied
|
||||
: NodeDeploymentStatus.Failed;
|
||||
row.AppliedAtUtc = DateTime.UtcNow;
|
||||
// #601 — an Applied+degraded ack keeps status Applied and records WHY in the reason column, so the row
|
||||
// An Applied+degraded ack keeps status Applied and records WHY in the reason column, so the row
|
||||
// reads as degraded (IsDegraded) rather than clean. A clean or Failed ack writes what it always did.
|
||||
row.FailureReason = IsDegradedAck(msg)
|
||||
? Truncate(DegradedReasonPrefix + (string.IsNullOrWhiteSpace(msg.DegradedReason)
|
||||
@@ -317,7 +317,7 @@ public sealed class ConfigPublishCoordinator : ReceiveActor, IWithTimers
|
||||
UpdateDeploymentStatus(db, _current.Value, DeploymentStatus.Sealed, sealNow: true);
|
||||
if (_degraded.Count > 0)
|
||||
{
|
||||
// #601 — still Sealed: every node DID apply this revision and is running it, and "latest sealed" is
|
||||
// Still Sealed: every node DID apply this revision and is running it, and "latest sealed" is
|
||||
// what drift detection and the publish actor's fallback key on, so a degraded deploy that was not
|
||||
// sealed would make the fleet look one revision behind what it actually runs. Sealed is not the
|
||||
// same as clean, though: the deployment's reason names the degraded nodes (per-node detail is on
|
||||
@@ -432,11 +432,16 @@ public sealed class ConfigPublishCoordinator : ReceiveActor, IWithTimers
|
||||
/// expected-ack set and incoming acks agree regardless of host-name casing.</summary>
|
||||
private sealed class CaseInsensitiveNodeIdComparer : IEqualityComparer<NodeId>
|
||||
{
|
||||
/// <inheritdoc />
|
||||
/// <summary>Compares two node ids by value, ignoring case.</summary>
|
||||
/// <param name="x">The first node id.</param>
|
||||
/// <param name="y">The second node id.</param>
|
||||
/// <returns><see langword="true"/> when the ids are equal ignoring case.</returns>
|
||||
public bool Equals(NodeId x, NodeId y) =>
|
||||
string.Equals(x.Value, y.Value, StringComparison.OrdinalIgnoreCase);
|
||||
|
||||
/// <inheritdoc />
|
||||
/// <summary>Gets a case-insensitive hash code for a node id.</summary>
|
||||
/// <param name="obj">The node id.</param>
|
||||
/// <returns>The hash code of the id value.</returns>
|
||||
public int GetHashCode(NodeId obj) =>
|
||||
StringComparer.OrdinalIgnoreCase.GetHashCode(obj.Value ?? string.Empty);
|
||||
}
|
||||
|
||||
+1
-1
@@ -181,7 +181,7 @@ public sealed class ClusterNodeAddressReconcilerActor : ReceiveActor, IWithTimer
|
||||
public static IReadOnlyList<(string Host, int Port)> FilterOwnClusterDriverMembers(
|
||||
IEnumerable<Member> members, string? ownClusterRole)
|
||||
{
|
||||
// R3-04 (01/C-9): GossipedRolesHave, not ordinal Contains — a peer gossiping a miscased
|
||||
// GossipedRolesHave, not ordinal Contains — a peer gossiping a miscased
|
||||
// 'Driver' (rolling-upgrade window) must not read as a phantom RunningNodeHasNoRow finding.
|
||||
var driverMembers = members
|
||||
.Where(m => m.Status == MemberStatus.Up && RoleParser.GossipedRolesHave(m.Roles, DriverRole));
|
||||
|
||||
@@ -31,7 +31,7 @@ public sealed record ManualFailoverSnapshot(string? PrimaryAddress, IReadOnlyLis
|
||||
/// moves with it and OPC UA clients re-select.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Post-Phase-6 (per-cluster mesh split): the Primary is elected per application
|
||||
/// With the per-cluster mesh split: the Primary is elected per application
|
||||
/// <c>Cluster</c>, because each cluster's redundant pair now runs its own independent
|
||||
/// 2-node Akka mesh. This service therefore acts on <b>this pair's own</b> Primary.
|
||||
/// </para>
|
||||
@@ -39,6 +39,7 @@ public sealed record ManualFailoverSnapshot(string? PrimaryAddress, IReadOnlyLis
|
||||
public interface IManualFailoverService
|
||||
{
|
||||
/// <summary>Reads the current driver membership from live cluster state.</summary>
|
||||
/// <returns>A snapshot of the current driver membership.</returns>
|
||||
ManualFailoverSnapshot GetSnapshot();
|
||||
|
||||
/// <summary>
|
||||
|
||||
@@ -123,7 +123,7 @@ public sealed class ManualFailoverService : IManualFailoverService
|
||||
}
|
||||
|
||||
private static List<Member> OrderedDrivers(IEnumerable<Member> members) => members
|
||||
// R3-04 (01/C-9): GossipedRolesHave, not ordinal Contains — a peer gossiping a miscased
|
||||
// GossipedRolesHave, not ordinal Contains — a peer gossiping a miscased
|
||||
// 'Driver' (rolling-upgrade window) must still be a manual-failover candidate.
|
||||
.Where(m => m.Status == MemberStatus.Up && RoleParser.GossipedRolesHave(m.Roles, RedundancyStateActor.DriverRole))
|
||||
.OrderBy(m => m, Member.AgeOrdering)
|
||||
|
||||
@@ -190,13 +190,12 @@ public sealed class RedundancyStateActor : ReceiveActor, IWithTimers
|
||||
if (string.IsNullOrWhiteSpace(host)) continue;
|
||||
|
||||
var isPrimary = driverPrimary is not null && driverPrimary == member.Address;
|
||||
// R3-04 (01/C-9): GossipedRolesHave, not ordinal Contains — a peer running an older build
|
||||
// GossipedRolesHave, not ordinal Contains — a peer running an older build
|
||||
// can still gossip a miscased 'Driver' during a rolling upgrade, and this list is what
|
||||
// /hosts and /fleet render, so a miscased-but-genuinely-driver member must not read as
|
||||
// Detached. NOTE: this does NOT reach SelectDriverPrimary/driverPrimary above — that
|
||||
// delegates to ClusterActiveNode.OldestUpMember (ZB.MOM.WW.Health.Akka), which matches via
|
||||
// Akka's own ordinal Member.HasRole and is not this repo's to change (see R3-04 execution
|
||||
// notes). So a member gossiping only 'Driver' now classifies Secondary rather than
|
||||
// Akka's own ordinal Member.HasRole and is not this repo's to change. So a member gossiping only 'Driver' now classifies Secondary rather than
|
||||
// Detached, but a PAIR that BOTH gossip 'Driver' still elects no Primary.
|
||||
var role = RoleParser.GossipedRolesHave(member.Roles, DriverRole)
|
||||
? (isPrimary ? CommonsRedundancyRole.Primary : CommonsRedundancyRole.Secondary)
|
||||
|
||||
@@ -21,7 +21,7 @@ namespace ZB.MOM.WW.OtOpcUa.ControlPlane;
|
||||
|
||||
public static class ServiceCollectionExtensions
|
||||
{
|
||||
// R3-04 (theme 4 guard): alias RoleParser.Admin rather than duplicating the literal — the same
|
||||
// Alias RoleParser.Admin rather than duplicating the literal — the same
|
||||
// pattern Runtime/ServiceCollectionExtensions.DriverRole already follows for RoleParser.Driver.
|
||||
public const string AdminRole = RoleParser.Admin;
|
||||
|
||||
@@ -120,7 +120,7 @@ public static class ServiceCollectionExtensions
|
||||
var dbFactory = resolver.GetService<IDbContextFactory<OtOpcUaConfigDbContext>>();
|
||||
var coordinator = registry.Get<ConfigPublishCoordinatorKey>();
|
||||
var probes = resolver.GetService<IEnumerable<IDriverProbe>>() ?? Enumerable.Empty<IDriverProbe>();
|
||||
// R2-11 (05/CONV-2): deploy-gate TagConfig strictness mode from appsettings
|
||||
// Deploy-gate TagConfig strictness mode from appsettings
|
||||
// (Deployment:TagConfigValidationMode = Warn default | Error opt-in).
|
||||
var mode = Enum.TryParse<TagConfigValidationMode>(
|
||||
resolver.GetService<IConfiguration>()?["Deployment:TagConfigValidationMode"],
|
||||
@@ -139,11 +139,11 @@ public static class ServiceCollectionExtensions
|
||||
},
|
||||
singletonOptions);
|
||||
|
||||
// Gitea #542 (2026-08-06): the fleet-status singleton is NO LONGER registered here — the
|
||||
// The fleet-status singleton is NO LONGER registered here — the
|
||||
// whole FleetStatusBroadcaster → DPS → SignalR bridge → FleetStatusHub chain was DELETED.
|
||||
// It had zero clients end-to-end (no browser JS, no HubConnection — /fleet reads
|
||||
// NodeDeploymentState from the ConfigDb on a poll), its DriverHostStatusHeartbeat input had
|
||||
// no production sender, and after mesh Phase 6 its "fleet" was only central's own pair.
|
||||
// no production sender, and after the mesh split its "fleet" was only central's own pair.
|
||||
|
||||
// Per-cluster mesh Phase 6: the redundancy-state singleton is NO LONGER registered here.
|
||||
// It was an admin-scoped, fleet-wide singleton — one Primary elected across the whole mesh.
|
||||
@@ -194,7 +194,7 @@ public static class ServiceCollectionExtensions
|
||||
/// redundancy.
|
||||
/// </summary>
|
||||
/// <param name="builder">The Akka configuration builder.</param>
|
||||
/// <param name="roleInfo">The local node's cluster-role view (Task 1's <c>ClusterRoleInfo</c>).</param>
|
||||
/// <param name="clusterOptions">The Akka cluster options, including the node's cluster role.</param>
|
||||
/// <returns>The builder for fluent chaining.</returns>
|
||||
/// <remarks>
|
||||
/// After the mesh split, central's mesh sees only its own pair — a driver-only site pair therefore
|
||||
@@ -225,7 +225,7 @@ public static class ServiceCollectionExtensions
|
||||
/// <remarks>
|
||||
/// Cluster-scope is the robust choice — it survives an accidental two-mesh merge by keeping one
|
||||
/// singleton per cluster. The <c>driver</c>-role fallback deliberately does NOT throw when a node
|
||||
/// has no cluster role, because (a) that is the pre-Phase-6 fleet-wide behavior on a legacy single
|
||||
/// has no cluster role, because (a) that is the earlier fleet-wide behavior on a legacy single
|
||||
/// mesh, keeping legacy/harness nodes and any not-yet-migrated deployment booting unchanged, and
|
||||
/// (b) on a genuinely split 2-node mesh the <c>driver</c> role is already pair-local — the mesh IS
|
||||
/// the pair. So the fallback is correct in both worlds and costs no availability.
|
||||
|
||||
@@ -115,6 +115,7 @@ public sealed class TelemetryStreamClient : IDisposable
|
||||
/// <param name="onEvent">Sink for each received raw <see cref="TelemetryEvent"/>.</param>
|
||||
/// <param name="onError">Invoked once on an abnormal transport failure (the reconnect trigger).</param>
|
||||
/// <param name="ct">Cancels the stream (normal shutdown).</param>
|
||||
/// <returns>A task that represents the asynchronous operation.</returns>
|
||||
/// <exception cref="ArgumentException"><paramref name="correlationId"/> is null or empty.</exception>
|
||||
/// <exception cref="ArgumentNullException"><paramref name="onEvent"/> or <paramref name="onError"/> is null.</exception>
|
||||
/// <exception cref="ObjectDisposedException">This client has been disposed.</exception>
|
||||
@@ -171,7 +172,7 @@ public sealed class TelemetryStreamClient : IDisposable
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
/// <summary>Marks the client disposed and releases the channel if this client created it.</summary>
|
||||
public void Dispose()
|
||||
{
|
||||
_disposed = true;
|
||||
|
||||
Reference in New Issue
Block a user