Barrier Manager

The Barrier Manager provides a unique synchronization capability which can be used to have a set of tasks block and be unblocked as a set. More...

Files
file	barrier.h
	This header file defines the Barrier Manager API.

Functions
rtems_status_code	rtems_barrier_create (rtems_name name, rtems_attribute attribute_set, uint32_t maximum_waiters, rtems_id *id)
	% More...
rtems_status_code	rtems_barrier_delete (rtems_id id)
	% More...
rtems_status_code	rtems_barrier_ident (rtems_name name, rtems_id *id)
	Identifies a barrier object by the specified object name. More...
rtems_status_code	rtems_barrier_release (rtems_id id, uint32_t *released)
	% More...
rtems_status_code	rtems_barrier_wait (rtems_id id, rtems_interval timeout)
	% More...

Detailed Description

The Barrier Manager provides a unique synchronization capability which can be used to have a set of tasks block and be unblocked as a set.

Function Documentation

rtems_barrier_create()

rtems_status_code rtems_barrier_create	(	rtems_name	name,
		rtems_attribute	attribute_set,
		uint32_t	maximum_waiters,
		rtems_id *	id
	)

%

Parameters

name	%
attribute_set	%
maximum_waiters	%
id	%

Definition at line 29 of file barriercreate.c.

rtems_barrier_delete()

rtems_status_code rtems_barrier_delete

(

rtems_id

id

)

%

Parameters

id

%

Definition at line 23 of file barrierdelete.c.

rtems_barrier_ident()

rtems_status_code rtems_barrier_ident	(	rtems_name	name,
		rtems_id *	id
	)

Identifies a barrier object by the specified object name.

This directive obtains the barrier identifier associated with the barrier name specified in name.

If the barrier name is not unique, then the barrier identifier will match the first barrier with that name in the search order. However, this barrier identifier is not guaranteed to correspond to the desired barrier. The barrier identifier is used with other barrier related directives to access the barrier.

The objects are searched from lowest to the highest index. Only the local node is searched.

Parameters

	name	is the object name to look up.
[out]	id	is the pointer to an object identifier variable. The object identifier of an object with the specified name will be stored in this variable, in case of a successful operation.

Return values

RTEMS_SUCCESSFUL	The requested operation was successful.
RTEMS_INVALID_ADDRESS	The id parameter was NULL.
RTEMS_INVALID_NAME	The name parameter was 0.
RTEMS_INVALID_NAME	There was no object with the specified name on the local node.

Definition at line 44 of file barrierident.c.

rtems_barrier_release()

rtems_status_code rtems_barrier_release	(	rtems_id	id,
		uint32_t *	released
	)

%

Parameters

id	%
released	%

Definition at line 24 of file barrierrelease.c.

rtems_barrier_wait()

rtems_status_code rtems_barrier_wait	(	rtems_id	id,
		rtems_interval	timeout
	)

%

Parameters

id	%
timeout	%

Definition at line 30 of file barrierwait.c.