docs: backfill XML documentation across 756 files
v2-ci / build (push) Failing after 1m43s
v2-ci / unit-tests (tests/Core/ZB.MOM.WW.OtOpcUa.Cluster.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.ControlPlane.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.OpcUaServer.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.Runtime.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.Security.Tests) (push) Has been skipped
v2-ci / integration (tests/Server/ZB.MOM.WW.OtOpcUa.Host.IntegrationTests) (push) Has been skipped
v2-ci / integration (tests/Server/ZB.MOM.WW.OtOpcUa.OpcUaServer.IntegrationTests) (push) Has been skipped
v2-ci / build (push) Failing after 1m43s
v2-ci / unit-tests (tests/Core/ZB.MOM.WW.OtOpcUa.Cluster.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.ControlPlane.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.OpcUaServer.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.Runtime.Tests) (push) Has been skipped
v2-ci / unit-tests (tests/Server/ZB.MOM.WW.OtOpcUa.Security.Tests) (push) Has been skipped
v2-ci / integration (tests/Server/ZB.MOM.WW.OtOpcUa.Host.IntegrationTests) (push) Has been skipped
v2-ci / integration (tests/Server/ZB.MOM.WW.OtOpcUa.OpcUaServer.IntegrationTests) (push) Has been skipped
Adds <summary>, <param>, <typeparam>, and <inheritdoc/> tags to public members surfaced by commentchecker — resolves 5,847 of 5,869 issues (99.6%) across three /fixdocs passes.
This commit is contained in:
@@ -23,11 +23,16 @@ public sealed class DbHealthProbeActor : ReceiveActor, IWithTimers
|
||||
private readonly ILoggingAdapter _log = Context.GetLogger();
|
||||
private DbHealthStatus _last = new(false, DateTime.MinValue, "not probed yet");
|
||||
|
||||
/// <summary>Gets or sets the timer scheduler for periodic health probes.</summary>
|
||||
public ITimerScheduler Timers { get; set; } = null!;
|
||||
|
||||
/// <summary>Creates a Props instance for the DbHealthProbeActor.</summary>
|
||||
/// <param name="dbFactory">The factory for creating ConfigDb contexts.</param>
|
||||
public static Props Props(IDbContextFactory<OtOpcUaConfigDbContext> dbFactory) =>
|
||||
Akka.Actor.Props.Create(() => new DbHealthProbeActor(dbFactory));
|
||||
|
||||
/// <summary>Initializes a new instance of the <see cref="DbHealthProbeActor"/> class.</summary>
|
||||
/// <param name="dbFactory">The factory for creating ConfigDb contexts.</param>
|
||||
public DbHealthProbeActor(IDbContextFactory<OtOpcUaConfigDbContext> dbFactory)
|
||||
{
|
||||
_dbFactory = dbFactory;
|
||||
@@ -35,6 +40,7 @@ public sealed class DbHealthProbeActor : ReceiveActor, IWithTimers
|
||||
Receive<Tick>(_ => RunProbe());
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
protected override void PreStart()
|
||||
{
|
||||
RunProbe();
|
||||
|
||||
@@ -37,8 +37,16 @@ public sealed class PeerOpcUaProbeActor : ReceiveActor, IWithTimers
|
||||
private readonly Action<object>? _broadcastOverride;
|
||||
private readonly ILoggingAdapter _log = Context.GetLogger();
|
||||
|
||||
/// <summary>Gets or sets the timer scheduler for this actor.</summary>
|
||||
public ITimerScheduler Timers { get; set; } = null!;
|
||||
|
||||
/// <summary>Creates actor props for the peer OPC UA probe.</summary>
|
||||
/// <param name="peer">The node identifier of the peer to probe.</param>
|
||||
/// <param name="interval">Optional probe interval; defaults to DefaultProbeInterval.</param>
|
||||
/// <param name="connectTimeout">Optional connection timeout; defaults to DefaultConnectTimeout.</param>
|
||||
/// <param name="opcUaPort">The OPC UA port to connect to; defaults to DefaultOpcUaPort.</param>
|
||||
/// <param name="broadcast">Optional custom broadcast delegate for probe results.</param>
|
||||
/// <returns>Props configured to create a PeerOpcUaProbeActor.</returns>
|
||||
public static Props Props(
|
||||
NodeId peer,
|
||||
TimeSpan? interval = null,
|
||||
@@ -52,6 +60,12 @@ public sealed class PeerOpcUaProbeActor : ReceiveActor, IWithTimers
|
||||
opcUaPort,
|
||||
broadcast));
|
||||
|
||||
/// <summary>Initializes a new instance of the PeerOpcUaProbeActor.</summary>
|
||||
/// <param name="peer">The node identifier of the peer to probe.</param>
|
||||
/// <param name="interval">The probe interval.</param>
|
||||
/// <param name="connectTimeout">The connection timeout.</param>
|
||||
/// <param name="opcUaPort">The OPC UA port to connect to.</param>
|
||||
/// <param name="broadcastOverride">Optional custom broadcast delegate for probe results.</param>
|
||||
public PeerOpcUaProbeActor(
|
||||
NodeId peer,
|
||||
TimeSpan interval,
|
||||
@@ -68,6 +82,7 @@ public sealed class PeerOpcUaProbeActor : ReceiveActor, IWithTimers
|
||||
ReceiveAsync<Tick>(_ => RunProbeAsync());
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
protected override void PreStart() =>
|
||||
Timers.StartPeriodicTimer("probe", Tick.Instance, _interval);
|
||||
|
||||
|
||||
Reference in New Issue
Block a user