asio::async_write

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

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)

Detailed Description

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

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:

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

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 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:

This operation is implemented in terms of zero 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().

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:

This operation is implemented in terms of zero 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: 
 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. 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.

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 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:

This operation is implemented in terms of zero 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.

Generated on Wed Sep 8 03:00:08 2010 for rphp by  doxygen 1.5.4