Files
duplicati/Duplicati/GUI/Duplicati.GUI.TrayIcon/ProcessBasedActionDelay.cs
T

84 lines
2.8 KiB
C#

using System;
using System.Threading.Tasks;
using CoCoL;
namespace Duplicati.GUI.TrayIcon;
/// <summary>
/// A class that delays the execution of actions.
/// </summary>
public class ProcessBasedActionDelay : IDisposable
{
/// <summary>
/// The channel that sends the delayed actions, buffer avoids deadlocks if multiple events are queued before starting.
/// </summary>
private readonly IChannel<Action> m_inboundActionChannel = Channel.Create<Action>(name: "UI Action", buffersize: 500);
/// <summary>
/// The channel that sends the start signal.
/// </summary>
private readonly IChannel<bool> m_initializedChannel = Channel.Create<bool>(name: "UI Initializer");
/// <summary>
/// Reference to the task running
/// </summary>
private readonly Task m_task;
/// <summary>
/// Initializes a new instance of the <see cref="ProcessBasedActionDelay"/> class.
/// </summary>
public ProcessBasedActionDelay()
{
m_task = RunProcessor(m_inboundActionChannel.AsReadOnly(), m_initializedChannel.AsReadOnly());
}
/// <summary>
/// Runs the processor process, which pauses until a ready signal is received.
/// </summary>
/// <param name="inboundChannel">The channel with actions to be delayed.</param>
/// <param name="initializedChannel">The channel that sends the start signal.</param>
/// <returns>The task running the processor process.</returns>
private static Task RunProcessor(IReadChannelEnd<Action> inboundChannel, IReadChannelEnd<bool> initializedChannel)
=> AutomationExtensions.RunTask(new
{
inboundChannel,
initializedChannel
}, async (self) =>
{
// Wait for initialization
await self.initializedChannel.ReadAsync();
while (true)
{
var action = await self.inboundChannel.ReadAsync();
action();
}
});
/// <summary>
/// Adds a new task to the processor
/// </summary>
/// <param name="action">The action to execute</param>
public void ExecuteAction(Action action)
// Note: WriteNoWait() is used to avoid waiting for the action to be read,
// as this would cause deadlocks if called from within the processor.
// The buffer size should be sufficient to allow for a reasonable number of actions to be queued.
=> m_inboundActionChannel.WriteNoWait(action);
/// <summary>
/// Signals the start of the processor
/// </summary>
public void SignalStart()
=> m_initializedChannel.TryWrite(true);
/// <summary>
/// Disposes the object
/// </summary>
public void Dispose()
{
m_inboundActionChannel.Retire();
m_initializedChannel.Retire();
}
}