asio::async_write


Functions

template<typename AsyncWriteStream, typename ConstBufferSequence, typename WriteHandler>
void asio::async_write (AsyncWriteStream &s, const ConstBufferSequence &buffers, WriteHandler handler)
template<typename AsyncWriteStream, typename ConstBufferSequence, typename CompletionCondition, typename WriteHandler>
void asio::async_write (AsyncWriteStream &s, const ConstBufferSequence &buffers, CompletionCondition completion_condition, WriteHandler handler)
template<typename AsyncWriteStream, typename Allocator, typename WriteHandler>
void asio::async_write (AsyncWriteStream &s, asio::basic_streambuf< Allocator > &b, WriteHandler handler)
template<typename AsyncWriteStream, typename Allocator, typename CompletionCondition, typename WriteHandler>
void asio::async_write (AsyncWriteStream &s, asio::basic_streambuf< Allocator > &b, CompletionCondition completion_condition, WriteHandler handler)

Function Documentation

template<typename AsyncWriteStream, typename Allocator, typename CompletionCondition, typename WriteHandler>
void asio::async_write ( AsyncWriteStream &  s,
basic_streambuf< Allocator > &  b,
CompletionCondition  completion_condition,
WriteHandler  handler 
) [inline]

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:

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

Definition at line 259 of file write.ipp.

References asio::async_write(), and asio::basic_streambuf< Allocator >::data().

template<typename AsyncWriteStream, typename Allocator, typename WriteHandler>
void asio::async_write ( AsyncWriteStream &  s,
basic_streambuf< Allocator > &  b,
WriteHandler  handler 
) [inline]

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:

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

Definition at line 269 of file write.ipp.

References asio::async_write(), and asio::transfer_all().

Referenced by libtorrent::http_tracker_connection::connected().

template<typename AsyncWriteStream, typename ConstBufferSequence, typename CompletionCondition, typename WriteHandler>
void asio::async_write ( AsyncWriteStream &  s,
const ConstBufferSequence &  buffers,
CompletionCondition  completion_condition,
WriteHandler  handler 
) [inline]

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 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: 
 bool completion_condition(
   const asio::error_code& 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 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. Invocation of the handler will be performed in a manner equivalent to using asio::io_service::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.

Definition at line 181 of file write.ipp.

Referenced by asio::buffered_write_stream< Stream >::async_flush(), asio::async_write(), and asio::ssl::detail::openssl_operation< Stream >::do_async_write().

template<typename AsyncWriteStream, typename ConstBufferSequence, typename WriteHandler>
void asio::async_write ( AsyncWriteStream &  s,
const ConstBufferSequence &  buffers,
WriteHandler  handler 
) [inline]

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.
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 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. Invocation of the handler will be performed in a manner equivalent to using asio::io_service::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.

Definition at line 194 of file write.ipp.

References asio::async_write(), and asio::transfer_all().

Generated on Sun May 25 00:20:20 2008 by  doxygen 1.5.6