Skip to content

clear_barrierClearBarrierClearBarrierclear_barrierT_clear_barrier🔗

Short description🔗

clear_barrierClearBarrierClearBarrierclear_barrierT_clear_barrier — Destroy a barrier synchronization object.

Signature🔗

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

Herror T_clear_barrier( const Htuple BarrierHandle )

void HBarrier::ClearBarrier( ) const

void HBarrier.ClearBarrier( )

Description🔗

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

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.

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🔗

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

Barrier synchronization object.

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

create_barrierCreateBarrier

See also

create_barrierCreateBarrier

Module🔗

Foundation