Ends a pending asynchronous read from a specific endpoint.
Assembly: System (in System.dll)
- Type: System.IAsyncResult
An IAsyncResult that stores state information and any user defined data for this asynchronous operation.
Return ValueType: System.Int32
If successful, the number of bytes received. If unsuccessful, returns 0.
asyncResult is a null reference (Nothing in Visual Basic).
asyncResult was not returned by a call to the BeginReceiveFrom method.
was previously called for the asynchronous read.
An error occurred when attempting to access the socket. See the Remarks section for more information.
The Socket has been closed.
The method completes the asynchronous read operation started in the BeginReceiveFrom method.
Before calling BeginReceiveFrom, you need to create a callback method that implements the AsyncCallback delegate. This callback method executes in a separate thread and is called by the system after BeginReceiveFrom returns. The callback method must accept the IAsyncResult returned by the BeginReceiveFrom method as a parameter.
Within the callback method, call the AsyncState method of the IAsyncResult to obtain the state object passed to the BeginReceiveFrom method. Extract the receiving Socket from this state object. After obtaining the Socket, you can call the method to successfully complete the read operation and return the number of bytes read.
The method will block until data is available. If you are using a connectionless protocol, will read the first enqueued datagram available in the incoming network buffer. If you are using a connection-oriented protocol, the method will read as much data as is available up to the number of bytes you specified in the size parameter of the BeginReceiveFrom method. If the remote host shuts down the Socket connection with the Shutdown method, and all available data has been received, the method will complete immediately and return zero bytes. To obtain the received data, call the AsyncState method of the IAsyncResult object, and extract the buffer contained in the resulting state object. To identify the originating host, extract the EndPoint and cast it to an IPEndPoint. Use the IPEndPoint.Address method to obtain the IP address and the IPEndPoint.Port method to obtain the port number.
If you receive a SocketException, use the SocketException.ErrorCode property to obtain the specific error code. After you have obtained this code, refer to the Windows Sockets version 2 API error code documentation in the MSDN library for a detailed description of the error.
This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing in the .NET Framework.