static/freebsd/man3/pthread_rwlockattr_setpshared.3 3.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

<table class="head">
  <tr>
    <td class="head-ltitle">PTHREAD_RWLOCKATTR_SETPSHARED(3)</td>
    <td class="head-vol">Library Functions Manual</td>
    <td class="head-rtitle">PTHREAD_RWLOCKATTR_SETPSHARED(3)</td>
  </tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">pthread_rwlockattr_setpshared</code> &#x2014;
    <span class="Nd">set the process shared attribute</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="LIBRARY"><a class="permalink" href="#LIBRARY">LIBRARY</a></h1>
<p class="Pp"><span class="Lb">POSIX Threads Library (libpthread,
    -lpthread)</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp"><code class="In">#include
    &lt;<a class="In">pthread.h</a>&gt;</code></p>
<p class="Pp"><var class="Ft">int</var>
  <br/>
  <code class="Fn">pthread_rwlockattr_setpshared</code>(<var class="Fa" style="white-space: nowrap;">pthread_rwlockattr_t
    *attr</var>, <var class="Fa" style="white-space: nowrap;">int
    pshared</var>);</p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The
    <a class="permalink" href="#pthread_rwlockattr_setpshared"><code class="Fn" id="pthread_rwlockattr_setpshared">pthread_rwlockattr_setpshared</code></a>()
    function sets the process shared attribute of <var class="Fa">attr</var> to
    the value referenced by <var class="Fa">pshared</var>. The
    <var class="Fa">pshared</var> argument may be one of two values:</p>
<dl class="Bl-tag">
  <dt id="PTHREAD_PROCESS_SHARED"><a class="permalink" href="#PTHREAD_PROCESS_SHARED"><code class="Dv">PTHREAD_PROCESS_SHARED</code></a></dt>
  <dd>Any thread of any process that has access to the memory where the
      read/write lock resides can manipulate the lock.</dd>
  <dt id="PTHREAD_PROCESS_PRIVATE"><a class="permalink" href="#PTHREAD_PROCESS_PRIVATE"><code class="Dv">PTHREAD_PROCESS_PRIVATE</code></a></dt>
  <dd>Only threads created within the same process as the thread that
      initialized the read/write lock can manipulate the lock. This is the
      default value.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="RETURN_VALUES"><a class="permalink" href="#RETURN_VALUES">RETURN
  VALUES</a></h1>
<p class="Pp">If successful, the
    <code class="Fn">pthread_rwlockattr_setpshared</code>() function will return
    zero. Otherwise an error number will be returned to indicate the error.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="ERRORS"><a class="permalink" href="#ERRORS">ERRORS</a></h1>
<p class="Pp">The <code class="Fn">pthread_rwlockattr_setpshared</code>()
    function will fail if:</p>
<dl class="Bl-tag">
  <dt id="EINVAL">[<a class="permalink" href="#EINVAL"><code class="Er">EINVAL</code></a>]</dt>
  <dd>The value specified by <var class="Fa">attr</var> or
      <var class="Fa">pshared</var> is invalid.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
  ALSO</a></h1>
<p class="Pp"><a class="Xr">pthread_rwlock_init(3)</a>,
    <a class="Xr">pthread_rwlockattr_getpshared(3)</a>,
    <a class="Xr">pthread_rwlockattr_init(3)</a></p>
</section>
<section class="Sh">
<h1 class="Sh" id="STANDARDS"><a class="permalink" href="#STANDARDS">STANDARDS</a></h1>
<p class="Pp">The <code class="Fn">pthread_rwlockattr_setpshared</code>()
    function is expected to conform to <span class="St">Version&#x00A0;2 of the
    Single UNIX Specification (&#x201C;SUSv2&#x201D;)</span>.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
<p class="Pp">The <code class="Fn">pthread_rwlockattr_setpshared</code>()
    function first appeared in <span class="Ux">FreeBSD 3.0</span>. Support for
    process-shared read/write locks appeared in <span class="Ux">FreeBSD
    11.0</span>.</p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">May 31, 2016</td>
    <td class="foot-os">FreeBSD 15.0</td>
  </tr>
</table>