Operator Reference
wait_barrier (Operator)
wait_barrier — Wait on the release of a barrier synchronization object.
Signature
wait_barrier( : : BarrierHandle : )
Description
wait_barrier blocks the thread at a barrier object given by
BarrierHandle until a specified number of threads have called the
same barrier object. This number is specified by parameter TeamSize
during the creation
of the barrier object by create_barrier.
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
BarrierHandle (input_control) barrier → (handle)
Barrier synchronization object.
Result
If the barrier handle is valid, the operator wait_barrier
returns 2 (
H_MSG_TRUE)
. If necessary, an exception is raised.
Possible Successors
Module
Foundation