usr/src/man/man3c/pthread_condattr_init.3c

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright 1991, 1992, 1994, The X/Open Company Ltd.
  44 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  45 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
  46 .\"
  47 .TH PTHREAD_CONDATTR_INIT 3C "Mar 23, 2005"
  48 .SH NAME
  49 pthread_condattr_init, pthread_condattr_destroy \- initialize or destroy
  50 condition variable attributes object
  51 .SH SYNOPSIS
  52 .LP
  53 .nf
  54 cc -mt [ \fIflag\fR... ] \fIfile\fR... -lpthread [ \fIlibrary\fR... ]
  55 #include <pthread.h>
  56
  57 \fBint\fR \fBpthread_condattr_init\fR(\fBpthread_condattr_t *\fR\fIattr\fR);
  58 .fi
  59
  60 .LP
  61 .nf
  62 \fBint\fR \fBpthread_condattr_destroy\fR(\fBpthread_condattr_t *\fR\fIattr\fR);
  63 .fi
  64
  65 .SH DESCRIPTION
  66 .sp
  67 .LP
  68 The \fBpthread_condattr_init()\fR function initializes a condition variable
  69 attributes object \fIattr\fR with the default value for all of the attributes
  70 defined by the implementation.
  71 .sp
  72 .LP
  73 At present, the only attribute available is the scope of condition variables.
  74 The default scope of the attribute is  \fBPTHREAD_PROCESS_PRIVATE\fR.
  75 .sp
  76 .LP
  77 Attempts to initialize previously initialized condition variable attributes
  78 object will leave the storage allocated by the previous initialization
  79 unallocated.
  80 .sp
  81 .LP
  82 After a condition variable attributes object has been used to initialize one or
  83 more condition variables, any function affecting the attributes object
  84 (including destruction) does not affect any previously initialized condition
  85 variables.
  86 .sp
  87 .LP
  88 The \fBpthread_condattr_destroy()\fR function destroys a condition variable
  89 attributes object; the object becomes, in effect, uninitialized. An
  90 implementation may cause \fBpthread_condattr_destroy()\fR to set the object
  91 referenced by \fIattr\fR to an invalid value. A destroyed condition variable
  92 attributes object can be re-initialized using \fBpthread_condattr_init()\fR;
  93 the results of otherwise referencing the object after it has been destroyed are
  94 undefined.
  95 .sp
  96 .LP
  97 Additional attributes, their default values, and the names of the associated
  98 functions to get and set those attribute values are implementation-dependent.
  99 .SH RETURN VALUES
 100 .sp
 101 .LP
 102 If successful, the \fBpthread_condattr_init()\fR and
 103 \fBpthread_condattr_destroy()\fR functions return  \fB0\fR. Otherwise, an error
 104 number is returned to indicate the error.
 105 .SH ERRORS
 106 .sp
 107 .LP
 108 The  \fBpthread_condattr_init()\fR function will fail if:
 109 .sp
 110 .ne 2
 111 .na
 112 \fB\fBENOMEM\fR\fR
 113 .ad
 114 .RS 10n
 115 Insufficient memory exists to initialize the condition variable attributes
 116 object.
 117 .RE
 118
 119 .sp
 120 .LP
 121 The \fBpthread_condattr_destroy()\fR function may fail if:
 122 .sp
 123 .ne 2
 124 .na
 125 \fB\fBEINVAL\fR\fR
 126 .ad
 127 .RS 10n
 128 The value specified by \fIattr\fR is invalid.
 129 .RE
 130
 131 .SH ATTRIBUTES
 132 .sp
 133 .LP
 134 See \fBattributes\fR(5) for descriptions of the following attributes:
 135 .sp
 136
 137 .sp
 138 .TS
 139 box;
 140 c | c
 141 l | l .
 142 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 143 _
 144 Interface Stability     Standard
 145 _
 146 MT-Level        MT-Safe
 147 .TE
 148
 149 .SH SEE ALSO
 150 .sp
 151 .LP
 152 \fBpthread_condattr_getpshared\fR(3C), \fBpthread_condattr_setpshared\fR(3C),
 153 \fBpthread_cond_init\fR(3C), \fBpthread_create\fR(3C),
 154 \fBpthread_mutex_init\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)