concurrency 0.0.13
concurrency library
To use this package, run the following command in your project's root directory:
Manual usage
Put the following dependency into your project's dependences section:
Structured Concurrency
<img src="https://github.com/symmetryinvestments/concurrency/workflows/build/badge.svg"/>
Provides various primitives useful for structured concurrency and async tasks.
Senders/Receivers
A Sender is a lazy Task (in the general sense of the word). It needs to be connected to a Receiver and then started before it will (eventually) call one of the three receiver methods exactly once: setValue, setDone, setError.
It can be used to model many asynchronous operations. It enforces structured concurrency because a Sender cannot start without it being awaited on.
setValue
is the only one allowed to throw exceptions, and if it does, setError
is called with the Exception. setDone
is called when the operation has been cancelled.
See http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2020/p0443r14.html for the C++ proposal for introducing Senders/Receivers.
Currently we have the following Senders:
ValueSender
. Just produces a plain value.ThreadSender
. Calls the setValue function in the context of a new thread.Nursery
. A place to await multiple Senders.ForkSender
. Forks the program and executes supplied function.ThrowingSender
. Always throws.DoneSender
. Always cancels.VoidSender
. Always calls setValue with no args.
Operations
Senders enjoy the following operations.
sync_wait
. It takes a Sender and blocks the current execution context until the Sender is completed. It then returns or throws anything the Sender has send, if any. (note: attributes are inferred when possible, so that e.g. if the Sender doesn't callsetError
,sync_wait
itself is nothrow).then
. Chains a callable to be invoked when the Sender is completed with a value.via
. Start one Sender in the setValue of another. Useful for when you want to change the execution context.ValueSender!int(4).via(ThreadSender())
produces anint
in the context of a new thread.withStopToken
. Likethen
but injects a StopToken as well.withStopSource
. When applied after a Sender you can stop the Sender manually with the stopsource. It will still stop when the downstream receiver's StopToken is triggered.race
. Runs 2 Senders and completes with the value produced by the first to complete, after first cancelling and awaiting the others. When both Senders complete with an error, the first error is propagated. When both Senders complete with cancellation,race
completes with cancellation as well.ignoreError
. Redirects thesetException
tosetDone
, so as not to trigger the downstream error path.finally_
. Takes a Sender and a callable or value and completes with that regardless of whether the Sender completed withsetValue
orsetException
.whenAll
. Produces a tuple of values after all Senders produced their values. If one or more Senders complete with an error,whenAll
will complete with the first error, after stopping and awaiting the remaining Senders. Likewise, if one Sender completes with cancellation,whenAll
completes with cancellation as well, after stopping and awaiting the remaining Senders.
To be added
retry
. It retries the underlying Sender as many times as unconfigured until success or cancellation.others...
Nursery
A place where Senders can be awaited in. Senders placed in the Nursery are started only when the Nursery is started.
In many ways it is like the when_all
, except as an object. That allows it to be passed around and for work to be registered into it dynamically.
StopToken
StopTokens are thread-safe objects used to request cancellation. They can be polled or subscribed to.
A receiver may have a getStopToken
that returns one. If not a default getStopToken
is available that returns a NeverStopToken
.
A Sender should retrieve a StopToken via getStopToken
on the connecting Receiver and try to abort as quick as possible when it gets triggered.
The simplest way is to poll the stoptoken regularly. There is a isStopRequested
method that will return true
if the Sender should abort. After cleanup the Sender must call setDone
.
NOTE: In some cases when a stop is requested, the Sender is already busy setting a value or an exception. Receivers should not assume that because the stoptoken is triggered only
setDone
will be called, it is perfectly valid to call one of the other two as well.
In some case you might need a push notification that a stop has been requested. There is a free function called onStop
that takes a StopToken and a delegate. The delegate will be called - in another execution context - to signify that a stop is requested. The onStop
function returns a StopCallback
that needs its dispose
to be called before or after the Sender has called one of the completion functions. Not calling dispose
will lead to memory leaks in long-running Senders (e.g. the Nursery).
See http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2020/p2175r0.html for a thorough explanation for why we need stop tokens in particular and cancellation in general.
- 0.0.13 released 3 years ago
- symmetryinvestments/concurrency
- proprietary
- Copyright © 2021, skoppe
- Authors:
- Dependencies:
- mir-core, concepts
- Versions:
-
5.0.5 2024-Jan-16 5.0.4 2023-Sep-25 5.0.3 2023-Apr-12 5.0.2 2022-Oct-28 5.0.1 2022-Oct-25 - Download Stats:
-
-
0 downloads today
-
0 downloads this week
-
27 downloads this month
-
137149 downloads total
-
- Score:
- 2.2
- Short URL:
- concurrency.dub.pm