Operator Reference
clear_barrier (Operator)
clear_barrier — Destroy a barrier synchronization object.
Signature
clear_barrier( : : BarrierHandle : )
Description
clear_barrier destroys the barrier object given in
BarrierHandle. No threads should be waiting on the barrier at the
time clear_barrier is called. After calling clear_barrier,
the barrier can no longer be used.
The handle BarrierHandle becomes invalid.
Execution Information
- Multithreading type: independent (runs in parallel even with exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
This operator modifies the state of the following input parameter:
During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.
Parameters
BarrierHandle (input_control, state is modified) barrier → (handle)
Barrier synchronization object.
Result
If the barrier handle is valid, the operator clear_barrier returns
2 (
H_MSG_TRUE)
. If necessary, an exception is raised.
Possible Predecessors
See also
Module
Foundation