xref: /freebsd/share/man/man3/pthread_rwlockattr_setpshared.3 (revision 9336e0699bda8a301cd2bfa37106b6ec5e32012e)
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 libpthread
35.Sh SYNOPSIS
36.In pthread.h
37.Ft int
38.Fn pthread_rwlockattr_setpshared "pthread_rwlockattr_t *attr" "int pshared"
39.Sh DESCRIPTION
40The
41.Fn pthread_rwlockattr_setpshared
42function sets the process shared attribute of
43.Fa attr
44to the value referenced by
45.Fa pshared .
46The
47.Fa pshared
48argument may be one of two values:
49.Bl -tag -width PTHREAD_PROCESS_PRIVATE
50.It Dv PTHREAD_PROCESS_SHARED
51Any thread of any process that has access to the memory where the
52read/write lock resides can manipulate the lock.
53.It Dv PTHREAD_PROCESS_PRIVATE
54Only threads created within the same process as the thread that
55initialized the read/write lock can manipulate the lock.
56This is
57the default value.
58.El
59.Sh RETURN VALUES
60If successful, the
61.Fn pthread_rwlockattr_setpshared
62function will return zero.
63Otherwise an error number will be returned
64to indicate the error.
65.Sh ERRORS
66The
67.Fn pthread_rwlockattr_setpshared
68function will fail if:
69.Bl -tag -width Er
70.It Bq Er EINVAL
71The value specified by
72.Fa attr
73or
74.Fa pshared
75is invalid.
76.El
77.Sh SEE ALSO
78.Xr pthread_rwlockattr_getpshared 3 ,
79.Xr pthread_rwlockattr_init 3 ,
80.Xr pthread_rwlock_init 3
81.Sh STANDARDS
82The
83.Fn pthread_rwlockattr_setpshared
84function is expected to conform to
85.St -susv2 .
86.Sh HISTORY
87The
88.Fn pthread_rwlockattr_setpshared
89function first appeared in
90.Fx 3.0 .
91.Sh BUGS
92The
93.Dv PTHREAD_PROCESS_SHARED
94attribute is not supported.
95