Go Cond
External
Internal
Overview
Cond
implements a condition variable, a rendezvous point for goroutines waiting for or announcing the occurrence of an event. In this definition, an "event" is an arbitrary signal between two or more goroutines that carries no information other than the fact that it has occurred. Cond
offers a way for a goroutine to "efficiently sleep" (be suspended) until it is signaled to wake up and check of a condition.
Each Cond
has an associated Locker
L
, commonly a *Mutex
or *RWMutex
, which must be held when changing the condition and when calling the Wait
method. A Cond
must not be copied after first use.
In the terminology of the Go memory model, Cond
arranges that a call to Broadcast()
or Signal()
"synchronizes before" any Wait
call that it unblocks. For many simple use cases, users will be better off using channels than a Cond
(Broadcast()
corresponds to closing a channel, and Signal
corresponds to sending on a channel).