Operator Reference

wait_barrierT_wait_barrierWaitBarrierWaitBarrierwait_barrier (Operator)

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

Signature

wait_barrier( : : BarrierHandle : )

Herror T_wait_barrier(const Htuple BarrierHandle)

void WaitBarrier(const HTuple& BarrierHandle)

void HBarrier::WaitBarrier() const

static void HOperatorSet.WaitBarrier(HTuple barrierHandle)

void HBarrier.WaitBarrier()

def wait_barrier(barrier_handle: HHandle) -> None

Description

wait_barrierwait_barrierWaitBarrierWaitBarrierwait_barrier blocks the thread at a barrier object given by BarrierHandleBarrierHandleBarrierHandlebarrierHandlebarrier_handle until a specified number of threads have called the same barrier object. This number is specified by parameter TeamSizeTeamSizeTeamSizeteamSizeteam_size during the creation of the barrier object by create_barriercreate_barrierCreateBarrierCreateBarriercreate_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

BarrierHandleBarrierHandleBarrierHandlebarrierHandlebarrier_handle (input_control)  barrier HBarrier, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Barrier synchronization object.

Result

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

Possible Successors

clear_barrierclear_barrierClearBarrierClearBarrierclear_barrier

Module

Foundation