xref: /freebsd/share/man/man3/pthread_rwlockattr_setpshared.3 (revision 6af83ee0d2941d18880b6aaa2b4facd1d30c6106)
1.\" Copyright (c) 1998 Alex Nash
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd August 4, 1998
28.Dt PTHREAD_RWLOCKATTR_SETPSHARED 3
29.Os
30.Sh NAME
31.Nm pthread_rwlockattr_setpshared
32.Nd set the process shared attribute
33.Sh LIBRARY
34.Lb libc_r
35.Lb libpthread
36.Lb libthr
37.Sh SYNOPSIS
38.In pthread.h
39.Ft int
40.Fn pthread_rwlockattr_setpshared "pthread_rwlockattr_t *attr" "int pshared"
41.Sh DESCRIPTION
42The
43.Fn pthread_rwlockattr_setpshared
44function sets the process shared attribute of
45.Fa attr
46to the value referenced by
47.Fa pshared .
48The
49.Fa pshared
50argument may be one of two values:
51.Bl -tag -width PTHREAD_PROCESS_PRIVATE
52.It Dv PTHREAD_PROCESS_SHARED
53Any thread of any process that has access to the memory where the
54read/write lock resides can manipulate the lock.
55.It Dv PTHREAD_PROCESS_PRIVATE
56Only threads created within the same process as the thread that
57initialized the read/write lock can manipulate the lock.
58This is
59the default value.
60.El
61.Sh RETURN VALUES
62If successful, the
63.Fn pthread_rwlockattr_setpshared
64function will return zero.
65Otherwise an error number will be returned
66to indicate the error.
67.Sh ERRORS
68The
69.Fn pthread_rwlockattr_setpshared
70function will fail if:
71.Bl -tag -width Er
72.It Bq Er EINVAL
73The value specified by
74.Fa attr
75or
76.Fa pshared
77is invalid.
78.El
79.Sh SEE ALSO
80.Xr pthread_rwlockattr_getpshared 3 ,
81.Xr pthread_rwlockattr_init 3 ,
82.Xr pthread_rwlock_init 3
83.Sh STANDARDS
84The
85.Fn pthread_rwlockattr_setpshared
86function is expected to conform to
87.St -susv2 .
88.Sh HISTORY
89The
90.Fn pthread_rwlockattr_setpshared
91function first appeared in
92.Fx 3.0 .
93.Sh BUGS
94The
95.Dv PTHREAD_PROCESS_SHARED
96attribute is not supported.
97