Socket.EndReceive 方法

定义

命名空间:

System.Net.Sockets

程序集:

System.Net.Sockets.dll

结束挂起的异步读取。

重载

EndReceive(IAsyncResult)	结束挂起的异步读取。
EndReceive(IAsyncResult, SocketError)	结束挂起的异步读取。

EndReceive(IAsyncResult)

Source:

Socket.cs

结束挂起的异步读取。

public:
 int EndReceive(IAsyncResult ^ asyncResult);

public int EndReceive (IAsyncResult asyncResult);

member this.EndReceive : IAsyncResult -> int

Public Function EndReceive (asyncResult As IAsyncResult) As Integer

参数

asyncResult

IAsyncResult

IAsyncResult，它存储此异步操作的状态信息以及所有用户定义的数据。

返回

Int32

收到的字节数。

例外

ArgumentNullException

asyncResult 为 null。

ArgumentException

对 BeginReceive(Byte[], Int32, Int32, SocketFlags, AsyncCallback, Object) 方法的调用未返回 asyncResult。

InvalidOperationException

先前曾为异步读取调用过 EndReceive(IAsyncResult)。

SocketException

尝试访问套接字时出错。

- 或 -

仅限 .NET 7+： Socket 已关闭。

ObjectDisposedException

仅.NET Framework、.NET Core 和 .NET 5-6：Socket已关闭。

注解

重要

这是一个兼容性 API。 不建议使用 APM (Begin* 和 End*) 方法进行新的开发。 请改用 Task基于 的等效项。

EndReceive 完成由 BeginReceive启动的操作。 需要传递 IAsyncResult 通过匹配 BeginReceive 调用创建的 。

方法 EndReceive 将阻止，直到数据可用。 如果使用无连接协议， EndReceive 将读取传入网络缓冲区中可用的第一个排队数据报。 如果使用的是面向连接的协议，则 EndReceive 方法将读取与可用数据量一样多的数据，最多可读取在 方法的 BeginReceive 参数中指定的size字节数。 如果远程主机关闭 Socket 了与 Shutdown 方法的连接，并且已收到所有可用数据，则 EndReceive 该方法将立即完成并返回零个字节。

注意

如果收到 ， SocketException请使用 SocketException.ErrorCode 属性获取特定的错误代码。

注意

当给定线程退出时，将取消由该线程发起的所有 I/O。 如果线程在操作完成之前退出，挂起的异步操作可能会失败。

备注

当你在应用程序中启用网络跟踪后，此成员将输出跟踪信息。 有关详细信息，请参阅 .NET Framework 中的网络跟踪。

另请参阅

• BeginReceive(Byte[], Int32, Int32, SocketFlags, AsyncCallback, Object)
• AsyncCallback
• IAsyncResult
• AsyncState
• Shutdown(SocketShutdown)

EndReceive(IAsyncResult, SocketError)

Source:

Socket.cs

结束挂起的异步读取。

public:
 int EndReceive(IAsyncResult ^ asyncResult, [Runtime::InteropServices::Out] System::Net::Sockets::SocketError % errorCode);

public int EndReceive (IAsyncResult asyncResult, out System.Net.Sockets.SocketError errorCode);

member this.EndReceive : IAsyncResult * SocketError -> int

Public Function EndReceive (asyncResult As IAsyncResult, ByRef errorCode As SocketError) As Integer

参数

asyncResult

IAsyncResult

IAsyncResult，它存储此异步操作的状态信息以及所有用户定义的数据。

errorCode

SocketError

一个 SocketError 对象，它存储套接字错误。

返回

Int32

收到的字节数。

例外

ArgumentNullException

asyncResult 为 null。

ArgumentException

对 BeginReceive(Byte[], Int32, Int32, SocketFlags, AsyncCallback, Object) 方法的调用未返回 asyncResult。

InvalidOperationException

先前曾为异步读取调用过 EndReceive(IAsyncResult)。

SocketException

尝试访问套接字时出错。

- 或 -

仅限 .NET 7+： Socket 已关闭。

ObjectDisposedException

仅.NET Framework、.NET Core 和 .NET 5-6：Socket已关闭。

注解

重要

这是一个兼容性 API。 不建议使用 APM (Begin* 和 End*) 方法进行新的开发。 请改用 Task基于 的等效项。

EndReceive 完成由 BeginReceive启动的操作。 需要传递 IAsyncResult 通过匹配 BeginReceive 调用创建的 。

方法 EndReceive 将阻止，直到数据可用。 如果使用无连接协议， EndReceive 将读取传入网络缓冲区中可用的第一个排队数据报。 如果使用的是面向连接的协议，则 EndReceive 方法将读取与可用数据量一样多的数据，最多可读取在 方法的 BeginReceive 参数中指定的size字节数。 如果远程主机关闭 Socket 了与 Shutdown 方法的连接，并且已收到所有可用数据，则 EndReceive 该方法将立即完成并返回零个字节。

注意

如果收到 ， SocketException请使用 SocketException.ErrorCode 属性获取特定的错误代码。

注意

当给定线程退出时，将取消由该线程发起的所有 I/O。 如果线程在操作完成之前退出，挂起的异步操作可能会失败。

备注

当你在应用程序中启用网络跟踪后，此成员将输出跟踪信息。 有关详细信息，请参阅 .NET Framework 中的网络跟踪。

另请参阅

• BeginReceive(Byte[], Int32, Int32, SocketFlags, AsyncCallback, Object)
• AsyncCallback
• IAsyncResult
• AsyncState
• Shutdown(SocketShutdown)