share/man/man3/pthread_mutexattr.3

   1 .\" Copyright (C) 2000 Jason Evans <jasone@FreeBSD.org>.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice(s), this list of conditions and the following disclaimer as
   9 .\"    the first lines of this file unmodified other than the possible
  10 .\"    addition of one or more copyright notices.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice(s), this list of conditions and the following disclaimer in
  13 .\"    the documentation and/or other materials provided with the
  14 .\"    distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
  17 .\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  19 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE
  20 .\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  23 .\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  24 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  25 .\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  26 .\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD$
  29 .Dd May 1, 2000
  30 .Dt PTHREAD_MUTEXATTR 3
  31 .Os
  32 .Sh NAME
  33 .Nm pthread_mutexattr_init ,
  34 .Nm pthread_mutexattr_destroy ,
  35 .Nm pthread_mutexattr_setprioceiling ,
  36 .Nm pthread_mutexattr_getprioceiling ,
  37 .Nm pthread_mutexattr_setprotocol ,
  38 .Nm pthread_mutexattr_getprotocol ,
  39 .Nm pthread_mutexattr_settype ,
  40 .Nm pthread_mutexattr_gettype
  41 .Nd mutex attribute operations
  42 .Sh LIBRARY
  43 .Lb libc_r
  44 .Lb libpthread
  45 .Lb libthr
  46 .Sh SYNOPSIS
  47 .In pthread.h
  48 .Ft int
  49 .Fn pthread_mutexattr_init "pthread_mutexattr_t *attr"
  50 .Ft int
  51 .Fn pthread_mutexattr_destroy "pthread_mutexattr_t *attr"
  52 .Ft int
  53 .Fn pthread_mutexattr_setprioceiling "pthread_mutexattr_t *attr" "int prioceiling"
  54 .Ft int
  55 .Fn pthread_mutexattr_getprioceiling "pthread_mutexattr_t *attr" "int *prioceiling"
  56 .Ft int
  57 .Fn pthread_mutexattr_setprotocol "pthread_mutexattr_t *attr" "int protocol"
  58 .Ft int
  59 .Fn pthread_mutexattr_getprotocol "pthread_mutexattr_t *attr" "int *protocol"
  60 .Ft int
  61 .Fn pthread_mutexattr_settype "pthread_mutexattr_t *attr" "int type"
  62 .Ft int
  63 .Fn pthread_mutexattr_gettype "pthread_mutexattr_t *attr" "int *type"
  64 .Sh DESCRIPTION
  65 Mutex attributes are used to specify parameters to
  66 .Fn pthread_mutex_init .
  67 One attribute object can be used in multiple calls to
  68 .Fn pthread_mutex_init ,
  69 with or without modifications between calls.
  70 .Pp
  71 The
  72 .Fn pthread_mutexattr_init
  73 function initializes
  74 .Fa attr
  75 with all the default mutex attributes.
  76 .Pp
  77 The
  78 .Fn pthread_mutexattr_destroy
  79 function destroys
  80 .Fa attr .
  81 .Pp
  82 The
  83 .Fn pthread_mutexattr_set*
  84 functions set the attribute that corresponds to each function name.
  85 .Pp
  86 The
  87 .Fn pthread_mutexattr_get*
  88 functions copy the value of the attribute that corresponds to each function name
  89 to the location pointed to by the second function parameter.
  90 .Sh RETURN VALUES
  91 If successful, these functions return 0.
  92 Otherwise, an error number is returned to indicate the error.
  93 .Sh ERRORS
  94 The
  95 .Fn pthread_mutexattr_init
  96 function will fail if:
  97 .Bl -tag -width Er
  98 .It Bq Er ENOMEM
  99 Out of memory.
 100 .El
 101 .Pp
 102 The
 103 .Fn pthread_mutexattr_destroy
 104 function will fail if:
 105 .Bl -tag -width Er
 106 .It Bq Er EINVAL
 107 Invalid value for
 108 .Fa attr .
 109 .El
 110 .Pp
 111 The
 112 .Fn pthread_mutexattr_setprioceiling
 113 function will fail if:
 114 .Bl -tag -width Er
 115 .It Bq Er EINVAL
 116 Invalid value for
 117 .Fa attr ,
 118 or invalid value for
 119 .Fa prioceiling .
 120 .El
 121 .Pp
 122 The
 123 .Fn pthread_mutexattr_getprioceiling
 124 function will fail if:
 125 .Bl -tag -width Er
 126 .It Bq Er EINVAL
 127 Invalid value for
 128 .Fa attr .
 129 .El
 130 .Pp
 131 The
 132 .Fn pthread_mutexattr_setprotocol
 133 function will fail if:
 134 .Bl -tag -width Er
 135 .It Bq Er EINVAL
 136 Invalid value for
 137 .Fa attr ,
 138 or invalid value for
 139 .Fa protocol .
 140 .El
 141 .Pp
 142 The
 143 .Fn pthread_mutexattr_getprotocol
 144 function will fail if:
 145 .Bl -tag -width Er
 146 .It Bq Er EINVAL
 147 Invalid value for
 148 .Fa attr .
 149 .El
 150 .Pp
 151 The
 152 .Fn pthread_mutexattr_settype
 153 function will fail if:
 154 .Bl -tag -width Er
 155 .It Bq Er EINVAL
 156 Invalid value for
 157 .Fa attr ,
 158 or invalid value for
 159 .Fa type .
 160 .El
 161 .Pp
 162 The
 163 .Fn pthread_mutexattr_gettype
 164 function will fail if:
 165 .Bl -tag -width Er
 166 .It Bq Er EINVAL
 167 Invalid value for
 168 .Fa attr .
 169 .El
 170 .Sh SEE ALSO
 171 .Xr pthread_mutex_init 3
 172 .Sh STANDARDS
 173 The
 174 .Fn pthread_mutexattr_init
 175 and
 176 .Fn pthread_mutexattr_destroy
 177 functions conform to
 178 .St -p1003.1-96
 179 .Pp
 180 The
 181 .Fn pthread_mutexattr_setprioceiling ,
 182 .Fn pthread_mutexattr_getprioceiling ,
 183 .Fn pthread_mutexattr_setprotocol ,
 184 .Fn pthread_mutexattr_getprotocol ,
 185 .Fn pthread_mutexattr_settype ,
 186 and
 187 .Fn pthread_mutexattr_gettype
 188 functions conform to
 189 .St -susv2