mirror of
https://github.com/Xahau/xahaud.git
synced 2025-12-06 17:27:52 +00:00
8b60ef9db4
9f10b11 Set version to 1.0.0-b28 195f974 Fix HTTP split parse edge case: 264fd41 Restyle async result constructions 572a0eb Split out and rename test stream classes 95b6646 Tidy up some WebSocket javadocs f6938d3 Set version to 1.0.0-b27 a6120cd Update copyright dates c7bfe7d Add documentation building instructions f6c91ce Tidy up tests and docs: f03985f Move basic_streambuf to streambuf.hpp (API Change): b8639a7 Invoke callback on pings and pongs (API Change): git-subtree-dir: src/beast git-subtree-split: 9f10b11eff58aeb793b673c8a8cb6e2bee3db621
62 lines
1.9 KiB
Plaintext
62 lines
1.9 KiB
Plaintext
[/
|
|
Copyright (c) 2013-2017 Vinnie Falco (vinnie dot falco at gmail dot com)
|
|
|
|
Distributed under the Boost Software License, Version 1.0. (See accompanying
|
|
file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
|
|
]
|
|
|
|
[section:Parser Parser requirements]
|
|
|
|
A [*Parser] is used to deserialize objects from
|
|
[link beast.ref.streams streams]. Objects of this type are used with
|
|
[link beast.ref.http__parse http::parse] and
|
|
[link beast.ref.http__async_parse http::async_parse]. The definition of
|
|
an object, and the predicate defining when the parse is complete, are
|
|
determined by the implementation.
|
|
|
|
In this table:
|
|
|
|
* `X` denotes a type meeting the requirements of [*Parser].
|
|
|
|
* `a` denotes a value of type `X`.
|
|
|
|
* `b` is a value meeting the requirements of __ConstBufferSequence__.
|
|
|
|
* `ec` is a value of type [link beast.ref.error_code `error_code&`].
|
|
|
|
[table Parser requirements
|
|
[[operation] [type] [semantics, pre/post-conditions]]
|
|
[
|
|
[`a.complete()`]
|
|
[`bool`]
|
|
[
|
|
Returns `true` when parsing is complete.
|
|
]
|
|
]
|
|
[
|
|
[`a.write(b, ec)`]
|
|
[`std::size_t`]
|
|
[
|
|
Sequentially parses the octets in the specified input buffer sequence
|
|
until an error occurs, the end of the buffer is reached, or parsing is
|
|
complete. Upon success, this function returns the number of bytes used
|
|
from the input. If an error occurs, `ec` is set to the error code and
|
|
parsing stops.
|
|
]
|
|
]
|
|
[
|
|
[`a.write_eof(ec)`]
|
|
[`void`]
|
|
[
|
|
Indicates to the parser that no more octets will be available.
|
|
Typically this function is called when the end of stream is reached.
|
|
For example, if a call to `boost::asio::ip::tcp::socket::read_some`
|
|
generates a `boost::asio::error::eof` error. Some objects, such as
|
|
certain HTTP/1 messages, determine the end of the message body by
|
|
an end of file marker or closing of the connection.
|
|
]
|
|
]
|
|
]
|
|
|
|
[endsect]
|