如何使用超时取消TaskCompletionSource

本文关键字：TaskCompletionSource 取消超时何使用 | 更新日期: 2023-09-27 18:17:32

我有一个函数，我使用await关键字异步调用:

public Task<StatePropertyEx> RequestStateForEntity(EntityKey entity, string propName)
{
    var tcs = new TaskCompletionSource<StateInfo>();
    try
    {
        var propInstance = BuildCacheKey(entity, propName);
        StateCacheItem cacheItem;
        if (_stateCache.TryGetValue(propInstance, out cacheItem))
        {
            tcs.SetResult( new StateInfo (cacheItem.State.Name, cacheItem.State.Value) );
            return tcs.Task;
        }
        //state not found in local cache so save the tcs for later and request the state
        var cacheKey = BuildCacheKey(entity, propName);
       _stateRequestItemList.TryAdd(cacheKey, new StateRequestItem(entity, propName, tcs));
        _evtClient.SubmitStateRequest(entity, propName);
        return tcs.Task;
    }
    catch (Exception ex)
    {
        tcs.SetException(ex);
        return tcs.Task;
    }
}

函数检查是否有它需要的信息，如果有就返回。如果它没有详细信息，它将发送一个请求，该请求最终将作为事件进入。此时，我的代码(未显示)找到存储的TaskCompletionSource项，设置结果并返回它。这一切都工作得很好，但我现在被要求考虑一种情况，即当我通过"_evtClient"请求状态时，可能永远不会返回回复。SubmitStateRequest(entity, propName);我需要实现某种超时机制，这样我就可以取消TCS任务，这样函数调用者就可以优雅地失败。我一直在看SO和互联网，找不到任何看起来正确的东西。我现在不确定是否需要以不同的方式重构上述代码。有人能给我一个类似的建议吗?

调用上述函数的代码可以像这样在一次点击中调用它:

var stateProperty = await RequestStateForEntity(key, stateName);

或批处理，像这样:

await
    Task.WhenAll(
        stateDefinitions.Select(stateDefinition => stateDefinition.Name)
            .Select(
                stateName =>
                    Task.Factory.StartNew(
                        async () => results.Add(await RequestStateForEntity(key, stateName)))
                        .Unwrap())
            .ToArray());

如何使用超时取消TaskCompletionSource

首先，您真正想要启用的是取消。取消来自超时的事实只是一个脚注。

。. NET对取消有很好的内置支持，基于任务的异步模式规定了如何使用它。

本质上，你要做的就是取一个CancellationToken:

Task<StatePropertyEx> RequestStateForEntity(EntityKey entity, string propName,
    CancellationToken cancellationToken);

接下来，您希望在发出令牌时做出响应。理想情况下，您只希望将CancellationToken传递给_evtClient，以便真正取消请求:

_evtClient.SubmitStateRequest(entity, propName, cancellationToken);

这是实现取消的正常方式，如果SubmitStateRequest已经理解取消，它会工作得很好。通常事件参数有一个表示取消的标志(例如，AsyncCompletedEventArgs.Cancelled)。如果可能的话，使用这种方法(即，根据需要更改_evtClient以支持取消)。

但有时这是不可能的。在这种情况下，您可以选择假装来支持取消。你实际上所做的只是忽略请求在被取消后完成的情况。这不是最理想的情况，但有时你别无选择。

就我个人而言，我不太喜欢这种方法，因为它使API"撒谎":方法签名声称支持取消，但它实际上只是假装支持取消。首先，我建议将其记录下来。加一个代码注释道歉说明_evtClient不支持取消，"取消"其实是假装取消。

然后，在状态请求项进入列表之后，但在实际请求发送之前，您需要自己钩入CancellationToken:

var item = new StateRequestItem(entity, propName, tcs);
_stateRequestItemList.TryAdd(cacheKey, item);
item.CancellationRegistration = cancellationToken.Register(() =>
{
  StateRequestItem cancelledItem;
  if (!_stateRequestItemList.TryRemove(cacheKey, out cancelledItem))
    return;
  cancelledItem.TaskCompletionSource.TrySetCanceled();
});
_evtClient.SubmitStateRequest(entity, propName);

最后，您需要更新事件处理程序完成代码(未显示)，以忽略状态请求项已经被删除的情况，并在找到状态请求项时处理CancellationRegistration。

一旦你的方法支持取消，那么很容易通过定时器取消:

var cts = new CancellationTokenSource(TimeSpan.FromSeconds(10));
CancellationToken token = cts.Token;

或任何其他类型的情况。比如说，如果用户取消了他正在做的事情。或者如果系统的另一部分决定不再需要这些数据。一旦你的代码支持取消，它就可以处理任何原因的取消。

您可以将CancellationToken传递给您的方法，它可以在内部实现取消逻辑:

public Task<StatePropertyEx> RequestStateForEntity(
    EntityKey entity, string propName, CancellationToken token)
{
    var tcs = new TaskCompletionSource<StateInfo>();
    try
    {
        // Cache checking
        _evtClient.SubmitStateRequest(entity, propName, token);
        return tcs.Task;
    }
    catch (Exception ex)
    {
        tcs.SetException(ex);
        return tcs.Task;
    }
}

And inside SubmitStateRequest:

token.ThrowIfCancellationRequest();

注意ThrowIfCancellationRequest将抛出一个OperationCanceledException，你需要处理。如果您正在进行阻塞调用，您可以在内部使用TimeSpan:

设置CancellationTokenSource。

var cts = new CancellationTokenSource(TimeSpan.FromSeconds(10));