arm4::util::ArmTransactionCountDownOnce Class Reference
[ARM 4.0 Support Classes]
A counting down transaction container for stopping a started when the initialized number of events occured. More...
Inheritance diagram for arm4::util::ArmTransactionCountDownOnce:
Public Member Functions | |
| ArmTransactionCountDownOnce (ArmTransaction &tran, size_t events, int32_t status=ArmConstants::STATUS_UNKNOWN, bool destroy=false) | |
| Initializes an ARM countdown latch which stops a ARM transaction if count drops to zero. | |
| bool | countDown () |
| Counts the latchs number of events down by one. | |
Detailed Description
A counting down transaction container for stopping a started when the initialized number of events occured.
Constructor & Destructor Documentation
| arm4::util::ArmTransactionCountDownOnce::ArmTransactionCountDownOnce | ( | ArmTransaction & | tran, | |
| size_t | events, | |||
| int32_t | status = ArmConstants::STATUS_UNKNOWN, |
|||
| bool | destroy = false | |||
| ) |
Initializes an ARM countdown latch which stops a ARM transaction if count drops to zero.
- Note:
- This class can only be used once
- Parameters:
-
tran Started ARM transaction to stop on finished() events Number of events to countdown before stopping (zero is invalid) status Default transaction status to use on stop call destroy If true the latch destroy the ARM transaction instance
Member Function Documentation
| bool arm4::util::ArmTransactionCountDownOnce::countDown | ( | ) |
Counts the latchs number of events down by one.
- Returns:
- true if transaction was stopped otherwise false
- Note:
- When the count drops to zero associated transaction is stopped
The documentation for this class was generated from the following file:
- Arm4/Util/ArmTransactionCountDown
Documentation generated on Thu May 24 2018 22:24:17. © 2018 by MyARM GmbH