Joseph Doherty
826312befe
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.
22 lines
1.3 KiB
C#
22 lines
1.3 KiB
C#
namespace ZB.MOM.WW.OtOpcUa.Core.Abstractions;
|
|
|
|
/// <summary>
|
|
/// Opts a tag-definition record into auto-retry on <see cref="IWritable.WriteAsync"/> failures.
|
|
/// Absence of this attribute means writes are <b>not</b> retried — a timed-out write may have
|
|
/// already succeeded at the device, and replaying pulses, alarm acks, counter increments, or
|
|
/// recipe-step advances can duplicate irreversible field actions.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Applied to tag-definition POCOs
|
|
/// (e.g. <c>ModbusTagDefinition</c>, <c>S7TagDefinition</c>, OPC UA client tag rows) at the
|
|
/// property or record level. <b>Reserved for the per-tag opt-in; NOT yet consulted</b> —
|
|
/// the dispatch site (<c>DriverInstanceActor.HandleWriteAsync</c>) currently treats every write as
|
|
/// non-idempotent, so no tag retries a write today. Threading tag-definition metadata to the dispatch
|
|
/// seam is the documented forward path; when it ships, the <c>CapabilityInvoker</c> non-idempotent arm
|
|
/// and the parser's Write/AlarmAcknowledge no-retry clamp are the two sites that relax.
|
|
/// </remarks>
|
|
[AttributeUsage(AttributeTargets.Property | AttributeTargets.Class | AttributeTargets.Struct, AllowMultiple = false, Inherited = true)]
|
|
public sealed class WriteIdempotentAttribute : Attribute
|
|
{
|
|
}
|