Beast Logo

PrevUpHomeNext

http::async_write_some

Write part of a message to a stream asynchronously using a serializer.

Synopsis

Defined in header <beast/http/write.hpp>

template<
    class AsyncWriteStream,
    bool isRequest,
    class Body,
    class Fields,
    class Decorator,
    class WriteHandler>
void-or-deduced
async_write_some(
    AsyncWriteStream& stream,
    serializer< isRequest, Body, Fields, Decorator >& sr,
    WriteHandler&& handler);
Description

This function is used to write part of a message to a stream asynchronously using a caller-provided HTTP/1 serializer. 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, and is known as a composed operation. The program must ensure that the stream performs no other write operations until this operation completes.

The amount of data actually transferred is controlled by the behavior of the underlying stream, performing bounded work for each call. This helps applications set reasonable timeouts. It also allows application-level flow control to function correctly. For example when using a TCP/IP based stream.

Parameters

Name

Description

stream

The stream to which the data is to be written. The type must support the AsyncWriteStream concept.

sr

The serializer to use. The object must remain valid at least until the handler is called; ownership is not transferred.

handler

The handler to be called when the operation completes. Copies will be made of the handler as required. The equivalent function signature of the handler must be:

 void handler(
    error_code const& error // result of operation
);

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.

See Also

http::serializer

Convenience header <beast/http.hpp>


PrevUpHomeNext