simon/moonpool
1
0
Fork 0
mirror of https://github.com/c-cube/moonpool.git synced 2025-12-14 14:56:17 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

some doc

Browse source
This commit is contained in:
Simon Cruanes 2023-09-14 22:40:26 -04:00
parent 3834bf0796
commit 39d4e61331
1 changed files with 14 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
src/bounded_queue.mli
View file

@ -1,4 +1,17 @@
(** A blocking queue of finite size. *) (** A blocking queue of finite size.
This queue, while still using locks underneath
(like the regular blocking queue) should be enough for
usage under reasonable contention.
The bounded size is helpful whenever some form of backpressure is
desirable: if the queue is used to communicate between producer(s)
and consumer(s), the consumer(s) can limit the rate at which
producer(s) send new work down their way.
Whenever the queue is full, means that producer(s) will have to
wait before pushing new work.
@since NEXT_RELEASE *)
type 'a t type 'a t
(** A bounded queue. *) (** A bounded queue. *)