如何在 .NET 4.0 中请求超时或取消之前“休眠”

Question

什么是睡眠一定时间的最佳方式，但能够被CancellationToken 中的IsCancellationRequested 打断？

我正在寻找适用于 .NET 4.0 的解决方案。

我想写

void MyFunc (CancellationToken ct)
{
   //... 
   // simulate some long lasting operation that should be cancelable 
   Thread.Sleep(TimeSpan.FromMilliseconds(10000), ct); 
}

Answer 1

我刚刚在这里写了一篇博客：

CancellationToken and Thread.Sleep

简而言之：

var cancelled = token.WaitHandle.WaitOne(TimeSpan.FromSeconds(5));

在您的上下文中：

void MyFunc (CancellationToken ct)
{
   //... 
   // simulate some long lasting operation that should be cancelable 
   var cancelled = ct.WaitHandle.WaitOne(TimeSpan.FromSeconds(10));
}

Answer 2

另外，我认为这很清楚：

Task.Delay(waitTimeInMs, cancellationToken).Wait(cancellationToken);

Answer 3

要在一定时间后取消异步操作，同时仍然能够手动取消操作，请使用以下内容

CancellationTokenSource cts = new CancellationTokenSource();
CancellationToken token = cts.Token;
cts.CancelAfter(5000);

这将导致五秒后取消。要取消您自己的操作，您只需将token 传递给您的异步方法并使用token.ThrowifCancellationRequested() 方法，您已经在某处设置了一个事件处理程序来触发cts.Cancel()。

所以一个完整的例子是：

CancellationTokenSource cts = new CancellationTokenSource();
CancellationToken token = cts.Token;
cts.CancelAfter(5000);

// Set up the event handler on some button.
if (cancelSource != null)
{
    cancelHandler = delegate
    {
        Cancel(cts);
    };
    stopButton.Click -= cancelHandler;
    stopButton.Click += cancelHandler;
}

// Now launch the method.
SomeMethodAsync(token);

其中stopButton是你点击取消正在运行的任务的按钮

private void Cancel(CancellationTokenSource cts)
{
    cts.Cancel();
}

方法定义为

SomeMethodAsync(CancellationToken token)
{
    Task t = Task.Factory.StartNew(() => 
        {
            msTimeout = 5000;
            Pump(token);
        }, token,
           TaskCreationOptions.None,
           TaskScheduler.Default);
}

现在，为了使您能够工作线程并启用用户取消，您需要编写一个“泵送”方法

int msTimeout;
bool timeLimitReached = false;
private void Pump(CancellationToken token)
{
    DateTime now = DateTime.Now;
    System.Timer t = new System.Timer(100);
    t.Elapsed -= t_Elapsed;
    t.Elapsed += t_Elapsed;
    t.Start();
    while(!timeLimitReached)
    {
        Thread.Sleep(250);
        token.ThrowIfCancellationRequested();
    }
}

void t_Elapsed(object sender, ElapsedEventArgs e)
{
    TimeSpan elapsed = DateTime.Now - this.readyUpInitialised;
    if (elapsed > msTimeout)
    {
        timeLimitReached = true;
        t.Stop();
        t.Dispose();
    }
}

注意，SomeAsyncMethod 将直接返回给调用者。要同时阻止呼叫者，您必须将 Task 在呼叫层次结构中向上移动。

Answer 4

CancellationToken.WaitHandle 在 CancellationTokenSource 被释放后访问时会抛出异常：

ObjectDisposedException: CancellationTokenSource 已被释放。

在某些情况下，尤其是在手动处理 linked cancellation sources 时（应该如此），这可能会很麻烦。

此扩展方法允许“安全取消等待”；但是，它应该与检查和正确标记取消令牌的状态和/或返回值的使用结合使用。这是因为它抑制了对 WaitHandle 的访问的异常，并且返回的速度可能比预期的要快。

internal static class CancellationTokenExtensions
{
    /// <summary>
    /// Wait up to a given duration for a token to be cancelled.
    /// Returns true if the token was cancelled within the duration
    /// or the underlying cancellation token source has been disposed.
    /// </summary>
    public static bool WaitForCancellation(this CancellationToken token, TimeSpan duration)
    {
        WaitHandle handle;
        try
        {
            handle = token.WaitHandle;
        }
        catch
        {
            /// The source of the token was disposed (already cancelled)
            return true;
        }

        if (handle.WaitOne(duration))
        {
            /// A cancellation occured during the wait
            return true;
        }
        else
        {
            /// No cancellation occured during the wait
            return false;
        }
    }
}

Answer 5

目前我发现的最佳解决方案是：

void MyFunc(CancellationToken ct)
{
  //...
  var timedOut = WaitHandle.WaitAny(new[] { ct.WaitHandle }, TimeSpan.FromMilliseconds(2000)) == WaitHandle.WaitTimeout;
  var cancelled = ! timedOut;
}

更新：

目前最好的解决方案是accepted answer。