如何使 UdpClient.ReceiveAsync() 可取消？

Question

我有一个带有方法的接口INetwork：

Task<bool> SendAsync(string messageToSend, CancellationToken ct)

接口的一个实现有这样的代码：

public async Task<bool> SendAsync(string messageToSend, CancellationToken ct)
{
  var udpClient = new UdpClient();
  var data = Encoding.UTF8.GetBytes (messageToSend);
  var sentBytes = await udpClient.SendAsync(data);
  return sentBytes == data.Length; 
}

很遗憾，UdpClient 类的 SendAsync() 不接受 CancellationToken。

所以我开始把它改成：

public Task<bool> SendAsync(string messageToSend, CancellationToken ct)
{
  var udpClient = new UdpClient();
  var data = Encoding.UTF8.GetBytes (messageToSend);
  var sendTask = udpClient.SendAsync(data);
  sendTask.Wait(ct);

  if(sendTask.Status == RanToCompletion)
  {
    return sendTask.Result == data.Length;
  }
}

显然这不起作用，因为没有返回 Task。但是，如果我返回任务，签名将不再匹配。 SendAsync() 返回一个Task<int>，但我需要一个Task<bool>。

现在我很困惑。 :-) 如何解决？

Answer 1

我知道这有点晚了，但我最近不得不取消 UdpClient ReceiveAsync/SendAsync。

您的第一个代码块正在发送而没有取消（您的标题说顺便接收...）。

您的第二个代码块绝对不是这样做的方法。您正在调用 *Async，然后是 Task.Wait，它会阻塞直到调用完成。这使得调用有效地同步并且调用 *Async 版本没有意义。最好的解决方案是按如下方式使用 Async：

...
var sendTask = udpClient.SendAsync(data);
var tcs = new TaskCompletionSource<bool>();
using( ct.Register( s => tcs.TrySetResult(true), null) )
{
    if( sendTask != await Task.WhenAny( task, tcs.Task) )
        // ct.Cancel() called
    else
        // sendTask completed first, so .Result will not block
}
...

在 UdpClient 上没有内置的取消方法（没有一个函数接受 CancellationToken），但您可以利用 Task.WhenAny 等待多个任务的能力。这将返回完成的第一个任务（这也是使用Task.Delay() 实现超时的简单方法）。然后我们只需要创建一个在取消CancellationToken 时将完成的任务，我们可以通过创建一个TaskCompletionSource 并使用CancellationToken 的回调设置它来完成。

一旦取消，我们可以关闭套接字以实际“取消”底层的读/写。

最初的想法来自另一个处理文件句柄的 SO 答案，但它也适用于套接字。我通常将它包装在一个扩展方法中，如下所示：

public static class AsyncExtensions
{
    public static async Task<T> WithCancellation<T>( this Task<T> task, CancellationToken cancellationToken )
    {
        var tcs = new TaskCompletionSource<bool>();
        using( cancellationToken.Register( s => ( (TaskCompletionSource<bool>)s ).TrySetResult( true ), tcs ) )
        {
            if( task != await Task.WhenAny( task, tcs.Task ) )
            {
                throw new OperationCanceledException( cancellationToken );
            }
        }

        return task.Result;
    }
}

然后像这样使用它：

try
{
    var data = await client.ReceiveAsync().WithCancellation(cts.Token);
    await client.SendAsync(data.Buffer, data.Buffer.Length, toep).WithCancellation(cts.Token);
}
catch(OperationCanceledException)
{
    client.Close();
}

Answer 2

首先，如果你想返回Task<bool>，你可以简单地使用Task.FromResult()。但你可能不应该这样做，拥有一个实际上是同步的异步方法没有多大意义。

除此之外，我还认为您不应该假装该方法已被取消，即使它没有。你可以做的是在你开始真正的SendAsync()之前检查令牌，但就是这样。

如果你真的想尽快假装方法被取消，你可以使用ContinueWith() with cancel：

var sentBytes = await sendTask.ContinueWith(t => t.Result, ct);

Answer 3

我建议您向自己发送消息。 一条消息说：“停止”。