The WaitSet class allows an application to wait until one or more of the attached Condition objects has a trigger_value of TRUE or until timeout expires.
More...
#include <WaitSet.hpp>
The WaitSet class allows an application to wait until one or more of the attached Condition objects has a trigger_value of TRUE or until timeout expires.
◆ WaitSet() [1/3]
◆ ~WaitSet()
◆ WaitSet() [2/3]
◆ WaitSet() [3/3]
◆ attach_condition()
Attaches a Condition to the Wait Set.
- Parameters
-
- Returns
- RETCODE_OK if attached correctly, error code otherwise
◆ detach_condition()
Detaches a Condition from the WaitSet.
- Parameters
-
- Returns
- RETCODE_OK if detached correctly, PRECONDITION_NOT_MET if condition was not attached
◆ get_conditions()
Retrieves the list of attached conditions.
- Parameters
-
attached_conditions | Reference to the collection of attached conditions |
- Returns
- RETCODE_OK if everything correct, error code otherwise
◆ operator=() [1/2]
◆ operator=() [2/2]
◆ wait()
Allows an application thread to wait for the occurrence of certain conditions.
If none of the conditions attached to the WaitSet have a trigger_value of true, the wait operation will block suspending the calling thread
- Parameters
-
active_conditions | Reference to the collection of conditions which trigger_value are true |
timeout | Maximum time of the wait |
- Returns
- RETCODE_OK if everything correct, PRECONDITION_NOT_MET if WaitSet already waiting, TIMEOUT if maximum time expired, error code otherwise
The documentation for this class was generated from the following file: