Panda3D
Public Member Functions | List of all members
ConditionVarDirect Class Reference

A condition variable, usually used to communicate information about changing state to a thread that is waiting for something to happen. More...

Inheritance diagram for ConditionVarDirect:
ConditionVar

Public Member Functions

MutexDirect getMutex ()
 Returns the mutex associated with this condition variable. More...
 
 notify ()
 Informs one of the other threads who are currently blocked on wait() that the relevant condition has changed. More...
 
 output (Ostream out)
 This method is declared virtual in ConditionVarDebug, but non-virtual in ConditionVarDirect. More...
 
 wait ()
 Waits on the condition. More...
 
 wait (double timeout)
 Waits on the condition, with a timeout. More...
 

Detailed Description

A condition variable, usually used to communicate information about changing state to a thread that is waiting for something to happen.

A condition variable can be used to "wake up" a thread when some arbitrary condition has changed.

A condition variable is associated with a single mutex, and several condition variables may share the same mutex.

Member Function Documentation

◆ getMutex()

MutexDirect getMutex ( )

Returns the mutex associated with this condition variable.

◆ notify()

notify ( )

Informs one of the other threads who are currently blocked on wait() that the relevant condition has changed.

If multiple threads are currently waiting, at least one of them will be woken up, although there is no way to predict which one. It is possible that more than one thread will be woken up.

The caller must be holding the mutex associated with the condition variable before making this call, which will not release the mutex.

If no threads are waiting, this is a no-op: the notify event is lost.

◆ output()

output ( Ostream  out)

This method is declared virtual in ConditionVarDebug, but non-virtual in ConditionVarDirect.

◆ wait() [1/2]

wait ( )

Waits on the condition.

The caller must already be holding the lock associated with the condition variable before calling this function.

wait() will release the lock, then go to sleep until some other thread calls notify() on this condition variable. At that time at least one thread waiting on the same ConditionVarDirect will grab the lock again, and then return from wait().

It is possible that wait() will return even if no one has called notify(). It is the responsibility of the calling process to verify the condition on return from wait, and possibly loop back to wait again if necessary.

Note the semantics of a condition variable: the mutex must be held before wait() is called, and it will still be held when wait() returns. However, it will be temporarily released during the wait() call itself.

◆ wait() [2/2]

wait ( double  timeout)

Waits on the condition, with a timeout.

The function will return when the condition variable is notified, or the timeout occurs. There is no way to directly tell which happened, and it is possible that neither in fact happened (spurious wakeups are possible).

See wait() with no parameters for more.