Zen

Source string Source string

type: heading
8/10000 · 8

The string is read-only.

Key English Actions
`P a(x)`
Requires ['MoveConstructible].
`friend rate_policy_access`
The member functions required in `P` should be private. [link beast.ref.boost__beast__rate_policy_access `rate_policy_access`] must be a friend of `P` for the implementation to gain access to the required member functions.
`a.available_read_bytes()`
36
`std::size_t`
This function is called by the implementation to determine the maximum number of allowed bytes to be transferred in the next read operation. The actual number of bytes subsequently transferred may be less than this number.

If the policy returns a value of zero, the read operation will asynchronously wait until the next timer interval before retrying. When the retry occurs, this function will be called again.
`a.available_write_bytes()`
This function is called by the implementation to determine the maximum number of allowed bytes to be transferred in the next write operation. The actual number of bytes subsequently transferred may be less than this number.

If the policy returns a value of zero, the read operation will asynchronously wait until the next timer interval before retrying. When the retry occurs, this function will be called again.
`a.transfer_read_bytes(n)`
The implementation calls this function to inform the policy that `n` bytes were successfully transferred in the most recent read operation. The policy object may optionally use this information to calculate throughputs and/or inform the algorithm used to determine subsequently queried transfer maximums.
`a.transfer_write_bytes(n)`
The implementation calls this function to inform the policy that `n` bytes were successfully transferred in the most recent write operation. The policy object may optionally use this information to calculate throughputs and/or inform the algorithm used to determine subsequently queried transfer limits.
`a.on_timer()`
The implementation calls this function every time the internal timer expires. The policy object may optionally use this opportunity to calculate elapsed time and throughput, and/or inform the algorithm used to determine subsequently queried transfer limits.
Exemplar
Models
* [link beast.ref.boost__beast__simple_rate_policy `simple_rate_policy`]
* [link beast.ref.boost__beast__unlimited_rate_policy `unlimited_rate_policy`]
Key English Actions
Models
`P a(x)`
Requires ['MoveConstructible].
`friend rate_policy_access`
The member functions required in `P` should be private. [link beast.ref.boost__beast__rate_policy_access `rate_policy_access`] must be a friend of `P` for the implementation to gain access to the required member functions.
`a.available_read_bytes()`
RatePolicy
This function is called by the implementation to determine the maximum number of allowed bytes to be transferred in the next read operation. The actual number of bytes subsequently transferred may be less than this number.

If the policy returns a value of zero, the read operation will asynchronously wait until the next timer interval before retrying. When the retry occurs, this function will be called again.
`a.available_write_bytes()`
This function is called by the implementation to determine the maximum number of allowed bytes to be transferred in the next write operation. The actual number of bytes subsequently transferred may be less than this number.

If the policy returns a value of zero, the read operation will asynchronously wait until the next timer interval before retrying. When the retry occurs, this function will be called again.
`a.transfer_read_bytes(n)`
The implementation calls this function to inform the policy that `n` bytes were successfully transferred in the most recent read operation. The policy object may optionally use this information to calculate throughputs and/or inform the algorithm used to determine subsequently queried transfer maximums.
`a.transfer_write_bytes(n)`
The implementation calls this function to inform the policy that `n` bytes were successfully transferred in the most recent write operation. The policy object may optionally use this information to calculate throughputs and/or inform the algorithm used to determine subsequently queried transfer limits.
`a.on_timer()`
The implementation calls this function every time the internal timer expires. The policy object may optionally use this opportunity to calculate elapsed time and throughput, and/or inform the algorithm used to determine subsequently queried transfer limits.
Exemplar
36
`std::size_t`

Loading…

User avatar admin

String added in the repository
Exemplar
Exemplar
06/05/2026
Browse all string changes

Glossary

English English
No related strings found in the glossary.

String information

Source string description
type: heading
Flags
read-only
Unit identifier
56294
Source string location
string ID 115
String age
06/05/2026
Last updated
06/05/2026
Source string age
06/05/2026
Translation file QuickBook file
doc/qbk/07_concepts/RatePolicy.qbk, string 28