refactoring

Author: lucasteles

Directory.Build.props

@@ -58,7 +58,7 @@
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="SonarAnalyzer.CSharp" Version="10.22.*">
+    <PackageReference Include="SonarAnalyzer.CSharp" Version="10.24.*">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>

samples/LobbyServer

@@ -0,0 +1,50 @@
+using Backdash.Options;
+using Timer = System.Timers.Timer;
+
+namespace Backdash.Network;
+
+sealed class ConnectionTimers(ProtocolOptions options) : IDisposable
+{
+    public readonly Timer QualityReport = new(options.QualityReportInterval);
+    public readonly Timer NetworkStats = new(options.NetworkPackageStatsInterval);
+    public readonly Timer KeepAlive = new(options.KeepAliveInterval);
+    public readonly Timer ResendInputs = new(options.ResendInputInterval);
+    public readonly Timer ConsistencyCheck = new(options.ConsistencyCheckInterval);
+
+    public void Dispose()
+    {
+        Stop();
+
+        KeepAlive.Dispose();
+        ResendInputs.Dispose();
+        QualityReport.Dispose();
+        NetworkStats.Dispose();
+        ConsistencyCheck.Dispose();
+    }
+
+    public void Start()
+    {
+        KeepAlive.Start();
+        QualityReport.Start();
+        ResendInputs.Start();
+
+        if (options.IsNetworkPackageStatsEnabled())
+            NetworkStats.Start();
+
+        if (options.IsConsistencyCheckEnabled())
+            ConsistencyCheck.Start();
+    }
+
+    public void Stop()
+    {
+        KeepAlive.Stop();
+        QualityReport.Stop();
+        ResendInputs.Stop();
+
+        if (options.IsNetworkPackageStatsEnabled())
+            NetworkStats.Stop();
+
+        if (options.IsConsistencyCheckEnabled())
+            ConsistencyCheck.Stop();
+    }
+}

src/Backdash/Network/ConnectionTimers.cs

@@ -10,7 +10,6 @@
 using Backdash.Synchronizing;
 using Backdash.Synchronizing.Input;
 using Backdash.Synchronizing.State;
-using Timer = System.Timers.Timer;
 
 namespace Backdash.Network;
 
@@ -27,11 +26,7 @@ sealed class PeerConnection<TInput> : IDisposable where TInput : unmanaged
     readonly ProtocolInputBuffer<TInput> inputBuffer;
     readonly ChecksumStore checksumStore;
 
-    readonly Timer qualityReportTimer;
-    readonly Timer networkStatsTimer;
-    readonly Timer keepAliveTimer;
-    readonly Timer resendInputsTimer;
-    readonly Timer consistencyCheckTimer;
+    readonly ConnectionTimers timers;
     readonly bool disconnectCheckEnabled;
     long startedAt;
 
@@ -58,24 +53,16 @@ ChecksumStore checksumStore
         this.outbox = outbox;
         this.inputBuffer = inputBuffer;
         this.checksumStore = checksumStore;
+        timers = new(options);
         disconnectCheckEnabled = options.IsDisconnectTimeoutEnabled();
 
-        keepAliveTimer = new(options.KeepAliveInterval);
-        keepAliveTimer.Elapsed += OnKeepAliveTick;
+        timers.KeepAlive.Elapsed += OnKeepAliveTick;
+        timers.ResendInputs.Elapsed += OnResendInputs;
+        timers.QualityReport.Elapsed += OnQualityReportTick;
+        timers.NetworkStats.Elapsed += OnNetworkStatsTick;
+        timers.ConsistencyCheck.Elapsed += OnConsistencyCheck;
 
-        resendInputsTimer = new(options.ResendInputInterval);
-        resendInputsTimer.Elapsed += OnResendInputs;
-
-        qualityReportTimer = new(options.QualityReportInterval);
-        qualityReportTimer.Elapsed += OnQualityReportTick;
-
-        networkStatsTimer = new(options.NetworkPackageStatsInterval);
-        networkStatsTimer.Elapsed += OnNetworkStatsTick;
-
-        consistencyCheckTimer = new(options.ConsistencyCheckInterval);
-        consistencyCheckTimer.Elapsed += OnConsistencyCheck;
-
-        state.StoppingToken.Register(StopTimers);
+        state.StoppingToken.Register(timers.Stop);
     }
 
     public void Dispose()
@@ -84,46 +71,14 @@ public void Dispose()
         if (!state.StoppingTokenSource.IsCancellationRequested)
             state.StoppingTokenSource.Cancel();
 
-        StopTimers();
+        timers.Stop();
         DispatchDisconnectEvent();
-
-        keepAliveTimer.Elapsed -= OnKeepAliveTick;
-        resendInputsTimer.Elapsed -= OnKeepAliveTick;
-        qualityReportTimer.Elapsed -= OnQualityReportTick;
-        networkStatsTimer.Elapsed -= OnNetworkStatsTick;
-        consistencyCheckTimer.Elapsed -= OnConsistencyCheck;
-
-        keepAliveTimer.Dispose();
-        resendInputsTimer.Dispose();
-        qualityReportTimer.Dispose();
-        networkStatsTimer.Dispose();
-        consistencyCheckTimer.Dispose();
-    }
-
-    void StartTimers()
-    {
-        keepAliveTimer.Start();
-        qualityReportTimer.Start();
-        resendInputsTimer.Start();
-
-        if (options.IsNetworkPackageStatsEnabled())
-            networkStatsTimer.Start();
-
-        if (options.IsConsistencyCheckEnabled())
-            consistencyCheckTimer.Start();
-    }
-
-    void StopTimers()
-    {
-        keepAliveTimer.Stop();
-        qualityReportTimer.Stop();
-        resendInputsTimer.Stop();
-
-        if (options.IsNetworkPackageStatsEnabled())
-            networkStatsTimer.Stop();
-
-        if (options.IsConsistencyCheckEnabled())
-            consistencyCheckTimer.Stop();
+        timers.KeepAlive.Elapsed -= OnKeepAliveTick;
+        timers.ResendInputs.Elapsed -= OnKeepAliveTick;
+        timers.QualityReport.Elapsed -= OnQualityReportTick;
+        timers.NetworkStats.Elapsed -= OnNetworkStatsTick;
+        timers.ConsistencyCheck.Elapsed -= OnConsistencyCheck;
+        timers.Dispose();
     }
 
     public void Disconnect()
@@ -149,7 +104,7 @@ public void Disconnect()
     public void Start()
     {
         if (startedAt is 0)
-            StartTimers();
+            timers.Start();
 
         startedAt = Stopwatch.GetTimestamp();
     }
@@ -260,41 +215,34 @@ void CheckDisconnection()
         }
     }
 
-    readonly object eventLocker = new();
 
     bool DispatchInterruptedEvent(TimeSpan timeout)
     {
-        lock (eventLocker)
-        {
-            if (state.Connection is not { DisconnectNotifySent: false, DisconnectEventSent: false })
-                return false;
+        if (state.Connection is not { DisconnectNotifySent: false, DisconnectEventSent: false })
+            return false;
 
-            networkEventHandler.OnNetworkEvent(state.Player, new(PeerEvent.ConnectionInterrupted)
+        networkEventHandler.OnNetworkEvent(state.Player, new(PeerEvent.ConnectionInterrupted)
+        {
+            ConnectionInterrupted = new()
             {
-                ConnectionInterrupted = new()
-                {
-                    DisconnectTimeout = timeout,
-                },
-            });
+                DisconnectTimeout = timeout,
+            },
+        });
 
-            state.Connection.DisconnectNotifySent = true;
+        state.Connection.DisconnectNotifySent = true;
 
-            return true;
-        }
+        return true;
     }
 
     bool DispatchDisconnectEvent()
     {
-        lock (eventLocker)
-        {
-            if (state.Connection.DisconnectEventSent)
-                return false;
+        if (state.Connection.DisconnectEventSent)
+            return false;
 
-            state.Connection.DisconnectEventSent = true;
-            networkEventHandler.OnNetworkEvent(PeerEvent.Disconnected, state.Player);
+        state.Connection.DisconnectEventSent = true;
+        networkEventHandler.OnNetworkEvent(PeerEvent.Disconnected, state.Player);
 
-            return true;
-        }
+        return true;
     }
 
     void OnKeepAliveTick(object? sender, ElapsedEventArgs e)

src/Backdash/Network/PeerConnection.cs

@@ -319,7 +319,8 @@ bool OnConsistencyCheckReply(ref readonly ProtocolMessage message, ref ProtocolM
 
         if (state.Consistency.AskedFrame != checkFrame || localChecksum.IsEmpty || checksum.IsEmpty)
         {
-            logger.Write(LogLevel.Warning, $"Unable to find reply local checksum #{checksum} for {checkFrame}");
+            logger.Write(LogLevel.Warning,
+                $"Unable to find reply local checksum #{checksum} for {checkFrame} [last: {checksumStore.LastFrame()}]");
             return false;
         }
 

src/Backdash/Network/Protocol/Comm/ProtocolInbox.cs

@@ -6,7 +6,7 @@
 
 namespace Backdash.Network.Protocol;
 
-sealed class ProtocolClientFactory(
+sealed class PeerClientFactory(
     NetcodeOptions options,
     IPeerSocketFactory socketFactory,
     Logger logger,

…etwork/Protocol/ProtocolClientFactory.cs …sh/Network/Protocol/PeerClientFactory.cssrc/Backdash/Network/Protocol/ProtocolClientFactory.cs renamed to src/Backdash/Network/Protocol/PeerClientFactory.cs src/Backdash/Network/Protocol/ProtocolClientFactory.cs renamed to src/Backdash/Network/Protocol/PeerClientFactory.cs

@@ -177,15 +177,15 @@ internal bool IsNetworkPackageStatsEnabled() =>
     ///     On each interval one peer requests a frame to other peer which must respond
     ///     with the state checksum of that frame.
     /// </summary>
-    /// <value>Defaults to <c>3_000</c> milliseconds</value>
+    /// <value>Defaults to <c>1</c> second</value>
     /// <seealso cref="ConsistencyCheckDistance" />
     /// <seealso cref="ConsistencyCheckTimeout" />
-    public TimeSpan ConsistencyCheckInterval { get; set; } = TimeSpan.FromSeconds(3);
+    public TimeSpan ConsistencyCheckInterval { get; set; } = TimeSpan.FromSeconds(1);
 
     /// <summary>
     ///     The number of checksum frames that will be keep for consistency checks.
     /// </summary>
-    /// <value>Defaults to <c>180</c></value>
+    /// <value>Defaults to <c>250</c></value>
     /// <seealso cref="ConsistencyCheckTimeout" />
     /// <seealso cref="ConsistencyCheckInterval" />
     public int ConsistencyCheckStoreSize { get; set; } = 250;
@@ -203,11 +203,10 @@ internal bool IsConsistencyCheckEnabled() =>
     /// <summary>
     ///     Max wait time for non-success consistency checks (0 to disable).
     /// </summary>
-    /// <value>Defaults to <c>10_000</c> milliseconds</value>
+    /// <value>Defaults to <c>10</c> seconds</value>
     /// <seealso cref="ConsistencyCheckDistance" />
     /// <seealso cref="ConsistencyCheckInterval" />
-    public TimeSpan ConsistencyCheckTimeout { get; set; } =
-        TimeSpan.FromMilliseconds(10_000);
+    public TimeSpan ConsistencyCheckTimeout { get; set; } = TimeSpan.FromSeconds(10);
 
     /// <summary>
     ///     Custom receive socket address size

src/Backdash/Options/ProtocolOptions.cs

@@ -100,7 +100,7 @@ SessionServices<TInput> services
             inputListener = new MemoryInputListener<TInput>(inputListener);
 
 
-        udp = services.ProtocolClientFactory.CreateClient(options.LocalPort, peerObservers);
+        udp = services.PeerClientFactory.CreateClient(options.LocalPort, peerObservers);
 
         peerConnectionFactory = new(
             networkEventQueue,

src/Backdash/Session/Backends/RemoteSession.cs

@@ -76,7 +76,7 @@ SessionServices<TInput> services
         inputs = new GameInput<ConfirmedInputs<TInput>>[options.SpectatorInputBufferLength];
         callbacks = services.SessionHandler;
         endianness = options.GetEndiannessNumberStateSerializer();
-        udp = services.ProtocolClientFactory.CreateClient(options.LocalPort, peerObservers);
+        udp = services.PeerClientFactory.CreateClient(options.LocalPort, peerObservers);
         ConfigureJobs(services);
 
         var magicNumber = services.Random.SyncNumber();

src/Backdash/Session/Backends/SpectatorSession.cs

@@ -16,7 +16,7 @@ sealed class SessionServices<TInput> where TInput : unmanaged
     public IChecksumProvider ChecksumProvider { get; }
     public Logger Logger { get; }
     public NetcodeJobManager JobManager { get; }
-    public ProtocolClientFactory ProtocolClientFactory { get; }
+    public PeerClientFactory PeerClientFactory { get; }
     public IStateStore StateStore { get; }
     public ChecksumStore ChecksumStore { get; }
     public IRandomNumberGenerator Random { get; }
@@ -60,7 +60,7 @@ public SessionServices(
         SessionHandler = services?.SessionHandler ?? new EmptySessionHandler(Logger);
 
         var socketFactory = services?.PeerSocketFactory ?? new PeerSocketFactory();
-        ProtocolClientFactory = new(options, socketFactory, Logger, LatencyStrategy);
+        PeerClientFactory = new(options, socketFactory, Logger, LatencyStrategy);
         Jobs = services?.Jobs.ToArray() ?? [];
         PluginManager = new(Logger, services?.Plugin);
     }