lib/libpthread/pthread_mutex_init.3

   1 .\" $NetBSD: pthread_mutex_init.3,v 1.4 2008/05/04 19:43:05 martin Exp $
   2 .\"
   3 .\" Copyright (c) 2002 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  14 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  15 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  17 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  23 .\" POSSIBILITY OF SUCH DAMAGE.
  24 .\"
  25 .\" Copyright (c) 1997 Brian Cully <shmit@kublai.com>
  26 .\" All rights reserved.
  27 .\"
  28 .\" Redistribution and use in source and binary forms, with or without
  29 .\" modification, are permitted provided that the following conditions
  30 .\" are met:
  31 .\" 1. Redistributions of source code must retain the above copyright
  32 .\"    notice, this list of conditions and the following disclaimer.
  33 .\" 2. Redistributions in binary form must reproduce the above copyright
  34 .\"    notice, this list of conditions and the following disclaimer in the
  35 .\"    documentation and/or other materials provided with the distribution.
  36 .\" 3. Neither the name of the author nor the names of any co-contributors
  37 .\"    may be used to endorse or promote products derived from this software
  38 .\"    without specific prior written permission.
  39 .\"
  40 .\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
  41 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  43 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  44 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  45 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  46 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  48 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  49 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  50 .\" SUCH DAMAGE.
  51 .\"
  52 .\" $FreeBSD: src/lib/libpthread/man/pthread_mutex_init.3,v 1.12 2002/09/16 19:29:29 mini Exp $
  53 .\"
  54 .Dd January 30, 2003
  55 .Dt PTHREAD_MUTEX_INIT 3
  56 .Os
  57 .Sh NAME
  58 .Nm pthread_mutex_init
  59 .Nd create a mutex
  60 .Sh LIBRARY
  61 .Lb libpthread
  62 .Sh SYNOPSIS
  63 .In pthread.h
  64 .Ft int
  65 .Fn pthread_mutex_init "pthread_mutex_t * restrict mutex" "const pthread_mutexattr_t * restrict attr"
  66 .Sh DESCRIPTION
  67 The
  68 .Fn pthread_mutex_init
  69 function creates a new mutex, with attributes specified with
  70 .Fa attr .
  71 If
  72 .Fa attr
  73 is NULL the default attributes are used.
  74 .Sh RETURN VALUES
  75 If successful,
  76 .Fn pthread_mutex_init
  77 will return zero and put the new mutex id into
  78 .Fa mutex ,
  79 otherwise an error number will be returned to indicate the error.
  80 .Sh ERRORS
  81 .Fn pthread_mutex_init
  82 shall fail if:
  83 .Bl -tag -width Er
  84 .It Bq Er EAGAIN
  85 The system lacks the resources to initialize another mutex.
  86 .It Bq Er ENOMEM
  87 The process cannot allocate enough memory to initialize another mutex.
  88 .El
  89 .Pp
  90 .Fn pthread_mutex_init
  91 may fail if:
  92 .Bl -tag -width Er
  93 .It Bq Er EINVAL
  94 The value specified by
  95 .Fa attr
  96 is invalid.
  97 .El
  98 .Sh SEE ALSO
  99 .Xr pthread_mutex_destroy 3 ,
 100 .Xr pthread_mutex_lock 3 ,
 101 .Xr pthread_mutex_trylock 3 ,
 102 .Xr pthread_mutex_unlock 3
 103 .Sh STANDARDS
 104 .Fn pthread_mutex_init
 105 conforms to
 106 .St -p1003.1-96 .