Merge pull request #303 from DarthAffe/DeviceExceptionHandling

Added exception-handling to all UpdateQueues

RGB.NET.Core/Devices/AbstractRGBDeviceProvider.cs

@@ -178,7 +178,7 @@ public abstract class AbstractRGBDeviceProvider : IRGBDeviceProvider
     /// </summary>
     /// <param name="ex">The exception to throw.</param>
     /// <param name="isCritical">Indicates if the exception is critical for device provider to work correctly.</param>
-    protected virtual void Throw(Exception ex, bool isCritical = false)
+    public virtual void Throw(Exception ex, bool isCritical = false)
     {
         ExceptionEventArgs args = new(ex, isCritical, ThrowsExceptions);
         try { OnException(args); } catch { /* we don't want to throw due to bad event handlers */ }

RGB.NET.Core/Devices/IRGBDeviceProvider.cs

@@ -20,6 +20,10 @@ public interface IRGBDeviceProvider : IDisposable
     /// <summary>
     /// Indicates if exceptions in the device provider are thrown or silently ignored.
     /// </summary>
+    /// <remarks>
+    /// This should only be set to <c>true</c> for debugging/development purposes.
+    /// Production code should use the <see cref="Exception"/>-Event to handle exceptions.
+    /// </remarks>
     bool ThrowsExceptions { get; }
 
     /// <summary>

RGB.NET.Devices.Asus/Generic/AsusUpdateQueue.cs

@@ -89,8 +89,9 @@ public class AsusUpdateQueue : UpdateQueue
 
             Device.Apply();
         }
-        catch
+        catch (Exception ex)
-        { /* "The server threw an exception." seems to be a thing here ... */
+        {
+            AsusDeviceProvider.Instance.Throw(ex, true);
         }
     }
 

RGB.NET.Devices.CoolerMaster/Generic/CoolerMasterUpdateQueue.cs

@@ -39,13 +39,20 @@ public class CoolerMasterUpdateQueue : UpdateQueue
     /// <inheritdoc />
     protected override void Update(in ReadOnlySpan<(object key, Color color)> dataSet)
     {
-        foreach ((object key, Color color) in dataSet)
+        try
         {
-            (int row, int column) = ((int, int))key;
+            foreach ((object key, Color color) in dataSet)
-            _deviceMatrix.KeyColor[row, column] = new _CoolerMasterKeyColor(color.GetR(), color.GetG(), color.GetB());
+            {
-        }
+                (int row, int column) = ((int, int))key;
+                _deviceMatrix.KeyColor[row, column] = new _CoolerMasterKeyColor(color.GetR(), color.GetG(), color.GetB());
+            }
 
-        _CoolerMasterSDK.SetAllLedColor(_deviceMatrix, _deviceIndex);
+            _CoolerMasterSDK.SetAllLedColor(_deviceMatrix, _deviceIndex);
+        }
+        catch (Exception ex)
+        {
+            CoolerMasterDeviceProvider.Instance.Throw(ex, true);
+        }
     }
 
     #endregion

RGB.NET.Devices.Corsair/CorsairDeviceProvider.cs

@@ -50,6 +50,26 @@ public class CorsairDeviceProvider : AbstractRGBDeviceProvider
     /// </summary>
     public CorsairSessionDetails SessionDetails { get; private set; } = new();
 
+    private CorsairSessionState _sessionState = CorsairSessionState.Invalid;
+    public CorsairSessionState SessionState
+    {
+        get => _sessionState;
+        private set
+        {
+            _sessionState = value;
+
+            try { SessionStateChanged?.Invoke(this, SessionState); }
+            catch { /* catch faulty event-handlers*/ }
+        }
+    }
+
+    #endregion
+
+    #region Events
+
+    // ReSharper disable once UnassignedField.Global
+    public EventHandler<CorsairSessionState>? SessionStateChanged;
+
     #endregion
 
     #region Constructors
@@ -74,7 +94,7 @@ public class CorsairDeviceProvider : AbstractRGBDeviceProvider
 
         using ManualResetEventSlim waitEvent = new(false);
 
-        void OnSessionStateChanged(object? sender, CorsairSessionState state)
+        void OnInitializeSessionStateChanged(object? sender, CorsairSessionState state)
         {
             if (state == CorsairSessionState.Connected)
                 // ReSharper disable once AccessToDisposedClosure
@@ -84,6 +104,7 @@ public class CorsairDeviceProvider : AbstractRGBDeviceProvider
         try
         {
             _CUESDK.SessionStateChanged += OnSessionStateChanged;
+            _CUESDK.SessionStateChanged += OnInitializeSessionStateChanged;
 
             CorsairError errorCode = _CUESDK.CorsairConnect();
             if (errorCode != CorsairError.Success)
@@ -100,10 +121,12 @@ public class CorsairDeviceProvider : AbstractRGBDeviceProvider
         }
         finally
         {
-            _CUESDK.SessionStateChanged -= OnSessionStateChanged;
+            _CUESDK.SessionStateChanged -= OnInitializeSessionStateChanged;
         }
     }
 
+    private void OnSessionStateChanged(object? sender, CorsairSessionState state) => SessionState = state;
+
     /// <inheritdoc />
     protected override IEnumerable<IRGBDevice> LoadDevices()
     {
@@ -129,7 +152,7 @@ public class CorsairDeviceProvider : AbstractRGBDeviceProvider
                 Throw(new RGBDeviceException($"Failed to take control of device '{device.id}'. (ErrorCode: {error})"));
 
             CorsairDeviceUpdateQueue updateQueue = new(GetUpdateTrigger(), device);
-            
+
             int channelLedCount = 0;
             for (int i = 0; i < device.channelCount; i++)
             {

RGB.NET.Devices.Corsair/Generic/CorsairDeviceUpdateQueue.cs

@@ -40,17 +40,24 @@ public class CorsairDeviceUpdateQueue : UpdateQueue
     /// <inheritdoc />
     protected override unsafe void Update(in ReadOnlySpan<(object key, Color color)> dataSet)
     {
-        Span<_CorsairLedColor> colors = new((void*)_colorPtr, dataSet.Length);
+        try
-        for (int i = 0; i < colors.Length; i++)
         {
-            (object id, Color color) = dataSet[i];
+            Span<_CorsairLedColor> colors = new((void*)_colorPtr, dataSet.Length);
-            (byte a, byte r, byte g, byte b) = color.GetRGBBytes();
+            for (int i = 0; i < colors.Length; i++)
-            colors[i] = new _CorsairLedColor((CorsairLedId)id, r, g, b, a);
+            {
-        }
+                (object id, Color color) = dataSet[i];
+                (byte a, byte r, byte g, byte b) = color.GetRGBBytes();
+                colors[i] = new _CorsairLedColor((CorsairLedId)id, r, g, b, a);
+            }
 
-        CorsairError error = _CUESDK.CorsairSetLedColors(_device.id!, dataSet.Length, _colorPtr);
+            CorsairError error = _CUESDK.CorsairSetLedColors(_device.id!, dataSet.Length, _colorPtr);
-        if (error != CorsairError.Success)
+            if (error != CorsairError.Success)
-            throw new RGBDeviceException($"Failed to update device '{_device.id}'. (ErrorCode: {error})");
+                throw new RGBDeviceException($"Failed to update device '{_device.id}'. (ErrorCode: {error})");
+        }
+        catch (Exception ex)
+        {
+            CorsairDeviceProvider.Instance.Throw(ex, true);
+        }
     }
 
     /// <inheritdoc />

RGB.NET.Devices.DMX/E131/E131UpdateQueue.cs

@@ -61,16 +61,23 @@ public class E131UpdateQueue : UpdateQueue
     /// <inheritdoc />
     protected override void Update(in ReadOnlySpan<(object key, Color color)> dataSet)
     {
-        DataPacket.SetSequenceNumber(GetNextSequenceNumber());
+        try
-
-        foreach ((object key, Color color) in dataSet)
         {
-            LedChannelMapping mapping = (LedChannelMapping)key;
+            DataPacket.SetSequenceNumber(GetNextSequenceNumber());
-            foreach ((int channel, Func<Color, byte> getValue) in mapping)
-                DataPacket.SetChannel(channel, getValue(color));
-        }
 
-        _socket.Send(DataPacket, DataPacket.Length);
+            foreach ((object key, Color color) in dataSet)
+            {
+                LedChannelMapping mapping = (LedChannelMapping)key;
+                foreach ((int channel, Func<Color, byte> getValue) in mapping)
+                    DataPacket.SetChannel(channel, getValue(color));
+            }
+
+            _socket.Send(DataPacket, DataPacket.Length);
+        }
+        catch (Exception ex)
+        {
+            DMXDeviceProvider.Instance.Throw(ex, true);
+        }
     }
 
     /// <summary>

RGB.NET.Devices.Logitech/PerDevice/LogitechPerDeviceUpdateQueue.cs

@@ -27,12 +27,19 @@ public class LogitechPerDeviceUpdateQueue : UpdateQueue
     /// <inheritdoc />
     protected override void Update(in ReadOnlySpan<(object key, Color color)> dataSet)
     {
-        Color color = dataSet[0].color;
+        try
+        {
+            Color color = dataSet[0].color;
 
-        _LogitechGSDK.LogiLedSetTargetDevice(LogitechDeviceCaps.DeviceRGB);
+            _LogitechGSDK.LogiLedSetTargetDevice(LogitechDeviceCaps.DeviceRGB);
-        _LogitechGSDK.LogiLedSetLighting((int)Math.Round(color.R * 100),
+            _LogitechGSDK.LogiLedSetLighting((int)Math.Round(color.R * 100),
-                                         (int)Math.Round(color.G * 100),
+                                             (int)Math.Round(color.G * 100),
-                                         (int)Math.Round(color.B * 100));
+                                             (int)Math.Round(color.B * 100));
+        }
+        catch (Exception ex)
+        {
+            LogitechDeviceProvider.Instance.Throw(ex, true);
+        }
     }
 
     #endregion

RGB.NET.Devices.Logitech/PerKey/LogitechPerKeyUpdateQueue.cs

@@ -27,16 +27,23 @@ public class LogitechPerKeyUpdateQueue : UpdateQueue
     /// <inheritdoc />
     protected override void Update(in ReadOnlySpan<(object key, Color color)> dataSet)
     {
-        _LogitechGSDK.LogiLedSetTargetDevice(LogitechDeviceCaps.PerKeyRGB);
+        try
-
-        foreach ((object key, Color color) in dataSet)
         {
-            // These will be LogitechLedId but the SDK expects an int and doesn't care about invalid values
+            _LogitechGSDK.LogiLedSetTargetDevice(LogitechDeviceCaps.PerKeyRGB);
-            int keyName = (int)key;
+
-            _LogitechGSDK.LogiLedSetLightingForKeyWithKeyName(keyName,
+            foreach ((object key, Color color) in dataSet)
-                                                              (int)MathF.Round(color.R * 100),
+            {
-                                                              (int)MathF.Round(color.G * 100),
+                // These will be LogitechLedId but the SDK expects an int and doesn't care about invalid values
-                                                              (int)MathF.Round(color.B * 100));
+                int keyName = (int)key;
+                _LogitechGSDK.LogiLedSetLightingForKeyWithKeyName(keyName,
+                                                                  (int)MathF.Round(color.R * 100),
+                                                                  (int)MathF.Round(color.G * 100),
+                                                                  (int)MathF.Round(color.B * 100));
+            }
+        }
+        catch (Exception ex)
+        {
+            LogitechDeviceProvider.Instance.Throw(ex, true);
         }
     }
 

RGB.NET.Devices.Msi/Generic/MsiDeviceUpdateQueue.cs

@@ -36,8 +36,15 @@ public class MsiDeviceUpdateQueue : UpdateQueue
     /// <inheritdoc />
     protected override void Update(in ReadOnlySpan<(object key, Color color)> dataSet)
     {
-        foreach ((object key, Color color) in dataSet)
+        try
-            _MsiSDK.SetLedColor(_deviceType, (int)key, color.GetR(), color.GetG(), color.GetB());
+        {
+            foreach ((object key, Color color) in dataSet)
+                _MsiSDK.SetLedColor(_deviceType, (int)key, color.GetR(), color.GetG(), color.GetB());
+        }
+        catch (Exception ex)
+        {
+            MsiDeviceProvider.Instance.Throw(ex, true);
+        }
     }
 
     #endregion

RGB.NET.Devices.Novation/Generic/MidiUpdateQueue.cs

@@ -37,8 +37,15 @@ public abstract class MidiUpdateQueue : UpdateQueue
     /// <inheritdoc />
     protected override void Update(in ReadOnlySpan<(object key, Color color)> dataSet)
     {
-        foreach ((object key, Color color) in dataSet)
+        try
-            SendMessage(CreateMessage(key, color));
+        {
+            foreach ((object key, Color color) in dataSet)
+                SendMessage(CreateMessage(key, color));
+        }
+        catch (Exception ex)
+        {
+            NovationDeviceProvider.Instance.Throw(ex, true);
+        }
     }
 
     /// <summary>

RGB.NET.Devices.OpenRGB/Generic/OpenRGBUpdateQueue.cs

@@ -51,10 +51,17 @@ public class OpenRGBUpdateQueue : UpdateQueue
     /// <inheritdoc />
     protected override void Update(in ReadOnlySpan<(object key, Color color)> dataSet)
     {
-        foreach ((object key, Color color) in dataSet)
+        try
-            _colors[(int)key] = new OpenRGBColor(color.GetR(), color.GetG(), color.GetB());
+        {
+            foreach ((object key, Color color) in dataSet)
+                _colors[(int)key] = new OpenRGBColor(color.GetR(), color.GetG(), color.GetB());
 
-        _openRGB.UpdateLeds(_deviceid, _colors);
+            _openRGB.UpdateLeds(_deviceid, _colors);
+        }
+        catch (Exception ex)
+        {
+            OpenRGBDeviceProvider.Instance.Throw(ex, true);
+        }
     }
 
     #endregion

RGB.NET.Devices.PicoPi/PicoPi/PicoPiBulkUpdateQueue.cs

@@ -46,20 +46,27 @@ public class PicoPiBulkUpdateQueue : UpdateQueue
     /// <inheritdoc />
     protected override void Update(in ReadOnlySpan<(object key, Color color)> dataSet)
     {
-        Span<byte> buffer = _dataBuffer;
+        try
-        foreach ((object key, Color color) in dataSet)
         {
-            int index = key as int? ?? -1;
+            Span<byte> buffer = _dataBuffer;
-            if (index < 0) continue;
+            foreach ((object key, Color color) in dataSet)
+            {
+                int index = key as int? ?? -1;
+                if (index < 0) continue;
 
-            (byte _, byte r, byte g, byte b) = color.GetRGBBytes();
+                (byte _, byte r, byte g, byte b) = color.GetRGBBytes();
-            int offset = index * 3;
+                int offset = index * 3;
-            buffer[offset] = r;
+                buffer[offset] = r;
-            buffer[offset + 1] = g;
+                buffer[offset + 1] = g;
-            buffer[offset + 2] = b;
+                buffer[offset + 2] = b;
+            }
+
+            _sdk.SendBulkUpdate(buffer, _channel);
+        }
+        catch (Exception ex)
+        {
+            PicoPiDeviceProvider.Instance.Throw(ex, true);
         }
-
-        _sdk.SendBulkUpdate(buffer, _channel);
     }
 
     #endregion

RGB.NET.Devices.PicoPi/PicoPi/PicoPiHIDUpdateQueue.cs

@@ -43,20 +43,27 @@ public class PicoPiHIDUpdateQueue : UpdateQueue
     /// <inheritdoc />
     protected override void Update(in ReadOnlySpan<(object key, Color color)> dataSet)
     {
-        Span<byte> buffer = _dataBuffer;
+        try
-        foreach ((object key, Color color) in dataSet)
         {
-            int index = key as int? ?? -1;
+            Span<byte> buffer = _dataBuffer;
-            if (index < 0) continue;
+            foreach ((object key, Color color) in dataSet)
+            {
+                int index = key as int? ?? -1;
+                if (index < 0) continue;
 
-            (byte _, byte r, byte g, byte b) = color.GetRGBBytes();
+                (byte _, byte r, byte g, byte b) = color.GetRGBBytes();
-            int offset = index * 3;
+                int offset = index * 3;
-            buffer[offset] = r;
+                buffer[offset] = r;
-            buffer[offset + 1] = g;
+                buffer[offset + 1] = g;
-            buffer[offset + 2] = b;
+                buffer[offset + 2] = b;
+            }
+
+            _sdk.SendHidUpdate(buffer, _channel);
+        }
+        catch (Exception ex)
+        {
+            PicoPiDeviceProvider.Instance.Throw(ex, true);
         }
-
-        _sdk.SendHidUpdate(buffer, _channel);
     }
 
     #endregion

RGB.NET.Devices.Razer/Generic/RazerUpdateQueue.cs

@@ -10,7 +10,7 @@ namespace RGB.NET.Devices.Razer;
 public abstract class RazerUpdateQueue : UpdateQueue
 {
     #region Properties & Fields
-        
+
     private Guid? _lastEffect;
 
     #endregion
@@ -23,8 +23,7 @@ public abstract class RazerUpdateQueue : UpdateQueue
     /// <param name="updateTrigger">The update trigger used to update this queue.</param>
     protected RazerUpdateQueue(IDeviceUpdateTrigger updateTrigger)
         : base(updateTrigger)
-    {
+    { }
-    }
 
     #endregion
 
@@ -33,16 +32,23 @@ public abstract class RazerUpdateQueue : UpdateQueue
     /// <inheritdoc />
     protected override void Update(in ReadOnlySpan<(object key, Color color)> dataSet)
     {
-        IntPtr effectParams = CreateEffectParams(dataSet);
+        try
-        Guid effectId = Guid.NewGuid();
+        {
-        CreateEffect(effectParams, ref effectId);
+            IntPtr effectParams = CreateEffectParams(dataSet);
+            Guid effectId = Guid.NewGuid();
+            CreateEffect(effectParams, ref effectId);
 
-        _RazerSDK.SetEffect(effectId);
+            _RazerSDK.SetEffect(effectId);
 
-        if (_lastEffect.HasValue)
+            if (_lastEffect.HasValue)
-            _RazerSDK.DeleteEffect(_lastEffect.Value);
+                _RazerSDK.DeleteEffect(_lastEffect.Value);
 
-        _lastEffect = effectId;
+            _lastEffect = effectId;
+        }
+        catch (Exception ex)
+        {
+            RazerDeviceProvider.Instance.Throw(ex, true);
+        }
     }
 
     /// <summary>

RGB.NET.Devices.SteelSeries/Generic/SteelSeriesDeviceUpdateQueue.cs

@@ -37,10 +37,17 @@ internal class SteelSeriesDeviceUpdateQueue : UpdateQueue
 
     protected override void OnUpdate(object? sender, CustomUpdateData customData)
     {
-        if (customData[CustomUpdateDataIndex.HEARTBEAT] as bool? ?? false)
+        try
-            SteelSeriesSDK.SendHeartbeat();
+        {
-        else
+            if (customData[CustomUpdateDataIndex.HEARTBEAT] as bool? ?? false)
-            base.OnUpdate(sender, customData);
+                SteelSeriesSDK.SendHeartbeat();
+            else
+                base.OnUpdate(sender, customData);
+        }
+        catch (Exception ex)
+        {
+            SteelSeriesDeviceProvider.Instance.Throw(ex, true);
+        }
     }
 
     /// <inheritdoc />

RGB.NET.Devices.WS281X/Generic/SerialPortUpdateQueue.cs

@@ -58,10 +58,17 @@ public abstract class SerialConnectionUpdateQueue<TData> : UpdateQueue
     /// <inheritdoc />
     protected override void Update(in ReadOnlySpan<(object key, Color color)> dataSet)
     {
-        foreach (TData command in GetCommands(dataSet.ToArray()))
+        try
         {
-            SerialConnection.ReadTo(Prompt);
+            foreach (TData command in GetCommands(dataSet.ToArray()))
-            SendCommand(command);
+            {
+                SerialConnection.ReadTo(Prompt);
+                SendCommand(command);
+            }
+        }
+        catch (Exception ex)
+        {
+            WS281XDeviceProvider.Instance.Throw(ex, true);
         }
     }
 

RGB.NET.Devices.Wooting/Generic/WootingUpdateQueue.cs

@@ -13,7 +13,7 @@ public class WootingUpdateQueue : UpdateQueue
     #region Properties & Fields
     private readonly byte _deviceid;
     #endregion
-    
+
     #region Constructors
 
     /// <summary>
@@ -33,17 +33,24 @@ public class WootingUpdateQueue : UpdateQueue
     /// <inheritdoc />
     protected override void Update(in ReadOnlySpan<(object key, Color color)> dataSet)
     {
-        lock (_WootingSDK.SdkLock)
+        try
         {
-            _WootingSDK.SelectDevice(_deviceid);
+            lock (_WootingSDK.SdkLock)
-            
-            foreach ((object key, Color color) in dataSet)
             {
-                (int row, int column) = ((int, int))key;
+                _WootingSDK.SelectDevice(_deviceid);
-                _WootingSDK.ArraySetSingle((byte)row, (byte)column, color.GetR(), color.GetG(), color.GetB());
-            }
 
-            _WootingSDK.ArrayUpdateKeyboard();
+                foreach ((object key, Color color) in dataSet)
+                {
+                    (int row, int column) = ((int, int))key;
+                    _WootingSDK.ArraySetSingle((byte)row, (byte)column, color.GetR(), color.GetG(), color.GetB());
+                }
+
+                _WootingSDK.ArrayUpdateKeyboard();
+            }
+        }
+        catch (Exception ex)
+        {
+            WootingDeviceProvider.Instance.Throw(ex, true);
         }
     }