basic_seq_packet_socket::async

basic_seq_packet_socket::async_send

Start an asynchronous send.

template<
    typename ConstBufferSequence,
    typename WriteHandler = DEFAULT>
DEDUCED async_send(
    const ConstBufferSequence & buffers,
    socket_base::message_flags flags,
    WriteHandler && handler = DEFAULT);

This function is used to asynchronously send data on the sequenced packet socket. The function call always returns immediately.

Parameters

buffers

One or more data buffers to be sent on the socket. 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 handler is called.

flags

Flags specifying how the send call is to be made.

handler

The handler to be called when the send operation completes. Copies will be made of the handler as required. The function signature of the 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 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.

Example

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

socket.async_send(asio::buffer(data, size), 0, 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