xref: /dflybsd-src/lib/libpthread/pthread_rwlockattr_setpshared.3 (revision 7ec6eaed9e6eb69ae18f61d7496e7dfa5bade99f)
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: src/lib/libc_r/man/pthread_rwlockattr_setpshared.3,v 1.3.2.4 2001/12/17 10:08:26 ru Exp $
26.\" $DragonFly: src/lib/libc_r/man/pthread_rwlockattr_setpshared.3,v 1.3 2006/02/17 19:35:07 swildner Exp $
27.\"
28.Dd April 15, 2009
29.Dt PTHREAD_RWLOCKATTR_SETPSHARED 3
30.Os
31.Sh NAME
32.Nm pthread_rwlockattr_setpshared
33.Nd set the process shared attribute
34.Sh LIBRARY
35.Lb libpthread
36.Sh SYNOPSIS
37.In pthread.h
38.Ft int
39.Fn pthread_rwlockattr_setpshared "pthread_rwlockattr_t *attr" "int pshared"
40.Sh DESCRIPTION
41The
42.Fn pthread_rwlockattr_setpshared
43function sets the process shared attribute of
44.Fa attr
45to the value referenced by
46.Fa pshared .
47.Fa pshared
48may 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.  This is
56the default value.
57.El
58.Sh RETURN VALUES
59If successful, the
60.Fn pthread_rwlockattr_setpshared
61function will return zero.  Otherwise an error number will be returned
62to indicate the error.
63.Sh ERRORS
64.Fn pthread_rwlockattr_setpshared
65will fail if:
66.Bl -tag -width Er
67.It Bq Er EINVAL
68The value specified by
69.Fa attr
70or
71.Fa pshared
72is invalid.
73.El
74.Sh SEE ALSO
75.Xr pthread_rwlockattr_init 3 ,
76.Xr pthread_rwlockattr_setpshared 3 ,
77.Xr pthread_rwlock_init 3
78.Sh STANDARDS
79The
80.Fn pthread_rwlockattr_setpshared
81function is expected to conform to
82.St -susv2 .
83.Sh HISTORY
84The
85.Fn pthread_rwlockattr_setpshared
86function first appeared in
87.Fx 3.0 .
88.Sh BUGS
89The
90.Dv PTHREAD_PROCESS_SHARED
91attribute is not supported.
92