asio::async_write

The async_write function is a composed asynchronous operation that writes a certain amount of data to a stream before completion. More...

Functions
template<typename AsyncWriteStream , typename DynamicBuffer_v1 , ASIO_COMPLETION_TOKEN_FOR(void(asio::error_code, std::size_t)) WriteHandler>
	asio::ASIO_INITFN_AUTO_RESULT_TYPE (WriteHandler, void(asio::error_code, std::size_t)) async_write(AsyncWriteStream &s
	Start an asynchronous operation to write all of the supplied data to a stream. More...
template<typename AsyncWriteStream , typename ConstBufferSequence , typename CompletionCondition , ASIO_COMPLETION_TOKEN_FOR(void(asio::error_code, std::size_t)) WriteHandler>
const ConstBufferSequence ASIO_MOVE_ARG(WriteHandler) handler ASIO_DEFAULT_COMPLETION_TOKEN(typename AsyncWriteStream	asio::ASIO_INITFN_AUTO_RESULT_TYPE (WriteHandler, void(asio::error_code, std::size_t)) async_write(AsyncWriteStream &s
	Start an asynchronous operation to write a certain amount of data to a stream. More...
const ConstBufferSequence CompletionCondition	asio::ASIO_MOVE_ARG (WriteHandler) handler

Variables
enable_if< execution::is_executor< Executor >::value||is_executor< Executor >::value >::type	asio::ASIO_MOVE_ARG (CompletionToken) token

Detailed Description

The async_write function is a composed asynchronous operation that writes a certain amount of data to a stream before completion.

Function Documentation

ASIO_INITFN_AUTO_RESULT_TYPE() [1/2]

template<typename AsyncWriteStream , typename DynamicBuffer_v1 , ASIO_COMPLETION_TOKEN_FOR(void(asio::error_code, std::size_t)) WriteHandler>

asio::ASIO_INITFN_AUTO_RESULT_TYPE ( WriteHandler  , void(asio::error_code, std::size_t)    ) &

inline

Start an asynchronous operation to write all of the supplied data to a stream.

Start an asynchronous operation to write all of the supplied data at the specified offset.

This function is used to asynchronously write a certain number of bytes of data to a stream. The function call always returns immediately. The asynchronous operation will continue until one of the following conditions is true:

• All of the data in the supplied buffers has been written. That is, the bytes transferred is equal to the sum of the buffer sizes.

• An error occurred.

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.

Parameters

s	The stream to which the data is to be written. The type must support the AsyncWriteStream concept.
buffers	One or more buffers containing the data to 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 handler is called.
handler	The handler to be called when the write 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 written from the // buffers. If an error occurred, // this will be less than the sum // of the buffer sizes. ); 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 asio::post().

Example

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

asio::async_write(s, asio::buffer(data, size), handler);

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

This function is used to asynchronously write a certain number of bytes of data to a stream. The function call always returns immediately. The asynchronous operation will continue until one of the following conditions is true:

• All of the data in the supplied dynamic buffer sequence has been written.

• An error occurred.

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.

Parameters

s	The stream to which the data is to be written. The type must support the AsyncWriteStream concept.
buffers	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 handler is called. Successfully written data is automatically consumed from the buffers.
handler	The handler to be called when the write 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 written from the // buffers. If an error occurred, // this will be less than the sum // of the buffer sizes. ); 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 asio::post().

This function is used to asynchronously write a certain number of bytes of data to a random access device at a specified offset. The function call always returns immediately. The asynchronous operation will continue until one of the following conditions is true:

• All of the data in the supplied buffers has been written. That is, the bytes transferred is equal to the sum of the buffer sizes.

• An error occurred.

This operation is implemented in terms of zero or more calls to the device's async_write_some_at function, and is known as a composed operation. The program must ensure that the device performs no overlapping write operations (such as async_write_at, the device's async_write_some_at function, or any other composed operations that perform writes) until this operation completes. Operations are overlapping if the regions defined by their offsets, and the numbers of bytes to write, intersect.

Parameters

d	The device to which the data is to be written. The type must support the AsyncRandomAccessWriteDevice concept.
offset	The offset at which the data will be written.
buffers	One or more buffers containing the data to 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 handler is called.
handler	The handler to be called when the write operation completes. Copies will be made of the handler as required. The function signature of the 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 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 asio::post().

Example

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

asio::async_write_at(d, 42, asio::buffer(data, size), handler);

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

ASIO_INITFN_AUTO_RESULT_TYPE() [2/2]

template<typename AsyncWriteStream , typename ConstBufferSequence , typename CompletionCondition , ASIO_COMPLETION_TOKEN_FOR(void(asio::error_code, std::size_t)) WriteHandler>

const ConstBufferSequence ASIO_MOVE_ARG (WriteHandler) handler ASIO_DEFAULT_COMPLETION_TOKEN( typename AsyncWriteStream asio::ASIO_INITFN_AUTO_RESULT_TYPE	(	WriteHandler	,
		void(asio::error_code, std::size_t)
	)		&

Start an asynchronous operation to write a certain amount of data to a stream.

This function is used to asynchronously write a certain number of bytes of data to a stream. The function call always returns immediately. The asynchronous operation will continue until one of the following conditions is true:

• All of the data in the supplied buffers has been written. That is, the bytes transferred is equal to the sum of the buffer sizes.

• The completion_condition function object returns 0.

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.

Parameters

s	The stream to which the data is to be written. The type must support the AsyncWriteStream concept.
buffers	One or more buffers containing the data to 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 handler is called.
completion_condition	The function object to be called to determine whether the write operation is complete. The signature of the function object must be: std::size_t completion_condition( // Result of latest async_write_some operation. const asio::error_code& error, // Number of bytes transferred so far. std::size_t bytes_transferred ); A return value of 0 indicates that the write operation is complete. A non-zero return value indicates the maximum number of bytes to be written on the next call to the stream's async_write_some function.
handler	The handler to be called when the write 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 written from the // buffers. If an error occurred, // this will be less than the sum // of the buffer sizes. ); 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 asio::post().

Example

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

asio::async_write(s,
   asio::buffer(data, size),
   asio::transfer_at_least(32),
   handler); 

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