ES barrier

Functions
int	ABT_xstream_barrier_create (uint32_t num_waiters, ABT_xstream_barrier *newbarrier)
	Create a new ES barrier. More...
int	ABT_xstream_barrier_free (ABT_xstream_barrier *barrier)
	Free the ES barrier. More...
int	ABT_xstream_barrier_wait (ABT_xstream_barrier barrier)
	Wait on the barrier. More...

Detailed Description

This group is for ES barrier.

Function Documentation

int ABT_xstream_barrier_create	(	uint32_t	num_waiters,
		ABT_xstream_barrier *	newbarrier
	)

Create a new ES barrier.

ABT_xstream_barrier_create() creates a new ES barrier and returns its handle through newbarrier. If an error occurs in this routine, a non-zero error code will be returned and newbarrier will be set to ABT_XSTREAM_BARRIER_NULL.

Parameters

[in]	num_waiters	number of waiters
[out]	newbarrier	handle to a new ES barrier

Returns

Error code

Return values

ABT_SUCCESS

on success

Definition at line 65 of file stream_barrier.c.

int ABT_xstream_barrier_free

(

ABT_xstream_barrier *

barrier

)

Free the ES barrier.

ABT_xstream_barrier_free() deallocates the memory used for the ES barrier object associated with the handle barrier. If it is successfully processed, barrier is set to ABT_XSTREAM_BARRIER_NULL.

Parameters

[in,out]

barrier

handle to the ES barrier

Returns

Error code

Return values

ABT_SUCCESS

on success

Definition at line 105 of file stream_barrier.c.

int ABT_xstream_barrier_wait

(

ABT_xstream_barrier

barrier

)

Wait on the barrier.

The work unit calling ABT_xstream_barrier_wait() waits on the barrier and blocks the entire ES until all the participants reach the barrier.

Parameters

[in]

barrier

handle to the ES barrier

Returns

Error code

Return values

ABT_SUCCESS

on success

Definition at line 143 of file stream_barrier.c.