Zen

Source string Source string

type: paragraph
48/10000 · 48

The string is read-only.

Key English Actions
* Receive the header first and body later.
* Receive a large body using a fixed-size buffer.
* Receive a message incrementally: bounded work in each I/O cycle.
* Defer the commitment to a __Body__ type until after reading the header.
These types of operations require callers to manage the lifetime of associated state, by constructing a class derived from __basic_parser__. Beast comes with the derived instance __parser__ which creates complete __message__ objects using the __basic_fields__ Fields container.
Parser
29
Name
29
Description
__parser__
/// An HTTP/1 parser for producing a message.
template<
bool isRequest, // `true` to parse an HTTP request
class Body, // The Body type for the resulting message
class Allocator = std::allocator<char>> // The type of allocator for the header
class parser
: public basic_parser<...>;
[link beast.ref.boost__beast__http__request_parser `request_parser`]
/// An HTTP/1 parser for producing a request message.
template<class Body, class Allocator = std::allocator<char>>
using request_parser = parser<true, Body, Allocator>;
[link beast.ref.boost__beast__http__response_parser `response_parser`]
/// An HTTP/1 parser for producing a response message.
template<class Body, class Allocator = std::allocator<char>>
using response_parser = parser<false, Body, Allocator>;
The __basic_parser__ and classes derived from it handle octet streams
The stream operations which work on parsers are:
71
Parser Stream Operations
71
Name
71
Description
[link beast.ref.boost__beast__http__read.overload1 [*read]]
Read everything into a parser from a __SyncReadStream__.
[link beast.ref.boost__beast__http__async_read.overload1 [*async_read]]
Read everything into a parser asynchronously from an __AsyncReadStream__.
[link beast.ref.boost__beast__http__read_header.overload1 [*read_header]]
Read only the header octets into a parser from a __SyncReadStream__.
[link beast.ref.boost__beast__http__async_read_header [*async_read_header]]
Read only the header octets into a parser asynchronously from an __AsyncReadStream__.
[link beast.ref.boost__beast__http__read_some.overload1 [*read_some]]
Read some octets into a parser from a __SyncReadStream__.
[link beast.ref.boost__beast__http__async_read_some [*async_read_some]]
Read some octets into a parser asynchronously from an __AsyncReadStream__.
English Actions
* Receive the header first and body later.
* Receive a large body using a fixed-size buffer.
* Receive a message incrementally: bounded work in each I/O cycle.
* Defer the commitment to a __Body__ type until after reading the header.
These types of operations require callers to manage the lifetime of associated state, by constructing a class derived from __basic_parser__. Beast comes with the derived instance __parser__ which creates complete __message__ objects using the __basic_fields__ Fields container.
Parser
__parser__
/// An HTTP/1 parser for producing a message.
template<
bool isRequest, // `true` to parse an HTTP request
class Body, // The Body type for the resulting message
class Allocator = std::allocator<char>> // The type of allocator for the header
class parser
: public basic_parser<...>;
[link beast.ref.boost__beast__http__request_parser `request_parser`]
/// An HTTP/1 parser for producing a request message.
template<class Body, class Allocator = std::allocator<char>>
using request_parser = parser<true, Body, Allocator>;
[link beast.ref.boost__beast__http__response_parser `response_parser`]
/// An HTTP/1 parser for producing a response message.
template<class Body, class Allocator = std::allocator<char>>
using response_parser = parser<false, Body, Allocator>;
The __basic_parser__ and classes derived from it handle octet streams
The stream operations which work on parsers are:
[link beast.ref.boost__beast__http__read.overload1 [*read]]
Read everything into a parser from a __SyncReadStream__.
[link beast.ref.boost__beast__http__async_read.overload1 [*async_read]]
Read everything into a parser asynchronously from an __AsyncReadStream__.
[link beast.ref.boost__beast__http__read_header.overload1 [*read_header]]
Read only the header octets into a parser from a __SyncReadStream__.
[link beast.ref.boost__beast__http__async_read_header [*async_read_header]]
Read only the header octets into a parser asynchronously from an __AsyncReadStream__.
[link beast.ref.boost__beast__http__read_some.overload1 [*read_some]]
Read some octets into a parser from a __SyncReadStream__.
[link beast.ref.boost__beast__http__async_read_some [*async_read_some]]
The parser contains a message constructed internally. Arguments passed to the parser's constructor are forwarded into the message container. The caller can access the message inside the parser by calling [link beast.ref.boost__beast__http__parser.get `parser::get`]. If the `Fields` and `Body` types are [*MoveConstructible], the caller can take ownership of the message by calling [link beast.ref.boost__beast__http__parser.release `parser::release`]. In this example we read an HTTP response with a string body using a parser, then print the response:
Incremental Read __example__
This function uses [link beast.ref.boost__beast__http__buffer_body `buffer_body`] and parser stream operations to read a message body progressively using a small, fixed-size buffer:
Reading large response body __example__
This example presents how to increase the default limit of the response body size, thus the content larger than the default 8MB can be read.

Loading…

User avatar admin

String added in the repository
The stream operations which work on parsers are:
The stream operations which work on parsers are:
06/05/2026
Browse all string changes

Glossary

English English
No related strings found in the glossary.

String information

Source string description
type: paragraph
Flags
read-only
Unit identifier
57352
Source string location
string ID 69
String age
06/05/2026
Last updated
06/05/2026
Source string age
06/05/2026
Translation file QuickBook file
doc/qbk/04_http/05_parser_streams.qbk, string 18