32 lines
1.1 KiB
C#
32 lines
1.1 KiB
C#
using System;
|
|
using System.Threading;
|
|
|
|
namespace Umbraco.Web.Scheduling
|
|
{
|
|
/// <summary>
|
|
/// Represents a latched background task.
|
|
/// </summary>
|
|
/// <remarks>Latched background tasks can suspend their execution until
|
|
/// a condition is met. However if the tasks runner has to terminate,
|
|
/// latched background tasks can be executed immediately, depending on
|
|
/// the value returned by RunsOnShutdown.</remarks>
|
|
internal interface ILatchedBackgroundTask : IBackgroundTask
|
|
{
|
|
/// <summary>
|
|
/// Gets a wait handle on the task condition.
|
|
/// </summary>
|
|
/// <exception cref="InvalidOperationException">The task is not latched.</exception>
|
|
WaitHandle Latch { get; }
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether the task is latched.
|
|
/// </summary>
|
|
bool IsLatched { get; }
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating whether the task can be executed immediately if the task runner has to terminate.
|
|
/// </summary>
|
|
bool RunsOnShutdown { get; }
|
|
}
|
|
}
|