使用 ValueTask 等待单个 .NET 事件

问题描述

我有一个简单的 ITimer 接口，其中只有一个经典的 Elapsed .NET 事件，该事件在特定时间跨度后引发。

interface ITimer
{
    void Start(TimeSpan interval);
    void Stop();
    public event EventHandler Elapsed;

}

现在我想创建一个类似于 Task.Delay(TimeSpan) 的功能，但它应该使用 ITimer 抽象而不是“实时”时间。同样不同的形式 Task.Delay(TimeSpan) 我认为返回 ValueTask 而不是 Task 可能是一个好主意，因为它可以实现无分配，并且通常可能性能更高。此外，无论如何只需要等待一次延迟完成即可。

现在一个有点幼稚的实现可能看起来像这样。这里的问题是，使用 ValueTask 根本没有任何好处。这样的实现怎么能充分利用 ValueTask 的承诺（便宜且无需分配）。

ValueTask Delay(TimeSpan duration,CancellationToken cancellationToken)
{
    // We get the ITimer instance from somwhere,doesn't matter for this question.
    ITimer timer = timerFactory.Create();
    var tcs = new taskcompletionsource<bool>();
    timer.Elapsed += (_,__) => { tcs.SetResult(true); };
    cancellationToken.Register(() =>
    {
        timer.Stop();
        throw new OperationCanceledException();
    });
    timer.Start(duration);
    return new ValueTask(tcs.Task);
}

解决方法

关于ManualResetValueTaskSourceCore<TResult> 的内容不多。它本质上是一个 TaskCompletionSource<T> 但对于 ValueTask<T>。

它确实打算在内部使用，就像你的计时器一样，但如果你想将它用作外部方法，你可以create a wrapper for it：

public sealed class ManualResetValueTaskSource<T> : IValueTaskSource<T>,IValueTaskSource
{
  private ManualResetValueTaskSourceCore<T> _logic; // mutable struct; do not make this readonly

  public bool RunContinuationsAsynchronously
  {
    get => _logic.RunContinuationsAsynchronously;
    set => _logic.RunContinuationsAsynchronously = value;
  }
  public void Reset() => _logic.Reset();
  public void SetResult(T result) => _logic.SetResult(result);
  public void SetException(Exception error) => _logic.SetException(error);

  short IValueTaskSource.Version => _logic.Version;
  short IValueTaskSource<T>.Version => _logic.Version;
  void IValueTaskSource.GetResult(short token) => _logic.GetResult(token);
  T IValueTaskSource<T>.GetResult(short token) => _logic.GetResult(token);
  ValueTaskSourceStatus IValueTaskSource.GetStatus(short token) => _logic.GetStatus(token);
  ValueTaskSourceStatus IValueTaskSource<T>.GetStatus(short token) => _logic.GetStatus(token);

  void IValueTaskSource.OnCompleted(Action<object?> continuation,object? state,short token,ValueTaskSourceOnCompletedFlags flags) => _logic.OnCompleted(continuation,state,token,flags);
  void IValueTaskSource<T>.OnCompleted(Action<object?> continuation,flags);
}

然后您可以这样使用它（为简单起见，取消了取消）：

ValueTask Delay(TimeSpan duration)
{
  ITimer timer = timerFactory.Create();
  var vts = new ManualResetValueTaskSource<object>();
  TimerElapsed eventHandler = null;
  eventHandler = (_,__) =>
  {
    timer.Elapsed -= eventHandler;
    vts.SetResult(null);
  };
  timer.Elapsed += eventHandler;
  timer.Start(duration);
  return new ValueTask(vts);
}

请注意，由于这是一个外部方法，您仍会分配 ManualResetValueTaskSource<T>（以及委托）。所以这并没有真正给你买什么，我会选择在这里使用 TaskCompletionSource<T>。当您添加 CancellationToken 支持并且必须处理计时器触发 (vts.SetResult) 和取消 (vts.SetException) 之间的竞争条件时尤其如此，因为我很确定只有一个其中的一部分应该在每个 ValueTask 操作中发生，并且我们的 Try* 中没有 ManualResetValueTaskSource<T> 变体，如 TaskCompletionSource<T> 那样。

ValueTask 真的是为了成为一等公民；即，理想情况下，您将更新实际的计时器实现（和接口）以在其自己的类中支持 ValueTask Delay(TimeSpan) 而不是外部方法。在定时器实例内部，它可以重用ValueTask后备类型（ManualResetValueTaskSource<T>），它可以知道何时调用Reset，并且可以完全避免委托/事件。