package lwt
Install
Dune Dependency
Authors
Maintainers
Sources
md5=18742da8b8fe3618e3fa700b7a884fe7
sha512=1c51fdb4d0856c89e2df08a1c0095ef28ebd0f613b07b03d0f66501ca5486515562071291e6d0932e57587ed0c9362c8b92c5c9eddb4d2bb2f5e129986b484a7
doc/lwt/Lwt_condition/index.html
Module Lwt_condition
Source
Conditions
Condition variables to synchronize between threads.
Condition variable type. The type parameter denotes the type of value propagated from notifier to waiter.
wait mutex condvar
will cause the current thread to block, awaiting notification for a condition variable, condvar
. If provided, the mutex
must have been previously locked (within the scope of Lwt_mutex.with_lock
, for example) and is temporarily unlocked until the condition is notified. Upon notification, mutex
is re-locked before wait
returns and the thread's activity is resumed. When the awaited condition is notified, the value parameter passed to signal
is returned.
signal condvar value
notifies that a condition is ready. A single waiting thread will be awoken and will receive the notification value which will be returned from wait
. Note that condition notification is not "sticky", i.e. if there is no waiter when signal
is called, the notification will be missed and the value discarded.
broadcast condvar value
notifies all waiting threads. Each will be awoken in turn and will receive the same notification value.