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

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved.
   4 .\" Copyright 1991, 1992, 1994, The X/Open Company Ltd.
   5 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   6 .\" http://www.opengroup.org/bookstore/.
   7 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   8 .\"  This notice shall appear on any product containing this material.
   9 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
  10 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
  11 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  12 .TH PTHREAD_COND_INIT 3C "Mar 23, 2005"
  13 .SH NAME
  14 pthread_cond_init, pthread_cond_destroy \- initialize or destroy condition
  15 variables
  16 .SH SYNOPSIS
  17 .LP
  18 .nf
  19 cc -mt [ \fIflag\fR... ] \fIfile\fR... -lpthread [ \fIlibrary\fR... ]
  20 #include <pthread.h>
  21
  22 \fBint\fR \fBpthread_cond_init\fR(\fBpthread_cond_t *restrict\fR \fIcond\fR,
  23      \fBconst pthread_condattr_t *restrict\fR \fIattr\fR);
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fBint\fR \fBpthread_cond_destroy\fR(\fBpthread_cond_t *\fR\fIcond\fR
  29 .fi
  30
  31 .LP
  32 .nf
  33 \fBpthread_cond_t\fR \fIcond\fR= \fBPTHREAD_COND_INITIALIZER\fR;
  34 .fi
  35
  36 .SH DESCRIPTION
  37 .sp
  38 .LP
  39 The function \fBpthread_cond_init()\fR initializes the condition variable
  40 referenced by \fIcond\fR with attributes referenced by \fIattr\fR. If
  41 \fIattr\fR is  \fBNULL\fR, the default condition variable attributes are used;
  42 the effect is the same as passing the address of a default condition variable
  43 attributes object. See \fBpthread_condattr_init\fR(3C). Upon successful
  44 initialization, the state of the condition variable becomes initialized.
  45 .sp
  46 .LP
  47 Attempting to initialize an already initialized condition variable results in
  48 undefined behavior.
  49 .sp
  50 .LP
  51 The function \fBpthread_cond_destroy()\fR destroys the given condition variable
  52 specified by \fIcond\fR; the object becomes, in effect, uninitialized. An
  53 implementation may cause \fBpthread_cond_destroy()\fR to set the object
  54 referenced by \fIcond\fR to an invalid value. A destroyed condition variable
  55 object can be re-initialized using \fBpthread_cond_init()\fR; the results of
  56 otherwise referencing the object after it has been destroyed are undefined.
  57 .sp
  58 .LP
  59 It is safe to destroy an initialized condition variable upon which no threads
  60 are currently blocked. Attempting to destroy a condition variable upon which
  61 other threads are currently blocked results in undefined behavior.
  62 .sp
  63 .LP
  64 In cases where default condition variable attributes are appropriate, the macro
  65 \fBPTHREAD_COND_INITIALIZER\fR can be used to initialize condition variables
  66 that are statically allocated. The effect is equivalent to dynamic
  67 initialization by a call to \fBpthread_cond_init()\fR with parameter \fIattr\fR
  68 specified as  \fBNULL,\fR except that no error checks are performed.
  69 .SH RETURN VALUES
  70 .sp
  71 .LP
  72 If successful, the \fBpthread_cond_init()\fR and \fBpthread_cond_destroy()\fR
  73 functions return  \fB0\fR. Otherwise, an error number is returned to indicate
  74 the error. The \fBEBUSY\fR and \fBEINVAL\fR error checks, if implemented, act
  75 as if they were performed immediately at the beginning of processing for the
  76 function and caused an error return prior to modifying the state of the
  77 condition variable specified by \fIcond\fR.
  78 .SH ERRORS
  79 .sp
  80 .LP
  81 The  \fBpthread_cond_init()\fR function will fail if:
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fBEAGAIN\fR\fR
  86 .ad
  87 .RS 10n
  88 The system lacked the necessary resources (other than memory) to initialize
  89 another condition variable.
  90 .RE
  91
  92 .sp
  93 .ne 2
  94 .na
  95 \fB\fBENOMEM\fR\fR
  96 .ad
  97 .RS 10n
  98 Insufficient memory exists to initialize the condition variable.
  99 .RE
 100
 101 .sp
 102 .LP
 103 The \fBpthread_cond_init()\fR function may fail if:
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fBEBUSY\fR\fR
 108 .ad
 109 .RS 10n
 110 The implementation has detected an attempt to re-initialize the object
 111 referenced by \fIcond\fR, a previously initialized, but not yet destroyed,
 112 condition variable.
 113 .RE
 114
 115 .sp
 116 .ne 2
 117 .na
 118 \fB\fBEINVAL\fR\fR
 119 .ad
 120 .RS 10n
 121 The value specified by \fIattr\fR is invalid.
 122 .RE
 123
 124 .sp
 125 .LP
 126 The \fBpthread_cond_destroy()\fR function may fail if:
 127 .sp
 128 .ne 2
 129 .na
 130 \fB\fBEBUSY\fR\fR
 131 .ad
 132 .RS 10n
 133 The implementation has detected an attempt to destroy the object referenced by
 134 \fIcond\fR while it is referenced (for example, while being used in a
 135 \fBpthread_cond_wait()\fR or \fBpthread_cond_timedwait()\fR) by another thread.
 136 .RE
 137
 138 .sp
 139 .ne 2
 140 .na
 141 \fB\fBEINVAL\fR\fR
 142 .ad
 143 .RS 10n
 144 The value specified by \fIcond\fR is invalid.
 145 .RE
 146
 147 .SH ATTRIBUTES
 148 .sp
 149 .LP
 150 See \fBattributes\fR(5) for descriptions of the following attributes:
 151 .sp
 152
 153 .sp
 154 .TS
 155 box;
 156 c | c
 157 l | l .
 158 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 159 _
 160 Interface Stability     Standard
 161 _
 162 MT-Level        MT-Safe
 163 .TE
 164
 165 .SH SEE ALSO
 166 .sp
 167 .LP
 168 \fBpthread_cond_signal\fR(3C), \fBpthread_cond_broadcast\fR(3C),
 169 \fBpthread_cond_wait\fR(3C), \fBpthread_cond_timedwait\fR(3C),
 170 \fBpthread_condattr_init\fR(3C), \fBattributes\fR(5), \fBcondition\fR(5),
 171 \fBstandards\fR(5)