timed_wait_conditionT_timed_wait_conditionTimedWaitConditionTimedWaitConditiontimed_wait_condition (Operator)
Name
timed_wait_conditionT_timed_wait_conditionTimedWaitConditionTimedWaitConditiontimed_wait_condition
— Bounded wait on the signal of a condition synchronization object.
Signature
Description
timed_wait_conditiontimed_wait_conditionTimedWaitConditionTimedWaitConditionTimedWaitConditiontimed_wait_condition
atomically unlocks MutexHandleMutexHandleMutexHandleMutexHandlemutexHandlemutex_handle
and
waits on
ConditionHandleConditionHandleConditionHandleConditionHandleconditionHandlecondition_handle
, as wait_conditionwait_conditionWaitConditionWaitConditionWaitConditionwait_condition
does, but it also bounds
the duration of the wait. If ConditionHandleConditionHandleConditionHandleConditionHandleconditionHandlecondition_handle
has not been signaled
within the amount of time specified by TimeoutTimeoutTimeoutTimeouttimeouttimeout
in micro seconds,
the mutex MutexHandleMutexHandleMutexHandleMutexHandlemutexHandlemutex_handle
is re-acquired and
timed_wait_conditiontimed_wait_conditionTimedWaitConditionTimedWaitConditionTimedWaitConditiontimed_wait_condition
returns the error H_ERR_TIMEOUT.
Using negative values for TimeoutTimeoutTimeoutTimeouttimeouttimeout
means an infinite waiting time.
Execution Information
- Multithreading type: independent (runs in parallel even with exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
Parameters
ConditionHandleConditionHandleConditionHandleConditionHandleconditionHandlecondition_handle
(input_control) condition →
HCondition, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Condition synchronization object.
MutexHandleMutexHandleMutexHandleMutexHandlemutexHandlemutex_handle
(input_control) mutex →
HMutex, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Mutex synchronization object.
TimeoutTimeoutTimeoutTimeouttimeouttimeout
(input_control) number →
HTupleintHTupleHtuple (integer) (int / long) (Hlong) (Hlong)
Timeout in micro seconds.
Result
timed_wait_conditiontimed_wait_conditionTimedWaitConditionTimedWaitConditionTimedWaitConditiontimed_wait_condition
returns TRUE if all parameters are correct.
If necessary, an exception is raised. If a timeout occurs, the error
H_ERR_TIMEOUT is raised.
Possible Successors
signal_conditionsignal_conditionSignalConditionSignalConditionSignalConditionsignal_condition
,
clear_conditionclear_conditionClearConditionClearConditionClearConditionclear_condition
Module
Foundation