11

我有使用 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());
4

2 回答 2

9

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

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

本质上，您想要做的是采取CancellationToken：

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

接下来，您想在该令牌发出信号时做出响应。理想情况下，您只想将CancellationTokendown 传递给，_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;

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

于 2014-08-12T12:21:58.047 回答
3

您可以将 a 传递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你需要处理的。如果您正在进行阻塞调用，则可以在内部设置CancellationTokenSourcea TimeSpan：

var cts = new CancellationTokenSource(TimeSpan.FromSeconds(10));
于 2014-08-12T12:10:33.177 回答