Commit c9f2b4ad authored by Shai Szulanski's avatar Shai Szulanski Committed by Facebook GitHub Bot

Add comment to Baton about cancellation

Differential Revision: D32394449

fbshipit-source-id: 2c2bc54c2d71cc677c35195adc73f579b5d0c101
parent bd17f2ca
...@@ -29,6 +29,11 @@ namespace coro { ...@@ -29,6 +29,11 @@ namespace coro {
/// coroutine to co_await the baton and suspend until the baton is posted by /// coroutine to co_await the baton and suspend until the baton is posted by
/// some thread via a call to .post(). /// some thread via a call to .post().
/// ///
/// This primitive is typically used in the construction of larger library types
/// rather than directly in user code.
///
/// As a primitive, this is not cancellation-aware.
///
/// The Baton supports being awaited by multiple coroutines at a time. If the /// The Baton supports being awaited by multiple coroutines at a time. If the
/// baton is not ready at the time it is awaited then an awaiting coroutine /// baton is not ready at the time it is awaited then an awaiting coroutine
/// suspends. All suspended coroutines waiting for the baton to be posted will /// suspends. All suspended coroutines waiting for the baton to be posted will
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment