// ReSharper disable MemberCanBePrivate.Global using System; using System.Diagnostics; using System.Threading; using System.Threading.Tasks; namespace RGB.NET.Core; /// /// /// Represents an update trigger that triggers in a set interval. /// public class TimerUpdateTrigger : AbstractUpdateTrigger { #region Properties & Fields private readonly object _lock = new(); private readonly CustomUpdateData? _customUpdateData; /// /// Gets or sets the update loop of this trigger. /// protected Task? UpdateTask { get; set; } /// /// Gets or sets the cancellation token source used to create the cancellation token checked by the . /// protected CancellationTokenSource? UpdateTokenSource { get; set; } /// /// Gets or sets the cancellation token checked by the . /// protected CancellationToken UpdateToken { get; set; } private double _updateFrequency = 1.0 / 30.0; /// /// Gets or sets the update-frequency in seconds. (Calculate by using '1.0 / updates per second') /// public double UpdateFrequency { get => _updateFrequency; set => SetProperty(ref _updateFrequency, value); } /// /// Gets the time it took the last update-loop cycle to run. /// public override double LastUpdateTime { get; protected set; } #endregion #region Constructors /// /// Initializes a new instance of the class. /// /// A value indicating if the trigger should automatically right after construction. public TimerUpdateTrigger(bool autostart = true) { if (autostart) // ReSharper disable once VirtualMemberCallInConstructor - HACK DarthAffe 01.06.2021: I've no idea how to correctly handle that case, for now just disable it Start(); } /// /// Initializes a new instance of the class. /// /// The update-data passed on each update triggered. /// A value indicating if the trigger should automatically right after construction. public TimerUpdateTrigger(CustomUpdateData? customUpdateData, bool autostart = true) { this._customUpdateData = customUpdateData; if (autostart) // ReSharper disable once VirtualMemberCallInConstructor - HACK DarthAffe 01.06.2021: I've no idea how to correctly handle that case, for now just disable it Start(); } #endregion #region Methods /// /// Starts the trigger if needed, causing it to performing updates. /// public override void Start() { lock (_lock) { if (UpdateTask == null) { UpdateTokenSource?.Dispose(); UpdateTokenSource = new CancellationTokenSource(); UpdateTask = Task.Factory.StartNew(UpdateLoop, (UpdateToken = UpdateTokenSource.Token), TaskCreationOptions.LongRunning, TaskScheduler.Default); } } } /// /// Stops the trigger if running, causing it to stop performing updates. /// public void Stop() { lock (_lock) { if (UpdateTask != null) { UpdateTokenSource?.Cancel(); try { // ReSharper disable once MethodSupportsCancellation UpdateTask.Wait(); } catch (AggregateException) { // ignored } finally { UpdateTask.Dispose(); UpdateTask = null; } } } } private void UpdateLoop() { OnStartup(); while (!UpdateToken.IsCancellationRequested) { long preUpdateTicks = Stopwatch.GetTimestamp(); OnUpdate(_customUpdateData); if (UpdateFrequency > 0) { double lastUpdateTime = ((Stopwatch.GetTimestamp() - preUpdateTicks) / 10000.0); LastUpdateTime = lastUpdateTime; int sleep = (int)((UpdateFrequency * 1000.0) - lastUpdateTime); if (sleep > 0) Thread.Sleep(sleep); } } } /// public override void Dispose() { Stop(); GC.SuppressFinalize(this); } #endregion }