// Copyright (C) 2025, The Duplicati Team // https://duplicati.com, hello@duplicati.com // // Permission is hereby granted, free of charge, to any person obtaining a // copy of this software and associated documentation files (the "Software"), // to deal in the Software without restriction, including without limitation // the rights to use, copy, modify, merge, publish, distribute, sublicense, // and/or sell copies of the Software, and to permit persons to whom the // Software is furnished to do so, subject to the following conditions: // // The above copyright notice and this permission notice shall be included in // all copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER // DEALINGS IN THE SOFTWARE. #nullable enable using System; using System.Collections.Generic; using Duplicati.Server.Serialization.Interface; namespace Duplicati.Server { /// /// This class handles synchronized waiting for events /// public class EventPollNotify { /// /// The lock that grants exclusive access to control structures /// private readonly object m_lock = new object(); /// /// The current eventID /// private long m_eventNo = 0; /// /// The list of subscribed waiting threads /// private readonly Queue m_waitQueue = new Queue(); /// /// An eventhandler for subscribing to event updates without blocking /// public event EventHandler? NewEvent; /// /// An eventhandler for subscribing to progress updates without blocking /// public event EventHandler?>? ProgressUpdate; /// /// An eventhandler for subscribing to queue updates without blocking /// public event EventHandler? TaskQueueUpdate; /// /// An eventhandler for subscribing to task completion without blocking /// public event EventHandler? TaskCompleted; /// /// An eventhandler for subscribing backup list updates without blocking /// public event EventHandler? BackupListUpdate; /// /// An eventhandler for subscribing to notifications updates without blocking /// public event EventHandler? NotificationsUpdated; /// /// An eventhandler for subscribing to server settings updates without blocking /// public event EventHandler? ServerSettingsUpdate; /// /// Gets the current event ID /// public long EventNo { get { return m_eventNo; } } /// /// Call to wait for an event that is newer than the current known event /// /// The last known event id /// The number of milliseconds to block /// The current event id public long Wait(long eventId, int milliseconds) { System.Threading.ManualResetEvent mre; lock (m_lock) { //If a newer event has already occured, return immediately if (eventId != m_eventNo) return m_eventNo; //Otherwise register this thread as waiting mre = new System.Threading.ManualResetEvent(false); m_waitQueue.Enqueue(mre); } //Wait until we are signalled or the time has elapsed mre.WaitOne(milliseconds, false); return m_eventNo; } /// /// Signals that an event has occurred and notifies all waiting threads /// public void SignalNewEvent() { lock (m_lock) { m_eventNo++; while (m_waitQueue.Count > 0) m_waitQueue.Dequeue().Set(); } if (NewEvent != null) NewEvent(this, null!); } public void SignalProgressUpdate(Func? pg) => ProgressUpdate?.Invoke(this, pg); public void SignalTaskQueueUpdate() => TaskQueueUpdate?.Invoke(this, null); public void SignalTaskCompleted(long taskId) => TaskCompleted?.Invoke(this, taskId); public void SignalServerSettingsUpdated() => ServerSettingsUpdate?.Invoke(this, null!); public void SignalBackupListUpdate() => BackupListUpdate?.Invoke(this, null!); public void SignalNotificationUpdate() => NotificationsUpdated?.Invoke(this, null!); } }