pthread_condattr_setpshared.html 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
  2. <HTML>
  3. <HEAD>
  4. <META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=utf-8">
  5. <TITLE>&quot;PTHREAD_CONDATTR_GETPSHARED&quot;(P) manual page</TITLE>
  6. <META NAME="GENERATOR" CONTENT="OpenOffice.org 1.1.3 (Linux)">
  7. <META NAME="CREATED" CONTENT="20050504;17542300">
  8. <META NAME="CHANGED" CONTENT="20050505;18293100">
  9. <!-- manual page source format generated by PolyglotMan v3.2, -->
  10. <!-- available at http://polyglotman.sourceforge.net/ -->
  11. </HEAD>
  12. <BODY LANG="en-GB" BGCOLOR="#ffffff" DIR="LTR">
  13. <H4>POSIX Threads for Windows – REFERENCE - <A HREF="http://sources.redhat.com/pthreads-win32">Pthreads-w32</A></H4>
  14. <P><A HREF="index.html">Reference Index</A></P>
  15. <P><A HREF="#toc">Table of Contents</A></P>
  16. <H2><A HREF="#toc0" NAME="sect0">Name</A></H2>
  17. <P>pthread_condattr_getpshared, pthread_condattr_setpshared - get and
  18. set the process-shared condition variable attributes
  19. </P>
  20. <H2><A HREF="#toc1" NAME="sect1">Synopsis</A></H2>
  21. <P><B>#include &lt;pthread.h&gt; </B>
  22. </P>
  23. <P><B>int pthread_condattr_getpshared(const pthread_condattr_t
  24. *restrict</B> <I>attr</I><B>, int *restrict</B> <I>pshared</I><B>);
  25. <BR>int pthread_condattr_setpshared(pthread_condattr_t *</B><I>attr</I><B>,
  26. int</B> <I>pshared</I><B>); </B>
  27. </P>
  28. <H2><A HREF="#toc2" NAME="sect2">Description</A></H2>
  29. <P>The <B>pthread_condattr_getpshared</B> function shall obtain the
  30. value of the <I>process-shared</I> attribute from the attributes
  31. object referenced by <I>attr</I>. The <B>pthread_condattr_setpshared</B>
  32. function shall set the <I>process-shared</I> attribute in an
  33. initialized attributes object referenced by <I>attr</I>.
  34. </P>
  35. <P>The <I>process-shared</I> attribute is set to
  36. <B>PTHREAD_PROCESS_SHARED</B> to permit a condition variable to be
  37. operated upon by any thread that has access to the memory where the
  38. condition variable is allocated, even if the condition variable is
  39. allocated in memory that is shared by multiple processes. If the
  40. <I>process-shared</I> attribute is <B>PTHREAD_PROCESS_PRIVATE</B>,
  41. the condition variable shall only be operated upon by threads created
  42. within the same process as the thread that initialized the condition
  43. variable; if threads of differing processes attempt to operate on
  44. such a condition variable, the behavior is undefined. The default
  45. value of the attribute is <B>PTHREAD_PROCESS_PRIVATE</B>.
  46. </P>
  47. <P><B>Pthreads-w32</B> defines _<B>POSIX_THREAD_PROCESS_SHARED</B> in
  48. pthread.h as -1 to indicate that these routines are implemented but
  49. that the process shared attribute is not supported.</P>
  50. <H2><A HREF="#toc3" NAME="sect3">Return Value</A></H2>
  51. <P>If successful, the <B>pthread_condattr_setpshared</B> function
  52. shall return zero; otherwise, an error number shall be returned to
  53. indicate the error.
  54. </P>
  55. <P>If successful, the <B>pthread_condattr_getpshared</B> function
  56. shall return zero and store the value of the <I>process-shared</I>
  57. attribute of <I>attr</I> into the object referenced by the <I>pshared</I>
  58. parameter. Otherwise, an error number shall be returned to indicate
  59. the error.
  60. </P>
  61. <H2><A HREF="#toc4" NAME="sect4">Errors</A></H2>
  62. <P>The <B>pthread_condattr_getpshared</B> and
  63. <B>pthread_condattr_setpshared</B> functions may fail if:
  64. </P>
  65. <DL>
  66. <DT><B>EINVAL</B>
  67. </DT><DD STYLE="margin-bottom: 0.5cm">
  68. The value specified by <I>attr</I> is invalid.
  69. </DD></DL>
  70. <P>
  71. The <B>pthread_condattr_setpshared</B> function may fail if:
  72. </P>
  73. <DL>
  74. <DT><B>EINVAL</B>
  75. </DT><DD STYLE="margin-bottom: 0.5cm">
  76. The new value specified for the attribute is outside the range of
  77. legal values for that attribute.
  78. </DD><DT>
  79. <B>ENOSYS</B>
  80. </DT><DD STYLE="margin-bottom: 0.5cm">
  81. The value specified by <I>attr</I> was <B>PTHREAD_PROCESS_SHARED</B>
  82. (Pthreads-w32).</DD></DL>
  83. <P>
  84. These functions shall not return an error code of [EINTR].
  85. </P>
  86. <P><I>The following sections are informative.</I>
  87. </P>
  88. <H2><A HREF="#toc5" NAME="sect5">Examples</A></H2>
  89. <P>None.
  90. </P>
  91. <H2><A HREF="#toc6" NAME="sect6">Application Usage</A></H2>
  92. <P><B>Pthreads-w32</B> defines <B>_POSIX_THREAD_PROCESS_SHARED</B> in
  93. pthread.h as -1 to indicate that these routines are implemented and
  94. may be used, but do not support the process shared option.</P>
  95. <H2><A HREF="#toc7" NAME="sect7">Rationale</A></H2>
  96. <P>None.
  97. </P>
  98. <H2><A HREF="#toc8" NAME="sect8">Future Directions</A></H2>
  99. <P>None.
  100. </P>
  101. <H2><A HREF="#toc9" NAME="sect9">See Also</A></H2>
  102. <P><A HREF="pthread_create.html"><B>pthread_create</B>(3)</A> <B>,</B>
  103. <A HREF="pthread_cond_init.html"><B>pthread_cond_destroy</B>(3)</A> <B>,</B>
  104. <A HREF="pthread_condattr_init.html"><B>pthread_condattr_destroy</B>(3)</A>
  105. <B>,</B> <A HREF="pthread_mutex_init.html"><B>pthread_mutex_destroy</B>(3)</A>
  106. <B>,</B> the Base Definitions volume of IEEE&nbsp;Std&nbsp;1003.1-2001,
  107. <I>&lt;pthread.h&gt;</I>
  108. </P>
  109. <H2><A HREF="#toc10" NAME="sect10">Copyright</A></H2>
  110. <P>Portions of this text are reprinted and reproduced in electronic
  111. form from IEEE Std 1003.1, 2003 Edition, Standard for Information
  112. Technology -- Portable Operating System Interface (POSIX), The Open
  113. Group Base Specifications Issue 6, Copyright (C) 2001-2003 by the
  114. Institute of Electrical and Electronics Engineers, Inc and The Open
  115. Group. In the event of any discrepancy between this version and the
  116. original IEEE and The Open Group Standard, the original IEEE and The
  117. Open Group Standard is the referee document. The original Standard
  118. can be obtained online at <A HREF="http://www.opengroup.org/unix/online.html">http://www.opengroup.org/unix/online.html</A>
  119. .
  120. </P>
  121. <P>Modified by Ross Johnson for use with <A HREF="http://sources.redhat.com/pthreads-win32">Pthreads-w32</A>.</P>
  122. <HR>
  123. <P><A NAME="toc"></A><B>Table of Contents</B></P>
  124. <UL>
  125. <LI><P STYLE="margin-bottom: 0cm"><A HREF="#sect0" NAME="toc0">Name</A>
  126. </P>
  127. <LI><P STYLE="margin-bottom: 0cm"><A HREF="#sect1" NAME="toc1">Synopsis</A>
  128. </P>
  129. <LI><P STYLE="margin-bottom: 0cm"><A HREF="#sect2" NAME="toc2">Description</A>
  130. </P>
  131. <LI><P STYLE="margin-bottom: 0cm"><A HREF="#sect3" NAME="toc3">Return
  132. Value</A>
  133. </P>
  134. <LI><P STYLE="margin-bottom: 0cm"><A HREF="#sect4" NAME="toc4">Errors</A>
  135. </P>
  136. <LI><P STYLE="margin-bottom: 0cm"><A HREF="#sect5" NAME="toc5">Examples</A>
  137. </P>
  138. <LI><P STYLE="margin-bottom: 0cm"><A HREF="#sect6" NAME="toc6">Application
  139. Usage</A>
  140. </P>
  141. <LI><P STYLE="margin-bottom: 0cm"><A HREF="#sect7" NAME="toc7">Rationale</A>
  142. </P>
  143. <LI><P STYLE="margin-bottom: 0cm"><A HREF="#sect8" NAME="toc8">Future
  144. Directions</A>
  145. </P>
  146. <LI><P STYLE="margin-bottom: 0cm"><A HREF="#sect9" NAME="toc9">See
  147. Also</A>
  148. </P>
  149. <LI><P><A HREF="#sect10" NAME="toc10">Copyright</A>
  150. </P>
  151. </UL>
  152. </BODY>
  153. </HTML>