chore: move away from persisted device list

Author: andrewbabbittdev

src/ChromaControl.SDK.OpenRGB.Sample/Worker.cs

@@ -13,7 +13,7 @@ namespace ChromaControl.SDK.OpenRGB.Sample;
 /// </summary>
 public partial class Worker : BackgroundService
 {
-    private bool _devicesReady;
+    private IReadOnlyList<OpenRGBDevice> _devices = [];
 
     private readonly ILogger<Worker> _logger;
     private readonly IOpenRGBService _service;
@@ -41,7 +41,7 @@ protected override async Task ExecuteAsync(CancellationToken stoppingToken)
 
         while (!stoppingToken.IsCancellationRequested)
         {
-            if (!_devicesReady)
+            if (_devices.Count == 0)
             {
                 await Task.Delay(1000, stoppingToken);
                 continue;
@@ -62,7 +62,7 @@ protected override async Task ExecuteAsync(CancellationToken stoppingToken)
 
             LogColorChangeMessage(_logger, currentColor.R, currentColor.G, currentColor.B);
 
-            foreach (var device in _service.Devices)
+            foreach (var device in _devices)
             {
                 var buffer = device.CreateColorBuffer();
 
@@ -77,6 +77,6 @@ protected override async Task ExecuteAsync(CancellationToken stoppingToken)
 
     private void OnDeviceListUpdated(object? sender, IReadOnlyList<OpenRGBDevice> e)
     {
-        _devicesReady = true;
+        _devices = e;
     }
 }

src/ChromaControl.SDK.OpenRGB/IOpenRGBService.cs

@@ -3,7 +3,6 @@
 // See the LICENSE file in the project root for more information.
 
 using ChromaControl.SDK.OpenRGB.Structs;
-using System.Collections.Immutable;
 using System.Drawing;
 using System.Text.Json.Nodes;
 
@@ -25,12 +24,7 @@ public interface IOpenRGBService
     event EventHandler<bool>? StartedChanged;
 
     /// <summary>
-    /// The devices available in OpenRGB.
-    /// </summary>
-    public ImmutableList<OpenRGBDevice> Devices { get; }
-
-    /// <summary>
-    /// Occurs when the <see cref="Devices"/> is updated.
+    /// Occurs when the device list is updated.
     /// </summary>
     event EventHandler<IReadOnlyList<OpenRGBDevice>>? DeviceListUpdated;
 
@@ -48,11 +42,11 @@ public interface IOpenRGBService
     Task Restart(CancellationToken cancellationToken = default);
 
     /// <summary>
-    /// Updates the device list.
+    /// Gets the device list.
     /// </summary>
     /// <param name="cancellationToken">A <see cref="CancellationToken"/>.</param>
     /// <returns>A <see cref="Task"/>.</returns>
-    Task UpdateDeviceListAsync(CancellationToken cancellationToken = default);
+    Task<IReadOnlyList<OpenRGBDevice>> GetDeviceListAsync(CancellationToken cancellationToken = default);
 
     /// <summary>
     /// Resizes a zone.

src/ChromaControl.SDK.OpenRGB/OpenRGBService.cs

@@ -4,8 +4,6 @@
 
 using ChromaControl.SDK.OpenRGB.Internal;
 using ChromaControl.SDK.OpenRGB.Structs;
-using System.Collections.Concurrent;
-using System.Collections.Immutable;
 using System.Drawing;
 using System.Text.Json.Nodes;
 
@@ -15,7 +13,6 @@ namespace ChromaControl.SDK.OpenRGB;
 public class OpenRGBService : IOpenRGBService, IAsyncDisposable
 {
     private NativeOpenRGBService _service;
-    private BlockingCollection<OpenRGBDevice> _devices;
     private readonly OpenRGBManager _manager;
 
     /// <inheritdoc/>
@@ -24,9 +21,6 @@ public class OpenRGBService : IOpenRGBService, IAsyncDisposable
     /// <inheritdoc/>
     public event EventHandler<bool>? StartedChanged;
 
-    /// <inheritdoc/>
-    public ImmutableList<OpenRGBDevice> Devices => [.. _devices];
-
     /// <inheritdoc/>
     public event EventHandler<IReadOnlyList<OpenRGBDevice>>? DeviceListUpdated;
 
@@ -37,7 +31,6 @@ public OpenRGBService()
     {
         _manager = new();
         _service = new();
-        _devices = [];
 
         _service.DeviceListUpdated += OnDeviceListUpdated;
     }
@@ -61,32 +54,27 @@ public async Task Restart(CancellationToken cancellationToken = default)
             _service = new();
             _service.DeviceListUpdated += OnDeviceListUpdated;
 
-            _devices = [];
-
             _manager.Stop();
 
             await StartServiceAsync(cancellationToken);
         }
     }
 
     /// <inheritdoc/>
-    public async Task UpdateDeviceListAsync(CancellationToken cancellationToken = default)
+    public async Task<IReadOnlyList<OpenRGBDevice>> GetDeviceListAsync(CancellationToken cancellationToken = default)
     {
-        while (_devices.Count > 0)
-        {
-            _devices.TryTake(out _);
-        }
+        var result = new List<OpenRGBDevice>();
 
         var controllerCountResult = await _service.RequestControllerCountAsync(cancellationToken);
 
         for (uint i = 0; i < controllerCountResult.Count; i++)
         {
             var controllerDataResult = await _service.RequestControllerDataAsync(i, cancellationToken);
 
-            _devices.Add(controllerDataResult.Device, cancellationToken);
+            result.Add(controllerDataResult.Device);
         }
 
-        DeviceListUpdated?.Invoke(this, Devices);
+        return result;
     }
 
     /// <inheritdoc/>
@@ -243,7 +231,8 @@ internal async Task StopServiceAsync()
 
     private async void OnDeviceListUpdated(object? sender, EventArgs e)
     {
-        await UpdateDeviceListAsync();
+        var devices = await GetDeviceListAsync();
+        DeviceListUpdated?.Invoke(this, devices);
 
         Started = true;
         StartedChanged?.Invoke(this, Started);