xref: /freebsd/share/man/man3/pthread_rwlockattr_setpshared.3 (revision d37ea99837e6ad50837fd9fe1771ddf1c3ba6002)
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.  This is
58the default value.
59.El
60.Sh RETURN VALUES
61If successful, the
62.Fn pthread_rwlockattr_setpshared
63function will return zero.  Otherwise an error number will be returned
64to indicate the error.
65.Sh SEE ALSO
66.Xr pthread_rwlockattr_getpshared 3 ,
67.Xr pthread_rwlockattr_init 3 ,
68.Xr pthread_rwlock_init 3
69.Sh STANDARDS
70The
71.Fn pthread_rwlockattr_setpshared
72function is expected to conform to
73.St -susv2 .
74.Sh ERRORS
75The
76.Fn pthread_rwlockattr_setpshared
77function will fail if:
78.Bl -tag -width Er
79.It Bq Er EINVAL
80The value specified by
81.Fa attr
82or
83.Fa pshared
84is invalid.
85.El
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