HTTP

Higher level functions such as Basic

This library offers programmers simple and performant models of HTTP messages and their associated operations including synchronous, asynchronous, and buffer-oriented parsing and serialization of messages in the HTTP/1 wire format using __Asio__. Specifically, the library provides:

Stream Reading

The functions [link beast.ref.boost__beast__http__read `read`], [link beast.ref.boost__beast__http__read_header `read_header`], [link beast.ref.boost__beast__http__read_some `read_some`], [link beast.ref.boost__beast__http__async_read `async_read`], [link beast.ref.boost__beast__http__async_read_header `async_read_header`], and [link beast.ref.boost__beast__http__async_read_some `async_read_some`] read HTTP/1 message data from a [link beast.concepts.streams stream].

Stream Writing

The functions [link beast.ref.boost__beast__http__write `write`], [link beast.ref.boost__beast__http__write_header `write_header`], [link beast.ref.boost__beast__http__write_some `write_some`], [link beast.ref.boost__beast__http__async_write `async_write`], [link beast.ref.boost__beast__http__async_write_header `async_write_header`], and [link beast.ref.boost__beast__http__async_write_some `async_write_some`] write HTTP/1 message data to a [link beast.concepts.streams stream].

Serialization

The __serializer__ produces a series of octet buffers conforming to the __rfc7230__ wire representation of a __message__.

Parsing

The __parser__ attempts to convert a series of octet buffers into a __message__.

Interfaces for operating on HTTP messages are structured into several layers. The highest level provides ease of use, while lower levels provide progressively more control, options, and flexibility. At the lowest level customization points are provided, where user defined types can replace parts of the implementation. The layers are arranged thusly:

[*6]

__message__

At the highest level, these free functions send or receive a complete HTTP message in one call. They are designed for ease of use: [link beast.ref.boost__beast__http__read.overload4 `read`], [link beast.ref.boost__beast__http__write.overload4 `write`], [link beast.ref.boost__beast__http__async_read.overload2 `async_read`], and [link beast.ref.boost__beast__http__async_write.overload2 `async_write`].

[*5]

__parser__, __serializer__

For more control, callers may take responsibility for managing the required __parser__ or __serializer__ transient state objects. This allows additional configuration such as limiting the number of bytes for message components during parsing, or regulating the size of buffers emitted during output. These functions send or receive complete messages using a serializer or parser: [link beast.ref.boost__beast__http__read.overload2 `read`], [link beast.ref.boost__beast__http__write.overload2 `write`], [link beast.ref.boost__beast__http__async_read.overload1 `async_read`], and [link beast.ref.boost__beast__http__async_write.overload1 `async_write`].

[*4]

__header__