boostorg/beast
1
0
Fork 1
mirror of https://github.com/boostorg/beast.git synced 2025-08-02 06:15:24 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update bytes_transferred documentation for http reads operations

Browse Source
This commit is contained in:
Mohammad Nejati
2024-02-12 10:30:26 +00:00
committed by Mohammad Nejati
parent f8ff44d072
commit 7d4da621ac
1 changed files with 30 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

93
include/boost/beast/http/read.hpp
View File

@@ -62,13 +62,9 @@ namespace http {
@param parser The parser to use. @param parser The parser to use.
@return The number of bytes transferred from the stream. @return The number of bytes consumed by the parser.
@throws system_error Thrown on failure. @throws system_error Thrown on failure.
@note The function returns the total number of bytes transferred from the
stream. This may be zero for the case where there is sufficient pre-existing
message data in the dynamic buffer.
*/ */
template< template<
class SyncReadStream, class SyncReadStream,
@@ -121,11 +117,7 @@ read_some(
@param ec Set to the error, if any occurred. @param ec Set to the error, if any occurred.
@return The number of bytes transferred from the stream. @return The number of bytes consumed by the parser.
@note The function returns the total number of bytes transferred from the
stream. This may be zero for the case where there is sufficient pre-existing
message data in the dynamic buffer.
*/ */
template< template<
class SyncReadStream, class SyncReadStream,
@@ -189,7 +181,7 @@ read_some(
@code @code
void handler( void handler(
error_code const& error, // result of operation error_code const& error, // result of operation
std::size_t bytes_transferred // the total number of bytes transferred from the stream std::size_t bytes_transferred // the number of bytes consumed by the parser
); );
@endcode @endcode
If the handler has an associated immediate executor, If the handler has an associated immediate executor,
@@ -198,10 +190,6 @@ read_some(
this function. Invocation of the handler will be performed in a this function. Invocation of the handler will be performed in a
manner equivalent to using `net::post`. manner equivalent to using `net::post`.
@note The completion handler will receive as a parameter the total number
of bytes transferred from the stream. This may be zero for the case where
there is sufficient pre-existing message data in the dynamic buffer.
@par Per-Operation Cancellation @par Per-Operation Cancellation
This asynchronous operation supports cancellation for the following This asynchronous operation supports cancellation for the following
@@ -270,14 +258,12 @@ async_read_some(
@param parser The parser to use. @param parser The parser to use.
@return The number of bytes transferred from the stream. @return The number of bytes consumed by the parser.
@throws system_error Thrown on failure. @throws system_error Thrown on failure.
@note The function returns the total number of bytes transferred from the @note The implementation will call @ref basic_parser::eager with the value
stream. This may be zero for the case where there is sufficient pre-existing `false` on the parser passed in.
message data in the dynamic buffer. The implementation will call
@ref basic_parser::eager with the value `false` on the parser passed in.
*/ */
template< template<
class SyncReadStream, class SyncReadStream,
@@ -329,12 +315,10 @@ read_header(
@param ec Set to the error, if any occurred. @param ec Set to the error, if any occurred.
@return The number of bytes transferred from the stream. @return The number of bytes consumed by the parser.
@note The function returns the total number of bytes transferred from the @note The implementation will call @ref basic_parser::eager with the value
stream. This may be zero for the case where there is sufficient pre-existing `false` on the parser passed in.
message data in the dynamic buffer. The implementation will call
@ref basic_parser::eager with the value `false` on the parser passed in.
*/ */
template< template<
class SyncReadStream, class SyncReadStream,
@@ -397,7 +381,7 @@ read_header(
@code @code
void handler( void handler(
error_code const& error, // result of operation error_code const& error, // result of operation
std::size_t bytes_transferred // the total number of bytes transferred from the stream std::size_t bytes_transferred // the number of bytes consumed by the parser
); );
@endcode @endcode
If the handler has an associated immediate executor, If the handler has an associated immediate executor,
@@ -406,11 +390,8 @@ read_header(
this function. Invocation of the handler will be performed in a this function. Invocation of the handler will be performed in a
manner equivalent to using `net::post`. manner equivalent to using `net::post`.
@note The completion handler will receive as a parameter the total number @note The implementation will call @ref basic_parser::eager with the value
of bytes transferred from the stream. This may be zero for the case where `false` on the parser passed in.
there is sufficient pre-existing message data in the dynamic buffer. The
implementation will call @ref basic_parser::eager with the value `false`
on the parser passed in.
@par Per-Operation Cancellation @par Per-Operation Cancellation
@@ -480,14 +461,12 @@ async_read_header(
@param parser The parser to use. @param parser The parser to use.
@return The number of bytes transferred from the stream. @return The number of bytes consumed by the parser.
@throws system_error Thrown on failure. @throws system_error Thrown on failure.
@note The function returns the total number of bytes transferred from the @note The implementation will call @ref basic_parser::eager with the value
stream. This may be zero for the case where there is sufficient pre-existing `true` on the parser passed in.
message data in the dynamic buffer. The implementation will call
@ref basic_parser::eager with the value `true` on the parser passed in.
*/ */
template< template<
class SyncReadStream, class SyncReadStream,
@@ -539,12 +518,10 @@ read(
@param ec Set to the error, if any occurred. @param ec Set to the error, if any occurred.
@return The number of bytes transferred from the stream. @return The number of bytes consumed by the parser.
@note The function returns the total number of bytes transferred from the @note The implementation will call @ref basic_parser::eager with the value
stream. This may be zero for the case where there is sufficient pre-existing `true` on the parser passed in.
message data in the dynamic buffer. The implementation will call
@ref basic_parser::eager with the value `true` on the parser passed in.
*/ */
template< template<
class SyncReadStream, class SyncReadStream,
@@ -607,7 +584,7 @@ read(
@code @code
void handler( void handler(
error_code const& error, // result of operation error_code const& error, // result of operation
std::size_t bytes_transferred // the total number of bytes transferred from the stream std::size_t bytes_transferred // the number of bytes consumed by the parser
); );
@endcode @endcode
If the handler has an associated immediate executor, If the handler has an associated immediate executor,
@@ -616,11 +593,8 @@ read(
this function. Invocation of the handler will be performed in a this function. Invocation of the handler will be performed in a
manner equivalent to using `net::post`. manner equivalent to using `net::post`.
@note The completion handler will receive as a parameter the total number @note The implementation will call @ref basic_parser::eager with the value
of bytes transferred from the stream. This may be zero for the case where `true` on the parser passed in.
there is sufficient pre-existing message data in the dynamic buffer. The
implementation will call @ref basic_parser::eager with the value `true`
on the parser passed in.
@par Per-Operation Cancellation @par Per-Operation Cancellation
@@ -693,14 +667,12 @@ async_read(
is undefined. The type must be meet the <em>MoveAssignable</em> and is undefined. The type must be meet the <em>MoveAssignable</em> and
<em>MoveConstructible</em> requirements. <em>MoveConstructible</em> requirements.
@return The number of bytes transferred from the stream. @return The number of bytes consumed by the parser.
@throws system_error Thrown on failure. @throws system_error Thrown on failure.
@note The function returns the total number of bytes transferred from the @note The implementation will call @ref basic_parser::eager with the value
stream. This may be zero for the case where there is sufficient pre-existing `true` on the parser passed in.
message data in the dynamic buffer. The implementation will call
@ref basic_parser::eager with the value `true` on the parser passed in.
*/ */
template< template<
class SyncReadStream, class SyncReadStream,
@@ -755,12 +727,10 @@ read(
@param ec Set to the error, if any occurred. @param ec Set to the error, if any occurred.
@return The number of bytes transferred from the stream. @return The number of bytes consumed by the parser.
@note The function returns the total number of bytes transferred from the @note The implementation will call @ref basic_parser::eager with the value
stream. This may be zero for the case where there is sufficient pre-existing `true` on the parser passed in.
message data in the dynamic buffer. The implementation will call
@ref basic_parser::eager with the value `true` on the parser passed in.
*/ */
template< template<
class SyncReadStream, class SyncReadStream,
@@ -826,7 +796,7 @@ read(
@code @code
void handler( void handler(
error_code const& error, // result of operation error_code const& error, // result of operation
std::size_t bytes_transferred // the total number of bytes transferred from the stream std::size_t bytes_transferred // the number of bytes consumed by the parser
); );
@endcode @endcode
If the handler has an associated immediate executor, If the handler has an associated immediate executor,
@@ -835,11 +805,8 @@ read(
this function. Invocation of the handler will be performed in a this function. Invocation of the handler will be performed in a
manner equivalent to using `net::post`. manner equivalent to using `net::post`.
@note The completion handler will receive as a parameter the total number @note The implementation will call @ref basic_parser::eager with the value
of bytes transferred from the stream. This may be zero for the case where `true` on the parser passed in.
there is sufficient pre-existing message data in the dynamic buffer. The
implementation will call @ref basic_parser::eager with the value `true`
on the parser passed in.
@par Per-Operation Cancellation @par Per-Operation Cancellation