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
http::write_some (2 of 2 overloads)

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

Synopsis

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

template<
    class SyncWriteStream,
    bool isRequest,
    class Body,
    class Fields>
std::size_t
write_some(
    SyncWriteStream& stream,
    serializer< isRequest, Body, Fields >& sr,
    error_code& ec);
Description

This function is used to write part of a message to a stream using a caller-provided HTTP/1 serializer. The call will block until one of the following conditions is true:

This operation is implemented in terms of one or more calls to the stream's write_some function. The amount of data actually transferred is controlled by the behavior of the underlying stream, subject to the buffer size limit of the serializer obtained or set through a call to http::serializer::limit. Setting a limit and performing bounded work 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 SyncWriteStream concept.

sr

The serializer to use.

ec

Set to indicate what error occurred, if any.

Return Value

The number of bytes written to the stream.

See Also

http::async_write_some, http::serializer

Convenience header <boost/beast/http.hpp>


PrevUpHomeNext