如何取消 BlockingCollection 上的 GetConsumingEnumerable()

Question

在下面的代码中，我使用 CancellationToken 来唤醒 GetConsumingEnumerable() 当生产者不生产并且我想跳出 foreach 并退出任务时。但我没有看到 IsCancellationRequested 被记录，并且我的 Task.Wait(timeOut) 等待完整的超时时间。我做错了什么？

userToken.Task = Task.Factory.StartNew(state =>
{
    userToken.CancelToken = new CancellationTokenSource();

    foreach (var broadcast in userToken.BroadcastQueue.GetConsumingEnumerable(userToken.CancelToken.Token))
    {
        if (userToken.CancelToken.IsCancellationRequested)
        {
            Log.Write("BroadcastQueue IsCancellationRequested");
            break;
            ...
        }
    }

    return 0;
}, "TaskSubscribe", TaskCreationOptions.LongRunning);

稍后...

UserToken.CancelToken.Cancel();          
try
{
    task.Wait(timeOut);
}
catch (AggregateException ar)
{
    Log.Write("AggregateException " + ar.InnerException, MsgType.InfoMsg);
}
catch (OperationCanceledException)
{
    Log.Write("BroadcastQueue Cancelled", MsgType.InfoMsg);
}

Answer 1

您可以使用CompleteAdding()，这表示不会再向集合中添加任何项目。如果使用GetConsumingEnumerable，foreach 将优雅地结束，因为它知道等待更多项目是没有意义的。

基本上，一旦您完成向BlockingCollection 添加项目后，只需执行以下操作：

myBlockingCollection.CompleteAdding() 

任何使用 GetConsumingEnumerable 执行 foreach 循环的线程都将停止循环。

Answer 2

我已经创建了快速原型，它似乎对我有用。

在令牌取消请求之前注意 Thread.Sleep(1000)。 您可能正在为 Token 变量创建 race condition，因为您在不同的线程中创建和访问 item.CancelToken 变量。

例如旨在取消任务的代码可能会在错误（上一个或 null）取消令牌上调用取消。

static void Main(string[] args)
{
    CancellationTokenSource token = null;
    BlockingCollection<string> coll = new BlockingCollection<string>();
    var t = Task.Factory.StartNew(state =>
    {
        token = new CancellationTokenSource();
        try
        {
            foreach (var broadcast in coll.GetConsumingEnumerable(token.Token))
            {
                if (token.IsCancellationRequested)
                {
                    return;
                }
            }
        }
        catch (OperationCanceledException)
        {
            Console.WriteLine("Cancel");
            return;
        }
    }, "TaskSubscribe", TaskCreationOptions.LongRunning);
    Thread.Sleep(1000);
    token.Cancel();
    t.Wait();
}