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

This is the documentation for a snapshot of the develop branch, built from commit f7b3e24375.
PrevUpHomeNext
http::write_header (2 of 2 overloads)

Write a header 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_header(
    SyncWriteStream& stream,
    serializer< isRequest, Body, Fields >& sr,
    error_code& ec);
Description

This function is used to write a header 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.

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.

Remarks

The implementation will call serializer::split with the value true on the serializer passed in.

See Also

serializer


PrevUpHomeNext