boost/fiber
2
0
Fork 0
mirror of https://github.com/boostorg/fiber.git synced 2026-02-11 23:52:29 +00:00
Code Issues Projects Releases Wiki Activity

Correctly describe bounded_channel's behavior with lwm items.

Browse Source 
I originally assumed that a blocked bounded_channel::push() would only unblock
once the number of items in the channel dropped _below_ lwm, and described it
that way. But in fact the push unblocks as soon as the number of items in the
channel drops as low as lwm. Update documentation accordingly.
This commit is contained in:
Nat Goodspeed
2015-08-15 11:20:19 -04:00
parent b51d78877c
commit 95cc663e43
1 changed files with 6 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
doc/channel.qbk
View File

@@ -266,16 +266,15 @@ time as (system time + `timeout_duration`).
bounded_channel( std::size_t hwm, std::size_t lwm);
[variablelist
[[Preconditions:] [`hwm >= lwm`]]
[[Preconditions:] [`hwm > lwm`]]
[[Effects:] [Constructs an object of class `bounded_channel`. The constructor
with two arguments constructs an object of class `bounded_channel` with a
high-watermark of `hwm` and a low-watermark of `lwm` items. The constructor
with one argument effectively sets both `hwm` and `lwm` to the same value
`wm`.]]
[[Throws:] [`invalid_argument` if `lwm > hwm`.]]
with one argument is effectively the same as `bounded_channel(wm, (wm-1))`.]]
[[Throws:] [`invalid_argument` if `lwm >= hwm`.]]
[[Notes:] [Once the number of values in the channel reaches `hwm`, any call to
`push()`, `push_wait_for()` or `push_wait_until()` will block until the number
of values in the channel has dropped below `lwm`. That is, if `lwm < hwm`, the
of values in the channel is at most `lwm`. That is, if `lwm < (hwm-1)`, the
channel can be in a state in which `push()`, `push_wait_for()` or `push_wait_until()`
calls will block (channel is full) even though the number of values
in the channel is less than `hwm`.]]
@@ -303,7 +302,7 @@ in the channel is less than `hwm`.]]
[template bounded_channel_push_effects[or] [xchannel_push_effects If channel
is not full, enqueues] Otherwise the calling fiber is suspended until
the number of values in the channel drops below `lwm` (return value
the number of values in the channel drops to `lwm` (return value
`success`)[or] the channel is `close()`d (return value `closed`)]
[member_heading bounded_channel..push]
@@ -361,7 +360,7 @@ time_point (return value `timeout`).]]
]
[template bounded_pop_unblocking[] Once the number of items remaining in the
channel drops below `lwm`, any fibers blocked on `push()`, `push_wait_for()`
channel drops to `lwm`, any fibers blocked on `push()`, `push_wait_for()`
or `push_wait_until()` may resume.]
[xchannel_pop bounded_channel... [bounded_pop_unblocking]]