mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-20 00:31:32 +08:00
Marc Schier
dbc09b8e22
# Description Adopt [`System.TimeProvider`](https://learn.microsoft.com/dotnet/api/system.timeprovider) across the stack so that every place that creates timers, runs duration math, or schedules periodic work is mockable, deterministic in tests, and immune to wall-clock changes. The migration touches Core, Core.Types, Server, Client, PubSub, Configuration, Gds (server + client), Lds, and the Quickstarts/Console reference apps. Per-component changes follow the same pattern: 1. Add a `private readonly TimeProvider m_timeProvider;` field. 2. Accept a nullable `TimeProvider? timeProvider = null` as the **last** constructor parameter (new overload; legacy constructor stays for binary compatibility and delegates with `timeProvider: null`). 3. Initialise the field with `m_timeProvider = timeProvider ??= TimeProvider.System;`. 4. Replace `new Timer(...)`, `Stopwatch`, `HiResClock.*`, `DateTime.UtcNow`-based duration math, and `Task.Delay(delay, ct)` in timing loops with the matching `m_timeProvider` API (`CreateTimer`, `GetTimestamp` / `GetElapsedTime`, `GetUtcNow().UtcDateTime`, `Task.Delay(delay, m_timeProvider, ct)`). 5. Wire the provider through DI: `AddOpcUaServerBuilder` / `AddOpcUaClientBuilder` register `TimeProvider.System` via `TryAddSingleton<TimeProvider>()` so tests can swap in `Microsoft.Extensions.Time.Testing.FakeTimeProvider`. `HiResClock` itself is kept (so the `ApplicationConfiguration.DisableHiResClock` schema flag still round-trips), but **every public member** is now `[Obsolete]` with a single shared message pointing to the new migration-guide section. The few internal call sites that still need to set/read `HiResClock` are wrapped with `#pragma warning disable CS0618`. ### Highlights per component - **Core / Stack** — `Opc.Ua.Core`, `Opc.Ua.Core.Types`, channel pipeline (`UaSCBinaryClientChannel`, `ChannelToken`, `UaSCBinaryChannel`), `ApplicationConfiguration`, certificate validators, `JwksIssuerKeyResolver`, `TimeProviderExtensions` polyfills (`GetTimestampMilliseconds`, `GetTickCount`, `CancellationTokenSource(timeout, timeProvider)`, `Task.Delay(delay, provider, ct)` polyfill for older TFMs). - **Server** — session lockout, subscription pipeline (publish/sample/keep-alive/lifetime), `MonitoredItemQueue`, alarm sampling rate, `IntervalRunner`, server diagnostics, configuration state machines, hosted services. - **Client** — `Session`, managed/V2 subscription engines, reconnect handlers, channel keep-alive, periodic publishing, complex-type discovery polling. - **PubSub** — `IntervalRunner` pipeline, message-receive timers, MQTT/UDP keep-alive, publishers/readers. - **Gds / Lds** — `LdsServer`, `LinqApplicationsDatabase` expiry housekeeping, GDS clients (push, pull), `DirectoryCertificateStore`, `ConnectionStateMachine`, classic subscription engine. - **Quickstarts / Console samples** — `SampleNodeManager`, `ReferenceNodeManager`, `AlarmNodeManager`, `BoilerState`, `MemoryBufferState`, `PublishedValuesWrites`. Samples resolve via `(Server as ITimeProviderProvider)?.TimeProvider ?? TimeProvider.System` so existing ctor signatures stay binary-compatible. - **Tests** — `Opc.Ua.PubSub.Tests` adds `IntervalRunnerTests`; existing `SubscriptionTests`, `UaPublisherTests`, and `TestDataSystem` move off `HiResClock`. Added `Microsoft.Extensions.TimeProvider.Testing` package for `FakeTimeProvider` (project-load warning surfaces on net48/net472 only — runtime is .NET 8+). ### Migration guide New section [**Time and Timer abstraction (`TimeProvider`)**](Docs/MigrationGuide.md#time-and-timer-abstraction-timeprovider) documents: - The canonical replacement table (`HiResClock.UtcNow` → `timeProvider.GetUtcNow().UtcDateTime`, `HiResClock.TickCount64` → `timeProvider.GetTimestamp()`, `new Timer` → `timeProvider.CreateTimer`, `Task.Delay(delay, ct)` → `Task.Delay(delay, timeProvider, ct)`, …). - The `TimeProvider? timeProvider = null` + `??=` constructor pattern. - DI wiring and how to swap in `FakeTimeProvider` in tests. - Before/after snippets for `HiResClock.TickCount64`, `HiResClock.UtcNow`, and `new Timer(...)`. ## Related Issues - Fixes #2458 ## Checklist - [x] I have signed the [CLA](https://opcfoundation.org/license/cla/ContributorLicenseAgreementv1.0.pdf) and read the [CONTRIBUTING](https://github.com/OPCFoundation/UA-.NETStandard/blob/master/CONTRIBUTING.md) doc. - [x] I have added tests that prove my fix is effective or that my feature works and increased code coverage. - [x] I have added all necessary documentation. - [x] I have verified that my changes do not introduce (new) build or analyzer warnings. - [ ] I ran **all** tests locally using the **UA.slnx** solution against at least .net **framework** and .net **10**, and all passed. - [ ] I fixed **all** failing and flaky tests in the CI pipelines and **all** CodeQL warnings. - [ ] I have addressed **all** PR feedback received.
768 lines
31 KiB
C#
768 lines
31 KiB
C#
/* ========================================================================
|
|
* Copyright (c) 2005-2025 The OPC Foundation, Inc. All rights reserved.
|
|
*
|
|
* OPC Foundation MIT License 1.00
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person
|
|
* obtaining a copy of this software and associated documentation
|
|
* files (the "Software"), to deal in the Software without
|
|
* restriction, including without limitation the rights to use,
|
|
* copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the
|
|
* Software is furnished to do so, subject to the following
|
|
* conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be
|
|
* included in all copies or substantial portions of the Software.
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
|
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
|
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
|
* OTHER DEALINGS IN THE SOFTWARE.
|
|
*
|
|
* The complete license agreement can be found here:
|
|
* http://opcfoundation.org/License/MIT/1.00/
|
|
* ======================================================================*/
|
|
|
|
using System;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
using Microsoft.Extensions.Logging;
|
|
using Opc.Ua.Redaction;
|
|
|
|
namespace Opc.Ua.Client
|
|
{
|
|
/// <summary>
|
|
/// Attempts to reconnect to the server using the legacy reconnect
|
|
/// flow. Operates against a raw <see cref="Session"/> (or a derived
|
|
/// type) by driving its <c>ReconnectAsync</c> /
|
|
/// <see cref="ISessionFactory.RecreateAsync(ISession, CancellationToken)"/>
|
|
/// pipeline directly.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// <para>
|
|
/// New code should prefer <see cref="ManagedSession"/> (created via
|
|
/// <see cref="ManagedSessionFactory"/> or <see cref="ManagedSessionBuilder"/>),
|
|
/// which encapsulates connection lifecycle, reconnect, and server
|
|
/// redundancy failover behind an <see cref="ISession"/> facade.
|
|
/// </para>
|
|
/// <para>
|
|
/// <see cref="SessionReconnectHandler"/> is intentionally retained as
|
|
/// a supported legacy entry point for callers that already manage
|
|
/// <see cref="Session"/> instances directly. It does <b>not</b>
|
|
/// support the <see cref="ManagedSession"/> facade — passing one to
|
|
/// <see cref="BeginReconnect(ISession,int,EventHandler)"/> throws
|
|
/// <see cref="NotSupportedException"/> because the managed session
|
|
/// already runs its own reconnect state machine.
|
|
/// </para>
|
|
/// </remarks>
|
|
public class SessionReconnectHandler : IDisposable
|
|
{
|
|
/// <summary>
|
|
/// The minimum reconnect period in ms.
|
|
/// </summary>
|
|
public const int MinReconnectPeriod = 500;
|
|
|
|
/// <summary>
|
|
/// The maximum reconnect period in ms.
|
|
/// </summary>
|
|
public const int MaxReconnectPeriod = 30000;
|
|
|
|
/// <summary>
|
|
/// The default reconnect period in ms.
|
|
/// </summary>
|
|
public const int DefaultReconnectPeriod = 1000;
|
|
|
|
/// <summary>
|
|
/// The default reconnect operation timeout in ms.
|
|
/// </summary>
|
|
public const int MinReconnectOperationTimeout = 5000;
|
|
|
|
/// <summary>
|
|
/// The internal state of the reconnect handler.
|
|
/// </summary>
|
|
[Flags]
|
|
public enum ReconnectState
|
|
{
|
|
/// <summary>
|
|
/// The reconnect handler is ready to start the reconnect timer.
|
|
/// </summary>
|
|
Ready = 0,
|
|
|
|
/// <summary>
|
|
/// The reconnect timer is triggered and waiting to reconnect.
|
|
/// </summary>
|
|
Triggered = 1,
|
|
|
|
/// <summary>
|
|
/// The reconnection is in progress.
|
|
/// </summary>
|
|
Reconnecting = 2,
|
|
|
|
/// <summary>
|
|
/// The reconnect handler is disposed and can not be used for further reconnect attempts.
|
|
/// </summary>
|
|
Disposed = 4
|
|
}
|
|
|
|
/// <summary>
|
|
/// Obsolete constructor
|
|
/// </summary>
|
|
[Obsolete("Use SessionReconnectHandler(ITelemetryContext, bool, int) instead.")]
|
|
public SessionReconnectHandler(bool reconnectAbort = false, int maxReconnectPeriod = -1)
|
|
// Telemetry is required by the modern ctor; this obsolete bridge forwards null!
|
|
// to preserve the parameterless reconnect-handler instantiation pattern.
|
|
: this(null!, reconnectAbort, maxReconnectPeriod)
|
|
{
|
|
}
|
|
|
|
/// <summary>
|
|
/// Create a reconnect handler.
|
|
/// </summary>
|
|
/// <param name="telemetry">The telemetry context to use to create obvservability instruments</param>
|
|
/// <param name="reconnectAbort">Set to <c>true</c> to allow reconnect abort if keep alive recovered.</param>
|
|
/// <param name="maxReconnectPeriod">
|
|
/// The upper limit for the reconnect period after exponential backoff.
|
|
/// -1 (default) indicates that no exponential backoff should be used.
|
|
/// </param>
|
|
public SessionReconnectHandler(
|
|
ITelemetryContext telemetry,
|
|
bool reconnectAbort = false,
|
|
int maxReconnectPeriod = -1)
|
|
: this(telemetry, reconnectAbort, maxReconnectPeriod, timeProvider: null)
|
|
{
|
|
}
|
|
|
|
/// <summary>
|
|
/// Create a reconnect handler.
|
|
/// </summary>
|
|
/// <param name="telemetry">The telemetry context to use to create obvservability instruments</param>
|
|
/// <param name="reconnectAbort">Set to <c>true</c> to allow reconnect abort if keep alive recovered.</param>
|
|
/// <param name="maxReconnectPeriod">
|
|
/// The upper limit for the reconnect period after exponential backoff.
|
|
/// -1 (default) indicates that no exponential backoff should be used.
|
|
/// </param>
|
|
/// <param name="timeProvider">Optional time provider used for timers and elapsed-time
|
|
/// calculations. Defaults to <see cref="TimeProvider.System"/>.</param>
|
|
public SessionReconnectHandler(
|
|
ITelemetryContext telemetry,
|
|
bool reconnectAbort,
|
|
int maxReconnectPeriod,
|
|
TimeProvider? timeProvider)
|
|
{
|
|
m_timeProvider = timeProvider ?? TimeProvider.System;
|
|
m_telemetry = telemetry;
|
|
m_logger = telemetry.CreateLogger<SessionReconnectHandler>();
|
|
m_reconnectAbort = reconnectAbort;
|
|
m_reconnectTimer = m_timeProvider.CreateTimer(
|
|
OnReconnectAsync,
|
|
this,
|
|
Timeout.InfiniteTimeSpan,
|
|
Timeout.InfiniteTimeSpan);
|
|
m_state = ReconnectState.Ready;
|
|
m_cancelReconnect = false;
|
|
m_updateFromServer = false;
|
|
m_baseReconnectPeriod = DefaultReconnectPeriod;
|
|
m_maxReconnectPeriod =
|
|
maxReconnectPeriod < 0
|
|
? -1
|
|
: Math.Max(
|
|
MinReconnectPeriod,
|
|
Math.Min(maxReconnectPeriod, MaxReconnectPeriod));
|
|
}
|
|
|
|
/// <summary>
|
|
/// Frees any unmanaged resources.
|
|
/// </summary>
|
|
public void Dispose()
|
|
{
|
|
Dispose(true);
|
|
GC.SuppressFinalize(this);
|
|
}
|
|
|
|
/// <summary>
|
|
/// An overrideable version of the Dispose.
|
|
/// </summary>
|
|
protected virtual void Dispose(bool disposing)
|
|
{
|
|
if (disposing)
|
|
{
|
|
lock (m_lock)
|
|
{
|
|
m_reconnectTimer?.Dispose();
|
|
m_reconnectTimer = null;
|
|
m_state = ReconnectState.Disposed;
|
|
}
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the session managed by the handler.
|
|
/// </summary>
|
|
/// <value>The session.</value>
|
|
public ISession? Session { get; private set; }
|
|
|
|
/// <summary>
|
|
/// The internal state of the reconnect handler.
|
|
/// </summary>
|
|
public ReconnectState State
|
|
{
|
|
get
|
|
{
|
|
lock (m_lock)
|
|
{
|
|
if (m_reconnectTimer == null)
|
|
{
|
|
return ReconnectState.Disposed;
|
|
}
|
|
return m_state;
|
|
}
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Cancel a reconnect in progress.
|
|
/// </summary>
|
|
public void CancelReconnect()
|
|
{
|
|
lock (m_lock)
|
|
{
|
|
if (m_reconnectTimer == null)
|
|
{
|
|
return;
|
|
}
|
|
|
|
if (m_state == ReconnectState.Triggered)
|
|
{
|
|
Session = null;
|
|
EnterReadyState();
|
|
return;
|
|
}
|
|
|
|
m_cancelReconnect = true;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Begins the reconnect process.
|
|
/// </summary>
|
|
public ReconnectState BeginReconnect(
|
|
ISession session,
|
|
int reconnectPeriod,
|
|
EventHandler callback)
|
|
{
|
|
return BeginReconnect(session, null, reconnectPeriod, callback);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Begins the reconnect process using a reverse connection.
|
|
/// </summary>
|
|
/// <exception cref="ServiceResultException">if the handler is
|
|
/// already disposed.</exception>
|
|
/// <exception cref="NotSupportedException">if <paramref name="session"/>
|
|
/// is not <see langword="null"/> and is not a <see cref="Session"/>
|
|
/// (or a type derived from it). <see cref="ManagedSession"/> and
|
|
/// other facade implementations of <see cref="ISession"/> drive
|
|
/// their own reconnect state machine and must not be passed
|
|
/// here.</exception>
|
|
public ReconnectState BeginReconnect(
|
|
ISession session,
|
|
ReverseConnectManager? reverseConnectManager,
|
|
int reconnectPeriod,
|
|
EventHandler callback)
|
|
{
|
|
// The reconnect handler drives Session.ReconnectAsync /
|
|
// ISessionFactory.RecreateAsync directly and assumes it owns
|
|
// the session lifecycle. Facade sessions (e.g. ManagedSession)
|
|
// already run their own reconnect / failover state machine,
|
|
// so mixing them here would be incorrect. Allow null
|
|
// (cancellation) and require Session-derived instances
|
|
// otherwise.
|
|
// (Use the fully qualified type to disambiguate from the
|
|
// local Session property.)
|
|
if (session is not null and
|
|
not Client.Session)
|
|
{
|
|
throw new NotSupportedException(
|
|
"SessionReconnectHandler only supports the legacy " +
|
|
"Session class (or types derived from it). " +
|
|
"ManagedSession and other ISession facades manage " +
|
|
"their own reconnection — use ManagedSession / " +
|
|
"ManagedSessionFactory instead.");
|
|
}
|
|
|
|
lock (m_lock)
|
|
{
|
|
if (m_reconnectTimer == null)
|
|
{
|
|
throw new ServiceResultException(StatusCodes.BadInvalidState);
|
|
}
|
|
|
|
// cancel reconnect requested, if possible
|
|
if (session == null)
|
|
{
|
|
if (m_state == ReconnectState.Triggered)
|
|
{
|
|
Session = null;
|
|
EnterReadyState();
|
|
return m_state;
|
|
}
|
|
// reconnect already in progress, schedule cancel
|
|
m_cancelReconnect = true;
|
|
return m_state;
|
|
}
|
|
|
|
// set reconnect period within boundaries
|
|
reconnectPeriod = CheckedReconnectPeriod(reconnectPeriod);
|
|
|
|
// ignore subsequent trigger requests
|
|
if (m_state == ReconnectState.Ready)
|
|
{
|
|
Session = session;
|
|
m_baseReconnectPeriod = reconnectPeriod;
|
|
m_reconnectFailed = false;
|
|
m_cancelReconnect = false;
|
|
m_callback = callback;
|
|
m_reverseConnectManager = reverseConnectManager;
|
|
m_reconnectTimer.Change(
|
|
TimeSpan.FromMilliseconds(JitteredReconnectPeriod(reconnectPeriod)),
|
|
Timeout.InfiniteTimeSpan);
|
|
m_reconnectPeriod = CheckedReconnectPeriod(reconnectPeriod, true);
|
|
m_state = ReconnectState.Triggered;
|
|
return m_state;
|
|
}
|
|
|
|
// if triggered, reset timer only if requested reconnect period is shorter
|
|
if (m_state == ReconnectState.Triggered && reconnectPeriod < m_baseReconnectPeriod)
|
|
{
|
|
m_baseReconnectPeriod = reconnectPeriod;
|
|
m_reconnectTimer.Change(
|
|
TimeSpan.FromMilliseconds(JitteredReconnectPeriod(reconnectPeriod)),
|
|
Timeout.InfiniteTimeSpan);
|
|
m_reconnectPeriod = CheckedReconnectPeriod(reconnectPeriod, true);
|
|
}
|
|
|
|
return m_state;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Returns the reconnect period with a random jitter.
|
|
/// </summary>
|
|
public virtual int JitteredReconnectPeriod(int reconnectPeriod)
|
|
{
|
|
// The factors result in a jitter of 10%.
|
|
const int jitterResolution = 1000;
|
|
const int jitterFactor = 10;
|
|
int jitter = reconnectPeriod *
|
|
UnsecureRandom.Shared.Next(-jitterResolution, jitterResolution) /
|
|
(jitterResolution * jitterFactor);
|
|
return reconnectPeriod + jitter;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Returns the reconnect period within the min and max boundaries.
|
|
/// </summary>
|
|
public virtual int CheckedReconnectPeriod(
|
|
int reconnectPeriod,
|
|
bool exponentialBackoff = false)
|
|
{
|
|
// exponential backoff is controlled by m_maxReconnectPeriod
|
|
if (m_maxReconnectPeriod > MinReconnectPeriod)
|
|
{
|
|
if (exponentialBackoff)
|
|
{
|
|
reconnectPeriod *= 2;
|
|
}
|
|
return Math.Min(
|
|
Math.Max(reconnectPeriod, MinReconnectPeriod),
|
|
m_maxReconnectPeriod);
|
|
}
|
|
|
|
return Math.Max(reconnectPeriod, MinReconnectPeriod);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Called when the reconnect timer expires.
|
|
/// </summary>
|
|
private async void OnReconnectAsync(object? state)
|
|
{
|
|
long reconnectStartTimestamp = m_timeProvider.GetTimestamp();
|
|
try
|
|
{
|
|
// check for exit.
|
|
ISession? session = Session;
|
|
lock (m_lock)
|
|
{
|
|
if (m_reconnectTimer == null || session == null)
|
|
{
|
|
return;
|
|
}
|
|
if (m_state != ReconnectState.Triggered)
|
|
{
|
|
return;
|
|
}
|
|
// enter reconnecting state
|
|
m_state = ReconnectState.Reconnecting;
|
|
}
|
|
|
|
bool keepaliveRecovered = false;
|
|
|
|
// preserve legacy behavior if reconnectAbort is not set
|
|
if (m_reconnectAbort &&
|
|
session.Connected &&
|
|
!session.KeepAliveStopped)
|
|
{
|
|
keepaliveRecovered = true;
|
|
// breaking change, the callback must only assign the new
|
|
// session if the property is != null
|
|
m_logger.LogInformation(
|
|
"Reconnect {SessionId} aborted, KeepAlive recovered.",
|
|
session.SessionId);
|
|
Session = session = null;
|
|
}
|
|
else
|
|
{
|
|
m_logger.LogInformation("Reconnect {SessionId}.", session.SessionId);
|
|
}
|
|
|
|
// do the reconnect or recover state.
|
|
if (keepaliveRecovered || await DoReconnectAsync().ConfigureAwait(false))
|
|
{
|
|
lock (m_lock)
|
|
{
|
|
EnterReadyState();
|
|
}
|
|
|
|
// notify the caller.
|
|
m_callback?.Invoke(this, EventArgs.Empty);
|
|
|
|
return;
|
|
}
|
|
}
|
|
catch (Exception exception)
|
|
{
|
|
m_logger.LogError("Unexpected error during reconnect: {Message}", Redact.Create(exception));
|
|
}
|
|
|
|
// schedule the next reconnect.
|
|
lock (m_lock)
|
|
{
|
|
if (m_state != ReconnectState.Disposed)
|
|
{
|
|
if (m_cancelReconnect)
|
|
{
|
|
EnterReadyState();
|
|
}
|
|
else
|
|
{
|
|
int elapsed = (int)m_timeProvider
|
|
.GetElapsedTime(reconnectStartTimestamp).TotalMilliseconds;
|
|
m_logger.LogInformation(
|
|
"Reconnect period is {ReconnectPeriod} ms, {Elapsed} ms elapsed in reconnect.",
|
|
m_reconnectPeriod,
|
|
elapsed);
|
|
int adjustedReconnectPeriod = CheckedReconnectPeriod(
|
|
m_reconnectPeriod - elapsed);
|
|
adjustedReconnectPeriod = JitteredReconnectPeriod(adjustedReconnectPeriod);
|
|
m_reconnectTimer?.Change(TimeSpan.FromMilliseconds(adjustedReconnectPeriod), Timeout.InfiniteTimeSpan);
|
|
m_logger.LogInformation(
|
|
"Next adjusted reconnect scheduled in {ReconnectPeriod} ms.",
|
|
adjustedReconnectPeriod);
|
|
m_reconnectPeriod = CheckedReconnectPeriod(m_reconnectPeriod, true);
|
|
m_state = ReconnectState.Triggered;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Reconnects to the server.
|
|
/// </summary>
|
|
/// <exception cref="ServiceResultException"></exception>
|
|
private async Task<bool> DoReconnectAsync()
|
|
{
|
|
// helper to override operation timeout
|
|
ITransportChannel? transportChannel = null;
|
|
ISession current = Session ??
|
|
throw ServiceResultException.Unexpected("Session is null");
|
|
|
|
// try a reconnect.
|
|
if (!m_reconnectFailed)
|
|
{
|
|
try
|
|
{
|
|
if (m_reverseConnectManager != null)
|
|
{
|
|
string? endpointUrl = current.Endpoint.EndpointUrl
|
|
?? throw ServiceResultException.Unexpected(
|
|
"Endpoint Url is null for reverse connect session RECONNECT.");
|
|
ITransportWaitingConnection connection = await m_reverseConnectManager
|
|
.WaitForConnectionAsync(
|
|
new Uri(endpointUrl),
|
|
current.Endpoint.Server.ApplicationUri)
|
|
.ConfigureAwait(false);
|
|
|
|
await current.ReconnectAsync(connection).ConfigureAwait(false);
|
|
}
|
|
else
|
|
{
|
|
await current.ReconnectAsync().ConfigureAwait(false);
|
|
}
|
|
|
|
// monitored items should start updating on their own.
|
|
return true;
|
|
}
|
|
catch (Exception exception)
|
|
{
|
|
// recreate the session if it has been closed.
|
|
if (exception is ServiceResultException sre)
|
|
{
|
|
m_logger.LogWarning("Reconnect failed. Reason={Reason}.", sre.Result);
|
|
|
|
// check if the server endpoint could not be reached.
|
|
if (sre.StatusCode == StatusCodes.BadTcpInternalError ||
|
|
sre.StatusCode == StatusCodes.BadCommunicationError ||
|
|
sre.StatusCode == StatusCodes.BadNotConnected ||
|
|
sre.StatusCode == StatusCodes.BadRequestTimeout ||
|
|
sre.StatusCode == StatusCodes.BadTimeout ||
|
|
sre.StatusCode == StatusCodes.BadNoCommunication ||
|
|
sre.StatusCode == StatusCodes.BadConnectionClosed)
|
|
{
|
|
// check if reactivating is still an option.
|
|
int timeout =
|
|
Convert.ToInt32(current.SessionTimeout) -
|
|
(int)m_timeProvider.GetElapsedTime(
|
|
current.LastKeepAliveTimestamp).TotalMilliseconds;
|
|
if (timeout > 0)
|
|
{
|
|
m_logger.LogInformation(
|
|
"Retry to reactivate, est. session timeout in {Timeout} ms.",
|
|
timeout);
|
|
return false;
|
|
}
|
|
}
|
|
|
|
// check if the security configuration may have changed
|
|
if (sre.StatusCode == StatusCodes.BadSecurityChecksFailed ||
|
|
sre.StatusCode == StatusCodes.BadCertificateInvalid)
|
|
{
|
|
m_updateFromServer = true;
|
|
m_logger.LogInformation(
|
|
"Reconnect failed due to security check. Request endpoint update from server. {Message}",
|
|
sre.Message);
|
|
}
|
|
// recreate session immediately, use existing channel
|
|
else if (sre.StatusCode == StatusCodes.BadSessionIdInvalid)
|
|
{
|
|
transportChannel = Session.NullableTransportChannel;
|
|
Session.DetachChannel();
|
|
}
|
|
else
|
|
{
|
|
// wait for next scheduled reconnect if connection failed,
|
|
// next attempt is to recreate session
|
|
m_reconnectFailed = true;
|
|
return false;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
m_logger.LogError(exception, "Reconnect failed.");
|
|
}
|
|
|
|
m_reconnectFailed = true;
|
|
}
|
|
}
|
|
|
|
// re-create the session.
|
|
try
|
|
{
|
|
ISession session;
|
|
if (m_reverseConnectManager != null)
|
|
{
|
|
ITransportWaitingConnection? connection;
|
|
do
|
|
{
|
|
EndpointDescription? endpointDescription =
|
|
current.Endpoint ?? transportChannel?.EndpointDescription;
|
|
string? endpointUrl = endpointDescription?.EndpointUrl
|
|
?? throw ServiceResultException.Unexpected(
|
|
"Endpoint Url is null for reverse connect session RECREATE.");
|
|
connection = await m_reverseConnectManager
|
|
.WaitForConnectionAsync(
|
|
new Uri(endpointUrl),
|
|
endpointDescription?.Server?.ApplicationUri)
|
|
.ConfigureAwait(false);
|
|
|
|
if (m_updateFromServer)
|
|
{
|
|
await UpdateEndpointFromServerAsync(
|
|
current.ConfiguredEndpoint,
|
|
connection).ConfigureAwait(false);
|
|
m_updateFromServer = false;
|
|
connection = null;
|
|
}
|
|
} while (connection == null);
|
|
|
|
session = await current.SessionFactory.RecreateAsync(current, connection)
|
|
.ConfigureAwait(false);
|
|
}
|
|
else
|
|
{
|
|
if (m_updateFromServer)
|
|
{
|
|
await UpdateEndpointFromServerAsync(
|
|
current.ConfiguredEndpoint).ConfigureAwait(false);
|
|
m_updateFromServer = false;
|
|
}
|
|
session = transportChannel == null
|
|
? await current
|
|
.SessionFactory.RecreateAsync(current)
|
|
.ConfigureAwait(false)
|
|
: await current
|
|
.SessionFactory.RecreateAsync(current, transportChannel)
|
|
.ConfigureAwait(false);
|
|
}
|
|
// note: the template session is not connected at this point
|
|
// and must be disposed by the owner
|
|
Session = session;
|
|
return true;
|
|
}
|
|
catch (ServiceResultException sre)
|
|
{
|
|
if (sre.InnerResult?.StatusCode == StatusCodes.BadSecureChannelClosed ||
|
|
sre.InnerResult?.StatusCode == StatusCodes.BadSecurityChecksFailed ||
|
|
sre.InnerResult?.StatusCode == StatusCodes.BadCertificateInvalid)
|
|
{
|
|
// schedule a fast endpoint update and retry
|
|
if (m_maxReconnectPeriod > MinReconnectPeriod &&
|
|
m_reconnectPeriod >= m_maxReconnectPeriod)
|
|
{
|
|
m_reconnectPeriod = m_baseReconnectPeriod;
|
|
}
|
|
m_logger.LogError(
|
|
"Could not reconnect due to failed security check. Request endpoint update from server. {Message}",
|
|
Redact.Create(sre));
|
|
}
|
|
else
|
|
{
|
|
m_logger.LogError(
|
|
"Could not reconnect the Session. Request endpoint update from server. {Message}",
|
|
Redact.Create(sre));
|
|
}
|
|
m_updateFromServer = true;
|
|
return false;
|
|
}
|
|
catch (Exception exception)
|
|
{
|
|
m_logger.LogError("Could not reconnect the Session. {ErrorMessage}", Redact.Create(exception));
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Updates the configured endpoint from the server discovery endpoint.
|
|
/// Falls back to the best available endpoint if the original security
|
|
/// configuration is no longer supported by the server.
|
|
/// </summary>
|
|
/// <param name="endpoint">The configured endpoint to update.</param>
|
|
/// <param name="connection">The optional transport connection for reverse connect.</param>
|
|
protected virtual async Task UpdateEndpointFromServerAsync(
|
|
ConfiguredEndpoint endpoint,
|
|
ITransportWaitingConnection? connection = null)
|
|
{
|
|
// EndpointUrl and SecurityPolicyUri are nullable on ConfiguredEndpoint but every
|
|
// session entering reconnect was created with both values populated, so the
|
|
// bangs reflect that lifecycle invariant. The null! arguments in the catch block
|
|
// are intentional sentinels for "no security policy" passed to the modern API
|
|
// which retains a non-nullable parameter for backward compatibility.
|
|
try
|
|
{
|
|
if (connection != null)
|
|
{
|
|
await endpoint
|
|
.UpdateFromServerAsync(
|
|
endpoint.EndpointUrl!,
|
|
connection,
|
|
endpoint.Description.SecurityMode,
|
|
endpoint.Description.SecurityPolicyUri!,
|
|
m_telemetry)
|
|
.ConfigureAwait(false);
|
|
}
|
|
else
|
|
{
|
|
await endpoint
|
|
.UpdateFromServerAsync(
|
|
endpoint.EndpointUrl!,
|
|
endpoint.Description.SecurityMode,
|
|
endpoint.Description.SecurityPolicyUri!,
|
|
m_telemetry)
|
|
.ConfigureAwait(false);
|
|
}
|
|
}
|
|
catch (ServiceResultException sre) when (
|
|
sre.StatusCode == StatusCodes.BadSecurityPolicyRejected ||
|
|
sre.StatusCode == StatusCodes.BadSecurityModeRejected)
|
|
{
|
|
// The original endpoint security configuration is no longer available on the server.
|
|
// Fall back to the best available endpoint without security constraints.
|
|
m_logger.LogWarning(
|
|
"Original endpoint security configuration not available on server, falling back to best available endpoint. {Message}",
|
|
sre.Message);
|
|
if (connection != null)
|
|
{
|
|
await endpoint
|
|
.UpdateFromServerAsync(
|
|
endpoint.EndpointUrl!,
|
|
connection,
|
|
MessageSecurityMode.Invalid,
|
|
null!,
|
|
m_telemetry)
|
|
.ConfigureAwait(false);
|
|
}
|
|
else
|
|
{
|
|
await endpoint
|
|
.UpdateFromServerAsync(
|
|
endpoint.EndpointUrl!,
|
|
MessageSecurityMode.Invalid,
|
|
null!,
|
|
m_telemetry)
|
|
.ConfigureAwait(false);
|
|
}
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Reset the timer and enter ready state.
|
|
/// </summary>
|
|
private void EnterReadyState()
|
|
{
|
|
m_reconnectTimer?.Change(Timeout.InfiniteTimeSpan, Timeout.InfiniteTimeSpan);
|
|
m_state = ReconnectState.Ready;
|
|
m_cancelReconnect = false;
|
|
m_updateFromServer = false;
|
|
}
|
|
|
|
private readonly ITelemetryContext m_telemetry;
|
|
private readonly Lock m_lock = new();
|
|
private ReconnectState m_state;
|
|
private bool m_reconnectFailed;
|
|
private readonly ILogger m_logger;
|
|
private readonly bool m_reconnectAbort;
|
|
private bool m_cancelReconnect;
|
|
private bool m_updateFromServer;
|
|
private int m_reconnectPeriod;
|
|
private int m_baseReconnectPeriod;
|
|
private readonly int m_maxReconnectPeriod;
|
|
private ITimer? m_reconnectTimer;
|
|
private readonly TimeProvider m_timeProvider;
|
|
private EventHandler? m_callback;
|
|
private ReverseConnectManager? m_reverseConnectManager;
|
|
}
|
|
}
|