NAME
pthread_barrierattr_destroy
pthread_barrierattr_init —
destroy and initialize the barrier attributes
object
SYNOPSIS
#include
<pthread.h>
int pthread_barrierattr_destroy(pthread_barrierattr_t *attr); int pthread_barrierattr_init(pthread_barrierattr_t *attr);
DESCRIPTION
The pthread_barrierattr_destroy ()
function shall destroy a barrier attributes object. A destroyed
attr attributes object can be reinitialized using
pthread_barrierattr_init (); the results of
otherwise referencing the object after it has been destroyed are undefined.
An implementation may cause
pthread_barrierattr_destroy () to set the object
referenced by attr to an invalid value.
The pthread_barrierattr_init () function
shall initialize a barrier attributes object attr with the
default value for all of the attributes defined by the implementation.
If pthread_barrierattr_init () is called
specifying an already initialized attr attributes object,
the results are undefined.
After a barrier attributes object has been used to initialize one or more barriers, any function affecting the attributes object (including destruction) shall not affect any previously initialized barrier.
The behavior is undefined if the value specified by the
attr argument to
pthread_barrierattr_destroy () does not refer to an
initialized barrier attributes object.
RETURN VALUE
If successful, the
pthread_barrierattr_destroy () and
pthread_barrierattr_init () functions shall return
zero; otherwise, an error number shall be returned to indicate the
error.
ERRORS
The pthread_barrierattr_init () function
shall fail if:
- [ENOMEM]
- Insufficient memory exists to initialize the barrier attributes object.
These functions shall not return an error code of [EINTR].
EXAMPLES
None.
APPLICATION USAGE
None.
RATIONALE
If an implementation detects that the value specified by the
attr argument to
pthread_barrierattr_destroy () does not refer to an
initialized barrier attributes object, it is recommended that the function
should fail and report an [EINVAL] error.
FUTURE DIRECTIONS
None.
SEE ALSO
pthread_barrierattr_getpshared(3)
XBD <pthread.h>
CHANGE HISTORY
First released in Issue 6. Derived from IEEE Std 1003.1j-2000.
In the SYNOPSIS, the inclusion of <sys/types.h> is no longer required.
Issue 7
The pthread_barrierattr_destroy () and
pthread_barrierattr_init () functions are moved from
the Barriers option to the Base.
The [EINVAL] error for an uninitialized barrier attributes object is removed; this condition results in undefined behavior.