Exit Zen
2
string ID 12
type: paragraph
English
An instance of [*RatePolicy] is associated with a [link beast.ref.boost__beast__basic_stream `basic_stream`], and controls the rate at which bytes may be independently sent and received. This may be used to achieve fine-grained bandwidth management and flow control.
266/2660 · 266
3
string ID 18
type: heading
English
Associated Types
16/160 · 16
4
string ID 20
type: list
English
* [link beast.ref.boost__beast__rate_policy_access `rate_policy_access`]
72/720 · 72
5
string ID 23
type: paragraph
English
These requirements may undergo non-backward compatible
54/540 · 54
6
string ID 27
type: heading
English
Requirements
12/120 · 12
7
string ID 29
type: paragraph
English
In this table:
14/140 · 14
8
string ID 31
type: list
English
* `P` denotes a type that meets the requirements of [*RatePolicy].
* `x` denotes an xvalue of type `P`
* `a` denotes a value of type `P`.
* `n` denotes a value of type `std::size_t`
181/1810 · 181
9
string ID 36
type: table title
English
Valid expressions
17/170 · 17
12
string ID 36
type: table cell
English
Semantics, Pre/Post-conditions
30/300 · 30
14
string ID 36
type: table cell
English
Requires ['MoveConstructible].
30/300 · 30
15
string ID 36
type: table cell
English
`friend rate_policy_access`
27/270 · 27
16
string ID 36
type: table cell
English
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.
222/2220 · 222
17
string ID 36
type: table cell
English
`a.available_read_bytes()`
26/260 · 26
19
string ID 36
type: table cell
English
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.
412/4120 · 412
20
string ID 36
type: table cell
English
`a.available_write_bytes()`
27/270 · 27
21
string ID 36
type: table cell
English
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.
413/4130 · 413
22
string ID 36
type: table cell
English
`a.transfer_read_bytes(n)`
26/260 · 26
23
string ID 36
type: table cell
English
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.
304/3040 · 304
24
string ID 36
type: table cell
English
`a.transfer_write_bytes(n)`
27/270 · 27
25
string ID 36
type: table cell
English
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.
303/3030 · 303