package moonpool
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=c4a1f974200530ab7f6014de3a369fdbb260ff454183640f32e51ba3fec51b15
sha512=865daabb96e3d60f88ecee9fc9030dad8b257fff4121b404e882d8a8d6687b737beb6e22366f52eb14e770dfab28b326853a1d3d883fa19bbd791d8450b40f8b
doc/moonpool/Moonpool/index.html
Module Moonpool
Source
Moonpool
A pool within a bigger pool (ie the ocean). Here, we're talking about pools of Thread.t
that are dispatched over several Domain.t
to enable parallelism.
We provide several implementations of pools with distinct scheduling strategies, alongside some concurrency primitives such as guarding locks (Lock.t
) and futures (Fut.t
).
A simple runner with a single background thread.
Runner that runs tasks in the caller thread.
Exception raised when trying to run tasks on runners that have been shut down.
Similar to Thread.create
, but it picks a background domain at random to run the thread. This ensures that we don't always pick the same domain to run all the various threads needed in an application (timers, event loops, etc.)
run_async runner task
schedules the task to run on the given runner. This means task()
will be executed at some point in the future, possibly in another thread.
run_wait_block runner f
schedules f
for later execution on the runner, like run_async
. It then blocks the current thread until f()
is done executing, and returns its result. If f()
raises an exception, then run_wait_block pool f
will raise it as well.
See run_async
for more details.
NOTE be careful with deadlocks (see notes in Fut.wait_block
about the required discipline to avoid deadlocks).
Number of threads recommended to saturate the CPU. For IO pools this makes little sense (you might want more threads than this because many of them will be blocked most of the time).
spawn ~on f
runs f()
on the runner (a thread pool typically) and returns a future result for it. See Fut.spawn
.
Task-local storage.
A simple blocking queue.
A blocking queue of finite size.
Atomic values.