Merge PR DarthAffe#339: Corsair DeviceConnection event implementation

Brings in Aytackydln's Corsair device-changed event implementation
(DarthAffe#339) with conflicts resolved
and a few regressions repaired.

Conflict resolutions:
- _CUESDK.cs: kept the stored SESSION_STATE_CHANGED_CALLBACK delegate
  field (required to prevent GC of the marshaled callback) while
  adopting the PR's typo fix (SesionState -> SessionState) and its
  early-return guard for Connecting/Timeout states.
- CorsairDeviceProvider.cs: took the PR's refactored structure
  (CreateSingleChannelDevice / CreateCorsairDeviceChannel methods)
  and restored three regressions:
    * "iCUE LINK System Hub" 8-Led-Series rename to "RX Fan"
    * "LX Fan" workaround for invalid ChannelDeviceType when
      device.model == "iCUE LINK System Hub" && ledCount == 18
    * Typo "8-Led-Series Fan Fan" -> "8-Led-Series Fan"

Co-Authored-By: Aytaç Kayadelen <kayadelena@gmail.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Author: 3 people

RGB.NET.Core/Devices/AbstractRGBDeviceProvider.cs

@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using System.Collections.ObjectModel;
 using System.Linq;
+using System.Runtime.CompilerServices;
 
 namespace RGB.NET.Core;
 
@@ -94,6 +95,15 @@ public bool Initialize(RGBDeviceType loadFilter = RGBDeviceType.All, bool throwE
             Reset();
             throw;
         }
+        catch (RGBDeviceException)
+        {
+            Reset();
+            if (throwExceptions)
+            {
+                throw;
+            }
+            return false;
+        }
         catch (Exception ex)
         {
             Reset();
@@ -158,6 +168,7 @@ protected virtual IEnumerable<IRGBDevice> GetLoadedDevices(RGBDeviceType loadFil
     /// <param name="id">The id of the update trigger.</param>
     /// <param name="updateRateHardLimit">The update rate hard limit to be set in the update trigger.</param>
     /// <returns>The update trigger mapped to the specified id.</returns>
+    [MethodImpl(MethodImplOptions.Synchronized)]
     protected virtual IDeviceUpdateTrigger GetUpdateTrigger(int id = -1, double? updateRateHardLimit = null)
     {
         if (_isDisposed) throw new ObjectDisposedException(GetType().FullName);

RGB.NET.Core/Update/Devices/DeviceUpdateTrigger.cs

@@ -141,11 +141,15 @@ public virtual async void Stop()
 
         UpdateTokenSource?.Cancel();
         if (UpdateTask != null)
-            try { await UpdateTask.ConfigureAwait(false); }
+            try
+            {
+                await UpdateTask.ConfigureAwait(false);
+                UpdateTask?.Dispose();
+            }
             catch (TaskCanceledException) { }
             catch (OperationCanceledException) { }
+            catch (InvalidOperationException) { }
 
-        UpdateTask?.Dispose();
         UpdateTask = null;
     }
 

RGB.NET.Devices.Corsair/CorsairDeviceProvider.cs

@@ -0,0 +1,8 @@
+namespace RGB.NET.Devices.Corsair;
+
+internal enum CorsairEventId
+{
+    Invalid = 0,
+    DeviceConnectionStatusChangedEvent = 1,
+    KeyEvent = 2,
+}

RGB.NET.Devices.Corsair/Enum/CorsairEventId.cs

@@ -14,6 +14,11 @@ public abstract class CorsairRGBDevice<TDeviceInfo> : AbstractRGBDevice<TDeviceI
 {
     #region Properties & Fields
 
+    /// <summary>
+    /// <inheritdoc cref="ICorsairRGBDevice"/>
+    /// </summary>
+    public string DeviceId => DeviceInfo.DeviceId;
+
     /// <summary>
     /// Gets the mapping of <see cref="LedId"/> to <see cref="CorsairLedId"/> used to update the LEDs of this device.
     /// </summary>
@@ -29,14 +34,32 @@ public abstract class CorsairRGBDevice<TDeviceInfo> : AbstractRGBDevice<TDeviceI
     /// <param name="info">The generic information provided by CUE for the device.</param>
     /// <param name="mapping">The mapping <see cref="LedId"/> to <see cref="CorsairLedId"/> used to update the LEDs of this device.</param>
     /// <param name="updateQueue">The queue used to update this device.</param>
-    protected CorsairRGBDevice(TDeviceInfo info, CorsairDeviceUpdateQueue updateQueue)
+    protected CorsairRGBDevice(TDeviceInfo info, IUpdateQueue updateQueue)
         : base(info, updateQueue)
     { }
 
     #endregion
 
     #region Methods
 
+    protected bool Equals(CorsairRGBDevice<TDeviceInfo> other)
+    {
+        return DeviceId == other.DeviceId;
+    }
+
+    public override bool Equals(object? obj)
+    {
+        if (ReferenceEquals(null, obj)) return false;
+        if (ReferenceEquals(this, obj)) return true;
+        if (obj.GetType() != this.GetType()) return false;
+        return Equals((CorsairRGBDevice<TDeviceInfo>)obj);
+    }
+
+    public override int GetHashCode()
+    {
+        return DeviceId.GetHashCode();
+    }
+
     void ICorsairRGBDevice.Initialize() => InitializeLayout();
 
     /// <summary>

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

@@ -1,4 +1,7 @@
-using System.Text.RegularExpressions;
+using System;
+using System.Security.Cryptography;
+using System.Text;
+using System.Text.RegularExpressions;
 using RGB.NET.Core;
 using RGB.NET.Devices.Corsair.Native;
 
@@ -33,7 +36,7 @@ public class CorsairRGBDeviceInfo : IRGBDeviceInfo
     /// Returns the unique ID provided by the Corsair-SDK.
     /// Returns string.Empty for Custom devices.
     /// </summary>
-    public string DeviceId { get; }
+    public string DeviceId { get; init; }
 
     /// <inheritdoc />
     public object? LayoutMetadata { get; set; }
@@ -67,7 +70,14 @@ internal CorsairRGBDeviceInfo(RGBDeviceType deviceType, _CorsairDeviceInfo nativ
         this.LedCount = ledCount;
         this.LedOffset = ledOffset;
 
-        DeviceName = DeviceHelper.CreateDeviceName(Manufacturer, Model);
+        if (nativeInfo.id == null)  // this device is 99% unpluggable
+        {
+            DeviceName = IdGenerator.MakeUnique(typeof(CorsairDeviceProvider), Manufacturer + " " + Model);
+        }
+        else
+        {
+            DeviceName = Manufacturer + " " + Model + " #" + HashAndShorten(DeviceId);
+        }
     }
 
     /// <summary>
@@ -86,7 +96,34 @@ internal CorsairRGBDeviceInfo(RGBDeviceType deviceType, _CorsairDeviceInfo nativ
         this.LedCount = ledCount;
         this.LedOffset = ledOffset;
 
-        DeviceName = DeviceHelper.CreateDeviceName(Manufacturer, Model);
+        if (nativeInfo.id == null)
+        {
+            DeviceName = IdGenerator.MakeUnique(typeof(CorsairDeviceProvider),Manufacturer + " " + Model) + " " + ledOffset;;
+        }
+        else
+        {
+            DeviceName = Manufacturer + " " + Model + " #" + HashAndShorten(DeviceId) + " " + ledOffset;
+        }
+    }
+
+    #endregion
+
+    #region Methods
+
+    private static string HashAndShorten(string input)
+    {
+        using SHA256 sha256Hash = SHA256.Create();
+        byte[] bytes = sha256Hash.ComputeHash(Encoding.UTF8.GetBytes(input));
+        // Take the first 4 bytes of the hash
+        byte[] shortenedBytes = new byte[4];
+        Array.Copy(bytes, shortenedBytes, 4);
+        // Convert the bytes to a string
+        StringBuilder shortenedHash = new();
+        foreach (byte b in shortenedBytes)
+        {
+            shortenedHash.Append(b.ToString("X2"));
+        }
+        return shortenedHash.ToString();
     }
 
     #endregion

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

@@ -7,5 +7,7 @@ namespace RGB.NET.Devices.Corsair;
 /// </summary>
 public interface ICorsairRGBDevice : IRGBDevice
 {
+    internal string DeviceId { get; }
+
     internal void Initialize();
 }

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

@@ -12,6 +12,7 @@
 namespace RGB.NET.Devices.Corsair.Native;
 
 internal delegate void CorsairSessionStateChangedHandler(nint context, _CorsairSessionStateChanged eventData);
+internal delegate void CorsairEventHandler(nint context, _CorsairEvent corsairEvent);
 
 // ReSharper disable once InconsistentNaming
 internal static unsafe class _CUESDK
@@ -50,14 +51,15 @@ internal static unsafe class _CUESDK
     // ReSharper disable once NotAccessedField.Local - This is important, the delegate can be collected if it's not stored!
     private static readonly CorsairSessionStateChangedHandler SESSION_STATE_CHANGED_CALLBACK;
 
-    internal static bool IsConnected => SesionState == CorsairSessionState.Connected;
-    internal static CorsairSessionState SesionState { get; private set; }
+    internal static bool IsConnected => SessionState == CorsairSessionState.Connected;
+    internal static CorsairSessionState SessionState { get; private set; }
 
     #endregion
 
     #region Events
 
     internal static event EventHandler<CorsairSessionState>? SessionStateChanged;
+    internal static event EventHandler<_CorsairDeviceConnectionStatusChangedEvent>? DeviceConnectionEvent;
 
     #endregion
 
@@ -72,10 +74,45 @@ static _CUESDK()
 
     #region Methods
 
-    private static void CorsairSessionStateChangedCallback(nint context, _CorsairSessionStateChanged eventdata)
+    private static void CorsairSessionStateChangedCallback(nint context, _CorsairSessionStateChanged eventData)
     {
-        SesionState = eventdata.state;
-        SessionStateChanged?.Invoke(null, eventdata.state);
+        SessionState = eventData.state;
+        try
+        {
+            SessionStateChanged?.Invoke(null, eventData.state);
+        }
+        catch { /* dont let exception go to sdk */ }
+
+        switch (eventData.state)
+        {
+            case CorsairSessionState.Connected:
+                _corsairSubscribeForEvents(CorsairEventCallback, 0);
+                break;
+            case CorsairSessionState.Closed:
+                _corsairUnsubscribeForEvents();
+                break;
+        }
+    }
+    
+    private static void CorsairEventCallback(nint context, _CorsairEvent eventData)
+    {
+        if (eventData.id != CorsairEventId.DeviceConnectionStatusChangedEvent)
+        {
+            return;
+        }
+
+        try
+        {
+            if (eventData.eventPointer == 0)
+            {
+                return;
+            }
+
+            _CorsairDeviceConnectionStatusChangedEvent connectionStatusChangedEvent =
+                Marshal.PtrToStructure<_CorsairDeviceConnectionStatusChangedEvent>(eventData.eventPointer)!;
+
+            DeviceConnectionEvent?.Invoke(null, connectionStatusChangedEvent);
+        }catch { /* dont let exception go to sdk */ }
     }
 
     #endregion
@@ -109,7 +146,7 @@ private static void LoadCUESDK()
         _corsairGetSessionDetails = (delegate* unmanaged[Cdecl]<nint, CorsairError>)LoadFunction("CorsairGetSessionDetails");
         _corsairDisconnect = (delegate* unmanaged[Cdecl]<CorsairError>)LoadFunction("CorsairDisconnect");
         _corsairGetDevices = (delegate* unmanaged[Cdecl]<_CorsairDeviceFilter, int, nint, out int, CorsairError>)LoadFunction("CorsairGetDevices");
-        _corsairGetDeviceInfo = (delegate* unmanaged[Cdecl]<string, _CorsairDeviceInfo, CorsairError>)LoadFunction("CorsairGetDeviceInfo");
+        _corsairGetDeviceInfo = (delegate* unmanaged[Cdecl]<string, ref _CorsairDeviceInfo, CorsairError>)LoadFunction("CorsairGetDeviceInfo");
         _corsairGetLedPositions = (delegate* unmanaged[Cdecl]<string, int, nint, out int, CorsairError>)LoadFunction("CorsairGetLedPositions");
         _corsairSetLedColors = (delegate* unmanaged[Cdecl]<string, int, nint, CorsairError>)LoadFunction("CorsairSetLedColors");
         _corsairSetLayerPriority = (delegate* unmanaged[Cdecl]<uint, CorsairError>)LoadFunction("CorsairSetLayerPriority");
@@ -118,6 +155,8 @@ private static void LoadCUESDK()
         _corsairReleaseControl = (delegate* unmanaged[Cdecl]<string, CorsairError>)LoadFunction("CorsairReleaseControl");
         _getDevicePropertyInfo = (delegate* unmanaged[Cdecl]<string, CorsairDevicePropertyId, uint, out CorsairDataType, out CorsairPropertyFlag, CorsairError>)LoadFunction("CorsairGetDevicePropertyInfo");
         _readDeviceProperty = (delegate* unmanaged[Cdecl]<string, CorsairDevicePropertyId, uint, nint, CorsairError>)LoadFunction("CorsairReadDeviceProperty");
+        _corsairSubscribeForEvents = (delegate* unmanaged[Cdecl]<CorsairEventHandler, nint, CorsairError>)LoadFunction("CorsairSubscribeForEvents");
+        _corsairUnsubscribeForEvents = (delegate* unmanaged[Cdecl]<CorsairError>)LoadFunction("CorsairSubscribeForEvents");
     }
 
     private static nint LoadFunction(string function)
@@ -170,7 +209,7 @@ internal static void UnloadCUESDK()
     private static delegate* unmanaged[Cdecl]<nint, CorsairError> _corsairGetSessionDetails;
     private static delegate* unmanaged[Cdecl]<CorsairError> _corsairDisconnect;
     private static delegate* unmanaged[Cdecl]<_CorsairDeviceFilter, int, nint, out int, CorsairError> _corsairGetDevices;
-    private static delegate* unmanaged[Cdecl]<string, _CorsairDeviceInfo, CorsairError> _corsairGetDeviceInfo;
+    private static delegate* unmanaged[Cdecl]<string, ref _CorsairDeviceInfo, CorsairError> _corsairGetDeviceInfo;
     private static delegate* unmanaged[Cdecl]<string, int, nint, out int, CorsairError> _corsairGetLedPositions;
     private static delegate* unmanaged[Cdecl]<string, int, nint, CorsairError> _corsairSetLedColors;
     private static delegate* unmanaged[Cdecl]<uint, CorsairError> _corsairSetLayerPriority;
@@ -179,12 +218,15 @@ internal static void UnloadCUESDK()
     private static delegate* unmanaged[Cdecl]<string, CorsairError> _corsairReleaseControl;
     private static delegate* unmanaged[Cdecl]<string, CorsairDevicePropertyId, uint, out CorsairDataType, out CorsairPropertyFlag, CorsairError> _getDevicePropertyInfo;
     private static delegate* unmanaged[Cdecl]<string, CorsairDevicePropertyId, uint, nint, CorsairError> _readDeviceProperty;
+    private static delegate* unmanaged[Cdecl]<CorsairEventHandler, nint, CorsairError> _corsairSubscribeForEvents;
+    private static delegate* unmanaged[Cdecl]<CorsairError> _corsairUnsubscribeForEvents;
 
     #endregion
 
     internal static CorsairError CorsairConnect()
     {
         if (_corsairConnectPtr == null) throw new RGBDeviceException("The Corsair-SDK is not initialized.");
+        if (SessionState is CorsairSessionState.Connecting or CorsairSessionState.Timeout) return CorsairError.Success;
         if (IsConnected) throw new RGBDeviceException("The Corsair-SDK is already connected.");
         return _corsairConnectPtr(SESSION_STATE_CHANGED_CALLBACK, 0);
     }
@@ -209,7 +251,6 @@ internal static CorsairError CorsairGetSessionDetails(out _CorsairSessionDetails
 
     internal static CorsairError CorsairDisconnect()
     {
-        if (!IsConnected) throw new RGBDeviceException("The Corsair-SDK is not connected.");
         return _corsairDisconnect();
     }
 
@@ -232,10 +273,12 @@ internal static CorsairError CorsairGetDevices(_CorsairDeviceFilter filter, out
         }
     }
 
-    internal static CorsairError CorsairGetDeviceInfo(string deviceId, _CorsairDeviceInfo deviceInfo)
+    internal static CorsairError CorsairGetDeviceInfo(string deviceId, out _CorsairDeviceInfo deviceInfo)
     {
         if (!IsConnected) throw new RGBDeviceException("The Corsair-SDK is not connected.");
-        return _corsairGetDeviceInfo(deviceId, deviceInfo);
+
+        deviceInfo = new _CorsairDeviceInfo();
+        return _corsairGetDeviceInfo(deviceId, ref deviceInfo);
     }
 
     internal static CorsairError CorsairGetLedPositions(string deviceId, out _CorsairLedPosition[] ledPositions)

RGB.NET.Devices.Corsair/Native/_CUESDK.cs

@@ -0,0 +1,19 @@
+using System.Runtime.InteropServices;
+
+namespace RGB.NET.Devices.Corsair.Native;
+
+[StructLayout(LayoutKind.Sequential)]
+public class _CorsairDeviceConnectionStatusChangedEvent
+{
+    /// <summary>
+    /// iCUE-SDK: null terminated Unicode string that contains unique device identifier
+    /// </summary>
+    [MarshalAs(UnmanagedType.ByValTStr, SizeConst = _CUESDK.CORSAIR_STRING_SIZE_M)]
+    internal string? deviceId;
+
+    /// <summary>
+    /// iCUE-SDK: true if connected, false if disconnected
+    /// </summary>
+    [MarshalAs(UnmanagedType.U1)]
+    internal bool isConnected;
+}

RGB.NET.Devices.Corsair/Native/_CorsairDeviceConnectionStatusChangedEvent.cs

@@ -12,7 +12,7 @@ namespace RGB.NET.Devices.Corsair.Native;
 /// iCUE-SDK: contains information about device
 /// </summary>
 [StructLayout(LayoutKind.Sequential)]
-internal sealed class _CorsairDeviceInfo
+internal struct _CorsairDeviceInfo
 {
     /// <summary>
     /// iCUE-SDK: enum describing device type