windows/ConditionVariable · Standard Library

Raw operating-system-thread wait primitive over one supplied mutex. wait temporarily releases that mutex, waits, and reacquires the same mode before return.

ConditionVariable

Methods

`INIT`

(--) Resets the condition variable to the initial empty-waiter state.

(mutex time shared -- signaled) Waits on the supplied mutex. The lock is released while waiting and reacquired in the same mode before return. The result is TRUE when waiting ends before timeout and FALSE when a finite timeout expires.

Preconditions

The current thread already holds mutex in exclusive mode when shared is FALSE.
The current thread already holds mutex in shared mode when shared is TRUE.

`wakeAll`

(--) Releases every thread that is already waiting at that moment.

`wakeOne`

(--) Releases one thread that is already waiting at that moment.

Remarks

A newly constructed ConditionVariable starts in the initialized empty-waiter state.

Wait semantics

wait borrows the supplied mutex.
With shared equal to FALSE, wait temporarily releases one exclusive acquisition and reacquires exclusive mode before return.
With shared equal to TRUE, wait temporarily releases one shared acquisition and reacquires shared mode before return.
time is measured in milliseconds.
time equal to -1 selects an infinite wait.
wait returns TRUE when waiting ends before timeout and FALSE only when a finite timeout expires.
wakeOne affects at most one thread that is already waiting, and wakeAll affects every thread that is already waiting.
No wake is remembered for later waiters.
wakeAll and wakeOne return no status value.

Examples

Windows wait example

"String"                    use
"control.Int32"             use
"windows/ConditionVariable" use
"windows/Mutex"             use

{} Int32 {} [
  mutex: Mutex;
  condition: ConditionVariable;
  @mutex.lock
  result: @mutex 0 FALSE @condition.wait;
  @mutex.unlock
  ("wait=" result LF) printList
  0
] "main" exportFunction

Expected Output

wait=FALSE