send() [5/5]

size_t xtd::net::sockets::socket::send	(	const std::vector< xtd::byte > &	buffer,
		size_t	offset,
		size_t	size,
		xtd::net::sockets::socket_flags	socket_flags,
		xtd::net::sockets::socket_error &	error_code
	)

Sends the specified number of bytes of data to a connected xtd::net::sockets::socket, starting at the specified offset, and using the specified xtd::net::sockets::socket_flags.

Parameters

buffer	An array of type byte that contains the data to be sent.
offset	The position in the data buffer at which to begin sending data.
size	The number of bytes to send.
socket_flags	A bitwise combination of the xtd::net::sockets::socket_flags values.
error_code	A xtd::net::sockets::socket_error object that stores the socket error.

Returns

The number of bytes sent to the xtd::net::sockets::socket.

Exceptions

xtd::argument_out_of_range_exception	size is less than 0 or exceeds the size of the buffer.
xtd::object_closed_exception	The xtd::net::sockets::socket has been closed.

Remarks

xtd::net::sockets::socket::send synchronously sends data to the remote host specified in the xtd::net::sockets::socket::connect or xtd::net::sockets::socket::accept method and returns the number of bytes successfully sent. xtd::net::sockets::socket::send can be used for both connection-oriented and connectionless protocols.

In this overload, if you specify the xtd::net::sockets::socket_flags::dont_route flag as the socket_flags parameter, the data you're sending won't be routed.

If you are using a connectionless protocol, you must call xtd::net::sockets::socket::connect before calling this method, or xtd::net::sockets::socket::send will throw a xtd::net::sockets::socket_exception. If you are using a connection-oriented protocol, you must either use xtd::net::sockets::socket::connect to establish a remote host connection, or use xtd::net::sockets::socket::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 xtd::net::sockets::socket::send_to method. If you do not use the xtd::net::sockets::socket::send_to method, you will have to call xtd::net::sockets::socket::connect before each call to xtd::net::sockets::socket::send. You can use xtd::net::sockets::socket::send_to even after you have established a default remote host with xtd::net::sockets::socket::connect. You can also change the default remote host prior to calling xtd::net::sockets::socket::send by making another call to xtd::net::sockets::socket::connect.

If you are using a connection-oriented protocol, xtd::net::sockets::socket::send will block until all of the bytes in the buffer are sent, unless a time-out was set by using xtd::net::sockets::socket::send_timeout. If the time-out value was exceeded, the xtd::net::sockets::socket::send call will throw a xtd::net::sockets::socket_exception. In nonblocking mode, xtd::net::sockets::socket::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 bytes in the buffer. 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

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.