在取消和处理 CancellationTokenSource 之间存在延迟是否可以保证 IsCancellationRequested 将设置为 true？

Question

C# Windows UWP 项目

我在调用另一个方法的异步方法中实现了 CancellationTokenSource 和 CancellationToken。此方法包含一个 while 循环，该循环将 bool 变量的值保持为 true，直到令牌源被取消。

异步方法由鼠标左键按下事件触发，并由使用 ColorPicker 控件时发生的鼠标左键释放事件取消。 bool 变量在 true 时允许将颜色值发送到设备，在 false 时阻止发送。

通过将该值保持为 true，只要鼠标按钮保持按下状态，设备就会在指针围绕颜色选择器移动时连续接收不同的颜色值。释放鼠标按钮后，生成的错误值（由将颜色值发送到设备的例程设置）阻止进一步的颜色消息发送到设备。

我的代码也按照我的意愿行事，但我担心如果我没有正确实现它可能会产生潜在的副作用。我在这个论坛上看到至少一个帖子表明顺序：cancel、dispose 和 set to null 可用于 CancellationTokenSource。但令我担心的是，我有一个可能无穷无尽的 while 循环，它完全取决于接收取消令牌。所以我的问题是过早处理 CancellationTokenSource 是否会阻止 token.IsCanellationRequested 设置为 true，如果是这样，添加延迟是否会增加任何好处？

以下是我的代码中相关的sn-ps：

全局变量：

public static bool colorPickerPtrPressed = false;
static CancellationTokenSource cts = null;
static CancellationToken token;

鼠标按钮事件：

private void ColorPicker_PtrPressedEvent(object sender, PointerRoutedEventArgs e)
{
    if(cts == null) cts = new CancellationTokenSource();
    token = cts.Token;

    var picker = sender as ColorPicker.ColorPicker;

    colorPickerPtrPressed = true;
    (picker.DataContext as SpheroViewModel).Color = picker.SelectedColor.Color;

    ColorChange(token);

}

private void ColorPicker_PtrReleasedEvent(object sender, PointerRoutedEventArgs e)
{
    if (cts != null)
    {
        cts.Cancel();
        Task.Delay(500).Wait(); // Allow some time for cancel to take effect
        cts.Dispose();
        cts = null;
    } 
}

取消令牌方法：

public static async Task ColorChange(CancellationToken token)
{
    await Task.Run(() =>
    AllowColorChange(token), token);
}

public static void AllowColorChange(CancellationToken token)
{
        while (!token.IsCancellationRequested)
        {
            colorPickerPtrPressed = true; // Maintain value as true
            Task.Delay(100).Wait(); // allow color updates periodically
        }
    return;
}

Answer 1

所以我的问题是，在取消和处置 CancellationTokenSource 之间存在延迟，正如我在下面的“ColorPicker_PtrReleasedEvent”中所做的那样，是否可以保证 while 循环将终止？

没有。取消模型是协作的，调用 Cancel 只需通过将所有令牌的 IsCancellationRequested 属性设置为 true 来提供取消通知。

然后由任何可取消的 API（即任何接受 CancellationToken 的方法）来监控此属性的值并响应取消请求。

所以ColorPicker_PtrReleasedEvent 无法保证while 循环将在AllowColorChange 中终止。

Answer 2

按照 TZ 的建议，我修改了最后三个方法以等待 AllowColorChange(token) 方法中的取消标志，然后将该结果用作对 CancellationTokenResult 的 dispose() 的许可并将其设置为 null。如果有人发现我所做的事情有问题，请告诉我。以下是修改后的代码，看起来效果不错：

    private void ColorPicker_PntrReleasedEvent(object sender, PointerRoutedEventArgs e)
    {
        if (cts != null)
        {
            cts.Cancel();
            //Task.Delay(200).Wait(); // Allow some time for cancel to take effect
            //cts.Dispose();
            //cts = null;
        }
    }

    public static async Task ColorChange(CancellationToken token)
    {
        bool task = false;
        task = await Task.Run<bool>(() =>
        AllowColorChange(token), token);
        if (task)
        {
            cts.Dispose();
            cts = null;
        }
        else
        {
            // Shouldn't ever reach this point
            bool isBrkPnt = true;
        }
    }

    public static async Task<bool> AllowColorChange(CancellationToken token)
    {
            while (!token.IsCancellationRequested)
            {
                colorPickerPtrPressed = true; // Maintain value as true
                await Task.Delay(100); // allow color updates periodically
            }
        return true; // signal that task was canceled
    }

}

Answer 3

在执行 Theodor Zoulias 的建议后，最终代码如下所示。可以看出，在取消和释放 CancellationTokenSource 之间没有使用任意延迟，而是将释放移动到由抛出 token.ThrowIfCancellationRequested(); 导致的 OperationCanceledException 触发的 catch{} 块；来自 while() 循环，该循环被移动到 try{} 块中，并且它的测试参数设置为 true。不再需要测试 token.IsCancellationRequested 作为 while 循环的参数的值。这种编码确保在 try{} 块中的任务被取消之前不会发生处置。

     private void ColorPicker_PntrPressedEvent(object sender, PointerRoutedEventArgs e)
    {
        if(cts == null) cts = new CancellationTokenSource();
        token = cts.Token;

        var picker = sender as ColorPicker.ColorPicker;

        colorPickerPtrPressed = true; // True allows new values of color to be sent to device
        (picker.DataContext as SpheroViewModel).Color = picker.SelectedColor.Color;

        ColorChange(token); // Don't await this

    }

    private void ColorPicker_PntrReleasedEvent(object sender, PointerRoutedEventArgs e)
    {
        if (cts != null)
        {
            cts.Cancel();
        }
    }

    public static async Task ColorChange(CancellationToken token)
    {
        try
        {
            await Task.Run(async () =>
            {
                while (true)
                {
                    token.ThrowIfCancellationRequested();
                    colorPickerPtrPressed = true; // Maintain value as true while mouse button remains pressed
                    await Task.Delay(100, token); // allow color updates periodically
                }
            }, token);
        }
        catch (OperationCanceledException ex) when (ex.CancellationToken == token) // includes TaskCanceledException
        {
            if (cts != null) // Shouldn't arrive here if it is null but check just in case
            {
                try
                {
                    cts.Dispose();
                    cts = null;
                }
                catch (ObjectDisposedException e)
                {
                    // Already disposed, do nothing
                    bool brkPnt = true;
                }
            }
        }
    }

}

}