如何使用超时取消 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(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());

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，你需要处理它。如果您正在进行阻塞调用，您可以在内部将CancellationTokenSource 设置为TimeSpan：

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