如何使用超时取消TaskCompletionSource

Question

我有一个函数，我使用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(实体，propName)”行请求状态时，可能永远不会返回答复。我需要实现某种超时机制，这样才能取消TCS任务，这样函数调用方就可以优雅地失败。我一直在看这个和互联网，找不到任何看上去对的东西。我现在不确定是否需要以不同的方式重构上面的代码。有人能给我建议或指出类似的情况吗？

调用上述函数的代码可以在这样的一次命中调用它：

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());

Answer 1

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

.NET有一些great built-in support for cancellation和Task-based Asynchronous Pattern prescribes how to use it。

本质上，你想要做的是拿一个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;

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

Answer 2

您可以将一个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;
    }
}

在SubmitStateRequest内部

token.ThrowIfCancellationRequest();

注ThrowIfCancellationRequest将抛出需要处理的OperationCanceledException。如果您正在进行阻塞调用，则可以在内部使用TimeSpan设置CancellationTokenSource。

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