Function

Summary

Locks, applies a setup function, calls condition-variable-broadcast and unlocks.

Package

mp

Signature

lock-and-condition-variable-broadcast lock condvar lock-timeout setup-function &rest args => signaledp

Arguments

lock

A lock.

condvar

A condition-variable.

lock-timeout

A non-negative real or nil.

setup-function

A function designator.

args

Arguments to setup-function.

Values

signaledp

A generalized boolean.

Description

The function lock-and-condition-variable-broadcast locks the lock lock, applies the function setup-function to args, calls condition-variable-broadcast and unlocks lock. lock-and-condition-variable-broadcast makes it easier to avoid mistakes when using a condition-variable.

lock-and-condition-variable-broadcast performs the equivalent of:

(mp:with-lock (lock
 nil lock-timeout
)

  (apply setup-function
 args
)

  (mp:condition-variable-broadcast condvar
))

It returns the result of the call to condition-variable-broadcast.

See condition-variable-broadcast and with-lock for more details.

Notes

setup-function is called with the lock held, so it should do the minimum amount of work and avoid locking other locks.

See also

lock-and-condition-variable-wait
simple-lock-and-condition-variable-wait
lock-and-condition-variable-signal
condition-variable-wait
condition-variable-signal
condition-variable-broadcast
processes-count
with-lock
Condition variables
Locks