bslmt::Condition Class Reference

#include <bslmt_condition.h>

Detailed Description

This class implements a portable inter-thread signaling primitive.

See bslmt_condition

Public Types
enum	{ e_TIMED_OUT = ConditionImpl<Platform::ThreadPolicy>::e_TIMED_OUT }

Public Member Functions
	Condition (bsls::SystemClockType::Enum clockType=bsls::SystemClockType::e_REALTIME)
	~Condition ()
void	broadcast ()
void	signal ()
int	timedWait (Mutex *mutex, const bsls::TimeInterval &absTime)
int	wait (Mutex *mutex)
bsls::SystemClockType::Enum	clockType () const

Member Enumeration Documentation

anonymous enum

anonymous enum

The value timedWait returns when a timeout occurs.

Enumerator
e_TIMED_OUT

Constructor & Destructor Documentation

Condition()

bslmt::Condition::Condition ( bsls::SystemClockType::Enum  clockType = bsls::SystemClockType::e_REALTIME )

inlineexplicit

Create a condition variable object. Optionally specify a clockType indicating the type of the system clock against which the bsls::TimeInterval absTime timeouts passed to the timedWait method are to be interpreted (see {Supported Clock-Types} in the component-level documentation). If clockType is not specified then the realtime system clock is used. This method does not return normally unless there are sufficient system resources to construct the object.

~Condition()

bslmt::Condition::~Condition ( )

inline

Destroy this condition variable object.

Member Function Documentation

broadcast()

void bslmt::Condition::broadcast ( )

inline

Signal this condition variable object by waking up all threads that are currently waiting on this condition. If there are no threads waiting on this condition, this method has no effect.

clockType()

bsls::SystemClockType::Enum bslmt::Condition::clockType ( ) const

inline

Return the clock type used for timeouts.

signal()

void bslmt::Condition::signal ( )

inline

Signal this condition variable object by waking up a single thread that is currently waiting on this condition. If there are no threads waiting on this condition, this method has no effect.

timedWait()

int bslmt::Condition::timedWait ( Mutex *  mutex, const bsls::TimeInterval &  absTime  )

inline

Atomically unlock the specified mutex and suspend execution of the current thread until this condition object is "signaled" (i.e., one of the signal or broadcast methods is invoked on this object) or until the specified absTime timeout expires, then re-acquire a lock on the mutex. absTime is an absolute time represented as an interval from some epoch, which is determined by the clock indicated at construction (see {Supported Clock-Types} in the component-level documentation), and is the earliest time at which the timeout may occur. The mutex remains locked by the calling thread upon returning from this function. Return 0 on success, and e_TIMED_OUT on timeout. Any other value indicates that an error has occurred. After an error, the condition may be destroyed, but any other use has undefined behavior.

Precondition

The behavior is undefined unless mutex is locked by the calling thread prior to calling this method.

Note

Note that spurious wakeups are rare but possible, i.e., this method may succeed (return 0) and return control to the thread without the condition object being signaled. Also note that the actual time of the timeout depends on many factors including system scheduling and system timer resolution, and may be significantly later than the time requested.

wait()

int bslmt::Condition::wait ( Mutex *  mutex )

inline

Atomically unlock the specified mutex and suspend execution of the current thread until this condition object is "signaled" (i.e., either signal or broadcast is invoked on this object in another thread), then re-acquire a lock on the mutex. Return 0 on success, and a non-zero value otherwise. Spurious wakeups are rare but possible; i.e., this method may succeed (return 0), and return control to the thread without the condition object being signaled.

Precondition

The behavior is undefined unless mutex is locked by the calling thread prior to calling this method.

Note

Note that mutex remains locked by the calling thread upon return from this function.

---

The documentation for this class was generated from the following file:

• bslmt_condition.h