xref: /netbsd-src/lib/libpthread/pthread_barrierattr.3 (revision b1c86f5f087524e68db12794ee9c3e3da1ab17a0)
1.\" $NetBSD: pthread_barrierattr.3,v 1.9 2010/07/09 10:45:36 wiz Exp $
2.\"
3.\" Copyright (c) 2002 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
14.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
15.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
17.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
23.\" POSSIBILITY OF SUCH DAMAGE.
24.\"
25.Dd July 9, 2010
26.Dt PTHREAD_BARRIERATTR 3
27.Os
28.Sh NAME
29.Nm pthread_barrierattr_init ,
30.Nm pthread_barrierattr_destroy ,
31.Nd barrier attribute operations
32.Sh LIBRARY
33.Lb libpthread
34.Sh SYNOPSIS
35.In pthread.h
36.Ft int
37.Fn pthread_barrierattr_init "pthread_barrierattr_t *attr"
38.Ft int
39.Fn pthread_barrierattr_destroy "pthread_barrierattr_t *attr"
40.Sh DESCRIPTION
41Barrier attributes are used to specify parameters to be used with
42.Xr pthread_barrier_init 3 .
43One attribute object can be used in multiple calls to
44.Fn pthread_barrier_init ,
45with or without modifications between calls.
46.Pp
47The
48.Fn pthread_barrierattr_init
49function initializes
50.Fa attr
51with the default barrier attributes.
52.Pp
53The
54.Fn pthread_barrierattr_destroy
55function destroys
56.Fa attr .
57.Sh RETURN VALUES
58If successful, these functions return 0.
59Otherwise, an error number is returned to indicate the error.
60.Sh ERRORS
61No error codes are defined for
62.Fn pthread_barrierattr_init .
63.Pp
64The
65.Fn pthread_barrierattr_destroy
66function may fail if:
67.Bl -tag -width Er
68.It Bq Er EINVAL
69The value specified by
70.Fa attr
71is invalid.
72.El
73.Sh SEE ALSO
74.Xr pthread_barrier_init 3
75.Sh STANDARDS
76Both functions conform to
77.St -p1003.1-2001 .
78