Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

PrevUpHomeNext
basic_stream::async_write_some

Write some data asynchronously.

Synopsis
template<
    class ConstBufferSequence,
    class WriteHandler = net::default_completion_token_t<Executor>>
DEDUCED
async_write_some(
    ConstBufferSequence const& buffers,
    WriteHandler&& handler = net::default_completion_token_t< Executor >{});
Description

This function is used to asynchronously write data to the underlying socket. This call always returns immediately. The asynchronous operation will continue until one of the following conditions is true:

The algorithm, known as a composed asynchronous operation, is implemented in terms of calls to the next layer's async_write_some function. The program must ensure that no other calls to basic_stream::async_write_some are performed until this operation completes. If the timeout timer expires while the operation is outstanding, the operation will be canceled and the completion handler will be invoked with the error timeout.

Parameters

Name

Description

buffers

The buffers from which the data will be written. If the size of the buffers is zero bytes, the operation always completes immediately with no error. 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 completion handler to invoke when the operation completes. The implementation takes ownership of the handler by performing a decay-copy. The equivalent function signature of the handler must be:

void handler(
    error_code error,               // Result of operation.
    std::size_t bytes_transferred   // Number of bytes written.
);

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 net::post.

Remarks

The async_write_some operation may not transmit all of the requested number of bytes. Consider using the function net::async_write if you need to ensure that the requested amount of data is sent before the asynchronous operation completes.


PrevUpHomeNext