usr/src/man/man3c/pthread_condattr_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_CONDATTR_INIT 3C "Mar 23, 2005"
  13 .SH NAME
  14 pthread_condattr_init, pthread_condattr_destroy \- initialize or destroy
  15 condition variable attributes object
  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_condattr_init\fR(\fBpthread_condattr_t *\fR\fIattr\fR);
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBint\fR \fBpthread_condattr_destroy\fR(\fBpthread_condattr_t *\fR\fIattr\fR);
  28 .fi
  29
  30 .SH DESCRIPTION
  31 .sp
  32 .LP
  33 The \fBpthread_condattr_init()\fR function initializes a condition variable
  34 attributes object \fIattr\fR with the default value for all of the attributes
  35 defined by the implementation.
  36 .sp
  37 .LP
  38 At present, the only attribute available is the scope of condition variables.
  39 The default scope of the attribute is  \fBPTHREAD_PROCESS_PRIVATE\fR.
  40 .sp
  41 .LP
  42 Attempts to initialize previously initialized condition variable attributes
  43 object will leave the storage allocated by the previous initialization
  44 unallocated.
  45 .sp
  46 .LP
  47 After a condition variable attributes object has been used to initialize one or
  48 more condition variables, any function affecting the attributes object
  49 (including destruction) does not affect any previously initialized condition
  50 variables.
  51 .sp
  52 .LP
  53 The \fBpthread_condattr_destroy()\fR function destroys a condition variable
  54 attributes object; the object becomes, in effect, uninitialized. An
  55 implementation may cause \fBpthread_condattr_destroy()\fR to set the object
  56 referenced by \fIattr\fR to an invalid value. A destroyed condition variable
  57 attributes object can be re-initialized using \fBpthread_condattr_init()\fR;
  58 the results of otherwise referencing the object after it has been destroyed are
  59 undefined.
  60 .sp
  61 .LP
  62 Additional attributes, their default values, and the names of the associated
  63 functions to get and set those attribute values are implementation-dependent.
  64 .SH RETURN VALUES
  65 .sp
  66 .LP
  67 If successful, the \fBpthread_condattr_init()\fR and
  68 \fBpthread_condattr_destroy()\fR functions return  \fB0\fR. Otherwise, an error
  69 number is returned to indicate the error.
  70 .SH ERRORS
  71 .sp
  72 .LP
  73 The  \fBpthread_condattr_init()\fR function will fail if:
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fBENOMEM\fR\fR
  78 .ad
  79 .RS 10n
  80 Insufficient memory exists to initialize the condition variable attributes
  81 object.
  82 .RE
  83
  84 .sp
  85 .LP
  86 The \fBpthread_condattr_destroy()\fR function may fail if:
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fBEINVAL\fR\fR
  91 .ad
  92 .RS 10n
  93 The value specified by \fIattr\fR is invalid.
  94 .RE
  95
  96 .SH ATTRIBUTES
  97 .sp
  98 .LP
  99 See \fBattributes\fR(5) for descriptions of the following attributes:
 100 .sp
 101
 102 .sp
 103 .TS
 104 box;
 105 c | c
 106 l | l .
 107 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 108 _
 109 Interface Stability     Standard
 110 _
 111 MT-Level        MT-Safe
 112 .TE
 113
 114 .SH SEE ALSO
 115 .sp
 116 .LP
 117 \fBpthread_condattr_getpshared\fR(3C), \fBpthread_condattr_setpshared\fR(3C),
 118 \fBpthread_cond_init\fR(3C), \fBpthread_create\fR(3C),
 119 \fBpthread_mutex_init\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)