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 (5 of 6 overloads)

Write a complete message to a stream.

Synopsis

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

template<
    class SyncWriteStream,
    bool isRequest,
    class Body,
    class Fields>
std::size_t
write(
    SyncWriteStream& stream,
    message< isRequest, Body, Fields >& msg,
    error_code& ec);
Description

This function is used to write a complete message to a stream using HTTP/1. 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 algorithm will use a temporary http::serializer with an empty chunk decorator to produce buffers.

Remarks

This function only participates in overload resolution if http::is_mutable_body_writer for Body returns true.

Parameters

Name

Description

stream

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

msg

The message to write.

ec

Set to the error, if any occurred.

Return Value

The number of bytes written to the stream.

See Also

http::message

Convenience header <boost/beast/http.hpp>


PrevUpHomeNext