Skip to content

wait_barrierWaitBarrierWaitBarrierwait_barrierT_wait_barrier🔗

Short description🔗

wait_barrierWaitBarrierWaitBarrierwait_barrierT_wait_barrier — Wait on the release of a barrier synchronization object.

Signature🔗

wait_barrier( barrier BarrierHandle )void WaitBarrier( const HTuple& BarrierHandle )static void HOperatorSet.WaitBarrier( HTuple barrierHandle )def wait_barrier( barrier_handle: HHandle ) -> None

Herror T_wait_barrier( const Htuple BarrierHandle )

void HBarrier::WaitBarrier( ) const

void HBarrier.WaitBarrier( )

Description🔗

wait_barrierWaitBarrier blocks the thread at a barrier object given by BarrierHandlebarrierHandlebarrier_handle until a specified number of threads have called the same barrier object. This number is specified by parameter TeamSizeteamSizeteam_size during the creation of the barrier object by create_barrierCreateBarrier.

Execution information🔗

Execution information
  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).

  • Multithreading scope: global (may be called from any thread).

  • Processed without parallelization.

Parameters🔗

BarrierHandlebarrierHandlebarrier_handle (input_control) barrier → (handle)HTuple (HHandle)HBarrier, HTuple (IntPtr)HHandleHtuple (handle)

Barrier synchronization object.

Result🔗

If the barrier handle is valid, the operator wait_barrierWaitBarrier returns 2 (H_MSG_TRUE). If necessary, an exception is raised.

Combinations with other operators🔗

Combinations

Possible successors

clear_barrierClearBarrier

Module🔗

Foundation