System.Net.Sockets.Socket.EndSendFile Method

Ends a pending asynchronous send of a file.

Syntax

public void EndSendFile (IAsyncResult asyncResult)

Parameters

asyncResult
An IAsyncResult object that stores state information for this asynchronous operation.

Remarks

Socket.EndSendFile(IAsyncResult) completes the asynchronous send operation started in Socket.BeginSendFile(string, AsyncCallback, object).

Before calling Socket.BeginSendFile(string, AsyncCallback, object), you must create a callback method that implements the AsyncCallback delegate. This callback method executes in a separate thread and is called by the system after Socket.BeginSendFile(string, AsyncCallback, object) returns. The callback method must accept the IAsyncResult object returned by the Socket.BeginSendFile(string, AsyncCallback, object) method as a parameter.

Within the callback method, call the IAsyncResult.AsyncState method of the IAsyncResult parameter to obtain the sending System.Net.Sockets.Socket. After obtaining the System.Net.Sockets.Socket, you can call the Socket.EndSendFile(IAsyncResult) method to successfully complete the send operation.

If you are using a connectionless protocol, Socket.EndSendFile(IAsyncResult) blocks until the datagram is sent. If you are using a connection-oriented protocol, Socket.EndSendFile(IAsyncResult) blocks until the entire file is sent. There is no guarantee that the data you send will appear on the network immediately. To increase network efficiency, the underlying system may delay transmission until a significant amount of outgoing data is collected. A successful completion of the Socket.BeginSendFile(string, AsyncCallback, object) method means that the underlying system has had room to buffer your data for a network send.

Note:

If you receive a System.Net.Sockets.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.

Note:

This member outputs trace information when you enable network tracing in your application. For more information, see [<topic://conUsingNetworkTracing>].

Requirements

Namespace: System.Net.Sockets
Assembly: System (in System.dll)
Assembly Versions: 2.0.0.0, 4.0.0.0