|
Start an asynchronous operation to write all of the supplied data to a stream.
template< typename AsyncWriteStream, typename DynamicBuffer_v1, typename WriteToken = DEFAULT> DEDUCED async_write( AsyncWriteStream & s, DynamicBuffer_v1 && buffers, WriteToken && token = DEFAULT, typename constraint< is_dynamic_buffer_v1< typename decay< DynamicBuffer_v1 >::type >::value >::type = 0, typename constraint< !is_dynamic_buffer_v2< typename decay< DynamicBuffer_v1 >::type >::value >::type = 0);
This function is used to asynchronously write a certain number of bytes of data to a stream. It is an initiating function for an asynchronous operation, and always returns immediately. The asynchronous operation will continue until one of the following conditions is true:
This operation is implemented in terms of zero or more calls to the stream's async_write_some function, and is known as a composed operation. The program must ensure that the stream performs no other write operations (such as async_write, the stream's async_write_some function, or any other composed operations that perform writes) until this operation completes.
The stream to which the data is to be written. The type must support the AsyncWriteStream concept.
The dynamic buffer sequence from which data will be written. 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. Successfully written data is automatically consumed from the buffers.
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:
void handler( // Result of operation. const asio::error_code& error, // Number of bytes written from the buffers. If an error // occurred, this will be less than the sum of the buffer sizes. std::size_t bytes_transferred );
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.
void(asio::error_code, std::size_t)
This asynchronous operation supports cancellation for the following cancellation_type
values:
cancellation_type::terminal
cancellation_type::partial
if they are also supported by the AsyncWriteStream
type's async_write_some
operation.