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

Explain that is_closed() doesn't imply is_empty().

Browse Source
This commit is contained in:
Nat Goodspeed
2015-08-05 07:51:10 -04:00
parent 4cdb326754
commit 1897a2a9fc
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/channel.qbk
View File

@@ -110,7 +110,9 @@ channel operations return the state of the channel.
[variablelist
[[Returns:] [`true` if channel has been closed.]]
[[Throws:] [Nothing.]]
[[Note:] [The channel is not closed by default.]]
[[Note:] [The channel is not closed by default. `is_closed()` returns `true`
when `close()` has been called, whether or not there are pending values in the
channel. The channel is not exhausted until `is_closed() && is_empty()`.]]
]
]
[xchannel_is_closed unbounded_channel]