ClassesClasses | | Operators

wait_barrierT_wait_barrierWaitBarrierWaitBarrier (Operator)

Name

wait_barrierT_wait_barrierWaitBarrierWaitBarrier — 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()

Description

wait_barrierwait_barrierWaitBarrierWaitBarrierWaitBarrier blocks the thread at a barrier object given by BarrierHandleBarrierHandleBarrierHandleBarrierHandlebarrierHandle 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_barriercreate_barrierCreateBarrierCreateBarrierCreateBarrier.

Execution Information

Parameters

BarrierHandleBarrierHandleBarrierHandleBarrierHandlebarrierHandle (input_control)  barrier HBarrier, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Barrier synchronization object.

Result

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

Possible Successors

clear_barrierclear_barrierClearBarrierClearBarrierClearBarrier

Module

Foundation


ClassesClasses | | Operators