| Home | Libraries | People | FAQ | More

# boost::asio::async_write

## Functions

template<typename Async_Write_Stream, typename Const_Buffers, typename Handler>
void | boost::asio::async_write (Async_Write_Stream &s, const Const_Buffers &buffers, Handler handler)
| Start an asynchronous operation to write of all of the supplied data to a stream.
template<typename Async_Write_Stream, typename Const_Buffers, typename Completion_Condition, typename Handler>
void | boost::asio::async_write (Async_Write_Stream &s, const Const_Buffers &buffers, Completion_Condition completion_condition, Handler handler)
| Start an asynchronous operation to write a certain amount of data to a stream.
template<typename Async_Write_Stream, typename Allocator, typename Handler>
void | boost::asio::async_write (Async_Write_Stream &s, basic_streambuf< Allocator > &b, Handler handler)
| Start an asynchronous operation to write a certain amount of data to a stream.
template<typename Async_Write_Stream, typename Allocator, typename Completion_Condition, typename Handler>
void | boost::asio::async_write (Async_Write_Stream &s, basic_streambuf< Allocator > &b, Completion_Condition completion_condition, Handler handler)
| Start an asynchronous operation to write a certain amount of data to a stream.

## Function Documentation

template<typename Async_Write_Stream, typename Const_Buffers, typename Handler>

void boost::asio::async_write | ( | Async_Write_Stream & | s,
|  | const Const_Buffers & | buffers,
|  | Handler | handler |
| ) |  |  |

Start an asynchronous operation to write of all of the supplied 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.

- An error occurred.

This operation is implemented in terms of one or more calls to the stream's async_write_some function.

Parameters:

  | s | The stream to which the data is to be written. The type must support the Async_Write_Stream 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 Async_Write_Stream::error_type& 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. Invocation of the handler will be performed in a manner equivalent to using boost::asio::io_service::post().

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

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

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

template<typename Async_Write_Stream, typename Const_Buffers, typename Completion_Condition, typename Handler>

void boost::asio::async_write | ( | Async_Write_Stream & | s,
|  | const Const_Buffers & | buffers,
|  | Completion_Condition | completion_condition,
|  | Handler | handler |
| ) |  |  |

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 true.

This operation is implemented in terms of one or more calls to the stream's async_write_some function.

Parameters:

  | s | The stream to which the data is to be written. The type must support the Async_Write_Stream 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:

       bool completion_condition(
         const Async_Write_Stream::error_type& error, // Result of latest write_some
                                                      // operation.

         std::size_t bytes_transferred                // Number of bytes transferred
                                                      // so far.
       );

  A return value of true indicates that the write operation is complete. False indicates that further calls to the stream's async_write_some function are required.

  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 Async_Write_Stream::error_type& 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. Invocation of the handler will be performed in a manner equivalent to using boost::asio::io_service::post().

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

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

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

template<typename Async_Write_Stream, typename Allocator, typename Handler>

void boost::asio::async_write | ( | Async_Write_Stream & | s,
|  | basic_streambuf< Allocator > & | b,
|  | Handler | handler |
| ) |  |  |

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 basic_streambuf has been written.

- An error occurred.

This operation is implemented in terms of one or more calls to the stream's async_write_some function.

Parameters:

  | s | The stream to which the data is to be written. The type must support the Async_Write_Stream concept.
  | b | A basic_streambuf object from which data will be written. Ownership of the streambuf is retained by the caller, which must guarantee that it remains 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 Async_Write_Stream::error_type& 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. Invocation of the handler will be performed in a manner equivalent to using boost::asio::io_service::post().

template<typename Async_Write_Stream, typename Allocator, typename Completion_Condition, typename Handler>

void boost::asio::async_write | ( | Async_Write_Stream & | s,
|  | basic_streambuf< Allocator > & | b,
|  | Completion_Condition | completion_condition,
|  | Handler | handler |
| ) |  |  |

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 basic_streambuf has been written.

- The completion_condition function object returns true.

This operation is implemented in terms of one or more calls to the stream's async_write_some function.

Parameters:

  | s | The stream to which the data is to be written. The type must support the Async_Write_Stream concept.
  | b | A basic_streambuf object from which data will be written. Ownership of the streambuf is retained by the caller, which must guarantee that it remains 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:

       bool completion_condition(
         const Async_Write_Stream::error_type& error, // Result of latest write_some
                                                      // operation.

         std::size_t bytes_transferred                // Number of bytes transferred
                                                      // so far.
       );

  A return value of true indicates that the write operation is complete. False indicates that further calls to the stream's async_write_some function are required.

  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 Async_Write_Stream::error_type& 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. Invocation of the handler will be performed in a manner equivalent to using boost::asio::io_service::post().

| Copyright © 2003 - 2006 Christopher M. Kohlhoff