Send Method (Byte[], SocketFlags)

  • Article

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Sends data to a connected Socket using the specified SocketFlags.

Namespace:  System.Net.Sockets
Assembly:  System (in System.dll)

Syntax

'Declaration
Public Function Send ( _
    buffer As Byte(), _
    socketFlags As SocketFlags _
) As Integer

public int Send(
    byte[] buffer,
    SocketFlags socketFlags
)

public:
int Send(
    array<unsigned char>^ buffer, 
    SocketFlags socketFlags
)

member Send : 
        buffer:byte[] * 
        socketFlags:SocketFlags -> int 

public function Send(
    buffer : byte[], 
    socketFlags : SocketFlags
) : int

Parameters

Return Value

Type: System. . :: . .Int32
The number of bytes sent to the Socket.

Remarks

Send synchronously sends data to the remote host established in the Connect or Accept method and returns the number of bytes successfully sent. The Send method can be used for both connection-oriented and connectionless protocols.

This overload requires a buffer that contains the data you want to send and a bitwise combination of SocketFlags. The buffer offset defaults to 0, and the number of bytes to send defaults to the size of the buffer. If you specify the DontRoute flag as the socketflags parameter value, the data you are sending will not be routed.

If you are using a connectionless protocol, you must call Connect before calling this method, or Send will throw a SocketException. If you are using a connection-oriented protocol, you must either use Connect to establish a remote host connection, or use Accept to accept an incoming connection.

If you are using a connectionless protocol and plan to send data to several different hosts, you should use the SendTo method. If you do not use the SendTo method, you will have to call the Connect method before each call to Send. You can use SendTo even after you have established a default remote host with Connect. You can also change the default remote host prior to calling Send by making another call to Connect.

If you are using a connection-oriented protocol, Send will block until all of the bytes in the buffer are sent, unless a time-out was set by using Socket..::..SendTimeout. If the time-out value was exceeded, the Send call will throw a SocketException. In nonblocking mode, Send may complete successfully even if it sends less than the number of bytes in the buffer. It is your application's responsibility to keep track of the number of bytes sent and to retry the operation until the application sends the requested number of bytes. There is also 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 Send method means that the underlying system has had room to buffer your data for a network send.

Note

You must ensure that the size of your buffer does not exceed the maximum packet size of the underlying service provider. If it does, the datagram will not be sent and Send will throw a SocketException. 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.

Note

The successful completion of a send does not indicate that the data was successfully delivered. If no buffer space is available within the transport system to hold the data to be transmitted, send will block unless the socket has been placed in nonblocking mode.

.NET Framework Security

See Also

Reference

Socket Class

Send Overload

System.Net.Sockets Namespace