\" $NetBSD: pthread_barrierattr.3,v 1.14 2025/02/10 20:40:55 riastradh Exp $
\"
\" Copyright (c) 2002 The NetBSD Foundation, Inc.
\" All rights reserved.
\" Redistribution and use in source and binary forms, with or without
\" modification, are permitted provided that the following conditions
\" are met:
\" 1. Redistributions of source code must retain the above copyright
\" notice, this list of conditions and the following disclaimer.
\" 2. Redistributions in binary form must reproduce the above copyright
\" notice, this list of conditions and the following disclaimer in the
\" documentation and/or other materials provided with the distribution.
\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
\" POSSIBILITY OF SUCH DAMAGE.
\"
Dd June 12, 2016
Dt PTHREAD_BARRIERATTR 3
Os
Sh NAME
Nm pthread_barrierattr_init ,
Nm pthread_barrierattr_destroy ,
Nm pthread_barrierattr_getpshared ,
Nm pthread_barrierattr_setpshared
Nd barrier attribute operations
Sh LIBRARY
Lb libpthread
Sh SYNOPSIS
In pthread.h
Ft int
Fn pthread_barrierattr_init "pthread_barrierattr_t *attr"
Ft int
Fn pthread_barrierattr_destroy "pthread_barrierattr_t *attr"
Ft int
Fn pthread_barrierattr_getpshared "const pthread_barrierattr_t * restrict attr" "int * restrict pshared"
Ft int
Fn pthread_barrierattr_setpshared "pthread_barrierattr_t * attr" "int pshared"
Sh DESCRIPTION
Barrier attributes are used to specify parameters to be used with
Xr pthread_barrier_init 3 .
One attribute object can be used in multiple calls to
Fn pthread_barrier_init ,
with or without modifications between calls.
Pp
The
Fn pthread_barrierattr_init
function initializes
Fa attr
with the default barrier attributes.
Pp
The
Fn pthread_barrierattr_destroy
function destroys
Fa attr .
Pp
The
Fn pthread_barrierattr_getpshared
function shall obtain the value of the process-shared attribute
from the attributes object referenced by
Fa attr .
Pp
The
Fn pthread_barrierattr_setpshared
function shall set the process-shared attribute in an initialized
attributes object referenced by
Fa attr .
Sh RETURN VALUES
If successful, these functions return 0.
Otherwise, an error number is returned to indicate the error.
Sh ERRORS
No error codes are defined for
Fn pthread_barrierattr_init .
Pp
The
Fn pthread_barrierattr_destroy
function may fail if:
Bl -tag -width Er
It Bq Er EINVAL
The value specified by
Fa attr
is invalid.
El
Pp
The
Fn pthread_barrierattr_getpshared
and
Fn pthread_barrierattr_setpshared
functions may fail if:
Bl -tag -width Er
It Bq Er EINVAL
The value specified by
Fa attr
is invalid.
El
Sh SEE ALSO
Xr pthread_barrier_init 3
Sh STANDARDS
These functions conform to
St -p1003.1-2001 .
Sh BUGS
The
Fn pthread_barrierattr_getpshared
and
Fn pthread_barrierattr_setpshared
functions are hidden by default since only thread shared attributes
are supported.