A condition variable whose semantics follow those used for POSIX-style conditions.
- iOS 2.0+
- macOS 10.5+
- tvOS 9.0+
- watchOS 2.0+
- Mac Catalyst 13.0+Beta
A condition object acts as both a lock and a checkpoint in a given thread. The lock protects your code while it tests the condition and performs the task triggered by the condition. The checkpoint behavior requires that the condition be true before the thread proceeds with its task. While the condition is not true, the thread blocks. It remains blocked until another thread signals the condition object.
The semantics for using an
NSCondition object are as follows:
Lock the condition object.
Test a boolean predicate. (This predicate is a boolean flag or other variable in your code that indicates whether it is safe to perform the task protected by the condition.)
If the boolean predicate is false, call the condition object’s
wait(until:)method to block the thread. Upon returning from these methods, go to step 2 to retest your boolean predicate. (Continue waiting and retesting the predicate until it is true.)
If the boolean predicate is true, perform the task.
Optionally update any predicates (or signal any conditions) affected by your task.
When your task is done, unlock the condition object.
The pseudocode for performing the preceding steps would therefore look something like the following:
Whenever you use a condition object, the first step is to lock the condition. Locking the condition ensures that your predicate and task code are protected from interference by other threads using the same condition. Once you have completed your task, you can set other predicates or signal other conditions based on the needs of your code. You should always set predicates and signal conditions while holding the condition object’s lock.
When a thread waits on a condition, the condition object unlocks its lock and blocks the thread. When the condition is signaled, the system wakes up the thread. The condition object then reacquires its lock before returning from the
wait(until:) method. Thus, from the point of view of the thread, it is as if it always held the lock.
A boolean predicate is an important part of the semantics of using conditions because of the way signaling works. Signaling a condition does not guarantee that the condition itself is true. There are timing issues involved in signaling that may cause false signals to appear. Using a predicate ensures that these spurious signals do not cause you to perform work before it is safe to do so. The predicate itself is simply a flag or other variable in your code that you test in order to acquire a Boolean result.
For more information on how to use conditions, see Using POSIX Thread Locks in Threading Programming Guide.