Clarify cv's are allocated on the heap

This commit is contained in:
Justin Ethier 2016-09-29 17:37:09 -04:00
parent 30c8f5f3a4
commit 91932bcfa5

View file

@ -71,7 +71,7 @@ Unlock the given mutex. If there are threads waiting on the mutex, one of those
Determine if the given object is a condition variable.
#make-condition-variable
(make-condition-variable)
Create a new condition variable.
Create a new condition variable. Like mutex objects, condition variables are always allocated directly on the heap since they are expected to be shared by more than one thread.
#condition-variable-wait!
(condition-variable-wait! condition-variable mutex)
Wait on a condition variable. The mutex must be locked by the calling thread, and will be locked upon successful return of this function.