Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Socket.EndSend Method

Ends a pending asynchronous send.

[Visual Basic]
Public Function EndSend( _
   ByVal asyncResult As IAsyncResult _
) As Integer
[C#]
public int EndSend(
 IAsyncResult asyncResult
);
[C++]
public: int EndSend(
 IAsyncResult* asyncResult
);
[JScript]
public function EndSend(
   asyncResult : IAsyncResult
) : int;

Parameters

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

Return Value

If successful, the number of bytes sent to the Socket; otherwise, an invalid Socket error.

Exceptions

Exception Type Condition
ArgumentNullException asyncResult is a null reference (Nothing in Visual Basic).
ArgumentException asyncResult was not returned by a call to the BeginSend method.
InvalidOperationException EndSend was previously called for the asynchronous read.
SocketException An error occurred when attempting to access the socket. See the Remarks section for more information.
ObjectDisposedException The Socket has been closed.

Remarks

EndSend completes the asynchronous send operation started in BeginSend.

Before calling BeginSend, 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 BeginSend returns. The callback method must accept the IAsyncResult returned by the BeginSend method as a parameter.

Within the callback method, call the AsyncState method of the IAsyncResult parameter to obtain the sending Socket. After obtaining the Socket, you can call the EndSend method to successfully complete the send operation and return the number of bytes sent.If you are using a connectionless protocol, EndSend will block until the datagram is sent. If you are using a connection-oriented protocol, EndSend will block until the requested number of bytes are 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 BeginSend method means that the underlying system has had room to buffer your data for a network send. If it is important to your application to send every byte to the remote host immediately, you can use SetSocketOption to enable SocketOptionName.NoDelay. For more information about buffering for network efficiency, refer to the Nagle algorithm in MSDN.

Note   If you receive a SocketException, use SocketException.ErrorCode to obtain the specific error code. Once you have obtained this code, you can refer to the Windows Socket Version 2 API error code documentation in MSDN for a detailed description of the error.

Example

[Visual Basic, C#, C++] The following example ends a pending asynchronous send.

[Visual Basic] 
Dim so As StateObject = CType(ar.AsyncState, StateObject)
Dim s As Socket = so.workSocket

Dim send As Integer = s.EndSend(ar)

Console.WriteLine(("The size of the message sent was :" + send.ToString()))

s.Close()
   End Sub 'Send_Callback

[C#] 
StateObject so = (StateObject) ar.AsyncState;
Socket s = so.workSocket;

int send = s.EndSend(ar);

   Console.WriteLine("The size of the message sent was :" + send.ToString());

s.Close();

[C++] 
StateObject* so = __try_cast<StateObject*>(ar->AsyncState);
Socket* s = so->workSocket;

int send = s->EndSend(ar);

Console::WriteLine(S"The size of the message sent was : {0}", __box(send));

s->Close();

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework, Common Language Infrastructure (CLI) Standard

See Also

Socket Class | Socket Members | System.Net.Sockets Namespace | Including Asynchronous Calls | BeginSend | AsyncCallback | AsyncState | SetSocketOption | NoDelay

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.