basic_raw_socket::async_send_to (1 of 2 overloads)

Start an asynchronous send.

template<
    typename ConstBufferSequence,
    typename WriteToken = DEFAULT>
DEDUCED async_send_to(
    const ConstBufferSequence & buffers,
    const endpoint_type & destination,
    WriteToken && token = DEFAULT);

This function is used to asynchronously send raw data to the specified remote endpoint. It is an initiating function for an asynchronous operation, and always returns immediately.

Parameters

buffers

One or more data buffers to be sent to the remote endpoint. Although the buffers object may be copied as necessary, ownership of the underlying memory blocks is retained by the caller, which must guarantee that they remain valid until the completion handler is called.

destination

The remote endpoint to which the data will be sent. Copies will be made of the endpoint as required.

token

The completion token that will be used to produce a completion handler, which will be called when the send completes. Potential completion tokens include use_future, use_awaitable, yield_context, or a function object with the correct completion signature. The function signature of the completion handler must be:

void handler(
  const asio::error_code& error, // Result of operation.
  std::size_t bytes_transferred // Number of bytes sent.
);

Regardless of whether the asynchronous operation completes immediately or not, the completion handler will not be invoked from within this function. On immediate completion, invocation of the handler will be performed in a manner equivalent to using post.

Completion Signature

void(asio::error_code, std::size_t)

Example

To send a single data buffer use the buffer function as follows:

asio::ip::udp::endpoint destination(
    asio::ip::address::from_string("1.2.3.4"), 12345);
socket.async_send_to(
    asio::buffer(data, size), destination, handler);

See the buffer documentation for information on sending multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.

Per-Operation Cancellation

On POSIX or Windows operating systems, this asynchronous operation supports cancellation for the following cancellation_type values:

cancellation_type::terminal
cancellation_type::partial
cancellation_type::total