从异步编程模型(APM)迁移到基于任务的异步模式(TAP)

时间:2014-05-02 22:22:25

标签: c# asynchronous task async-await

.NET中有许多类使用旧的Asynchronous Programming Model (APM)“不再推荐用于新开发”。 APM使用Begin / End方法对,End方法将IAsyncResult对象作为参数。一个这样的类是TcpClient,您可以使用它来异步连接,如下所示:

private void SomeMethod()
{
    this.tcpClient = new TcpClient();
    IAsyncResult result = this.tcpClient.BeginConnect(ip, port, EndConnect, null);
}

private void EndConnect(IAsyncResult asyncResult)
{
    this.tcpClient.EndConnect(asyncResult);

    // ... do stuff ...
}

Task-based Asynchronous Pattern (TAP)是一种更现代的异步编程形式,可以通过使用asyncawait关键字来实现。

因此,如果您有一个类似TcpClient的类,它使用APM模型并且不公开任何任务,那么如何将其异步方法调整到TAP以便它们可以与async / {{一起使用1}}?

2 个答案:

答案 0 :(得分:12)

它是in the documentation you linked to

作为一般规则,您应首先查看或询问是否有直接支持TAP的更新API。几乎所有BCL类都已更新以支持TAP,少数(例如HttpWebRequest)已替换为TAP替代(例如HttpClient)。在这种情况下,没有TAP TcpClient等价物,所以包装它们是最好的选择。

如果您通过APM包装器编写TAP,我建议使用简单的扩展方法:

public static Task ConnectTaskAsync(this TcpClient client, IPAddress address, int port)
{
  return Task.Factory.FromAsync(client.BeginConnect, client.EndConnect, address, port, null);
}

这为您提供了一种消费它们的自然方式,并将您的" interop"任何包含实际逻辑的代码中的代码:

async Task SomeMethodAsync()
{
  this.tcpClient = new TcpClient();
  await this.tcpClient.ConnectTaskAsync(ip, port);
  // ... do stuff ...
}

答案 1 :(得分:4)

您可以使用Task.Factory.FromAsync。示例(适用于BeginReceive / EndReceive):

public static class SocketsExt
{
    static public Task ReceiveDataAsync(
        this TcpClient tcpClient,
        byte[] buffer)
    {
        return Task.Factory.FromAsync(
            (asyncCallback, state) =>
                tcpClient.Client.BeginReceive(buffer, 0, buffer.Length, 
                    SocketFlags.None, asyncCallback, state),
            (asyncResult) =>
                tcpClient.Client.EndReceive(asyncResult), 
            null);
    }
}