process-wait-local-with-timeout

process-wait-local-with-timeout Function

Summary

Has the same semantics as process-wait-with-timeout, but does not interact with the scheduler.

Package

Signature

process-wait-local-with-timeout wait-reason timeout function &rest args => result

Arguments

`wait-reason`⇩	A string.
`timeout`⇩	A non-negative real or `nil`.
`function`⇩	A function designator.
`args`⇩	Arguments passed to function.

Values

result

A boolean.

Description

The function process-wait-local-with-timeout suspends the current Lisp process until the predicate function applied to args returns true or until timeout seconds have passed.

process-wait-local-with-timeout has same semantics as process-wait-with-timeout, but is "local", which here means that it does not interact with the scheduler. The scheduler does not call the wait function and hence never wakes the waiting process.

wait-reason is used as the wait-reason while waiting.

timeout is in seconds.

The circumstances in which the function wait-function is called, and the restrictions on it, are as documented for process-wait-local except that the wait function can additionally be called when it times out.

process-wait-local-with-timeout returns t if a call to the wait function returns true. It returns nil if it times out.