boost::asio::basic_stream_socket::async_write_some

Start an asynchronous write.

Synopsis

Declared in <boost/asio/basic_stream_socket.hpp>

template<
    typename ConstBufferSequence,
    boost::asio::completion_token_for<void(boost::system::error_code, size_t)> WriteToken = default_completion_token_t<executor_type>>
decltype(async_initiate<WriteToken,
        void (boost::system::error_code, std::size_t)>(
          declval<initiate_async_send>(), token,
          buffers, socket_base::message_flags(0)))
async_write_some(
    ConstBufferSequence const& buffers,
    WriteToken&& token = default_completion_token_t<executor_type>());

Description

This function is used to asynchronously write data to the stream socket. It is an initiating function for an asynchronous_operation, and always returns immediately.

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

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 boost::asio::async_immediate().

Completion Signature

void(boost::system::error_code, std::size_t)
The write operation may not transmit all of the data to the peer. Consider using the async_write function if you need to ensure that all data is written before the asynchronous operation completes.

Example

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

socket.async_write_some(boost::asio::buffer(data, size), handler);

See the buffer documentation for information on writing 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 boost::asio::cancellation_type values:

  • cancellation_type::terminal

  • cancellation_type::partial

  • cancellation_type::total

Parameters

Name

Description

buffers

One or more data buffers to be written to 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 completion handler is called.

token

The completion_token that will be used to produce a completion handler, which will be called when the write 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:

Created with MrDocs

Edit this Page