clear_barrierT_clear_barrierClearBarrierClearBarrierclear_barrier (Operator)

Name

clear_barrierT_clear_barrierClearBarrierClearBarrierclear_barrier — Destroy a barrier synchronization object.

Signature

clear_barrier( : : BarrierHandle : )

Herror T_clear_barrier(const Htuple BarrierHandle)

void ClearBarrier(const HTuple& BarrierHandle)

void HBarrier::ClearBarrier() const

static void HOperatorSet.ClearBarrier(HTuple barrierHandle)

void HBarrier.ClearBarrier()

def clear_barrier(barrier_handle: HHandle) -> None

Description

clear_barrierclear_barrierClearBarrierClearBarrierClearBarrierclear_barrier destroys the barrier object given in BarrierHandleBarrierHandleBarrierHandleBarrierHandlebarrierHandlebarrier_handle. No threads should be waiting on the barrier at the time clear_barrierclear_barrierClearBarrierClearBarrierClearBarrierclear_barrier is called. After calling clear_barrierclear_barrierClearBarrierClearBarrierClearBarrierclear_barrier, the barrier can no longer be used. The handle BarrierHandleBarrierHandleBarrierHandleBarrierHandlebarrierHandlebarrier_handle becomes invalid.

Execution Information

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

BarrierHandleBarrierHandleBarrierHandleBarrierHandlebarrierHandlebarrier_handle (input_control, state is modified)  barrier HBarrier, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Barrier synchronization object.

Result

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

Possible Predecessors

create_barriercreate_barrierCreateBarrierCreateBarrierCreateBarriercreate_barrier

See also

create_barriercreate_barrierCreateBarrierCreateBarrierCreateBarriercreate_barrier

Module

Foundation