#include <bslmt_latch.h>
|
| enum | { e_TIMED_OUT = Condition::e_TIMED_OUT
} |
| | The value timedWait returns when a timeout occurs. More...
|
| |
This class defines a thread synchronization mechanism that allows one or more threads to wait until a certain number of operations have been performed by other threads.
See bslmt_latch
◆ anonymous enum
◆ Latch() [1/3]
Create a latch that will synchronize on the specified count number of events, and when count events have been recorded will release any waiting threads. 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. If clockType is not specified then the realtime system clock is used. The behavior is undefined unless 0 <= count.
◆ Latch() [2/3]
| bslmt::Latch::Latch |
( |
int |
count, |
|
|
const bsl::chrono::system_clock & |
|
|
) |
| |
|
inline |
Create a latch that will synchronize on the specified count number of events, and when count events have been recorded will release any waiting threads. Use the realtime system clock as the clock against which the absTime timeouts passed to the timedWait methods are interpreted (see {Supported Clock-Types} in the component-level documentation). The behavior is undefined unless 0 <= count.
◆ Latch() [3/3]
| bslmt::Latch::Latch |
( |
int |
count, |
|
|
const bsl::chrono::steady_clock & |
|
|
) |
| |
|
inline |
Create a latch that will synchronize on the specified count number of events, and when count events have been recorded will release any waiting threads. Use the monotonic system clock as the clock against which the absTime timeouts passed to the timedWait methods are interpreted (see {Supported Clock-Types} in the component-level documentation). The behavior is undefined unless 0 <= count.
◆ ~Latch()
Destroy this latch. The behavior is undefined if any threads are waiting on this latch.
◆ arrive()
| void bslmt::Latch::arrive |
( |
| ) |
|
Decrement the number of events that this latch is waiting for by 1, and if the resulting number of events is 0 release any waiting threads. The behavior is undefined unless the sum of all events that have arrived at this latch does not exceed the count with which it was initialized. Note that the initial count of events is supplied at construction.
◆ arriveAndWait()
| void bslmt::Latch::arriveAndWait |
( |
| ) |
|
Decrement the number of events that this latch is waiting for by 1, and if the resulting number of events is 0 release any waiting threads; otherwise, block until the required number of events has been reached. The behavior is undefined unless the sum of all events that have arrived at this latch does not exceed the count with which it was initialized. Note that the initial count of events is supplied at construction. Also note that this method is equivalent to the following sequence:
◆ clockType()
◆ countDown()
| void bslmt::Latch::countDown |
( |
int |
numEvents | ) |
|
Decrement the number of events that this latch is waiting for by the specified numEvents, and if the resulting number of events is 0 release any waiting threads. The behavior is undefined unless numEvents > 0 and the sum of all events that have arrived at this latch does not exceed the count with which it was initialized. Note that the initial count of events is supplied at construction.
◆ currentCount()
| int bslmt::Latch::currentCount |
( |
| ) |
const |
Return the current number of events for which this latch is waiting. Note that this method is provided primarily for debugging purposes (i.e., its intended use is not as a synchronization mechanism), and can be used only as an upper bound for the current count without other external state information.
◆ timedWait() [1/2]
template<class CLOCK , class DURATION >
| int bslmt::Latch::timedWait |
( |
const bsl::chrono::time_point< CLOCK, DURATION > & |
absTime | ) |
|
|
inline |
Block until the number of events that this latch is waiting for reaches 0, or until the specified absTime timeout expires. Return 0 on success, e_TIMED_OUT on timeout, and a non-zero value different from e_TIMED_OUT if an error occurs. Errors are unrecoverable. After an error, the latch may be destroyed, but any other use has undefined behavior. absTime is an absolute time represented as an interval from some epoch, which is determined by the clock associated with the time point.
◆ timedWait() [2/2]
Block until the number of events that this latch is waiting for reaches 0, or until the specified absTime timeout expires. Return 0 on success, e_TIMED_OUT on timeout, and a non-zero value different from e_TIMED_OUT if an error occurs. Errors are unrecoverable. After an error, the latch may be destroyed, but any other use has undefined behavior. absTime is an absolute time represented as an interval from some epoch as determined by the clock specified at construction (see {Supported Clock-Types} in the component-level documentation).
◆ tryWait()
| bool bslmt::Latch::tryWait |
( |
| ) |
const |
Return true if this latch has already been released (i.e., the number of events the latch is waiting on is 0), and false otherwise. This method does not block. Note that a return value of true indicates a permanent state change (the latch has released and will never be un-released), but a return value of false is ephemeral and cannot typically be acted upon without additional external state information.
◆ wait()
| void bslmt::Latch::wait |
( |
| ) |
|
Block until the number of events that this latch is waiting for reaches 0.
The documentation for this class was generated from the following file:
1.9.8