share/man/man3c/pthread_once.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 (c) 1995 IEEE. All Rights Reserved.
  44 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  45 .\" Portions Copyright (c) 2005, Sun Microsystems, Inc.
  46 .\"
  47 .TH PTHREAD_ONCE 3C "Mar 23, 2005"
  48 .SH NAME
  49 pthread_once \- initialize dynamic package
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 cc -mt [ \fIflag\fR... ] \fIfile\fR... -lpthread [ \fIlibrary\fR... ]
  54
  55 #include <pthread.h>
  56 \fBpthread_once_t\fR \fIonce_control\fR = \fBPTHREAD_ONCE_INIT\fR;
  57
  58 \fBint\fR \fBpthread_once\fR(\fBpthread_once_t *\fR\fIonce_control\fR,
  59      \fBvoid (*\fR\fIinit_routine\fR)(\fBvoid\fR));
  60 .fi
  61
  62 .SH DESCRIPTION
  63 .sp
  64 .LP
  65 If any thread in a process with a \fIonce_control\fR parameter makes a call to
  66 \fBpthread_once()\fR, the first call will summon the \fBinit_routine()\fR, but
  67 subsequent calls will not. The \fIonce_control\fR parameter determines whether
  68 the associated initialization routine has been called. The \fBinit_routine()\fR
  69 is complete upon return of \fBpthread_once()\fR.
  70 .sp
  71 .LP
  72 \fBpthread_once()\fR is not a cancellation point; however, if the function
  73 \fBinit_routine()\fR is a cancellation point and is canceled, the effect on
  74 \fIonce_control\fR is the same as if \fBpthread_once()\fR had never been
  75 called.
  76 .sp
  77 .LP
  78 The constant \fBPTHREAD_ONCE_INIT\fR is defined in the \fB<pthread.h>\fR
  79 header.
  80 .sp
  81 .LP
  82 If \fIonce_control\fR has automatic storage duration or is not initialized by
  83 \fBPTHREAD_ONCE_INIT\fR, the behavior of \fBpthread_once()\fR is undefined.
  84 .SH RETURN VALUES
  85 .sp
  86 .LP
  87 Upon successful completion, \fBpthread_once()\fR returns \fB0\fR. Otherwise, an
  88 error number is returned to indicate the error.
  89 .SH ERRORS
  90 .sp
  91 .ne 2
  92 .na
  93 \fB\fBEINVAL\fR \fR
  94 .ad
  95 .RS 11n
  96 \fIonce_control\fR or  \fIinit_routine\fR is \fINULL\fR.
  97 .RE
  98
  99 .SH ATTRIBUTES
 100 .sp
 101 .LP
 102 See \fBattributes\fR(5) for descriptions of the following attributes:
 103 .sp
 104
 105 .sp
 106 .TS
 107 box;
 108 c | c
 109 l | l .
 110 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 111 _
 112 Interface Stability     Standard
 113 _
 114 MT-Level        MT-Safe
 115 .TE
 116
 117 .SH SEE ALSO
 118 .sp
 119 .LP
 120 \fBattributes\fR(5), \fBstandards\fR(5)
 121 .SH NOTES
 122 .sp
 123 .LP
 124 Solaris threads do not offer this functionality.